dsapi_types.h

Go to the documentation of this file.

/* Emacs mode: -*- C -*- */

/* 
 * Copyright (c) 2004-2013, 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.
 *
 */

/*
 * dsapi_types.h
 *
 * Public data types and forward declarations of private
 * data types.
 *
 */

/* 
 * 
 *
 * @VERSION@
 */

/* Necessary to include dsapi_const.h to get DS_Status */
#include <isode/ds/dsapi/dsapi_const.h>

#ifndef ISODE_DSAPI_TYPES_H
#define ISODE_DSAPI_TYPES_H

/* Common structures. */
typedef struct DS_Session DS_Session;

typedef struct DS_BindParams DS_BindParams;
typedef struct DS_Identity DS_Identity;
typedef struct DS_SASLProps DS_SASLProps;
typedef struct DS_AttrVal DS_AttrVal;
typedef struct DS_Attr DS_Attr;
typedef struct DS_Entry DS_Entry;
typedef struct DS_Referral DS_Referral;
typedef struct DS_ReferralAddress DS_ReferralAddress;
typedef struct DS_DN DS_DN;
typedef struct DS_Result DS_Result;
typedef struct DS_Error DS_Error;
typedef struct DS_Indication DS_Indication;
typedef struct DS_Attr DS_AttrList;
typedef struct DS_AttrVal DS_AttrValList;
typedef struct DS_DN DS_DNList;
typedef struct DS_Entry DS_EntryList;
typedef struct DS_Referral DS_ReferralList;
typedef struct DS_CommonArgs DS_CommonArgs;
typedef struct IF_Dn DS_InternalDN;
typedef struct DS_LDIF DS_LDIF;

/* Unsupported interfaces (not for public use) */
typedef struct DS_RanLDIF DS_RanLDIF;
typedef struct DS_DNIndex DS_DNIndex;

typedef enum {
    DSScopeBaseObject = 0, 
    DSScopeOneLevel = 1,   
    DSScopeSubtree = 2     
} DSSearchScope;

typedef enum {
    DSLimitNoProblem = 0,       
    DSLimitTimeExceeded = 1,    
    DSLimitSizeExceeded = 2,    
    DSLimitAdminLimitExceeded = 3 
} DSLimitProblem;

typedef enum {
    DSModAdd = 0,       
    DSModDelete = 1,    
    DSModReplace = 2    
} DSModType;

typedef enum {
    DSEntryNormal = 0,  
    DSEntryModify = 1,  
    DSEntryAdd = 2,     
    DSEntryDelete = 3,  
    DSEntryRename = 4   
} DSEntryType;

typedef enum {
    DSNotYetConnected = 0,      
    DSConnectionLost = 1,       
    DSUnbound = 2,              
    DSVerificationFailed = 3,  
    DSConnectionBound = 0x100,
    DSConnectionAnonymous = (DSConnectionBound + 1),
    DSConnectionSimple = (DSConnectionBound + 2),
    DSConnectionStrong = (DSConnectionBound + 3),
    DSConnectionSasl = (DSConnectionBound + 4)
} DSSessionState;

typedef enum {
    DSActionContinue = 0,       
    DSActionAbort = 1           
} DSHookAction;

typedef DSHookAction DS_ErrorHook(void *object, char *operation, DS_Status status, void *user);

#endif /* ISODE_DSAPI_TYPES_H */