1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677 |
- /*******************************************************************************
- * Copyright (c) 2018 Wind River Systems, Inc. All Rights Reserved.
- *
- * All rights reserved. This program and the accompanying materials
- * are made available under the terms of the Eclipse Public License v1.0
- * and Eclipse Distribution License v1.0 which accompany this distribution.
- *
- * The Eclipse Public License is available at
- * http://www.eclipse.org/legal/epl-v10.html
- * and the Eclipse Distribution License is available at
- * http://www.eclipse.org/org/documents/edl-v10.php.
- *
- * Contributors:
- * Keith Holman - initial implementation and documentation
- *******************************************************************************/
- #if !defined(WEBSOCKET_H)
- #define WEBSOCKET_H
- #include "Clients.h"
- /**
- * WebSocket op codes
- * @{
- */
- #define WebSocket_OP_CONTINUE 0x0 /* 0000 - continue frame */
- #define WebSocket_OP_TEXT 0x1 /* 0001 - text frame */
- #define WebSocket_OP_BINARY 0x2 /* 0010 - binary frame */
- #define WebSocket_OP_CLOSE 0x8 /* 1000 - close frame */
- #define WebSocket_OP_PING 0x9 /* 1001 - ping frame */
- #define WebSocket_OP_PONG 0xA /* 1010 - pong frame */
- /** @} */
- /**
- * Various close status codes
- * @{
- */
- #define WebSocket_CLOSE_NORMAL 1000
- #define WebSocket_CLOSE_GOING_AWAY 1001
- #define WebSocket_CLOSE_PROTOCOL_ERROR 1002
- #define WebSocket_CLOSE_UNKNOWN_DATA 1003
- #define WebSocket_CLOSE_RESERVED 1004
- #define WebSocket_CLOSE_NO_STATUS_CODE 1005 /* reserved: not to be used */
- #define WebSocket_CLOSE_ABNORMAL 1006 /* reserved: not to be used */
- #define WebSocket_CLOSE_BAD_DATA 1007
- #define WebSocket_CLOSE_POLICY 1008
- #define WebSocket_CLOSE_MSG_TOO_BIG 1009
- #define WebSocket_CLOSE_NO_EXTENSION 1010
- #define WebScoket_CLOSE_UNEXPECTED 1011
- #define WebSocket_CLOSE_TLS_FAIL 1015 /* reserved: not be used */
- /** @} */
- /* closes a websocket connection */
- void WebSocket_close(networkHandles *net, int status_code, const char *reason);
- /* sends upgrade request */
- int WebSocket_connect(networkHandles *net, const char *uri);
- /* calculates the extra data required in a packet to hold a WebSocket frame header */
- size_t WebSocket_calculateFrameHeaderSize(networkHandles *net, int mask_data,
- size_t data_len);
- /* obtain data from network socket */
- int WebSocket_getch(networkHandles *net, char* c);
- char *WebSocket_getdata(networkHandles *net, size_t bytes, size_t* actual_len);
- /* send data out, in websocket format only if required */
- int WebSocket_putdatas(networkHandles* net, char* buf0, size_t buf0len,
- int count, char** buffers, size_t* buflens, int* freeData);
- /* releases any resources used by the websocket system */
- void WebSocket_terminate(void);
- /* handles websocket upgrade request */
- int WebSocket_upgrade(networkHandles *net);
- #endif /* WEBSOCKET_H */
|