Functions for accessing the attributes of queue objects. More...

Modules
	Creating Queue Filter and Selector objects
	The Queue interface uses Filters and Selectors for choosing objects to operate on. Filters are used to select messages based on various properties. Selectors are used for channels, MTAs and messages based on the channel/MTA/message hierarchy.

Functions
int	SOMQmanagerGetStrParam (struct SOMSession session, int paramtype, char buffer, size_t buflen, size_t *paramlenp)
	Return an string-valued parameter from the manager object. More...

int	SOMQmanagerGetIntParam (struct SOMSession session, int paramtype, int valp)
	Return an integer-valued parameter from the manager object. More...

int	SOMQchannelGetStrParam (struct SOMQchannel channel, int paramtype, char buffer, size_t buflen, size_t *paramlenp)
	Return an string-valued parameter from the channel object. More...

int	SOMQchannelGetIntParam (struct SOMQchannel channel, int paramtype, int valp)
	Return an integer-valued parameter from the channel object. More...

int	SOMQmtaGetStrParam (struct SOMQmta mta, int paramtype, char buffer, size_t buflen, size_t *paramlenp)
	Return an string-valued parameter from the mta object. More...

int	SOMQmtaGetIntParam (struct SOMQmta mta, int paramtype, int valp)
	Return an integer-valued parameter from the mta object. More...

int	SOMQmtaGetInmsg (struct SOMQmta mta, int number, int getnext, struct SOMQinmsg *inmpp)
	Return the pointer to an inbound message object. More...

int	SOMQmtaGetAssoc (struct SOMQmta mta, int assocnum, int getnext, struct SOMQassoc *aspp)
	Return the pointer to an inbound message object. More...

int	SOMQmessageGetStrParam (struct SOMQmessage message, int paramtype, char buffer, size_t buflen, size_t *paramlenp)
	Return an string-valued parameter from the message object. More...

int	SOMQmessageGetIntParam (struct SOMQmessage message, int paramtype, int valp)
	Return an integer-valued parameter from the message object. More...

int	SOMQmessageGetRecip (struct SOMQmessage message, int number, struct SOMQrecip *rpp)
	Return the pointer to a recipient object. More...

int	SOMQrecipGetStrParam (struct SOMQrecip recip, int paramtype, char buffer, size_t buflen, size_t *paramlenp)
	Return an string-valued parameter from the recip object. More...

int	SOMQrecipGetIntParam (struct SOMQrecip recip, int paramtype, int valp)
	Return an integer-valued parameter from the recip object. More...

int	SOMQinmsgGetStrParam (struct SOMQinmsg inmsg, int paramtype, char buffer, size_t buflen, size_t *paramlenp)
	Return an string-valued parameter from the inbound message object. More...

int	SOMQinmsgGetIntParam (struct SOMQinmsg inmsg, int paramtype, int valp)
	Return an integer-valued parameter from the inbound message object. More...

int	SOMQassocGetStrParam (struct SOMQassoc assoc, int paramtype, char buffer, size_t buflen, size_t *paramlenp)
	Return an string-valued parameter from the association object. More...

int	SOMQassocGetIntParam (struct SOMQassoc assoc, int paramtype, int valp)
	Return an integer-valued parameter from the association object. More...

Detailed Description

Functions for accessing the attributes of queue objects.

Function Documentation

◆ SOMQmanagerGetStrParam()

int SOMQmanagerGetStrParam	(	struct SOMSession *	session,
		int	paramtype,
		char *	buffer,
		size_t	buflen,
		size_t *	paramlenp
	)

Return an string-valued parameter from the manager object.

Parameters

session	[in] Pointer to session object
paramtype	[in] Type of parameter
buffer	[in/out] address for result
buflen	[in] length of buffer provided
paramlenp	[out] Pointer to receive actual length

Returns: Zero on success or non-zero error code

◆ SOMQmanagerGetIntParam()

int SOMQmanagerGetIntParam	(	struct SOMSession *	session,
		int	paramtype,
		int *	valp
	)

Return an integer-valued parameter from the manager object.

Parameters

