queue.h

Go to the documentation of this file.

/*  Copyright (c) 2004-2009, Isode Limited, London, England.
 *  All rights reserved.
 *                                                                       
 *  Acquisition and use of this software and related materials for any      
 *  purpose requires a written licence agreement from Isode Limited,
 *  or a written licence from an organisation licenced by Isode Limited
 *  to grant such a licence.
 *
 */

#ifndef _SOM_QUEUE_H
#define _SOM_QUEUE_H

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

#define SOM_FACILITY_QUEUE (1<<1) 
/* Object types */

struct SOMQchannel;
struct SOMQmta;
struct SOMQmessage;
struct SOMQrecip;
struct SOMQinmsg;
struct SOMQassoc;

typedef void SOMQueueCallback (struct SOMSession *session,
                               void *ophandle,
                               void *clientdata,
                               int status);

typedef void SOMQchannelCallback (struct SOMSession *session,
                                  void *ophandle,
                                  void *clientdata,
                                  struct SOMQchannel *channel);


typedef void SOMQmtaCallback (struct SOMSession *session,
                              void *ophandle,
                              void *clientdata,
                              struct SOMQmta *mta);


typedef void SOMQmessageCallback (struct SOMSession *session,
                                  void *ophandle,
                                  void *clientdata,
                                  struct SOMQmessage *message);


/* Callback setting functions */

SOMAPI_CDECL int SOMQueueSetCallback (struct SOMSession *session,
                                      SOMQueueCallback *callback,
                                      SOMQueueCallback **oldvalue);



SOMAPI_CDECL int SOMQueueSetChannelCallback (struct SOMSession *session,
                                             SOMQchannelCallback *callback,
                                             SOMQchannelCallback **oldvalue);



SOMAPI_CDECL int SOMQueueSetMtaCallback (struct SOMSession *session,
                                         SOMQmtaCallback *callback,
                                         SOMQmtaCallback **oldvalue);



SOMAPI_CDECL int SOMQueueSetMessageCallback (struct SOMSession *session,
                                             SOMQmessageCallback *callback,
                                             SOMQmessageCallback **oldvalue);


/* \} */

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


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

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


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

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


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

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

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

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


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


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

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


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

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


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

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


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

/* \} */

struct SOMQfilterSet;
struct SOMQfilter;
struct SOMQselector;

SOMAPI_CDECL struct SOMQfilter *SOMQfilterNew (void);

SOMAPI_CDECL struct SOMQfilter *SOMQfilterChain (struct SOMQfilter *fp,
                                                 struct SOMQfilter *newp);

SOMAPI_CDECL struct SOMQselector *SOMQselectorNew (void);


SOMAPI_CDECL int SOMQfilterDelete (struct SOMQfilter *fp);

SOMAPI_CDECL int SOMQselectorDelete (struct SOMQselector *fp);

SOMAPI_CDECL int SOMQfilterAddStrParam (struct SOMQfilter *fp,
                                        int paramtype,
                                        const char *value,
                                        size_t length);
 
SOMAPI_CDECL int SOMQfilterAddIntParam (struct SOMQfilter *fp,
                                        int paramtype,
                                        int value);

SOMAPI_CDECL int SOMQselectorAddStrParam (struct SOMQselector *fp,
                                          int paramtype,
                                          const char *value,
                                          size_t length);
 
SOMAPI_CDECL int SOMQselectorAddIntParam (struct SOMQselector *fp,
                                          int paramtype,
                                          int value);

/* \} */


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         
};

SOMAPI_CDECL int SOMQueueControl (struct SOMSession *session,
                                  enum som_qmcontrol control,
                                  void              *ophandle,
                                  int                async);


SOMAPI_CDECL int SOMQueueStatus (struct SOMSession *session,
                                 void              *ophandle,
                                 int                async);


SOMAPI_CDECL int SOMQchannelControl (struct SOMSession   *session,
                                     struct SOMQselector *selector,
                                     enum som_qocontrol   control,
                                     const char          *data,
                                     int                  datalen,
                                     void                *ophandle,
                                     int                  async);


SOMAPI_CDECL int SOMQchannelRead (struct SOMSession   *session,
                                  struct SOMQselector *selector,
                                  void                *ophandle,
                                  int                  async);

SOMAPI_CDECL int SOMQmtaControl (struct SOMSession   *session,
                                 struct SOMQselector *selector,
                                 enum som_qocontrol   control,
                                 const char          *data,
                                 int                  datalen,
                                 void                *ophandle,
                                 int                  async);


SOMAPI_CDECL int SOMQmtaRead (struct SOMSession   *session,
                              struct SOMQselector *selector,
                              int                  limit,
                              void                *ophandle,
                              int                  async);

SOMAPI_CDECL int SOMQmessageControl (struct SOMSession   *session,
                                     struct SOMQselector *selector,
                                     enum som_qocontrol   control,
                                     const char          *data,
                                     int                  datalen,
                                     void                *ophandle,
                                     int                  async);


SOMAPI_CDECL int SOMQmessageRead (struct SOMSession   *session,
                                  struct SOMQselector *selector,
                                  int                  limit,
                                  void                *ophandle,
                                  int                  async);


SOMAPI_CDECL int SOMQmessageSearch (struct SOMSession   *session,
                                    struct SOMQfilter   *filter,
                                    void                *ophandle,
                                    int                  async);


/* \} */

#endif /* _SOM_QUEUE_H */