Data Structures | Macros | Typedefs | Enumerations
Vortex Types: Types definitions used across Vortex Library.

Data Structures

struct  _VortexPayloadFeederStatus
 Public structure that represents transfer status associated to a single payload feeder transfer. More...
 

Macros

#define MAX_CHANNEL_NO   2147483647
 Maximum number of channel allowed to be created inside a VortexConnection. More...
 
#define MAX_CHANNELS_NO   2147483647
 the maximum number of channel which can be created on an connection (or session). More...
 
#define MAX_MESSAGE_NO   2147483647
 The maximum number which can identify a message. More...
 
#define MAX_MSG_NO   2147483647
 Maximum number of messages allowed to be sent for a specific channel instance. More...
 
#define MAX_SEQ_MOD   (INT64_CONSTANT(4294967296))
 Module number used to rotate sequence number for a channel if it overcomes MAX_SEQ_NO. More...
 
#define MAX_SEQ_NO   (INT64_CONSTANT(4294967295))
 Maximum sequence number allowed to be used for a channel created. More...
 
#define MAX_SEQUENCE_NO   4294967295
 The maximum number to be used on sequence frame payload. More...
 
#define MIME_CONTENT_DESCRIPTION   "Content-Description"
 Macro declaration to protect code from misspelling "Content-Description" MIME header. More...
 
#define MIME_CONTENT_ID   "Content-ID"
 Macro declaration to protect code from misspelling "Content-ID" MIME header. More...
 
#define MIME_CONTENT_TRANSFER_ENCODING   "Content-Transfer-Encoding"
 Macro declaration to protect code from misspelling "Content-Transfer-Encoding" MIME header. More...
 
#define MIME_CONTENT_TYPE   "Content-Type"
 Macro declaration to protect code from misspelling "Content-Type" MIME header. More...
 
#define MIME_VERSION   "MIME-Version"
 Macro declaration to protect code from misspelling "MIME-Version" MIME header. More...
 
#define QUEUE_PRIORITY_PUSH(queue, data)
 Helper macro which allows to PRIORITY push data into a particular queue, checking some conditions, which are logged at the particular position if they fail. More...
 
#define QUEUE_PUSH(queue, data)
 Helper macro which allows to push data into a particular queue, checking some conditions, which are logged at the particular position if they fail. More...
 
#define VORTEX_MAX_BUFFER_SIZE   131072
 Maximum buffer value to be read from the network in a single operation. More...
 

Typedefs

typedef struct _VortexAsyncQueue VortexAsyncQueue
 Message queue implementation that allows to communicate several threads in a safe manner. More...
 
typedef struct _VortexCBuffer VortexCBuffer
 Circular byte buffer used by Vortex to efficiently pack bytes in a circular buffer. More...
 
typedef struct _VortexChannel VortexChannel
 A Vortex Channel object. More...
 
typedef struct _VortexChannelPool VortexChannelPool
 Vortex Channel Pool definition. More...
 
typedef __OS_COND_TYPE__ VortexCond
 Conditional variable mutex, encapsulating the underlaying operating system implementation for conditional variables inside critical sections. More...
 
typedef struct _VortexConnection VortexConnection
 A Vortex Connection object (BEEP session representation). More...
 
typedef struct
_VortexConnectionOpts 
VortexConnectionOpts
 Optional structure used to signal additional values to modify how a connection is created. More...
 
typedef struct _VortexCtx VortexCtx
 Vortex library context. More...
 
typedef struct _VortexFrame VortexFrame
 A Vortex Frame object. More...
 
typedef struct _VortexHash VortexHash
 Thread safe hash table based on Glib Hash table intensively used across Vortex Library. More...
 
typedef struct _VortexMimeHeader VortexMimeHeader
 MIME header content representation, allowing to get the content associated and the next value associated on the same header (if were defined). More...
 
typedef __OS_MUTEX_TYPE__ VortexMutex
 Mutex definition that encapsulates the underlaying mutex API. More...
 
typedef struct _VortexPayloadFeeder VortexPayloadFeeder
 Type used to represent a payload feeder. More...
 
typedef struct
_VortexPayloadFeederStatus 
VortexPayloadFeederStatus
 Public structure that represents transfer status associated to a single payload feeder transfer. More...
 
typedef struct _VortexQueue VortexQueue
 Thread safe queue table based on Glib Queue used across Vortex Library. More...
 
