Structure holding all configuration parameters used to open an ET system. More...

#include <et_private.h>

Data Fields
int	init
	ET_STRUCT_OK if structure initialized, else ET_STRUCT_NEW. More...

int	wait
	ET_OPEN_WAIT if user wants to wait for ET system to appear, else ET_OPEN_NOWAIT. More...

int	cast
	ET_BROADCAST for users to discover host & port # of ET system server by broadcasting, ET_MULTICAST for users to discover host & port # of ET system server by multicasting, ET_BROADANDMULTICAST for users to discover host & port # of ET system server by both broad and multicasting, or ET_DIRECT when users specify host & TCP port # of ET system. More...

int	ttl
	Multicast ttl value (number of router hops permitted). More...

int	mode
	ET_HOST_AS_REMOTE if connection to a local ET system is made as if the client were remote, or ET_HOST_AS_LOCAL if shared memory is to be used if local. More...

int	debug_default
	Default debug output level which may be ET_DEBUG_NONE, ET_DEBUG_SEVERE, ET_DEBUG_ERROR, ET_DEBUG_WARN, or ET_DEBUG_INFO. More...

int	udpport
	Port number for broadcast, multicast & direct UDP communication. More...

int	serverport
	Port number for ET system's TCP server thread. More...

int	policy
	Policy to determine which responding ET system to a broad/ulticast will be chosen as the official respondent: 1) ET_POLICY_ERROR - return error if more than one response, else return the single respondent, 2) ET_POLICY_FIRST - pick the first to respond, 3) ET_POLICY_LOCAL - pick the local system first and if it doesn't respond, the first that does. More...

int	tcpSendBufSize
	TCP send buffer size in bytes of socket connecting to ET TCP server. More...

int	tcpRecvBufSize
	TCP receive buffer size in bytes of socket connecting to ET TCP server. More...

int	tcpNoDelay
	If 0, sockets to system have TCP_NODELAY option off, else on. More...

struct timespec	timeout
	Max time to wait for ET system to appear if wait = ET_OPEN_WAIT. More...

char	host [ET_MAXHOSTNAMELEN]
	Host of ET system which defaults to local host if unset and may be ET_HOST_ANYWHERE for an ET system that may be local or remote, ET_HOST_REMOTE for an ET system that's remote, or ET_HOST_LOCAL for an ET system that is local (may be in dot-decimal form). More...

char	interface [ET_IPADDRSTRLEN]
	Dot-decimal IP address specifying the network interface. More...

codaIpAddr *	netinfo
	Linked list of structs containing all network info. More...

codaIpList *	bcastaddrs
	Linked list of all local subnet broadcast addresses (dot-decimal). More...

codaDotDecIpAddrs	mcastaddrs
	All multicast addresses (dot-decimal). More...

Detailed Description

Structure holding all configuration parameters used to open an ET system.

Field Documentation

codaIpList* et_open_config_t::bcastaddrs

Linked list of all local subnet broadcast addresses (dot-decimal).

Referenced by et_open_config_addbroadcast(), et_open_config_destroy(), et_open_config_init(), and et_open_config_removebroadcast().

int et_open_config_t::cast

ET_BROADCAST for users to discover host & port # of ET system server by broadcasting, ET_MULTICAST for users to discover host & port # of ET system server by multicasting, ET_BROADANDMULTICAST for users to discover host & port # of ET system server by both broad and multicasting, or ET_DIRECT when users specify host & TCP port # of ET system.

Referenced by et_open_config_getcast(), et_open_config_init(), et_open_config_setcast(), and etr_open().

int et_open_config_t::debug_default

Default debug output level which may be ET_DEBUG_NONE, ET_DEBUG_SEVERE, ET_DEBUG_ERROR, ET_DEBUG_WARN, or ET_DEBUG_INFO.

Referenced by et_open_config_getdebugdefault(), et_open_config_init(), et_open_config_setdebugdefault(), and etr_open().

char et_open_config_t::host[ET_MAXHOSTNAMELEN]

Host of ET system which defaults to local host if unset and may be ET_HOST_ANYWHERE for an ET system that may be local or remote, ET_HOST_REMOTE for an ET system that's remote, or ET_HOST_LOCAL for an ET system that is local (may be in dot-decimal form).

Referenced by et_findlocality(), et_open_config_gethost(), et_open_config_init(), et_open_config_sethost(), and etr_open().

int et_open_config_t::init

ET_STRUCT_OK if structure initialized, else ET_STRUCT_NEW.

char et_open_config_t::interface[ET_IPADDRSTRLEN]

Dot-decimal IP address specifying the network interface.

Referenced by et_open_config_getinterface(), et_open_config_init(), et_open_config_setinterface(), and etr_open().

codaDotDecIpAddrs et_open_config_t::mcastaddrs

All multicast addresses (dot-decimal).

Referenced by et_open_config_addmulticast(), et_open_config_init(), and et_open_config_removemulticast().

int et_open_config_t::mode

ET_HOST_AS_REMOTE if connection to a local ET system is made as if the client were remote, or ET_HOST_AS_LOCAL if shared memory is to be used if local.

Referenced by et_findlocality(), et_open_config_getmode(), et_open_config_init(), and et_open_config_setmode().

codaIpAddr* et_open_config_t::netinfo

Linked list of structs containing all network info.

Referenced by et_open_config_destroy(), et_open_config_init(), and etr_open().

int et_open_config_t::policy

Policy to determine which responding ET system to a broad/ulticast will be chosen as the official respondent: 1) ET_POLICY_ERROR - return error if more than one response, else return the single respondent, 2) ET_POLICY_FIRST - pick the first to respond, 3) ET_POLICY_LOCAL - pick the local system first and if it doesn't respond, the first that does.

Referenced by et_open(), et_open_config_getpolicy(), et_open_config_init(), and et_open_config_setpolicy().

int et_open_config_t::serverport

Port number for ET system's TCP server thread.

Referenced by et_open_config_getserverport(), et_open_config_init(), et_open_config_setserverport(), and etr_open().

int et_open_config_t::tcpNoDelay

If 0, sockets to system have TCP_NODELAY option off, else on.

Referenced by et_open_config_gettcp(), et_open_config_init(), et_open_config_settcp(), and etr_open().

int et_open_config_t::tcpRecvBufSize

TCP receive buffer size in bytes of socket connecting to ET TCP server.

Referenced by et_open_config_gettcp(), et_open_config_init(), et_open_config_settcp(), and etr_open().

int et_open_config_t::tcpSendBufSize

TCP send buffer size in bytes of socket connecting to ET TCP server.