session.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_SESSION_H
#define _SOM_SESSION_H
 
/* stdlib.h is included to ensure the declaration of size_t */
#include <stdlib.h>
 
#include "cdecl.h"
#include "errors.h"
 
#define SOM_LIBRARY_VERSION 100 
struct SOMSession;
 
typedef void SOMSessionCallback (struct SOMSession *session,
                                 void *ophandle,
                                 void *clientdata,
                                 int status,
                                 const char *opdata,
                                 size_t opdatalen);
 
SOMAPI_CDECL const char *SOMError (int error);
 
SOMAPI_CDECL void SOMSetService(struct SOMSession *session,
                                const char *service);
 
SOMAPI_CDECL int SOMSessionAuthenticated(struct SOMSession *session);
 
SOMAPI_CDECL int SOMInit (int version);
 
/* Create a Session object which can be used in a multithreaded,
 * single-SOM-session-per-thread, synchronous, manner */
#define SOM_FACILITY_MULTITHREADED (32)
 
SOMAPI_CDECL int SOMSessionCreate (int facilities,
                                   void *clientdata,
                                   struct SOMSession **session);
                                                                              
SOMAPI_CDECL int SOMEventPoll (int dispatch, int timeout);
 
SOMAPI_CDECL int SOMEventPollSingle (struct SOMSession *sp, int dispatch, int timeout);
 
SOMAPI_CDECL int SOMSessionSetTLS (struct SOMSession *session,
                                   const char *identity,
                                   const char *passphrase);
                                                                               
SOMAPI_CDECL int SOMSessionSetSessionCallback (struct SOMSession *session,
                                            SOMSessionCallback *callback,
                                            SOMSessionCallback **oldvalue);
                                                                               
SOMAPI_CDECL int SOMSessionOpen (struct SOMSession      *session,
                                 const char             *host,
                                 int                     port,
                                 const char             *username,
                                 const char             *password,
                                 void                   *ophandle,
                                 int                     async);
 
SOMAPI_CDECL int SOMSessionOpenRole (struct SOMSession      *session,
                                     const char             *host,
                                     int                     port,
                                     const char             *username,
                                     const char             *password,
                                     const char             *role,
                                     void                   *ophandle,
                                     int                     async);
 
 
SOMAPI_CDECL int SOMSessionOpenMech (struct SOMSession      *session,
                                    const char             *host,
                                    int                     port,
                                    const char             *username,
                                    const char             *passwd,
                                    void                   *ophandle,
                                    int                     async,
                                    const char             *mech);
 
 
SOMAPI_CDECL int SOMSessionOpenMechRole (struct SOMSession      *session,
                                         const char             *host,
                                         int                     port,
                                         const char             *username,
                                         const char             *passwd,
                                         const char             *role,
                                         void                   *ophandle,
                                         int                     async,
                                         const char             *mech);
 
SOMAPI_CDECL int SOMSessionClose (struct SOMSession *sp);
 
 
SOMAPI_CDECL int SOMSessionDelete (struct SOMSession *session);
 
 
 
SOMAPI_CDECL int SOMSessionClear (struct SOMSession *session,
                               int facilities);
 
/* \} */
 
#endif /* _SOM_SESSION_H */