typedef __OS_THREAD_TYPE__ VortexThread
 Thread definition, which encapsulates the os thread API, allowing to provide a unified type for all threading interface. More...
 
typedef axlPointer(* VortexThreadFunc )(axlPointer user_data)
 Handle definition for the family of function that is able to accept the function vortex_thread_create. More...
 
typedef struct _WaitReplyData WaitReplyData
 Wait Reply data used for Wait Reply Method. More...
 

Enumerations

enum  VortexConnectionHandler { CONNECTION_CHANNEL_ADD_HANDLER = 1, CONNECTION_CHANNEL_REMOVE_HANDLER = 2 }
 List of possible handlers that can be uninstalled from a connection after being added. More...
 
enum  VortexConnectionOptItem { VORTEX_OPTS_END = 0, VORTEX_SERVERNAME_FEATURE = 1, VORTEX_SERVERNAME_ACQUIRE = 2, VORTEX_OPTS_RELEASE = 3 }
 Connection options. More...
 
enum  VortexConnectionStage { CONNECTION_STAGE_POST_CREATED = 1, CONNECTION_STAGE_PROCESS_GREETINGS_FEATURES = 2 }
 Enum definition to configure stages during the connection creation. More...
 
enum  VortexEncoding { EncodingUnknown = 1, EncodingNone = 2, EncodingBase64 = 3 }
 Enum value used to report which encoding is being used for the content profile send at the channel start phase. More...
 
enum  VortexFrameType {
  VORTEX_FRAME_TYPE_UNKNOWN, VORTEX_FRAME_TYPE_MSG, VORTEX_FRAME_TYPE_RPY, VORTEX_FRAME_TYPE_ANS,
  VORTEX_FRAME_TYPE_ERR, VORTEX_FRAME_TYPE_NUL, VORTEX_FRAME_TYPE_SEQ
}
 Describes the type allowed for a frame or the type a frame actually have. More...
 
enum  VortexIoWaitingFor { READ_OPERATIONS = 1 << 0, WRITE_OPERATIONS = 1 << 1 }
 Allows to specify which type of operation should be implemented while calling to Vortex Library internal IO blocking abstraction. More...
 
enum  VortexIoWaitingType { VORTEX_IO_WAIT_SELECT = 1, VORTEX_IO_WAIT_POLL = 2, VORTEX_IO_WAIT_EPOLL = 3 }
 Enumeration type that allows to use the waiting mechanism to be used by the core library to perform wait on changes on sockets handled. More...
 
enum  VortexMutexConf { VORTEX_MUTEX_CONF_NONRECURSIVE = 1 << 0, VORTEX_MUTEX_CONF_RECURSIVE = 1 << 1 }
 Configuration options available for vortex_mutex_create_full function. More...
 
enum  VortexNetTransport { VORTEX_IPv4 = 1, VORTEX_IPv6 = 2 }
 Definition for supported network transports. More...
 
enum  VortexPayloadFeederOp { PAYLOAD_FEEDER_GET_SIZE = 1, PAYLOAD_FEEDER_GET_CONTENT = 2, PAYLOAD_FEEDER_IS_FINISHED = 3, PAYLOAD_FEEDER_RELEASE = 4 }
 Enumeration type used to represent the query operations that must support a VortexPayloadFeeder implementation. More...
 
enum  VortexPeerRole { VortexRoleUnknown, VortexRoleInitiator, VortexRoleListener, VortexRoleMasterListener }
 In the context of the initial session creation, the BEEP peer allows you to get which is the role of a given VortexConnection object. More...
 
enum  VortexStatus {
  VortexError = 1, VortexOk = 2, VortexBindError = 3, VortexWrongReference = 4,
  VortexNameResolvFailure = 5, VortexSocketCreationError = 6, VortexSocketSanityError = 7, VortexConnectionError = 8,
  VortexConnectionTimeoutError = 9, VortexGreetingsFailure = 10, VortexXmlValidationError = 11, VortexConnectionCloseCalled = 12,
  VortexConnectionForcedClose = 13, VortexProtocolError = 14, VortexConnectionFiltered = 15, VortexMemoryFail = 16,
  VortexUnnotifiedConnectionClose = 17
}
 Vortex Operation Status. More...
 
enum  VortexThreadConf { VORTEX_THREAD_CONF_END = 0, VORTEX_THREAD_CONF_JOINABLE = 1, VORTEX_THREAD_CONF_DETACHED = 2 }
 Thread configuration its to modify default behaviour provided by the thread creation API. More...
 

Detailed Description