socket_frames.h

Go to the documentation of this file.

/*
 * Copyright (c) 2019 Digi International Inc.,
 * All rights not expressly granted are reserved.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this file,
 * You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * Digi International Inc., 9350 Excelsior Blvd., Suite 700, Hopkins, MN 55343
 * ===========================================================================
 */

#ifndef XBEE_SOCKET_FRAMES_H
#define XBEE_SOCKET_FRAMES_H

#include "xbee/platform.h"

XBEE_BEGIN_DECLS

#define XBEE_SOCK_STATUS_SUCCESS        0x00    
#define XBEE_SOCK_STATUS_INVALID_PARAM  0x01    
#define XBEE_SOCK_STATUS_FAILED_TO_READ 0x02    
#define XBEE_SOCK_STATUS_IN_PROGRESS    0x03    
#define XBEE_SOCK_STATUS_CONNECTED      0x04    
#define XBEE_SOCK_STATUS_UNKNOWN        0x05    
#define XBEE_SOCK_STATUS_BAD_SOCKET     0x20    
#define XBEE_SOCK_STATUS_OFFLINE        0x22    
#define XBEE_SOCK_STATUS_INTERNAL_ERR   0x31    
#define XBEE_SOCK_STATUS_RESOURCE_ERR   0x32    
#define XBEE_SOCK_STATUS_BAD_PROTOCOL   0x7B    
// ^^^ Be sure to update xbee_sock_status_str() when adding to this macro list.

#define XBEE_SOCK_SOCKET_ID_INVALID     0xFF

#define XBEE_FRAME_SOCK_CREATE          0x40
typedef XBEE_PACKED(xbee_frame_sock_create_t, {
    uint8_t     frame_type;     
    uint8_t     frame_id;       
    uint8_t     protocol;
#define XBEE_SOCK_PROTOCOL_UDP          0       
#define XBEE_SOCK_PROTOCOL_TCP          1       
#define XBEE_SOCK_PROTOCOL_SSL          4       
}) xbee_frame_sock_create_t;


#define XBEE_FRAME_SOCK_OPTION_REQ      0x41
typedef XBEE_PACKED(xbee_header_sock_option_req_t, {
    uint8_t     frame_type;     
    uint8_t     frame_id;       
    uint8_t     socket_id;      
    uint8_t     option_id;      
#define XBEE_SOCK_OPT_ID_TLS_PROFILE    0x00
}) xbee_header_sock_option_req_t;

#define XBEE_FRAME_SOCK_OPTION_RESP     0xC1
typedef XBEE_PACKED(xbee_frame_sock_option_resp_t, {
    uint8_t     frame_type;     
    uint8_t     frame_id;       
    uint8_t     socket_id;      
    uint8_t     option_id;      
    uint8_t     status;         
    uint8_t     option_data[1]; 
}) xbee_frame_sock_option_resp_t;


#define XBEE_FRAME_SOCK_CONNECT         0x42
typedef XBEE_PACKED(xbee_header_sock_connect_t, {
    uint8_t     frame_type;     
    uint8_t     frame_id;       
    uint8_t     socket_id;      
    uint16_t    remote_port_be; 
    uint8_t     addr_type;      
#define XBEE_SOCK_ADDR_TYPE_IPV4        0   
#define XBEE_SOCK_ADDR_TYPE_HOSTNAME    1   
}) xbee_header_sock_connect_t;


#define XBEE_FRAME_SOCK_CLOSE           0x43
typedef XBEE_PACKED(xbee_frame_sock_close_t, {
    uint8_t     frame_type;     
    uint8_t     frame_id;       
    uint8_t     socket_id;      
}) xbee_frame_sock_close_t;


#define XBEE_FRAME_SOCK_SEND            0x44
typedef XBEE_PACKED(xbee_header_sock_send_t, {
    uint8_t     frame_type;     
    uint8_t     frame_id;       
    uint8_t     socket_id;      
    uint8_t     options;        
}) xbee_header_sock_send_t;


