NCBI C++ ToolKit: Connectors

do {                                                   \
        if (timeout) {                                     \
            meta->default_timeout = &meta->default_tmo;    \
            meta->default_tmo     = *timeout;              \
        } else                                             \
            meta->default_timeout = 0;                     \
    } while (0);


Classes
struct	SCONN_Callback
struct	SMetaConnector
struct	SConnectorTag
struct	SFileConnAttr
struct	SSERVICE_Extra
Defines
#define	CONN_N_CALLBACKS 1
#define	CONN_TWO2ONE(a, b) a##b
#define	CONN_SET_METHOD(meta, method, function, connector)
#define	CONN_SET_DEFAULT_TIMEOUT(meta, timeout)
#define	SERVICE_CreateConnector(service) SERVICE_CreateConnectorEx(service, fSERV_Any, 0, 0)
Typedefs
typedef SConnectionTag *	CONN
typedef void(*	FConnCallback )(CONN conn, ECONN_Callback type, void *data)
typedef SConnectorTag *	CONNECTOR
typedef const char (	FConnectorGetType )(CONNECTOR connector)
typedef char (	FConnectorDescr )(CONNECTOR connector)
typedef EIO_Status(*	FConnectorOpen )(CONNECTOR connector, const STimeout *timeout)
typedef EIO_Status(*	FConnectorWait )(CONNECTOR connector, EIO_Event event, const STimeout *timeout)
typedef EIO_Status(*	FConnectorWrite )(CONNECTOR connector, const void buf, size_t size, size_t n_written, const STimeout *timeout)
typedef EIO_Status(*	FConnectorFlush )(CONNECTOR connector, const STimeout *timeout)
typedef EIO_Status(*	FConnectorRead )(CONNECTOR connector, void buf, size_t size, size_t n_read, const STimeout *timeout)
typedef EIO_Status(*	FConnectorStatus )(CONNECTOR connector, EIO_Event direction)
typedef EIO_Status(*	FConnectorClose )(CONNECTOR connector, const STimeout *timeout)
typedef void(*	FSetupVTable )(SMetaConnector *meta, CONNECTOR connector)
typedef void(*	FDestroy )(CONNECTOR connector)
typedef SConnectorTag	SConnector
typedef unsigned int	TFCDC_Flags
typedef unsigned int	THCC_Flags
typedef int(*	FHttpParseHTTPHeader )(const char http_header, void adjust_data, int server_error)
typedef int(*	FHttpAdjustNetInfo )(SConnNetInfo net_info, void adjust_data, unsigned int failure_count)
typedef void(*	FHttpAdjustCleanup )(void *adjust_data)
typedef void(*	FHTTP_NcbiMessageHook )(const char *message)
typedef const SSERV_Info (	FSERVICE_GetNextInfo )(SERV_ITER iter, void *data)
typedef void(*	FSERVICE_CleanupData )(void *data)
typedef void(*	FSERVICE_ResetData )(void *data)
Enumerations
enum	ECONN_Callback { eCONN_OnClose = 0 }
enum	EFileConnMode { eFCM_Truncate, eFCM_Seek, eFCM_Append }
enum	EFCDC_Flags { fFCDC_LogControl = 1, fFCDC_LogData = 2, fFCDC_LogAll = fFCDC_LogControl \| fFCDC_LogData }
enum	EFCDC_OldFlags { eFCDC_LogControl = fFCDC_LogControl, eFCDC_LogData = fFCDC_LogData, eFCDC_LogAll = fFCDC_LogAll }
enum	EHCC_Flags { fHCC_AutoReconnect = 0x1, fHCC_SureFlush = 0x2, fHCC_KeepHeader = 0x4, fHCC_UrlDecodeInput = 0x8, fHCC_UrlEncodeOutput = 0x10, fHCC_UrlCodec = 0x18, fHCC_UrlEncodeArgs = 0x20, fHCC_DropUnread = 0x40, fHCC_NoUpread = 0x80, fHCC_Flushable = 0x100, fHCC_InsecureRedirect = 0x200, fHCC_NoAutoRetry = 0x400 }
enum	ESCC_Flags { fSCC_DebugPrintout = fSOCK_LogOn, fSCC_Secure = fSOCK_Secure, fSCC_SetReadOnWrite = fSOCK_ReadOnWrite }
Functions
EIO_Status	CONN_Create (CONNECTOR connector, CONN *conn)
EIO_Status	CONN_ReInit (CONN conn, CONNECTOR connector)
const char *	CONN_GetType (CONN conn)
char *	CONN_Description (CONN conn)
EIO_Status	CONN_SetTimeout (CONN conn, EIO_Event event, const STimeout *new_timeout)
const STimeout *	CONN_GetTimeout (CONN conn, EIO_Event event)
EIO_Status	CONN_Wait (CONN conn, EIO_Event event, const STimeout *timeout)
EIO_Status	CONN_Write (CONN conn, const void buf, size_t size, size_t n_written, EIO_WriteMethod how)
EIO_Status	CONN_PushBack (CONN conn, const void *buf, size_t size)
EIO_Status	CONN_Flush (CONN conn)
EIO_Status	CONN_Read (CONN conn, void buf, size_t size, size_t n_read, EIO_ReadMethod how)
EIO_Status	CONN_ReadLine (CONN conn, char line, size_t size, size_t n_read)
EIO_Status	CONN_Status (CONN conn, EIO_Event dir)
EIO_Status	CONN_Close (CONN conn)
EIO_Status	CONN_SetCallback (CONN conn, ECONN_Callback type, const SCONN_Callback new_cb, SCONN_Callback old_cb)
EIO_Status	METACONN_Add (SMetaConnector *meta, CONNECTOR connector)
EIO_Status	METACONN_Remove (SMetaConnector *meta, CONNECTOR connector)
CONNECTOR	FILE_CreateConnector (const char in_file_name, const char out_file_name)
CONNECTOR	FILE_CreateConnectorEx (const char in_file_name, const char out_file_name, const SFileConnAttr *attr)
CONNECTOR	FTP_CreateDownloadConnector (const char host, unsigned short port, const char user, const char pass, const char path, TFCDC_Flags flag)
CONNECTOR	HTTP_CreateConnector (const SConnNetInfo net_info, const char user_header, THCC_Flags flags)
CONNECTOR	HTTP_CreateConnectorEx (const SConnNetInfo net_info, THCC_Flags flags, FHttpParseHTTPHeader parse_http_hdr, FHttpAdjustNetInfo adjust_net_info, void adjust_data, FHttpAdjustCleanup adjust_cleanup)
void	HTTP_SetNcbiMessageHook (FHTTP_NcbiMessageHook)
CONNECTOR	MEMORY_CreateConnector (void)
CONNECTOR	MEMORY_CreateConnectorEx (BUF buf)
CONNECTOR	NAMEDPIPE_CreateConnector (const string &pipename, size_t pipebufsize=0)
	Create CNamedPipe-based CONNECTOR.