session	[in] Pointer to session object
paramtype	[in] Type of parameter
valp	[out] Pointer to receive value

Returns: Zero on success or non-zero error code

◆ SOMQchannelGetStrParam()

int SOMQchannelGetStrParam	(	struct SOMQchannel *	channel,
		int	paramtype,
		char *	buffer,
		size_t	buflen,
		size_t *	paramlenp
	)

Return an string-valued parameter from the channel object.

Parameters

channel	[in] Pointer to channel object
paramtype	[in] Type of parameter
buffer	[in/out] address for result
buflen	[in] length of buffer provided
paramlenp	[out] Pointer to receive actual length

Returns: Zero on success or non-zero error code

◆ SOMQchannelGetIntParam()

int SOMQchannelGetIntParam	(	struct SOMQchannel *	channel,
		int	paramtype,
		int *	valp
	)

Return an integer-valued parameter from the channel object.

Parameters

channel	[in] Pointer to channel object
paramtype	[in] Type of parameter
valp	[out] Pointer to receive value

Returns: Zero on success or non-zero error code

◆ SOMQmtaGetStrParam()

int SOMQmtaGetStrParam	(	struct SOMQmta *	mta,
		int	paramtype,
		char *	buffer,
		size_t	buflen,
		size_t *	paramlenp
	)

Return an string-valued parameter from the mta object.

Parameters

mta	[in] Pointer to mta object
paramtype	[in] Type of parameter
buffer	[in/out] address for result
buflen	[in] length of buffer provided
paramlenp	[out] Pointer to receive actual length

Returns: Zero on success or non-zero error code

◆ SOMQmtaGetIntParam()

int SOMQmtaGetIntParam	(	struct SOMQmta *	mta,
		int	paramtype,
		int *	valp
	)

Return an integer-valued parameter from the mta object.

Parameters

mta	[in] Pointer to mta object
paramtype	[in] Type of parameter
valp	[out] Pointer to receive value

Returns: Zero on success or non-zero error code

◆ SOMQmtaGetInmsg()

int SOMQmtaGetInmsg	(	struct SOMQmta *	mta,
		int	number,
		int	getnext,
		struct SOMQinmsg **	inmpp
	)

Return the pointer to an inbound message object.

Parameters

mta	[in] Pointer to mta object
number	[in] If non-zero, return message matching number
getnext	[in] If non-zero, return the next msg
inmpp	[out] Pointer to receive object pointer

Returns: Zero on success or non-zero error code

The msgid can be a specific ID, which is an integer. If getnext is zero, then that ID is returned. If it is non-zero, then the next message from the list is returned. The iteration can be started with getnext non-zero and msgid being zero.

◆ SOMQmtaGetAssoc()

int SOMQmtaGetAssoc	(	struct SOMQmta *	mta,
		int	assocnum,
		int	getnext,
		struct SOMQassoc **	aspp
	)

Return the pointer to an inbound message object.

Parameters

mta	[in] Pointer to mta object
assocnum	[in] Per-MTA association index
getnext	[in] If non-zero, return the next msg
aspp	[out] Pointer to receive object pointer

Returns: Zero on success or non-zero error code

If getnext is zero, then that association is returned. If it is non-zero, then the next association from the list is returned. The iteration can be started with getnext non-zero and assocnum being zero.

◆ SOMQmessageGetStrParam()

int SOMQmessageGetStrParam	(	struct SOMQmessage *	message,
		int	paramtype,
		char *	buffer,
		size_t	buflen,
		size_t *	paramlenp
	)

Return an string-valued parameter from the message object.

Parameters

message	[in] Pointer to message object
paramtype	[in] Type of parameter
buffer	[in/out] address for result
buflen	[in] length of buffer provided
paramlenp	[out] Pointer to receive actual length

Returns: Zero on success or non-zero error code

◆ SOMQmessageGetIntParam()

int SOMQmessageGetIntParam	(	struct SOMQmessage *	message,
		int	paramtype,
		int *	valp
	)

Return an integer-valued parameter from the message object.

Parameters

message	[in] Pointer to message object
paramtype	[in] Type of parameter
valp	[out] Pointer to receive value

