zCm/zcm__domain_8h_source.html

#ifndef ZCM_ZCM_DOMAIN_H

#define ZCM_ZCM_DOMAIN_H


#ifdef __cplusplus

extern "C" {

#endif


#define ZCM_DOMAIN_NAME_MAX 256

#define ZCM_DOMAIN_PATH_MAX 1024

#define ZCM_DOMAIN_ENDPOINT_MAX 512


typedef struct zcm_domain_info {

  int has_domain_mapping;

  char domain[ZCM_DOMAIN_NAME_MAX];

  char domains_file[ZCM_DOMAIN_PATH_MAX];

  char query_endpoint[ZCM_DOMAIN_ENDPOINT_MAX];

  char bind_endpoint[ZCM_DOMAIN_ENDPOINT_MAX];

  char publish_host[ZCM_DOMAIN_NAME_MAX];

  int port;

} zcm_domain_info_t;


int zcm_domain_info_load(zcm_domain_info_t *out_info);


int zcm_domain_info_update_published_host(const zcm_domain_info_t *info);


#ifdef __cplusplus

} /* extern "C" */

#endif


#endif /* ZCM_ZCM_DOMAIN_H */

zcm_domain_info
Resolved broker endpoints for the current environment.
Definition zcm_domain.h:27

zcm_domain_info::port
int port
Broker TCP port extracted from the resolved endpoint.
Definition zcm_domain.h:41

zcm_domain_info::has_domain_mapping
int has_domain_mapping
Nonzero when values came from a ZCMDOMAIN -> ZCmDomains mapping.
Definition zcm_domain.h:29

zcm_domain_info::bind_endpoint
char bind_endpoint[ZCM_DOMAIN_ENDPOINT_MAX]
Local endpoint the broker on this host should bind to.
Definition zcm_domain.h:37

zcm_domain_info::domain
char domain[ZCM_DOMAIN_NAME_MAX]
Selected domain name from ZCMDOMAIN, or empty when explicit broker override is used.
Definition zcm_domain.h:31

zcm_domain_info::query_endpoint
char query_endpoint[ZCM_DOMAIN_ENDPOINT_MAX]
Shared/advertised broker endpoint used by clients to connect to the broker.
Definition zcm_domain.h:35

zcm_domain_info::publish_host
char publish_host[ZCM_DOMAIN_NAME_MAX]
Hostname/IP that should be written back to ZCmDomains as the published broker host.
Definition zcm_domain.h:39

zcm_domain_info::domains_file
char domains_file[ZCM_DOMAIN_PATH_MAX]
Resolved path to the ZCmDomains file used for lookup/update.
Definition zcm_domain.h:33

zcm_domain_info_t
struct zcm_domain_info zcm_domain_info_t
Resolved broker endpoints for the current environment.

ZCM_DOMAIN_PATH_MAX
#define ZCM_DOMAIN_PATH_MAX
Maximum number of bytes reserved for the resolved ZCmDomains path.
Definition zcm_domain.h:16

zcm_domain_info_update_published_host
int zcm_domain_info_update_published_host(const zcm_domain_info_t *info)
Publish the active broker host back into ZCmDomains.

ZCM_DOMAIN_NAME_MAX
#define ZCM_DOMAIN_NAME_MAX
Maximum number of bytes reserved for domain and host name strings.
Definition zcm_domain.h:14

ZCM_DOMAIN_ENDPOINT_MAX
#define ZCM_DOMAIN_ENDPOINT_MAX
Maximum number of bytes reserved for one broker endpoint string.
Definition zcm_domain.h:18

zcm_domain_info_load
int zcm_domain_info_load(zcm_domain_info_t *out_info)
Resolve broker endpoints from environment and ZCmDomains.