Go to file
Joris Vink 49ca95f390 Add our messaging framework.
With this framework apps can now send messages between worker processes.

A new API function exists:
	int kore_msg_register(u_int8_t id, void (*cb)(const void *, u_int32_t);

This API call allows your app to register a new message callback for a given ID.

You can then send messages on this ID to other workers using:
	void kore_msg_send(u_int8_t id, void *data, u_int32_t length);

This framework will interally be used for a few things such as allowing
websocket data to broadcasted between all workers, adding unified caching
and hopefully eventually moving the access log to this as well.

Some internals have changed with this commit:
	* worker_clients has been called connections.
	* the parent now initializes the net, and event subsystems.
	* kore_worker_websocket_broadcast() is dead.
2015-06-22 21:13:32 +02:00
conf Add task_threads configuration option. 2015-06-04 10:29:22 +02:00
examples Add our messaging framework. 2015-06-22 21:13:32 +02:00
includes Add our messaging framework. 2015-06-22 21:13:32 +02:00
src Add our messaging framework. 2015-06-22 21:13:32 +02:00
.gitignore Ignore DSYM on osx 2014-04-12 18:49:32 +02:00
.travis.yml travis 2015-05-13 09:40:52 +02:00
LICENSE Bump copyright to 2015 2015-04-07 13:08:26 +02:00
Makefile Add our messaging framework. 2015-06-22 21:13:32 +02:00
README.md Call it NOTLS instead. 2015-05-25 09:42:34 -04:00

README.md

About

Build Status

Kore (https://kore.io) is an easy to use web application framework for writing scalable web APIs in C. Its main goals are security, scalability and allowing rapid development and deployment of such APIs.

Because of this Kore is an ideal candidate for building robust, scalable and secure web things.

Features

  • Supports SNI
  • Supports SPDY/3.1
  • Supports HTTP/1.1
  • Websocket support
  • Lightweight background tasks
  • Built-in parameter validation
  • Only HTTPS connections allowed
  • Multiple modules can be loaded at once
  • Built-in asynchronous PostgreSQL support
  • Default sane TLS ciphersuites (PFS in all major browsers)
  • Load your web application as a precompiled dynamic library
  • Modules can be reloaded on-the-fly, even while serving content
  • Event driven (epoll/kqueue) architecture with per CPU core workers

License

  • Kore is licensed under the ISC license

Platforms supported

  • Linux
  • OpenBSD
  • FreeBSD
  • OSX

See https://kore.io/doc/#requirements for more information.

Latest release

Old releases

Building Kore

Requirements

  • libz
  • openssl >= 1.0.1i

Requirements for background tasks (optional)

  • pthreads

Requirements for pgsql (optional)

  • libpq

Normal compilation and installation:

# git clone https://github.com/jorisvink/kore.git
# cd kore
# make
# make install

If you would like to build a specific flavor, you can enable those by setting a shell environment variable before running make.

  • TASKS=1 (compiles in task support)
  • PGSQL=1 (compiles in pgsql support)
  • DEBUG=1 (enables use of -d for debug)
  • NOTLS=1 (compiles Kore without OpenSSL)
  • KORE_PEDANTIC_MALLOC=1 (zero all allocated memory)

Example libraries

You can find example libraries under examples/.

The examples contain a README file with instructions on how to build or use them.

I apologize for unclear examples or documentation, I am working on improving those.

Bugs, contributions and more

If you run into any bugs, have suggestions or patches please contact me at joris@coders.se.

More information can be found on https://kore.io/