Skip to content

Fix issue #695 #696

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Fix issue #695 #696

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
162 changes: 98 additions & 64 deletions src/SocketIOclient.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,96 +9,130 @@
#define SOCKETIOCLIENT_H_

#include "WebSockets.h"
#include "WebSocketsClient.h"

#define EIO_HEARTBEAT_INTERVAL 20000

#define EIO_MAX_HEADER_SIZE (WEBSOCKETS_MAX_HEADER_SIZE + 1)
#define SIO_MAX_HEADER_SIZE (EIO_MAX_HEADER_SIZE + 1)

typedef enum {
eIOtype_OPEN = '0', ///< Sent from the server when a new transport is opened (recheck)
eIOtype_CLOSE = '1', ///< Request the close of this transport but does not shutdown the connection itself.
eIOtype_PING = '2', ///< Sent by the client. Server should answer with a pong packet containing the same data
eIOtype_PONG = '3', ///< Sent by the server to respond to ping packets.
eIOtype_MESSAGE = '4', ///< actual message, client and server should call their callbacks with the data
eIOtype_UPGRADE = '5', ///< Before engine.io switches a transport, it tests, if server and client can communicate over this transport. If this test succeed, the client sends an upgrade packets which requests the server to flush its cache on the old transport and switch to the new transport.
eIOtype_NOOP = '6', ///< A noop packet. Used primarily to force a poll cycle when an incoming websocket connection is received.
eIOtype_OPEN =
'0', ///< Sent from the server when a new transport is opened (recheck)
eIOtype_CLOSE = '1', ///< Request the close of this transport but does not
///< shutdown the connection itself.
eIOtype_PING = '2', ///< Sent by the client. Server should answer with a pong
///< packet containing the same data
eIOtype_PONG = '3', ///< Sent by the server to respond to ping packets.
eIOtype_MESSAGE = '4', ///< actual message, client and server should call
///< their callbacks with the data
eIOtype_UPGRADE =
'5', ///< Before engine.io switches a transport, it tests, if server and
///< client can communicate over this transport. If this test
///< succeed, the client sends an upgrade packets which requests the
///< server to flush its cache on the old transport and switch to
///< the new transport.
eIOtype_NOOP = '6', ///< A noop packet. Used primarily to force a poll cycle
///< when an incoming websocket connection is received.
} engineIOmessageType_t;

typedef enum {
sIOtype_CONNECT = '0',
sIOtype_DISCONNECT = '1',
sIOtype_EVENT = '2',
sIOtype_ACK = '3',
sIOtype_ERROR = '4',
sIOtype_BINARY_EVENT = '5',
sIOtype_BINARY_ACK = '6',
sIOtype_CONNECT = '0',
sIOtype_DISCONNECT = '1',
sIOtype_EVENT = '2',
sIOtype_ACK = '3',
sIOtype_ERROR = '4',
sIOtype_BINARY_EVENT = '5',
sIOtype_BINARY_ACK = '6',
} socketIOmessageType_t;

