zCm/zcm_8h_source.html

#ifndef ZCM_ZCM_H

#define ZCM_ZCM_H


#ifdef __cplusplus

extern "C" {

#endif


#include <stddef.h>


#include "zcm_domain.h"


#define ZCM_OK 0

#define ZCM_ERR (-1)


typedef struct zcm_context zcm_context_t;

typedef struct zcm_broker zcm_broker_t;


zcm_context_t *zcm_context_new(void);


void zcm_context_free(zcm_context_t *ctx);


zcm_broker_t *zcm_broker_start(zcm_context_t *ctx, const char *endpoint);


void zcm_broker_stop(zcm_broker_t *broker);


int zcm_broker_is_running(const zcm_broker_t *broker);


const char *zcm_version_string(void);


void *zcm_context_zmq(zcm_context_t *ctx);


#ifdef __cplusplus

} /* extern "C" */

#endif


#endif /* ZCM_ZCM_H */

zcm_version_string
const char * zcm_version_string(void)
Return the library version string.

zcm_broker_start
zcm_broker_t * zcm_broker_start(zcm_context_t *ctx, const char *endpoint)
Start a broker service bound to the provided endpoint.

zcm_broker_stop
void zcm_broker_stop(zcm_broker_t *broker)
Stop and free a broker created by zcm_broker_start().

zcm_context_t
struct zcm_context zcm_context_t
Opaque process-wide context handle.
Definition zcm.h:27

zcm_context_new
zcm_context_t * zcm_context_new(void)
Create a new zCm context.

zcm_broker_t
struct zcm_broker zcm_broker_t
Opaque broker handle.
Definition zcm.h:29

zcm_broker_is_running
int zcm_broker_is_running(const zcm_broker_t *broker)
Check whether a broker service loop is still running.

zcm_context_free
void zcm_context_free(zcm_context_t *ctx)
Destroy a context created by zcm_context_new().

zcm_context_zmq
void * zcm_context_zmq(zcm_context_t *ctx)
Get the underlying ZeroMQ context pointer.

zcm_domain.h
Shared zCm domain endpoint resolution helpers.