Protocol
================




---------------------------------------------------------------
Definitions
---------------------------------------------------------------



.. c:macro:: WS_GUID

   


   .. code-block:: c
      :caption: Definition
   
      #define WS_GUID "258EAFA5-E914-47DA-95CA-C5AB0DC85B11"


.. c:type:: ymo_ws_proto_version

   Protocol version enum.


   .. code-block:: c
      :caption: Definition
   
      YMO_ENUM8_TYPEDEF(ymo_ws_proto_version) {
          DRAFT_IETF_HYBI_THEWEBSOCKETPROTOCOL_00, /* INTERIM */
          DRAFT_IETF_HYBI_THEWEBSOCKETPROTOCOL_01, /* INTERIM */
          DRAFT_IETF_HYBI_THEWEBSOCKETPROTOCOL_02, /* INTERIM */
          DRAFT_IETF_HYBI_THEWEBSOCKETPROTOCOL_03, /* INTERIM */
          DRAFT_IETF_HYBI_THEWEBSOCKETPROTOCOL_04, /* INTERIM */
          DRAFT_IETF_HYBI_THEWEBSOCKETPROTOCOL_05, /* INTERIM */
          DRAFT_IETF_HYBI_THEWEBSOCKETPROTOCOL_06, /* INTERIM */
          DRAFT_IETF_HYBI_THEWEBSOCKETPROTOCOL_07, /* INTERIM */
          DRAFT_IETF_HYBI_THEWEBSOCKETPROTOCOL_08, /* INTERIM */
          /*----------------
           * 9-12: RESERVED
           *----------------*/
          RFC_6455 = 13, /* STANDARD */
      } YMO_ENUM8_AS(ymo_ws_proto_version_t);


---------------------------------------------------------------
Functions
---------------------------------------------------------------



.. c:function:: ymo_status_t ymo_proto_ws_init( ymo_proto_t* proto, ymo_server_t* server)

   



.. c:function:: void ymo_proto_ws_cleanup( ymo_proto_t* proto, ymo_server_t* server)

   



.. c:function:: void* ymo_proto_ws_conn_init( void* proto_data, ymo_conn_t* conn)

   



.. c:function:: ymo_status_t ymo_proto_ws_conn_ready( void* proto_data, ymo_conn_t* conn, void* conn_data)

   



.. c:function:: void ymo_proto_ws_conn_cleanup( void* proto_data, ymo_conn_t* conn, void* conn_data)

   



.. c:function:: ssize_t ymo_proto_ws_read( void* proto_data, ymo_conn_t* conn, void* conn_data, char* recv_buf, size_t len)

   WS Parse main entry point.
   :param server: ymo_server issuing the parse request
   :param session: WS session we're parsing
   :param proto_data: WS-specific data created by proto init
   :param recv_buf: server read buffer
   :param len: number of bytes in recv_buf
   
   Returns number of bytes parsed on success, -1 on failure.



.. c:function:: ymo_status_t ymo_proto_ws_write( void* proto_data, ymo_conn_t* conn, void* conn_data, int socket)

   WS protocol write callback.
   



.. c:function:: ymo_http_upgrade_status_t ymo_ws_upgrade_cb( const char* hdr_upgrade, ymo_http_request_t* request, ymo_http_response_t* response)

   WebSocket upgrade handler. Attempts upgrade, as per RFC6455.