CONNECTOR	PIPE_CreateConnector (const string &cmd, const vector< string > &args, CPipe::TCreateFlags create_flags=0, CPipe *pipe=0)
	Create CPipe-based CONNECTOR.
CONNECTOR	SERVICE_CreateConnectorEx (const char service, TSERV_Type types, const SConnNetInfo net_info, const SSERVICE_Extra *params)
CONNECTOR	SOCK_CreateConnector (const char *host, unsigned short port, unsigned int max_try)
CONNECTOR	SOCK_CreateConnectorEx (const char host, unsigned short port, unsigned int max_try, const void init_data, size_t init_size, TSOCK_Flags flags)
CONNECTOR	SOCK_CreateConnectorOnTop (SOCK sock, unsigned int max_try)
CONNECTOR	SOCK_CreateConnectorOnTopEx (SOCK sock, unsigned int max_try, TSOCK_Flags flags)

Connectors
[CONNECT]

Classes

Defines

Typedefs

Enumerations

Functions

Define Documentation

Typedef Documentation

Enumeration Type Documentation

Function Documentation

Connectors [CONNECT]

Classes

Defines

Typedefs

Enumerations

Functions

Define Documentation

Typedef Documentation

Enumeration Type Documentation

Function Documentation

Connectors
[CONNECT]