MqIoS API
[MqS API]

building, splitting, reading and sending of a Msgque packet. More...

Defines
#define	MqIoGetId(io)   ((MQ_STR)MqIoGetOpt(io,IO_N_GENERIC,GENERIC_ID))
	get the generic ID from the MqIoS
#define	MqIoGetCom(io)   (*((MqIoComE*)MqIoGetOpt(io,IO_COM,0)))
	get the socket-type (e.g. TCP or UDS) from the MqIoS
#define	MqIoGetInted(io)   (*((MQ_INT2*)MqIoGetOpt(io,IO_N_GENERIC,GENERIC_INETD)))
	get the inetd flag (e.g. YES(1) or NO(0)) from the MqIoS
#define	MqIoGetBufferSize(io)   (*((MQ_INT4*)MqIoGetOpt(io,IO_N_GENERIC,GENERIC_BUFFERSIZE)))
	get the buffer-size from the MqIoS
Enumerations
enum	MqIoComE { IO_UDS, IO_TCP }
	the socket-type, UDS or TCP
enum	MqIoOptE { IO_COM, IO_N_TCP, IO_N_UDS, IO_N_GENERIC }
	IO specific options used by MqIoGetOpt
enum	MqTcpOptE { TCP_HOST, TCP_PORT }
	TCP specific options used by MqIoGetOpt
enum	MqUdsOptE { UDS_FILE }
	UDS specific options used by MqIoGetOpt
enum	MqGenericOptE { GENERIC_ID, GENERIC_BUFFERSIZE, GENERIC_SOERROR, GENERIC_INETD }
	GENERIC (e.g. TCP and UDS) specific options used by MqIoGetOpt
Functions
MQ_EXTERN MQ_PTR	MqIoGetOpt (MqIoSP const io, MqIoOptE opt, MQ_INT2 opt2)
	generic procedure to query MqIoS, TcpS, UdsS and GenericS options

---

Detailed Description

building, splitting, reading and sending of a Msgque packet.

the MqIoS object is used to manage the socket communication used for sending and receiving Msgque packets. every MqS object has only one MqIoS object and every MqIoS object has only one MqS object. the MqIoS object is the root object of a TcpS (e.g. -tcp command-line argument) or UdsS (e.g. -uds command-line argument) object. the both 'worker' objects MqReadS and MqSendS are using the MqIoS object for reading and sending of a Msgque packet.

---

Function Documentation

MQ_EXTERN MQ_PTR MqIoGetOpt (  MqIoSP const   io, MqIoOptE  opt, MQ_INT2  opt2 )

generic procedure to query MqIoS, TcpS, UdsS and GenericS options Parameters: io  the MqIoS object to work on opt  first option level opt2  second option level (e.g. used for TcpS, UdsS and GenericS) options

---