diff options
| author | Timo Dritschler <timo.dritschler@kit.edu> | 2015-04-10 19:01:29 +0200 |
|---|---|---|
| committer | Timo Dritschler <timo.dritschler@kit.edu> | 2015-04-10 19:01:29 +0200 |
| commit | de68b48a1ff110e965f2c02fc930201ece9980d2 (patch) | |
| tree | 8a4a6aed2a5c3ca9ce9c366daaa103916930333d /src/kiro-rdma.h | |
| parent | 0f4974458f3b10bf7f5939e3d7659b0f793e2347 (diff) | |
| download | kiro-de68b48a1ff110e965f2c02fc930201ece9980d2.tar.gz kiro-de68b48a1ff110e965f2c02fc930201ece9980d2.tar.bz2 kiro-de68b48a1ff110e965f2c02fc930201ece9980d2.tar.xz kiro-de68b48a1ff110e965f2c02fc930201ece9980d2.zip | |
Made all in-source documentation Gtk-Doc conformant
Diffstat (limited to 'src/kiro-rdma.h')
| -rw-r--r-- | src/kiro-rdma.h | 31 |
1 files changed, 29 insertions, 2 deletions
diff --git a/src/kiro-rdma.h b/src/kiro-rdma.h index c17e044..cd07f84 100644 --- a/src/kiro-rdma.h +++ b/src/kiro-rdma.h @@ -16,6 +16,13 @@ Franklin St, Fifth Floor, Boston, MA 02110, USA */ +/** + * SECTION: kiro-rdma + * + * KIRO toolbox for common operations with and around the + * RDMA Connection Manager for InfiniBand mechanisms + */ + #include <stdio.h> #include <stdlib.h> #include <unistd.h> @@ -26,7 +33,14 @@ #include <rdma/rdma_cma.h> - +/** + * kiro_connection_context: (skip) + * + * Holds all necessary metainformation to indentify with an abstract Kiro + * Connection. This is constructed and attached to a rdma_cm_id's context + * pointer. + * + */ struct kiro_connection_context { // Information and necessary structurs @@ -48,7 +62,13 @@ struct kiro_connection_context { }; - +/** + * kiro_ctrl_msg: (skip) + * + * Struct representing a Kiro control-flow message which is used internally by + * all kiro komponents to communicate with their peer(s) + * + */ struct kiro_ctrl_msg { enum { @@ -64,6 +84,13 @@ struct kiro_ctrl_msg { }; +/** + * kiro_rdma_mem: (skip) + * + * Container for all necessary information and data-elements that are needed to + * describe memory that can be managed by means of RDMA + * + */ struct kiro_rdma_mem { void *mem; // Pointer to the beginning of the memory block |