zCm 0.1.0
Lightweight messaging toolkit
Loading...
Searching...
No Matches
zcm.h File Reference

Base zCm context and broker lifecycle API.

#include <stddef.h>
#include "zcm_domain.h"

Go to the source code of this file.

Macros

#define ZCM_OK   0
 Success return code.
#define ZCM_ERR   (-1)
 Generic failure return code.

Typedefs

typedef struct zcm_context zcm_context_t
 Opaque process-wide context handle.
typedef struct zcm_broker zcm_broker_t
 Opaque broker handle.

Functions

zcm_context_tzcm_context_new (void)
 Create a new zCm context.
void zcm_context_free (zcm_context_t *ctx)
 Destroy a context created by zcm_context_new().
zcm_broker_tzcm_broker_start (zcm_context_t *ctx, const char *endpoint)
 Start a broker service bound to the provided endpoint.
void zcm_broker_stop (zcm_broker_t *broker)
 Stop and free a broker created by zcm_broker_start().
int zcm_broker_is_running (const zcm_broker_t *broker)
 Check whether a broker service loop is still running.
const char * zcm_version_string (void)
 Return the library version string.
void * zcm_context_zmq (zcm_context_t *ctx)
 Get the underlying ZeroMQ context pointer.