ELClientSocket.h

Go to the documentation of this file.

 
#ifndef _EL_CLIENT_SOCKET_H_
#define _EL_CLIENT_SOCKET_H_
 
#include <Arduino.h>
#include "FP.h"
#include "ELClient.h"
 
#define DEFAULT_SOCKET_TIMEOUT  5000 
#define USERCB_SENT 0 
#define USERCB_RECV 1 
#define USERCB_RECO 2 
#define USERCB_CONN 3 
// Socket mode definitions
#define SOCKET_TCP_CLIENT 0 
#define SOCKET_TCP_CLIENT_LISTEN 1 
#define SOCKET_TCP_SERVER 2 
#define SOCKET_UDP 3 
// Enable/disable debug output. If defined enables the debug output on Serial port
//#define DEBUG_EN /**< Enable/disable debug output */
 
// The ELClientSocket class sends data over a simple Socket connection to a remote server. Each instance
// is used to communicate with one server and multiple instances can be created to send
// to multiple servers.
// The ELClientSocket class does not support concurrent requests to the same server because
// only a single response can be recevied at a time and the responses of the two requests
// may arrive out of order.
// A major limitation of the Socket class is that it does not wait for the response data. 
class ELClientSocket {
    public:
        ELClientSocket(ELClient *e);
 
        // Initialize communication to a remote server, this communicates with esp-link but does not
        // open a connection to the remote server. Host may be a hostname or an IP address.
        // Port needs to be defined different from usual HTTP/HTTPS/FTP/SSH ports
        // sock_mode defines whether the socket act as a client (with or without receiver) or as a server
        // Returns 0 if the set-up is
        // successful, returns a negative error code if it failed.
        // Optional a pointer to a callback function be added. The callback function will be called after data is sent out, 
        // after data was received or when an error occured. See example code port how to use it.
        int begin(const char* host, uint16_t port, uint8_t sock_mode, void (*userCb)(uint8_t resp_type, uint8_t client_num, uint16_t len, char *data)=0);
 
        // Send data to the remote server. The data must be null-terminated
        void send(const char* data);
 
        // Send data to the remote server.
        void send(const char* data, int len);
 
        // Retrieve the response from the remote server, returns the number of send or received bytes, 0 if no
        // response (may need to wait longer)
        // !!! UDP doesn't check if the data was received or if the receiver IP/socket is available !!! You need to implement your own
        // error control!
        uint16_t getResponse(uint8_t *resp_type, uint8_t *client_num, char* data, uint16_t maxLen);
 
        // Wait for the response from the remote server, returns the length of received data or 0 if no
        // response (timeout occurred)
        // Blocks the Arduino code for 5 seconds! not recommended to use. See code examples how to use the callback function instead
        uint16_t waitResponse(uint8_t *resp_type, uint8_t *client_num, char* data, uint16_t maxLen, uint32_t timeout=DEFAULT_SOCKET_TIMEOUT);
 
        int32_t remote_instance; 
    private:
        ELClient *_elc; 
        void socketCallback(void* resp);
        FP<void, void*> socketCb; 
        typedef void (* _userCallback)(uint8_t resp_type, uint8_t client_num, uint16_t len, char *data);
        _userCallback _userCb; 
        bool _hasUserCb = false; 
        int16_t _status; 
        uint16_t _len; 
        char *_data; 
        uint8_t _resp_type; 
        uint8_t _client_num; 
};
#endif // _EL_CLIENT_SOCKET_H_