Vortex Types: Types definitions used across Vortex Library.


Defines

#define MAX_BUFFER_SIZE   65536
 Maximum buffer value to be read from the network in a single operation.
#define MAX_CHANNEL_NO   2147483647
 Maximum number of channel allowed to be created inside a VortexConnection.
#define MAX_CHANNELS_NO   2147483647
 the maximum number of channel which can be created on an connection (or session).
#define MAX_MESSAGE_NO   2147483647
 The maximum number which can identify a message.
#define MAX_MSG_NO   2147483647
 Maximum number of messages allowed to be sent for a specific channel instance.
#define MAX_SEQ_MOD   (INT64_CONSTANT(4294967296))
 Module number used to rotate sequence number for a channel if it overcomes MAX_SEQ_NO.
#define MAX_SEQ_NO   (INT64_CONSTANT(4294967295))
 Maximum sequence number allowed to be used for a channel created.
#define MAX_SEQUENCE_NO   4294967295
 The maximum number to be used on sequence frame payload.
#define MIME_CONTENT_DESCRIPTION   "Content-Description"
 Macro declaration to protect code from misspelling "Content-Description" MIME header.
#define MIME_CONTENT_ID   "Content-ID"
 Macro declaration to protect code from misspelling "Content-ID" MIME header.
#define MIME_CONTENT_TRANSFER_ENCODING   "Content-Transfer-Encoding"
 Macro declaration to protect code from misspelling "Content-Transfer-Encoding" MIME header.
#define MIME_CONTENT_TYPE   "Content-Type"
 Macro declaration to protect code from misspelling "Content-Type" MIME header.
#define MIME_VERSION   "MIME-Version"
 Macro declaration to protect code from misspelling "MIME-Version" MIME header.
#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.
#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.

Typedefs

typedef struct _VortexAsyncQueue VortexAsyncQueue
 Message queue implementation that allows to communicate several threads in a safe manner.
typedef struct _VortexChannel VortexChannel
 A Vortex Channel object.
typedef struct _VortexChannelPool VortexChannelPool
 Vortex Channel Pool definition.
typedef __OS_COND_TYPE__ VortexCond
 Conditional variable mutex, encapsulating the underlaying operating system implementation for conditional variables inside critical sections.
typedef struct _VortexConnection VortexConnection
 A Vortex Connection object (BEEP session representation).
typedef struct _VortexCtx VortexCtx
 Vortex library context.
typedef struct _VortexFrame VortexFrame
 A Vortex Frame object.
typedef struct _VortexHash VortexHash
 Thread safe hash table based on Glib Hash table intensively used across Vortex Library.
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).
typedef __OS_MUTEX_TYPE__ VortexMutex
 Mutex definition that encapsulates the underlaying mutex API.
typedef struct _VortexQueue VortexQueue
 Thread safe queue table based on Glib Queue used across Vortex Library.
typedef __OS_THREAD_TYPE__ VortexThread
 Thread definition, which encapsulates the os thread API, allowing to provide a unified type for all threading interface.
typedef axlPointer(* VortexThreadFunc )(axlPointer user_data)
 Handle definition for the family of function that is able to accept the function vortex_thread_create.
typedef struct
_VortexTunnelSettings 
VortexTunnelSettings
 Opaque type representing a proxy configuration used by the Vortex Engine to create a new connection to a remote point through an application layer gateway implementing the TUNNEL profile.
typedef struct _WaitReplyData WaitReplyData
 Wait Reply data used for Wait Reply Method.

Enumerations

enum  VortexDebugLevel { VORTEX_LEVEL_DEBUG, VORTEX_LEVEL_WARNING, VORTEX_LEVEL_CRITICAL }
 Debug levels of logging messages printed by Vortex. More...
enum  VortexEncoding { EncodingUnknown, EncodingNone, EncodingBase64 }
 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  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 }
 Vortex Operation Status This enum is used to represent different Vortex Library status. More...
enum  VortexThreadConf { VORTEX_THREAD_CONF_END = 0, VORTEX_THREAD_CONF_JOINABLE = 1 }
 Thread configuration its to modify default behaviour provided by the thread creation API. More...
enum  VortexTunnelItem {
  TUNNEL_END_CONF = 1, TUNNEL_FQDN = 2, TUNNEL_PORT = 3, TUNNEL_IP4 = 4,
  TUNNEL_IP6 = 5, TUNNEL_SRV = 6, TUNNEL_URI = 7, TUNNEL_ENDPOINT = 8
}
 Proxy TUNNEL item configuration. More...