Returns: Zero on success or non-zero error code

◆ SOMQmessageGetRecip()

int SOMQmessageGetRecip	(	struct SOMQmessage *	message,
		int	number,
		struct SOMQrecip **	rpp
	)

Return the pointer to a recipient object.

Parameters

message	[in] Pointer to message object
number	[in] Recipient number
rpp	[out] Pointer to receive object pointer

Returns: Zero on success or non-zero error code

The recipient number is the internal recipient number.

◆ SOMQrecipGetStrParam()

int SOMQrecipGetStrParam	(	struct SOMQrecip *	recip,
		int	paramtype,
		char *	buffer,
		size_t	buflen,
		size_t *	paramlenp
	)

Return an string-valued parameter from the recip object.

Parameters

recip	[in] Pointer to recip object
paramtype	[in] Type of parameter
buffer	[in/out] address for result
buflen	[in] length of buffer provided
paramlenp	[out] Pointer to receive actual length

Returns: Zero on success or non-zero error code

◆ SOMQrecipGetIntParam()

int SOMQrecipGetIntParam	(	struct SOMQrecip *	recip,
		int	paramtype,
		int *	valp
	)

Return an integer-valued parameter from the recip object.

Parameters

recip	[in] Pointer to recip object
paramtype	[in] Type of parameter
valp	[out] Pointer to receive value

Returns: Zero on success or non-zero error code

◆ SOMQinmsgGetStrParam()

int SOMQinmsgGetStrParam	(	struct SOMQinmsg *	inmsg,
		int	paramtype,
		char *	buffer,
		size_t	buflen,
		size_t *	paramlenp
	)

Return an string-valued parameter from the inbound message object.

Parameters

inmsg	[in] Pointer to inmsg object
paramtype	[in] Type of parameter
buffer	[in/out] address for result
buflen	[in] length of buffer provided
paramlenp	[out] Pointer to receive actual length

Returns: Zero on success or non-zero error code

◆ SOMQinmsgGetIntParam()

int SOMQinmsgGetIntParam	(	struct SOMQinmsg *	inmsg,
		int	paramtype,
		int *	valp
	)

Return an integer-valued parameter from the inbound message object.

Parameters

inmsg	[in] Pointer to inmsg object
paramtype	[in] Type of parameter
valp	[out] Pointer to receive value

Returns: Zero on success or non-zero error code

◆ SOMQassocGetStrParam()

int SOMQassocGetStrParam	(	struct SOMQassoc *	assoc,
		int	paramtype,
		char *	buffer,
		size_t	buflen,
		size_t *	paramlenp
	)

Return an string-valued parameter from the association object.

Parameters

assoc	[in] Pointer to assoc object
paramtype	[in] Type of parameter
buffer	[in/out] address for result
buflen	[in] length of buffer provided
paramlenp	[out] Pointer to receive actual length

Returns: Zero on success or non-zero error code

◆ SOMQassocGetIntParam()

int SOMQassocGetIntParam	(	struct SOMQassoc *	assoc,
		int	paramtype,
		int *	valp
	)

Return an integer-valued parameter from the association object.

Parameters

assoc	[in] Pointer to assoc object
paramtype	[in] Type of parameter
valp	[out] Pointer to receive value

Returns: Zero on success or non-zero error code

Modules

Functions

Detailed Description

Function Documentation

◆ SOMQmanagerGetStrParam()

◆ SOMQmanagerGetIntParam()

◆ SOMQchannelGetStrParam()

◆ SOMQchannelGetIntParam()

◆ SOMQmtaGetStrParam()

◆ SOMQmtaGetIntParam()

◆ SOMQmtaGetInmsg()

◆ SOMQmtaGetAssoc()

◆ SOMQmessageGetStrParam()

◆ SOMQmessageGetIntParam()

◆ SOMQmessageGetRecip()

◆ SOMQrecipGetStrParam()

◆ SOMQrecipGetIntParam()

◆ SOMQinmsgGetStrParam()

◆ SOMQinmsgGetIntParam()

◆ SOMQassocGetStrParam()

◆ SOMQassocGetIntParam()