Typedefs | Enumerations | Functions
Vortex WebSocket API: support for BEEP connections over WebSocket

Typedefs

typedef struct
_VortexWebsocketSetup 
VortexWebsocketSetup
 Connection setup object. More...
 

Enumerations

enum  VortexWebsocketConfItem {
  VORTEX_WEBSOCKET_CONF_ITEM_PROXY_HOST = 1, VORTEX_WEBSOCKET_CONF_ITEM_PROXY_PORT = 2, VORTEX_WEBSOCKET_CONF_ITEM_CONN_OPTS = 3, VORTEX_WEBSOCKET_CONF_ITEM_ORIGIN = 4,
  VORTEX_WEBSOCKET_CONF_ITEM_HOST = 5, VORTEX_WEBSOCKET_CONF_ITEM_ENABLE_TLS = 6, VORTEX_WEBSOCKET_CONF_ITEM_ENABLE_DEBUG = 7, VORTEX_WEBSOCKET_CONF_CERT_VERIFY = 8
}
 Configurations allowed to be set on VortexWebsocketSetup. More...
 

Functions

noPollCtx * vortex_websocket_connection_get_ctx (VortexConnection *conn)
 Allows to get the noPollCtx context associated to the noPollConn supported the given BEEP session. More...
 
axl_bool vortex_websocket_connection_is (VortexConnection *conn)
 Allows to check if the provided connection was created by using vortex_websocket_connection_new or vortex_websocket_listener_new. More...
 
axl_bool vortex_websocket_connection_is_tls_running (VortexConnection *conn)
 Allows to check if the provided connection has TLS enabled (WebSocket over TLS). More...
 
VortexConnectionvortex_websocket_connection_new (const char *host, const char *port, VortexWebsocketSetup *setup, VortexConnectionNew on_connected, axlPointer user_data)
 Creates a new BEEP connection to a remote BEEP server, by connecting to a WEBSOCKET server supporting WEBSOCKET CONNECT method (proxy server). More...
 
VortexConnectionvortex_websocket_listener_new (VortexCtx *ctx, noPollConn *listener, VortexListenerReadyFull on_ready_full, axlPointer user_data)
 Allows to create a new BEEP listener accepting connections over WebSocket. More...
 
axlPointer vortex_websocket_listener_port_sharing (VortexCtx *ctx, noPollCtx *nopoll_ctx, const char *local_addr, const char *local_port)
 Allows to activate Vortex Library port sharing feature on the provided local listener address and local listener port. More...
 
void vortex_websocket_setup_conf (VortexWebsocketSetup *setup, VortexWebsocketConfItem item, axlPointer value)
 Allows to configure a particular value (VortexWebsocketConfItem) on the provided setup (VortexWebsocketSetup). More...
 
VortexWebsocketSetupvortex_websocket_setup_new (VortexCtx *ctx)
 Allows to create a VortexWebsocketSetup object which is used to configure the WEBSOCKET CONNECT implementation. More...
 
axl_bool vortex_websocket_setup_ref (VortexWebsocketSetup *setup)
 Allows to increment the reference counting associated to the VortexWebsocketSetup object. More...
 
void vortex_websocket_setup_unref (VortexWebsocketSetup *setup)
 Terminates the VortexWebsocketSetup reference provided. More...
 

Detailed Description