git.meshlink.io Git - meshlink/blob - src/meshlink++.h

   1 /*
   2     meshlink++.h -- MeshLink C++ API
   3     Copyright (C) 2014 Guus Sliepen <guus@meshlink.io>
   4
   5     This program is free software; you can redistribute it and/or modify
   6     it under the terms of the GNU General Public License as published by
   7     the Free Software Foundation; either version 2 of the License, or
   8     (at your option) any later version.
   9
  10     This program is distributed in the hope that it will be useful,
  11     but WITHOUT ANY WARRANTY; without even the implied warranty of
  12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13     GNU General Public License for more details.
  14
  15     You should have received a copy of the GNU General Public License along
  16     with this program; if not, write to the Free Software Foundation, Inc.,
  17     51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 */
  19
  20 #ifndef MESHLINKPP_H
  21 #define MESHLINKPP_H
  22
  23 #include <meshlink.h>
  24
  25 namespace meshlink {
  26         class mesh;
  27         class node;
  28         class channel;
  29
  30         /// Severity of log messages generated by MeshLink.
  31         typedef meshlink_log_level_t log_level_t;
  32
  33         /// Code of most recent error encountered.
  34         typedef meshlink_errno_t errno_t;
  35
  36         /// A callback for receiving data from the mesh.
  37         /** @param mesh      A handle which represents an instance of MeshLink.
  38          *  @param source    A pointer to a meshlink::node describing the source of the data.
  39          *  @param data      A pointer to a buffer containing the data sent by the source.
  40          *  @param len       The length of the received data.
  41          */
  42         typedef void (*receive_cb_t)(mesh *mesh, node *source, const void *data, size_t len);
  43
  44         /// A callback reporting node status changes.
  45         /** @param mesh       A handle which represents an instance of MeshLink.
  46          *  @param node       A pointer to a meshlink::node describing the node whose status changed.
  47          *  @param reachable  True if the node is reachable, false otherwise.
  48          */
  49         typedef void (*node_status_cb_t)(mesh *mesh, node *node, bool reachable);
  50
  51         /// A callback for receiving log messages generated by MeshLink.
  52         /** @param mesh      A handle which represents an instance of MeshLink.
  53          *  @param level     An enum describing the severity level of the message.
  54          *  @param text      A pointer to a string containing the textual log message.
  55          */
  56         typedef void (*log_cb_t)(mesh *mesh, log_level_t level, const char *text);
  57
  58         /// A callback for accepting incoming channels.
  59         /** @param mesh         A handle which represents an instance of MeshLink.
  60          *  @param channel      A handle for the incoming channel.
  61          *  @param node         The node from which this channel is being initiated.
  62          *  @param port         The port number the peer wishes to connect to.
  63          *  @param data         A pointer to a buffer containing data already received. (Not yet used.)
  64          *  @param len          The length of the data. (Not yet used.)
  65          *
  66          *  @return             This function should return true if the application accepts the incoming channel, false otherwise.
  67          *                      If returning false, the channel is invalid and may not be used anymore.
  68          */
  69         typedef bool (*channel_accept_cb_t)(mesh *mesh, channel *channel, node *node, uint16_t port, const void *data, size_t len);
  70
  71         /// A callback for receiving data from a channel.
  72         /** @param mesh         A handle which represents an instance of MeshLink.
  73          *  @param channel      A handle for the channel.
  74          *  @param data         A pointer to a buffer containing data sent by the source.
  75          *  @param len          The length of the data.
  76          */
  77         typedef void (*channel_receive_cb_t)(mesh *mesh, channel *channel, const void *data, size_t len);
  78
  79         /// A class describing a MeshLink node.
  80         class node: public meshlink_node_t {
  81         };
  82
  83         /// A class describing a MeshLink channel.
  84         class channel: public meshlink_channel_t {
  85         };
  86
  87         /// A class describing a MeshLink mesh.
  88         class mesh: public meshlink_handle_t {
  89                 public:
  90                 // TODO: delete constructor, add a destructor.
  91
  92                 /// Start MeshLink.
  93                 /** This function causes MeshLink to open network sockets, make outgoing connections, and
  94                  *  create a new thread, which will handle all network I/O.
  95                  *
  96                  *  @return         This function will return true if MeshLink has succesfully started its thread, false otherwise.
  97                  */
  98                 bool start() {
  99                         return meshlink_start(this);
 100                 }
 101
 102                 /// Stop MeshLink.
 103                 /** This function causes MeshLink to disconnect from all other nodes,
 104                  *  close all sockets, and shut down its own thread.
 105                  */
 106                 void stop() {
 107                         meshlink_stop(this);
 108                 }
 109
 110                 /// Set the receive callback.
 111                 /** This functions sets the callback that is called whenever another node sends data to the local node.
 112                  *  The callback is run in MeshLink's own thread.
 113                  *  It is therefore important that the callback uses apprioriate methods (queues, pipes, locking, etc.)
 114                  *  to hand the data over to the application's thread.
 115                  *  The callback should also not block itself and return as quickly as possible.
 116                  *
 117                  *  @param cb        A pointer to the function which will be called when another node sends data to the local node.
 118                  */
 119                 void set_receive_cb(receive_cb_t cb) {
 120                         meshlink_set_receive_cb(this, (meshlink_receive_cb_t)cb);
 121                 }
 122
 123                 /// Set the node status callback.
 124                 /** This functions sets the callback that is called whenever another node's status changed.
 125                  *  The callback is run in MeshLink's own thread.
 126                  *  It is therefore important that the callback uses apprioriate methods (queues, pipes, locking, etc.)
 127                  *  to hand the data over to the application's thread.
 128                  *  The callback should also not block itself and return as quickly as possible.
 129                  *
 130                  *  @param cb        A pointer to the function which will be called when another node's status changes.
 131                  */
 132                 void set_node_status_cb(node_status_cb_t cb) {
 133                         meshlink_set_node_status_cb(this, (meshlink_node_status_cb_t)cb);
 134                 }
 135
 136                 /// Set the log callback.
 137                 /** This functions sets the callback that is called whenever MeshLink has some information to log.
 138                  *  The callback is run in MeshLink's own thread.
 139                  *  It is important that the callback uses apprioriate methods (queues, pipes, locking, etc.)
 140                  *  to hand the data over to the application's thread.
 141                  *  The callback should also not block itself and return as quickly as possible.
 142                  *
 143                  *  @param level     An enum describing the minimum severity level. Debugging information with a lower level will not trigger the callback.
 144                  *  @param cb        A pointer to the function which will be called when another node sends data to the local node.
 145                  */
 146                 void set_log_cb(meshlink_log_level_t level, log_cb_t cb) {
 147                         meshlink_set_log_cb(this, level, (meshlink_log_cb_t)cb);
 148                 }
 149
 150                 /// Send data to another node.
 151                 /** This functions sends one packet of data to another node in the mesh.
 152                  *  The packet is sent using UDP semantics, which means that
 153                  *  the packet is sent as one unit and is received as one unit,
 154                  *  and that there is no guarantee that the packet will arrive at the destination.
 155                  *  The application should take care of getting an acknowledgement and retransmission if necessary.
 156                  *
 157                  *  @param destination  A pointer to a meshlink::node describing the destination for the data.
 158                  *  @param data         A pointer to a buffer containing the data to be sent to the source.
 159                  *  @param len          The length of the data.
 160                  *  @return             This function will return true if MeshLink has queued the message for transmission, and false otherwise.
 161                  *                      A return value of true does not guarantee that the message will actually arrive at the destination.
 162                  */
 163                 bool send(node *destination, const void *data, unsigned int len) {
 164                         return meshlink_send(this, destination, data, len);
 165                 }
 166
 167                 /// Get a handle for a specific node.
 168                 /** This function returns a handle for the node with the given name.
 169                  *
 170                  *  @param name         The name of the node for which a handle is requested.
 171                  *
 172                  *  @return             A pointer to a meshlink::node which represents the requested node,
 173                  *                      or NULL if the requested node does not exist.
 174                  */
 175                 node *get_node(const char *name) {
 176                         return (node *)meshlink_get_node(this, name);
 177                 }
 178
 179                 /// Get a list of all nodes.
 180                 /** This function returns a list with handles for all known nodes.
 181                  *
 182                  *  @param nodes        A pointer to an array of pointers to meshlink::node, which should be allocated by the application.
 183                  *  @param nmemb        The maximum number of pointers that can be stored in the nodes array.
 184                  *
 185                  *  @return             The number of known nodes. This can be larger than nmemb, in which case not all nodes were stored in the nodes array.
 186                  */
 187                 size_t get_all_nodes(node **nodes, size_t nmemb) {
 188                         return meshlink_get_all_nodes(this, (meshlink_node_t **)nodes, nmemb);
 189                 }
 190
 191                 /// Sign data using the local node's MeshLink key.
 192                 /** This function signs data using the local node's MeshLink key.
 193                  *  The generated signature can be securely verified by other nodes.
 194                  *
 195                  *  @param data         A pointer to a buffer containing the data to be signed.
 196                  *  @param len          The length of the data to be signed.
 197                  *  @param signature    A pointer to a buffer where the signature will be stored.
 198                  *  @param siglen       The size of the signature buffer. Will be changed after the call to match the size of the signature itself.
 199                  *
 200                  *  @return             This function returns true if the signature is valid, false otherwise.
 201                  */
 202                 bool sign(const void *data, size_t len, void *signature, size_t *siglen) {
 203                         return meshlink_sign(this, data, len, signature, siglen);
 204                 }
 205
 206                 /// Verify the signature generated by another node of a piece of data.
 207                 /** This function verifies the signature that another node generated for a piece of data.
 208                  *
 209                  *  @param source       A pointer to a meshlink_node_t describing the source of the signature.
 210                  *  @param data         A pointer to a buffer containing the data to be verified.
 211                  *  @param len          The length of the data to be verified.
 212                  *  @param signature    A pointer to a string containing the signature.
 213                  *  @param siglen       The size of the signature.
 214                  *
 215                  *  @return             This function returns true if the signature is valid, false otherwise.
 216                  */
 217                 bool verify(node *source, const void *data, size_t len, const void *signature, size_t siglen) {
 218                         return meshlink_verify(this, source, data, len, signature, siglen);
 219                 }
 220
 221                 /// Add an Address for the local node.
 222                 /** This function adds an Address for the local node, which will be used for invitation URLs.
 223                  *
 224                  *  @param address      A string containing the address, which can be either in numeric format or a hostname.
 225                  *
 226                  *  @return             This function returns true if the address was added, false otherwise.
 227                  */
 228                 bool add_address(const char *address) {
 229                         return meshlink_add_address(this, address);
 230                 }
 231
 232                 /// Invite another node into the mesh.
 233                 /** This function generates an invitation that can be used by another node to join the same mesh as the local node.
 234                  *  The generated invitation is a string containing a URL.
 235                  *  This URL should be passed by the application to the invitee in a way that no eavesdroppers can see the URL.
 236                  *  The URL can only be used once, after the user has joined the mesh the URL is no longer valid.
 237                  *
 238                  *  @param name         The name that the invitee will use in the mesh.
 239                  *
 240                  *  @return             This function returns a string that contains the invitation URL.
 241                  *                      The application should call free() after it has finished using the URL.
 242                  */
 243                 char *invite(const char *name) {
 244                         return meshlink_invite(this, name);
 245                 }
 246
 247                 /// Use an invitation to join a mesh.
 248                 /** This function allows the local node to join an existing mesh using an invitation URL generated by another node.
 249                  *  An invitation can only be used if the local node has never connected to other nodes before.
 250                  *  After a succesfully accepted invitation, the name of the local node may have changed.
 251                  *
 252                  *  @param invitation   A string containing the invitation URL.
 253                  *
 254                  *  @return             This function returns true if the local node joined the mesh it was invited to, false otherwise.
 255                  */
 256                 bool join(const char *invitation) {
 257                         return meshlink_join(this, invitation);
 258                 }
 259
 260                 /// Export the local node's key and addresses.
 261                 /** This function generates a string that contains the local node's public key and one or more IP addresses.
 262                  *  The application can pass it in some way to another node, which can then import it,
 263                  *  granting the local node access to the other node's mesh.
 264                  *
 265                  *  @return             This function returns a string that contains the exported key and addresses.
 266                  *                      The application should call free() after it has finished using this string.
 267                  */
 268                 char *export_key() {
 269                         return meshlink_export(this);
 270                 }
 271
 272                 /// Import another node's key and addresses.
 273                 /** This function accepts a string containing the exported public key and addresses of another node.
 274                  *  By importing this data, the local node grants the other node access to its mesh.
 275                  *
 276                  *  @param data         A string containing the other node's exported key and addresses.
 277                  *
 278                  *  @return             This function returns true if the data was valid and the other node has been granted access to the mesh, false otherwise.
 279                  */
 280                 bool import_key(const char *data) {
 281                         return meshlink_import(this, data);
 282                 }
 283
 284                 /// Blacklist a node from the mesh.
 285                 /** This function causes the local node to blacklist another node.
 286                  *  The local node will drop any existing connections to that node,
 287                  *  and will not send data to it nor accept any data received from it any more.
 288                  *
 289                  *  @param node         A pointer to a meshlink::node describing the node to be blacklisted.
 290                  */
 291                 void blacklist(node *node) {
 292                         return meshlink_blacklist(this, node);
 293                 }
 294
 295                 /// Set the accept callback.
 296                 /** This functions sets the callback that is called whenever another node sends data to the local node.
 297                  *  The callback is run in MeshLink's own thread.
 298                  *  It is therefore important that the callback uses apprioriate methods (queues, pipes, locking, etc.)
 299                  *  to hand the data over to the application's thread.
 300                  *  The callback should also not block itself and return as quickly as possible.
 301                  *
 302                  *  @param channel   A handle for the channel.
 303                  *  @param cb        A pointer to the function which will be called when another node sends data to the local node.
 304                  */
 305                 void set_channel_accept_cb(channel *channel, channel_accept_cb_t cb) {
 306                         return meshlink_set_channel_accept_cb(this, (meshlink_channel_accept_cb_t)cb);
 307                 }
 308
 309                 /// Open a reliable stream channel to another node.
 310                 /** This function is called whenever a remote node wants to open a channel to the local node.
 311                  *  The application then has to decide whether to accept or reject this channel.
 312                  *
 313                  *  @param node         The node to which this channel is being initiated.
 314                  *  @param port         The port number the peer wishes to connect to.
 315                  *  @param cb           A pointer to the function which will be called when the remote node sends data to the local node.
 316                  *  @param data         A pointer to a buffer containing data to already queue for sending.
 317                  *  @param len          The length of the data.
 318                  *
 319                  *  @return             A handle for the channel, or NULL in case of an error.
 320                  */
 321                 channel *channel_open(node *node, uint16_t port, channel_receive_cb_t cb, const void *data, size_t len) {
 322                         return (channel *)meshlink_channel_open(this, node, port, (meshlink_channel_receive_cb_t)cb, data, len);
 323                 }
 324
 325                 /// Partially close a reliable stream channel.
 326                 /** This shuts down the read or write side of a channel, or both, without closing the handle.
 327                  *  It can be used to inform the remote node that the local node has finished sending all data on the channel,
 328                  *  but still allows waiting for incoming data from the remote node.
 329                  *
 330                  *  @param channel      A handle for the channel.
 331                  *  @param direction    Must be one of SHUT_RD, SHUT_WR or SHUT_RDWR.
 332                  */
 333                 void channel_shutdown(channel *channel, int direction) {
 334                         return meshlink_channel_shutdown(this, channel, direction);
 335                 }
 336
 337                 /// Close a reliable stream channel.
 338                 /** This informs the remote node that the local node has finished sending all data on the channel.
 339                  *  It also causes the local node to stop accepting incoming data from the remote node.
 340                  *  Afterwards, the channel handle is invalid and must not be used any more.
 341                  *
 342                  *  @param channel      A handle for the channel.
 343                  */
 344                 void channel_close(meshlink_channel_t *channel) {
 345                         return meshlink_channel_close(this, channel);
 346                 }
 347
 348                 /// Transmit data on a channel
 349                 /** This queues data to send to the remote node.
 350                  *
 351                  *  @param channel      A handle for the channel.
 352                  *  @param data         A pointer to a buffer containing data sent by the source.
 353                  *  @param len          The length of the data.
 354                  *
 355                  *  @return             The amount of data that was queued, which can be less than len, or a negative value in case of an error.
 356                  */
 357                 ssize_t channel_send(channel *channel, void *data, size_t len) {
 358                         return meshlink_channel_send(this, channel, data, len);
 359                 }
 360
 361         };
 362
 363         /// Initialize MeshLink's configuration directory.
 364         /** This function causes MeshLink to initialize its configuration directory,
 365          *  if it hasn't already been initialized.
 366          *  It only has to be run the first time the application starts,
 367          *  but it is not a problem if it is run more than once, as long as
 368          *  the arguments given are the same.
 369          *
 370          *  This function does not start any network I/O yet. The application should
 371          *  first set callbacks, and then call meshlink_start().
 372          *
 373          *  @param confbase The directory in which MeshLink will store its configuration files.
 374          *  @param name     The name which this instance of the application will use in the mesh.
 375          *
 376          *  @return         This function will return a pointer to a meshlink::mesh if MeshLink has succesfully set up its configuration files, NULL otherwise.
 377          */
 378         static mesh *open(const char *confbase, const char *name) {
 379                 return (mesh *)meshlink_open(confbase, name);
 380         }
 381
 382         /// Close the MeshLink handle.
 383         /** This function calls meshlink_stop() if necessary,
 384          *  and frees all memory allocated by MeshLink.
 385          *  Afterwards, the handle and any pointers to a struct meshlink_node are invalid.
 386          */
 387         static void close(mesh *mesh) {
 388                 meshlink_close(mesh);
 389         }
 390 };
 391
 392 #endif // MESHLINKPP_H