xws/websocket_http API 参考

xrtWsServerConfigInit

在完整、允许未对齐的存储中初始化服务端默认配置。

void xrtWsServerConfigInit( xwsserverconfig* pConfig );

参数	说明
xwsserverconfig* pConfig	配置结构

返回：在完整、允许未对齐的存储中初始化服务端默认配置。

示例已编译验证

wsserverconfiginit obj;
xrtWsServerConfigInit(&obj);

xrtWsServerConfigValid

从允许未对齐的完整快照无分配验证服务端配置。

bool xrtWsServerConfigValid( const xwsserverconfig* pConfig );

参数	说明
const xwsserverconfig* pConfig	配置结构

返回：从允许未对齐的完整快照无分配验证服务端配置。

示例已编译验证

/* 从允许未对齐的完整快照无分配验证服务端配置。 */
result = xrtWsServerConfigValid(pConfig);

xrtWsServerCheck

XRT_API bool xrtWsServerCheck( const xhttpserverrequest* pRequest, const xwsserverconfig* pConfig, xwsserverhandshake* pHandshake );

;

返回：XRT_API bool xrtWsServerCheck( const xhttpserverrequest* pRequest, const xwsserverconfig* pConfig, xwsserverhandshake* pHandshake );

示例已编译验证

/* XRT_API bool xrtWsServerCheck( const xhttpserverrequest* pRequest, const xwsserverconfig* pConfig, xwsserverhandshake* pHandshake ); */
result = xrtWsServerCheck();

xrtWsServerReply

从完整、允许未对齐的已验证握手快照创建拥有型 101 Reply。

xhttpreply* xrtWsServerReply( const xwsserverhandshake* pHandshake );

参数	说明
const xwsserverhandshake* pHandshake	Handshake 参数

返回：从完整、允许未对齐的已验证握手快照创建拥有型 101 Reply。

示例已编译验证

/* 从完整、允许未对齐的已验证握手快照创建拥有型 101 Reply。 */
result = xrtWsServerReply(pHandshake);

xrtWsServerReject

XRT_API xnetresult xrtWsServerReject( xhttpconn* pHttp, const xerror* pError );

;

返回：XRT_API xnetresult xrtWsServerReject( xhttpconn* pHttp, const xerror* pError );

示例已编译验证

/* XRT_API xnetresult xrtWsServerReject( xhttpconn* pHttp, const xerror* pError ); */
result = xrtWsServerReject();

xrtWsUpgradeAccept

XRT_API xnetresult xrtWsUpgradeAccept( xhttpconn* pHttp, const xwsserverconfig* pConfig, const xwsserverhandshake* pHandshake, const xhttpheaders* pHeaders, const xwsconnevents* pEvents, ptr pEventData, xwsupgradeproc pProc, ptr pData );

;

返回：XRT_API xnetresult xrtWsUpgradeAccept( xhttpconn* pHttp, const xwsserverconfig* pConfig, const xwsserverhandshake* pHandshake, const xhttpheaders* pHeaders, const xwsconnevents* pEvents, ptr pEventData, xwsupgradeproc pProc, ptr pData );

示例已编译验证

/* XRT_API xnetresult xrtWsUpgradeAccept( xhttpconn* pHttp, const xwsserverconfig* pConfig, const xwsserverhandshake* pHandshake, const xhttpheaders* pHeaders, const xwsconnevents* pEvents, ptr pEventData, xwsupgradeproc pProc, ptr pData ); */
result = xrtWsUpgradeAccept();

xrtWsUpgrade

XRT_API xnetresult xrtWsUpgrade( xhttpconn* pHttp, const xwsserverconfig* pConfig, const xwsconnevents* pEvents, ptr pEventData, xwsupgradeproc pProc, ptr pData );

;

返回：XRT_API xnetresult xrtWsUpgrade( xhttpconn* pHttp, const xwsserverconfig* pConfig, const xwsconnevents* pEvents, ptr pEventData, xwsupgradeproc pProc, ptr pData );

示例已编译验证

/* XRT_API xnetresult xrtWsUpgrade( xhttpconn* pHttp, const xwsserverconfig* pConfig, const xwsconnevents* pEvents, ptr pEventData, xwsupgradeproc pProc, ptr pData ); */
result = xrtWsUpgrade();

xrtWsClientConfigInit

在完整、允许未对齐的存储中初始化客户端默认配置。

