ncbi_connector.h File Reference

#include <connect/ncbi_core.h>

Include dependency graph for ncbi_connector.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Go to the SVN repository for this file.

Classes
struct	SMetaConnector
	Standard set of connector methods to handle a connection (corresponding connectors are also in here), part of the connection handle ("CONN"). More...
struct	SConnectorTag
	Connector specification. More...

Macros
#define	CONN_SET_METHOD(meta, method, function, connector)
#define	CONN_SET_DEFAULT_TIMEOUT(meta, timeout)

Typedefs
typedef struct SConnectorTag *	CONNECTOR
	connector handle More...
typedef const char *(*	FConnectorGetType) (CONNECTOR connector)
	Get the name of the connector (may NOT be NULL) More...
typedef char *(*	FConnectorDescr) (CONNECTOR connector)
	Get the human readable connector's description (may be NULL on error) More...
typedef EIO_Status(*	FConnectorOpen) (CONNECTOR connector, const STimeout *timeout)
	Open connection. More...
typedef EIO_Status(*	FConnectorWait) (CONNECTOR connector, EIO_Event event, const STimeout *timeout)
	Wait until either read or write (depending on the "event" value) becomes available, or until "timeout" expires, or until error occurs. More...
typedef EIO_Status(*	FConnectorWrite) (CONNECTOR connector, const void *buf, size_t size, size_t *n_written, const STimeout *timeout)
	Write to connector. More...
typedef EIO_Status(*	FConnectorFlush) (CONNECTOR connector, const STimeout *timeout)
	Flush yet unwritten output data, if any. More...
typedef EIO_Status(*	FConnectorRead) (CONNECTOR connector, void *buf, size_t size, size_t *n_read, const STimeout *timeout)
	Read from connector. More...
typedef EIO_Status(*	FConnectorStatus) (CONNECTOR connector, EIO_Event direction)
	Obtain last I/O completion code from the transport level (connector). More...
typedef EIO_Status(*	FConnectorClose) (CONNECTOR connector, const STimeout *timeout)
	Close data link (if any) and cleanup related data structures. More...
typedef void(*	FSetupVTable) (CONNECTOR connector)
	Upcall on request to setup virtual function table (called from connection). More...
typedef void(*	FDestroy) (CONNECTOR connector)
	Destroy connector and its data handle. More...
typedef struct SConnectorTag	SConnector
	Connector specification. More...

Functions
EIO_Status	METACONN_Insert (SMetaConnector *meta, CONNECTOR connector)
	Insert a connector in the beginning of the connection's list of connectors. More...
EIO_Status	METACONN_Remove (SMetaConnector *meta, CONNECTOR connector)
	Delete given "connector" all its descendants (all connectors if "connector" is NULL) from the connections's list of connectors. More...

Variables
const STimeout	g_NcbiDefConnTimeout
	DEF_CONN_TIMEOUT as STimeout. More...