From 65c2326592b7b1496c468459689904843e443b26 Mon Sep 17 00:00:00 2001 From: Timo Dritschler Date: Thu, 20 Nov 2014 17:37:55 +0100 Subject: Release KIRO to GitHub under LGPL v2.1 Added kiro_*_free methods to all three units Added installation guide Added readme Added licence file --- README.md | 74 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 74 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 0000000..4cb06a9 --- /dev/null +++ b/README.md @@ -0,0 +1,74 @@ +General Information +====================== + +KIRO is the KITs InfiniBand remote communication library. +It provides a simple server and client class that can be used to pass arbitrary +information from the server to the client using _native_ InfiniBand +communication. +It also provides a network transmittable ring-buffer (TRB) which can be used as +a transmission container for same-sized objects. + +The library is optimized for speed and ease of use. + + +Installation +===================== + +Please refer to the INSTALL file of this project. + + +Usage +==================== + +Example KIRO server usage + +``` +#include +... + +int memSize = 42; +void *mem = malloc(memSize); //This is the memory we want to provide + +KiroServer *server = kiro_server_new (); + +const char *address = "192.168.1.1"; +const char *port = "60010"; +kiro_server_start (server, address, port, mem, memSize); +// The KIRO server is now running + +... + +kiro_server_stop (server); +kiro_server_free (server); + +... +``` + +Example KIRO client usage +``` +#include +... + +KiroClient *client = kiro_client_new (); + +const char *address = "192.168.1.1"; +const char *port = "60010"; + +kiro_client_connect (client, address, port); +//The client is now connected + +kiro_client_sync (client); + +void *mem = kiro_client_get_memory (client); + +kiro_client_free (client); +``` + +For TRB usage, check the examples in the _test_ directory + + +Licensing +===================== + +kiro is copyright to the Karlsruhe Institute of Technology and licensed under +the LGPL 2.1. -- cgit v1.2.3