queue.h File Reference

Switch Operation Management Interface: Accessing Queue. More...

#include "session.h"
#include "queueatt.h"

Go to the source code of this file.

Macros

#define SOM_FACILITY_QUEUE   (1<<1)
 

Typedefs

typedef void SOMQueueCallback(struct SOMSession *session, void *ophandle, void *clientdata, int status)
 Prototype for callback for queue operation completion. More...
 
typedef void SOMQchannelCallback(struct SOMSession *session, void *ophandle, void *clientdata, struct SOMQchannel *channel)
 Prototype for callback for reporting channel object. More...
 
typedef void SOMQmtaCallback(struct SOMSession *session, void *ophandle, void *clientdata, struct SOMQmta *mta)
 Prototype for callback for reporting mta object. More...
 
typedef void SOMQmessageCallback(struct SOMSession *session, void *ophandle, void *clientdata, struct SOMQmessage *message)
 Prototype for callback for reporting message object. More...
 

Enumerations

enum  som_qmcontrol {
  SOM_QM_ABORT, SOM_QM_SHUTDOWN, SOM_QM_RESTART, SOM_QM_REREADQUEUE,
  SOM_QM_DISABLE_SUBMISSION, SOM_QM_ENABLE_SUBMISSION, SOM_QM_DISABLE_ALL, SOM_QM_ENABLE_ALL,
  SOM_QM_INCREASE_MAXCHANS, SOM_QM_DECREASE_MAXCHANS, SOM_QM_LOAD_CONFIG
}
 
enum  som_qocontrol {
  SOM_QO_STOP, SOM_QO_START, SOM_QO_DISABLE_IN, SOM_QO_ENABLE_IN,
  SOM_QO_DELAY_CLEAR, SOM_QO_DELAY_SET, SOM_QO_MINIMISE, SOM_QO_DELETE,
  SOM_QO_CONNECT, SOM_QO_DISCONNECT, SOM_QO_TIMEOUT, SOM_QO_NONDELIVER,
  SOM_QO_REDIRECT, SOM_QO_REPROCESS, SOM_QO_RELOAD, SOM_QO_ABORT,
  SOM_QO_PAUSE, SOM_QO_RESUME
}
 

Functions

int SOMQueueSetCallback (struct SOMSession *session, SOMQueueCallback *callback, SOMQueueCallback **oldvalue)
 Set the Queue callback function for this session. More...
 
int SOMQueueSetChannelCallback (struct SOMSession *session, SOMQchannelCallback *callback, SOMQchannelCallback **oldvalue)
 Set the callback function for channel objects for this session. More...
 
int SOMQueueSetMtaCallback (struct SOMSession *session, SOMQmtaCallback *callback, SOMQmtaCallback **oldvalue)
 Set the callback function for Mtas for this session. More...
 
int SOMQueueSetMessageCallback (struct SOMSession *session, SOMQmessageCallback *callback, SOMQmessageCallback **oldvalue)
 Set the callback function for messages for this session. More...
 
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...
 
struct SOMQfilter * SOMQfilterNew (void)
 Create new filter object. More...
 
struct SOMQfilter * SOMQfilterChain (struct SOMQfilter *fp, struct SOMQfilter *newp)
 Add filter to chain. More...
 
struct SOMQselector * SOMQselectorNew (void)
 Create new selector object. More...
 
int SOMQfilterDelete (struct SOMQfilter *fp)
 Delete filter chain. More...
 
int SOMQselectorDelete (struct SOMQselector *fp)
 Delete selector. More...
 
int SOMQfilterAddStrParam (struct SOMQfilter *fp, int paramtype, const char *value, size_t length)
 Add string-valued parameter to the filter. More...
 
int SOMQfilterAddIntParam (struct SOMQfilter *fp, int paramtype, int value)
 Add integer-valued parameter to the filter. More...
 
int SOMQselectorAddStrParam (struct SOMQselector *fp, int paramtype, const char *value, size_t length)
 Add string-valued parameter to the selector. More...
 
int SOMQselectorAddIntParam (struct SOMQselector *fp, int paramtype, int value)
 Add integer-valued parameter to the selector. More...
 
int SOMQueueControl (struct SOMSession *session, enum som_qmcontrol control, void *ophandle, int async)
 Perform control operation on Queue Manager. More...
 
int SOMQueueStatus (struct SOMSession *session, void *ophandle, int async)
 Get current Queue Manager status. More...
 
int SOMQchannelControl (struct SOMSession *session, struct SOMQselector *selector, enum som_qocontrol control, const char *data, int datalen, void *ophandle, int async)
 Perform control operation on Queue Channel. More...
 
int SOMQchannelRead (struct SOMSession *session, struct SOMQselector *selector, void *ophandle, int async)
 Perform control operation on Queue Channel. More...
 
int SOMQmtaControl (struct SOMSession *session, struct SOMQselector *selector, enum som_qocontrol control, const char *data, int datalen, void *ophandle, int async)
 Perform control operation on Queue Mta. More...
 
int SOMQmtaRead (struct SOMSession *session, struct SOMQselector *selector, int limit, void *ophandle, int async)
 Perform control operation on Queue Mta. More...
 
int SOMQmessageControl (struct SOMSession *session, struct SOMQselector *selector, enum som_qocontrol control, const char *data, int datalen, void *ophandle, int async)
 Perform control operation on Queue Message. More...
 
int SOMQmessageRead (struct SOMSession *session, struct SOMQselector *selector, int limit, void *ophandle, int async)
 Perform control operation on Queue Message. More...
 
int SOMQmessageSearch (struct SOMSession *session, struct SOMQfilter *filter, void *ophandle, int async)
 Perform control operation on Queue Message. More...
 

Detailed Description

Switch Operation Management Interface: Accessing Queue.

Note: Queue operations return their results normally via a callback. Which callback this is depends on the data type. If the request returns multiple objects, then there will be multiple calls to the relevant callback.

Asynchronous operations return the overall operation status through the main callback. This is not called for synchronous operations.

The data on the queue manager itself is available (after a query operation) via the main session object.

Definition in file queue.h.

Macro Definition Documentation

◆ SOM_FACILITY_QUEUE

#define SOM_FACILITY_QUEUE   (1<<1)

Mask requesting queue manager facility

Definition at line 33 of file queue.h.