#define XBEE_FRAME_SOCK_SENDTO          0x45
typedef XBEE_PACKED(xbee_header_sock_sendto_t, {
    uint8_t     frame_type;     
    uint8_t     frame_id;       
    uint8_t     socket_id;      
    uint32_t    remote_addr_be; 
    uint16_t    remote_port_be; 
    uint8_t     options;        
}) xbee_header_sock_sendto_t;


#define XBEE_FRAME_SOCK_BIND_LISTEN     0x46
typedef XBEE_PACKED(xbee_frame_sock_bind_listen_t, {
    uint8_t     frame_type;     
    uint8_t     frame_id;       
    uint8_t     socket_id;      
    uint16_t    local_port_be;  
}) xbee_frame_sock_bind_listen_t;


#define XBEE_FRAME_SOCK_CREATE_RESP     0xC0

#define XBEE_FRAME_SOCK_CONNECT_RESP    0xC2

#define XBEE_FRAME_SOCK_CLOSE_RESP      0xC3

#define XBEE_FRAME_SOCK_LISTEN_RESP     0xC6

typedef XBEE_PACKED(xbee_frame_sock_shared_resp_t, {
    uint8_t     frame_type;
    uint8_t     frame_id;       
    uint8_t     socket_id;      
    uint8_t     status;         
}) xbee_frame_sock_shared_resp_t;


#define XBEE_FRAME_SOCK_IPV4_CLIENT 0xCC
typedef XBEE_PACKED(xbee_frame_sock_ipv4_client_t, {
    uint8_t     frame_type;     
    uint8_t     sock_listen_id; 
    uint8_t     sock_client_id; 
    uint32_t    remote_addr_be; 
    uint16_t    remote_port_be; 
}) xbee_frame_sock_ipv4_client_t;


#define XBEE_FRAME_SOCK_RECEIVE         0xCD
typedef XBEE_PACKED(xbee_frame_sock_receive_t, {
    uint8_t     frame_type;     
    uint8_t     frame_id;       
    uint8_t     socket_id;      
    uint8_t     status;         
    uint8_t     payload[1];     
}) xbee_frame_sock_receive_t;


#define XBEE_FRAME_SOCK_RECEIVE_FROM    0xCE
typedef XBEE_PACKED(xbee_frame_sock_receive_from_t, {
    uint8_t     frame_type;     
    uint8_t     frame_id;       
    uint8_t     socket_id;      
    uint32_t    remote_addr_be; 
    uint16_t    remote_port_be; 
    uint8_t     status;         
    uint8_t     payload[1];     
}) xbee_frame_sock_receive_from_t;


#define XBEE_FRAME_SOCK_STATE           0xCF
typedef XBEE_PACKED(xbee_frame_sock_state_t, {
    uint8_t     frame_type;     
    uint8_t     socket_id;      
    uint8_t     state;          
#define XBEE_SOCK_STATE_CONNECTED               0x00
#define XBEE_SOCK_STATE_DNS_FAILED              0x01
#define XBEE_SOCK_STATE_CONNECTION_REFUSED      0x02
#define XBEE_SOCK_STATE_TRANSPORT_CLOSED        0x03
#define XBEE_SOCK_STATE_TIMED_OUT               0x04
#define XBEE_SOCK_STATE_INTERNAL_ERR            0x05
#define XBEE_SOCK_STATE_HOST_UNREACHABLE        0x06
#define XBEE_SOCK_STATE_CONNECTION_LOST         0x07    
#define XBEE_SOCK_STATE_UNKNOWN_ERR             0x08
#define XBEE_SOCK_STATE_UNKNOWN_SERVER          0x09
#define XBEE_SOCK_STATE_RESOURCE_ERR            0x0A
#define XBEE_SOCK_STATE_LISTENER_CLOSED         0x0B
// ^^^ Be sure to update xbee_sock_state_str() when adding to this macro list.

}) xbee_frame_sock_state_t;

#define XBEE_SOCK_STR_BUF_SIZE          40

const char *xbee_sock_status_str(uint8_t status,
                                 char buffer[XBEE_SOCK_STR_BUF_SIZE]);

const char *xbee_sock_state_str(uint8_t state,
                                char buffer[XBEE_SOCK_STR_BUF_SIZE]);

XBEE_END_DECLS

#endif // XBEE_SOCKET_FRAMES_H