void xrtWsClientConfigInit( xwsclientconfig* pConfig );

参数	说明
xwsclientconfig* pConfig	配置结构

返回：在完整、允许未对齐的存储中初始化客户端默认配置。

示例已编译验证

wsclientconfiginit obj;
xrtWsClientConfigInit(&obj);

xrtWsRequestCreate

XRT_API xhttprequest* xrtWsRequestCreate( xstrview Url );

;

返回：XRT_API xhttprequest* xrtWsRequestCreate( xstrview Url );

示例已编译验证

/* XRT_API xhttprequest* xrtWsRequestCreate( xstrview Url ); */
xhandle* h = xrtWsRequestCreate();

xrtWsClientRequestCreate

XRT_API xhttprequest* xrtWsClientRequestCreate( xstrview Url, const xwsclientconfig* pConfig, char sKey[XWS_KEY_CAPACITY] );

;

返回：XRT_API xhttprequest* xrtWsClientRequestCreate( xstrview Url, const xwsclientconfig* pConfig, char sKey[XWS_KEY_CAPACITY] );

示例已编译验证

/* XRT_API xhttprequest* xrtWsClientRequestCreate( xstrview Url, const xwsclientconfig* pConfig, char sKey[XWS_KEY_CAPACITY] ); */
xhandle* h = xrtWsClientRequestCreate();

xrtWsClientRequestClone

XRT_API xhttprequest* xrtWsClientRequestClone( const xhttprequest* pRequest, const xwsclientconfig* pConfig, char sKey[XWS_KEY_CAPACITY] );

;

返回：XRT_API xhttprequest* xrtWsClientRequestClone( const xhttprequest* pRequest, const xwsclientconfig* pConfig, char sKey[XWS_KEY_CAPACITY] );

示例已编译验证

/* XRT_API xhttprequest* xrtWsClientRequestClone( const xhttprequest* pRequest, const xwsclientconfig* pConfig, char sKey[XWS_KEY_CAPACITY] ); */
result = xrtWsClientRequestClone();

xrtWsClientCheck

XRT_API bool xrtWsClientCheck( const xhttpresponse* pResponse, xstrview Key, const xwsclientconfig* pConfig, xwsclienthandshake* pHandshake );

;

返回：XRT_API bool xrtWsClientCheck( const xhttpresponse* pResponse, xstrview Key, const xwsclientconfig* pConfig, xwsclienthandshake* pHandshake );

示例已编译验证

/* XRT_API bool xrtWsClientCheck( const xhttpresponse* pResponse, xstrview Key, const xwsclientconfig* pConfig, xwsclienthandshake* pHandshake ); */
result = xrtWsClientCheck();

xrtWsConnect

XRT_API xhttpcall* xrtWsConnect( xhttpclient* pClient, xstrview Url, const xwsclientconfig* pConfig, const xwsconnevents* pEvents, ptr pEventData, xwsconnectproc pProc, ptr pData );

;

返回：XRT_API xhttpcall* xrtWsConnect( xhttpclient* pClient, xstrview Url, const xwsclientconfig* pConfig, const xwsconnevents* pEvents, ptr pEventData, xwsconnectproc pProc, ptr pData );

示例已编译验证

/* XRT_API xhttpcall* xrtWsConnect( xhttpclient* pClient, xstrview Url, const xwsclientconfig* pConfig, const xwsconnevents* pEvents, ptr pEventData, xwsconnectproc pProc, ptr pData ); */
result = xrtWsConnect();

xrtWsConnectRequest

XRT_API xhttpcall* xrtWsConnectRequest( xhttpclient* pClient, const xhttprequest* pRequest, const xwsclientconfig* pConfig, const xwsconnevents* pEvents, ptr pEventData, xwsconnectproc pProc, ptr pData );

;

返回：XRT_API xhttpcall* xrtWsConnectRequest( xhttpclient* pClient, const xhttprequest* pRequest, const xwsclientconfig* pConfig, const xwsconnevents* pEvents, ptr pEventData, xwsconnectproc pProc, ptr pData );

示例已编译验证

/* XRT_API xhttpcall* xrtWsConnectRequest( xhttpclient* pClient, const xhttprequest* pRequest, const xwsclientconfig* pConfig, const xwsconnevents* pEvents, ptr pEventData, xwsconnectproc pProc, ptr pData ); */
result = xrtWsConnectRequest();