class SocketIOclient : protected WebSocketsClient {
public:
public:
#ifdef __AVR__
typedef void (*SocketIOclientEvent)(socketIOmessageType_t type, uint8_t * payload, size_t length);
typedef void (*SocketIOclientEvent)(socketIOmessageType_t type,
uint8_t* payload, size_t length);
#else
typedef std::function<void(socketIOmessageType_t type, uint8_t * payload, size_t length)> SocketIOclientEvent;
typedef std::function<void(socketIOmessageType_t type, uint8_t* payload,
size_t length)>
SocketIOclientEvent;
#endif

SocketIOclient(void);
virtual ~SocketIOclient(void);
SocketIOclient(void);
virtual ~SocketIOclient(void);

void begin(const char * host, uint16_t port, const char * url = "/socket.io/?EIO=3", const char * protocol = "arduino");
void begin(String host, uint16_t port, String url = "/socket.io/?EIO=3", String protocol = "arduino");
void begin(const char* host, uint16_t port,
const char* url = "/socket.io/?EIO=3",
const char* protocol = "arduino");
void begin(String host, uint16_t port, String url = "/socket.io/?EIO=3",
String protocol = "arduino");

#ifdef HAS_SSL
void beginSSL(const char * host, uint16_t port, const char * url = "/socket.io/?EIO=3", const char * protocol = "arduino");
void beginSSL(String host, uint16_t port, String url = "/socket.io/?EIO=3", String protocol = "arduino");
void beginSSL(const char* host, uint16_t port,
const char* url = "/socket.io/?EIO=3",
const char* protocol = "arduino");
void beginSSL(String host, uint16_t port, String url = "/socket.io/?EIO=3",
String protocol = "arduino");
#ifndef SSL_AXTLS
void beginSSLWithCA(const char * host, uint16_t port, const char * url = "/socket.io/?EIO=3", const char * CA_cert = NULL, const char * protocol = "arduino");
void beginSSLWithCA(const char * host, uint16_t port, const char * url = "/socket.io/?EIO=3", BearSSL::X509List * CA_cert = NULL, const char * protocol = "arduino");
void setSSLClientCertKey(const char * clientCert = NULL, const char * clientPrivateKey = NULL);
void setSSLClientCertKey(BearSSL::X509List * clientCert = NULL, BearSSL::PrivateKey * clientPrivateKey = NULL);
void beginSSLWithCA(const char* host, uint16_t port,
const char* url = "/socket.io/?EIO=3",
const char* CA_cert = NULL,
const char* protocol = "arduino");
void beginSSLWithCA(const char* host, uint16_t port,
const char* url = "/socket.io/?EIO=3",
BearSSL::X509List* CA_cert = NULL,
const char* protocol = "arduino");
void setSSLClientCertKey(const char* clientCert = NULL,
const char* clientPrivateKey = NULL);
void setSSLClientCertKey(BearSSL::X509List* clientCert = NULL,
BearSSL::PrivateKey* clientPrivateKey = NULL);
#endif
#endif
bool isConnected(void);

void onEvent(SocketIOclientEvent cbEvent);

bool sendEVENT(uint8_t * payload, size_t length = 0, bool headerToPayload = false);
bool sendEVENT(const uint8_t * payload, size_t length = 0);
bool sendEVENT(char * payload, size_t length = 0, bool headerToPayload = false);
bool sendEVENT(const char * payload, size_t length = 0);
bool sendEVENT(String & payload);

bool send(socketIOmessageType_t type, uint8_t * payload, size_t length = 0, bool headerToPayload = false);
bool send(socketIOmessageType_t type, const uint8_t * payload, size_t length = 0);
bool send(socketIOmessageType_t type, char * payload, size_t length = 0, bool headerToPayload = false);
bool send(socketIOmessageType_t type, const char * payload, size_t length = 0);
bool send(socketIOmessageType_t type, String & payload);

void setExtraHeaders(const char * extraHeaders = NULL);
void setReconnectInterval(unsigned long time);

void loop(void);

void configureEIOping(bool disableHeartbeat = false);

protected:
bool _disableHeartbeat = false;
uint64_t _lastHeartbeat = 0;
SocketIOclientEvent _cbEvent;
virtual void runIOCbEvent(socketIOmessageType_t type, uint8_t * payload, size_t length) {
if(_cbEvent) {
_cbEvent(type, payload, length);
}
bool isConnected(void);

void onEvent(SocketIOclientEvent cbEvent);

bool sendEVENT(uint8_t* payload, size_t length = 0,
bool headerToPayload = false);
bool sendEVENT(const uint8_t* payload, size_t length = 0);
bool sendEVENT(char* payload, size_t length = 0,
bool headerToPayload = false);
bool sendEVENT(const char* payload, size_t length = 0);
bool sendEVENT(String& payload);

bool send(socketIOmessageType_t type, uint8_t* payload, size_t length = 0,
bool headerToPayload = false);
bool send(socketIOmessageType_t type, const uint8_t* payload,
size_t length = 0);
bool send(socketIOmessageType_t type, char* payload, size_t length = 0,
bool headerToPayload = false);
bool send(socketIOmessageType_t type, const char* payload, size_t length = 0);
bool send(socketIOmessageType_t type, String& payload);

void setExtraHeaders(const char* extraHeaders = NULL);
void setReconnectInterval(unsigned long time);

void loop(void);

void configureEIOping(bool disableHeartbeat = false);

protected:
bool _disableHeartbeat = false;
uint64_t _lastHeartbeat = 0;
SocketIOclientEvent _cbEvent;
virtual void runIOCbEvent(socketIOmessageType_t type, uint8_t* payload,
size_t length) {
if (_cbEvent) {
_cbEvent(type, payload, length);
}
}

void initClient(void);
void initClient(void);

// Handeling events from websocket layer
virtual void runCbEvent(WStype_t type, uint8_t * payload, size_t length) {
handleCbEvent(type, payload, length);
}
void handleCbEvent(WStype_t type, uint8_t * payload, size_t length);
// Handeling events from websocket layer
virtual void runCbEvent(WStype_t type, uint8_t* payload, size_t length) {
handleCbEvent(type, payload, length);
}
void handleCbEvent(WStype_t type, uint8_t* payload, size_t length);
};

#endif /* SOCKETIOCLIENT_H_ */