socket.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_H
#define XBEE_SOCKET_H

#include "xbee/platform.h"
#include "xbee/socket_frames.h"
#include "xbee/tx_status.h"

XBEE_BEGIN_DECLS

typedef int xbee_sock_t;

#ifndef XBEE_SOCK_SOCKET_COUNT
#define XBEE_SOCK_SOCKET_COUNT          10
#endif

typedef void (*xbee_sock_notify_fn)(xbee_sock_t socket,
                                    uint8_t frame_type,
                                    uint8_t message);

typedef void (*xbee_sock_receive_fn)(xbee_sock_t socket,
                                     uint8_t status,
                                     const void *payload,
                                     size_t payload_len);

typedef void (*xbee_sock_receive_from_fn)(xbee_sock_t socket,
                                          uint8_t status,
                                          uint32_t remote_addr,
                                          uint16_t remote_port,
                                          const void *datagram,
                                          size_t datagram_len);

typedef xbee_sock_receive_fn
    (*xbee_sock_ipv4_client_fn)(xbee_sock_t listening_socket,
                                xbee_sock_t client_socket,
                                uint32_t remote_addr,
                                uint16_t remote_port);

typedef void (*xbee_sock_option_resp_fn)(xbee_sock_t socket,
                                         uint8_t option_id,
                                         uint8_t status,
                                         const void *data,
                                         size_t data_len);


xbee_sock_t xbee_sock_create(xbee_dev_t *xbee,
                             uint8_t protocol,
                             xbee_sock_notify_fn notify_handler);

int xbee_sock_connect(xbee_sock_t socket, uint16_t remote_port,
                      uint32_t remote_addr, const char *remote_host,
                      xbee_sock_receive_fn receive_handler);

int xbee_sock_bind(xbee_sock_t socket, uint16_t local_port,
                   xbee_sock_receive_from_fn receive_from_handler);

int xbee_sock_listen(xbee_sock_t socket, uint16_t local_port,
                     xbee_sock_ipv4_client_fn ipv4_client_handler);

// Future: maybe make tx_options an int or uint16_t -- lower byte passed in
// frame, upper byte used for API options (like DISABLE_TX_STATUS).
int xbee_sock_send(xbee_sock_t socket, uint8_t tx_options,
                   const void *payload, size_t payload_len);

int xbee_sock_sendto(xbee_sock_t socket, uint8_t tx_options,
                     uint32_t remote_addr, uint16_t remote_port,
                     const void *payload, size_t payload_len);

int xbee_sock_option(xbee_sock_t socket, uint8_t option_id, const void *data,
                     size_t data_len, xbee_sock_option_resp_fn callback);

int xbee_sock_reset(xbee_dev_t *xbee);


int xbee_sock_close(xbee_sock_t socket);


int xbee_sock_close_all(xbee_dev_t *xbee);


int xbee_sock_frame_handler(xbee_dev_t *xbee, const void FAR *rawframe,
                            uint16_t length, void FAR *context);


#define XBEE_SOCK_FRAME_HANDLERS        { 0, 0, xbee_sock_frame_handler, NULL }

XBEE_END_DECLS

#endif // XBEE_SOCKET_H