types.h

/*
 * OCILIB - C Driver for Oracle (C Wrapper for Oracle OCI)
 *
 * Website: http://www.ocilib.net
 *
 * Copyright (c) 2007-2023 Vincent ROGIER <vince.rogier@ocilib.net>
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
/* IMPORTANT NOTICE
 *
 * This file contains explanations about Oracle and OCI technologies. 
 * OCILIB is a wrapper around OCI and thus exposes OCI features. 
 * The OCILIB documentation intends to explain Oracle / OCI concepts
 * and is naturally based on the official Oracle OCI documentation. 
 * 
 * Some parts of OCILIB documentation may include some information 
 * taken and adapted from the following Oracle documentations :
 *  - Oracle Call Interface Programmer's Guide
 *  - Oracle Streams - Advanced Queuing User's Guide
 */
 
#ifndef OCILIB_OCILIBC_TYPES_H_INCLUDED
#define OCILIB_OCILIBC_TYPES_H_INCLUDED
 
#include "ocilibc/defines.h"
 
typedef struct OCI_Environment OCI_Environment;
 
typedef struct OCI_Pool OCI_Pool;
 
typedef struct OCI_Connection OCI_Connection;
 
typedef struct OCI_Statement OCI_Statement;
 
typedef struct OCI_Bind OCI_Bind;
 
typedef struct OCI_Resultset OCI_Resultset;
 
typedef struct OCI_Column OCI_Column;
 
typedef struct OCI_Lob OCI_Lob;
 
typedef struct OCI_File OCI_File;
 
typedef struct OCI_Transaction OCI_Transaction;
 
typedef struct OCI_Long OCI_Long;
 
typedef struct OCI_Number OCI_Number;
 
typedef struct OCI_Date OCI_Date;
 
typedef struct OCI_Timestamp OCI_Timestamp;
 
typedef struct OCI_Interval OCI_Interval;
 
typedef struct OCI_Object OCI_Object;
 
typedef struct OCI_Coll OCI_Coll;
 
typedef struct OCI_Elem OCI_Elem;
 
typedef struct OCI_Iter OCI_Iter;
 
typedef struct OCI_Ref OCI_Ref;
 
typedef struct OCI_TypeInfo OCI_TypeInfo;
 
typedef struct OCI_HashTable OCI_HashTable;
 
typedef struct OCI_Error OCI_Error;
 
typedef struct OCI_Mutex OCI_Mutex;
 
typedef struct OCI_Thread OCI_Thread;
 
typedef struct OCI_DirPath OCI_DirPath;
 
typedef struct OCI_Subscription OCI_Subscription;
 
typedef struct OCI_Event OCI_Event;
 
typedef struct OCI_Msg OCI_Msg;
 
typedef struct OCI_Agent OCI_Agent;
 
typedef struct OCI_Dequeue OCI_Dequeue;
 
typedef struct OCI_Enqueue OCI_Enqueue;
 
typedef void (*POCI_ERROR)
(
    OCI_Error *err
);
 
typedef void (*POCI_THREAD)
(
    OCI_Thread *thread,
    void *      arg
);
 
typedef void (*POCI_THREADKEYDEST)
(
    void *data
);
 
typedef void (*POCI_NOTIFY)
(
    OCI_Event *event
);
 
typedef void (*POCI_NOTIFY_AQ)
(
    OCI_Dequeue *dequeue
);
 
typedef unsigned int (*POCI_TAF_HANDLER)
(
    OCI_Connection *con,
    unsigned int    type,
    unsigned int    event
);
 
typedef void (*POCI_HA_HANDLER)
(
    OCI_Connection *con,
    unsigned int    source,
    unsigned int    event,
    OCI_Timestamp * time
);
 
/* public structures */
 
typedef struct OCI_XID
{
    long formatID;
    long gtrid_length;
    long bqual_length;
    char data[128];
} OCI_XID;
 
typedef union OCI_Variant
{
    /* integers */
    int num;
 
    /* raw data */
    unsigned char *p_bytes;
 
    /* pointer to c natives types */
    void *  p_void;
    int *   p_int;
    float * p_float;
    double *p_double;
    otext * p_text;
 
    /* ocilib object types */
    OCI_Date *     p_date;
    OCI_Interval * p_interval;
    OCI_Timestamp *p_timestamp;
    OCI_Long *     p_long;
    OCI_Lob *      p_lob;
    OCI_File *     p_file;
    OCI_Statement *p_stmt;
    OCI_Column *   p_col;
    OCI_Object *   p_obj;
    OCI_Coll *     p_coll;
    OCI_Iter *     p_iter;
    OCI_Elem *     p_elem;
} OCI_Variant;
 
typedef struct OCI_HashValue
{
    OCI_Variant           value;
    struct OCI_HashValue *next;
} OCI_HashValue;
 
typedef struct OCI_HashEntry
{
    otext *               key;
    struct OCI_HashValue *values;
    struct OCI_HashEntry *next;
} OCI_HashEntry;
 
#endif    /* OCILIB_OCILIBC_TYPES_H_INCLUDED */