101 lines
3.4 KiB
C
101 lines
3.4 KiB
C
|
/*
|
||
|
|
* libwebsockets - small server side websockets and web server implementation
|
||
|
|
*
|
||
|
|
* Copyright (C) 2010 - 2019 Andy Green <andy@warmcat.com>
|
||
|
|
*
|
||
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
||
|
|
* of this software and associated documentation files (the "Software"), to
|
||
|
|
* deal in the Software without restriction, including without limitation the
|
||
|
|
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
|
||
|
|
* sell copies of the Software, and to permit persons to whom the Software is
|
||
|
|
* furnished to do so, subject to the following conditions:
|
||
|
|
*
|
||
|
|
* The above copyright notice and this permission notice shall be included in
|
||
|
|
* all copies or substantial portions of the Software.
|
||
|
|
*
|
||
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||
|
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
||
|
|
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
|
||
|
|
* IN THE SOFTWARE.
|
||
|
|
*/
|
||
|
|
|
||
|
|
/** \defgroup wsstatus Websocket status APIs
|
||
|
|
* ##Websocket connection status APIs
|
||
|
|
*
|
||
|
|
* These provide information about ws connection or message status
|
||
|
|
*/
|
||
|
|
///@{
|
||
|
|
/**
|
||
|
|
* lws_send_pipe_choked() - tests if socket is writable or not
|
||
|
|
* \param wsi: lws connection
|
||
|
|
*
|
||
|
|
* Allows you to check if you can write more on the socket
|
||
|
|
*/
|
||
|
|
LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
|
||
|
|
lws_send_pipe_choked(struct lws *wsi);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* lws_is_final_fragment() - tests if last part of ws message
|
||
|
|
*
|
||
|
|
* \param wsi: lws connection
|
||
|
|
*/
|
||
|
|
LWS_VISIBLE LWS_EXTERN int
|
||
|
|
lws_is_final_fragment(struct lws *wsi);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* lws_is_first_fragment() - tests if first part of ws message
|
||
|
|
*
|
||
|
|
* \param wsi: lws connection
|
||
|
|
*/
|
||
|
|
LWS_VISIBLE LWS_EXTERN int
|
||
|
|
lws_is_first_fragment(struct lws *wsi);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* lws_get_reserved_bits() - access reserved bits of ws frame
|
||
|
|
* \param wsi: lws connection
|
||
|
|
*/
|
||
|
|
LWS_VISIBLE LWS_EXTERN unsigned char
|
||
|
|
lws_get_reserved_bits(struct lws *wsi);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* lws_get_opcode() - access opcode of ws frame
|
||
|
|
* \param wsi: lws connection
|
||
|
|
*/
|
||
|
|
LWS_VISIBLE LWS_EXTERN uint8_t
|
||
|
|
lws_get_opcode(struct lws *wsi);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* lws_partial_buffered() - find out if lws buffered the last write
|
||
|
|
* \param wsi: websocket connection to check
|
||
|
|
*
|
||
|
|
* Returns 1 if you cannot use lws_write because the last
|
||
|
|
* write on this connection is still buffered, and can't be cleared without
|
||
|
|
* returning to the service loop and waiting for the connection to be
|
||
|
|
* writeable again.
|
||
|
|
*
|
||
|
|
* If you will try to do >1 lws_write call inside a single
|
||
|
|
* WRITEABLE callback, you must check this after every write and bail if
|
||
|
|
* set, ask for a new writeable callback and continue writing from there.
|
||
|
|
*
|
||
|
|
* This is never set at the start of a writeable callback, but any write
|
||
|
|
* may set it.
|
||
|
|
*/
|
||
|
|
LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
|
||
|
|
lws_partial_buffered(struct lws *wsi);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* lws_frame_is_binary(): true if the current frame was sent in binary mode
|
||
|
|
*
|
||
|
|
* \param wsi: the connection we are inquiring about
|
||
|
|
*
|
||
|
|
* This is intended to be called from the LWS_CALLBACK_RECEIVE callback if
|
||
|
|
* it's interested to see if the frame it's dealing with was sent in binary
|
||
|
|
* mode.
|
||
|
|
*/
|
||
|
|
LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
|
||
|
|
lws_frame_is_binary(struct lws *wsi);
|
||
|
|
///@}
|