/** * \file net.h * * \brief Network communication functions * * Copyright (C) 2006-2011, ARM Limited, All Rights Reserved * * This file is part of mbed TLS (https://polarssl.org) * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License along * with this program; if not, write to the Free Software Foundation, Inc., * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. */ #ifndef POLARSSL_NET_H #define POLARSSL_NET_H #if !defined(POLARSSL_CONFIG_FILE) #include "config.h" #else #include POLARSSL_CONFIG_FILE #endif #include #if defined(POLARSSL_HAVE_TIME) #if defined(_MSC_VER) && !defined(EFIX64) && !defined(EFI32) #include typedef UINT32 uint32_t; #else #include #endif #endif /* POLARSSL_HAVE_TIME */ #define POLARSSL_ERR_NET_SOCKET_FAILED -0x0042 /**< Failed to open a socket. */ #define POLARSSL_ERR_NET_CONNECT_FAILED -0x0044 /**< The connection to the given server / port failed. */ #define POLARSSL_ERR_NET_BIND_FAILED -0x0046 /**< Binding of the socket failed. */ #define POLARSSL_ERR_NET_LISTEN_FAILED -0x0048 /**< Could not listen on the socket. */ #define POLARSSL_ERR_NET_ACCEPT_FAILED -0x004A /**< Could not accept the incoming connection. */ #define POLARSSL_ERR_NET_RECV_FAILED -0x004C /**< Reading information from the socket failed. */ #define POLARSSL_ERR_NET_SEND_FAILED -0x004E /**< Sending information through the socket failed. */ #define POLARSSL_ERR_NET_CONN_RESET -0x0050 /**< Connection was reset by peer. */ #define POLARSSL_ERR_NET_WANT_READ -0x0052 /**< Connection requires a read call. */ #define POLARSSL_ERR_NET_WANT_WRITE -0x0054 /**< Connection requires a write call. */ #define POLARSSL_ERR_NET_UNKNOWN_HOST -0x0056 /**< Failed to get an IP address for the given hostname. */ #define POLARSSL_ERR_NET_TIMEOUT -0x0011 /**< The operation timed out. */ #define POLARSSL_NET_LISTEN_BACKLOG 10 /**< The backlog that listen() should use. */ #define NET_PROTO_TCP 0 /**< The TCP transport protocol */ #define NET_PROTO_UDP 1 /**< The UDP transport protocol */ #ifdef __cplusplus extern "C" { #endif /** * \brief Initiate a connection with host:port in the given protocol * * \param fd Socket to use * \param host Host to connect to * \param port Port to connect to * \param proto Protocol: NET_PROTO_TCP or NET_PROTO_UDP * * \return 0 if successful, or one of: * POLARSSL_ERR_NET_SOCKET_FAILED, * POLARSSL_ERR_NET_UNKNOWN_HOST, * POLARSSL_ERR_NET_CONNECT_FAILED * * \note Sets the socket in connected mode even with UDP. */ int net_connect( int *fd, const char *host, int port, int proto ); /** * \brief Create a receiving socket on bind_ip:port in the chosen * protocol. If bind_ip == NULL, all interfaces are bound. * * \param fd Socket to use * \param bind_ip IP to bind to, can be NULL * \param port Port number to use * \param proto Protocol: NET_PROTO_TCP or NET_PROTO_UDP * * \return 0 if successful, or one of: * POLARSSL_ERR_NET_SOCKET_FAILED, * POLARSSL_ERR_NET_BIND_FAILED, * POLARSSL_ERR_NET_LISTEN_FAILED * * \note Regardless of the protocol, opens the sockets and binds it. * In addition, make the socket listening if protocol is TCP. */ int net_bind( int *fd, const char *bind_ip, int port, int proto ); /** * \brief Accept a connection from a remote client * * \param bind_fd Relevant socket * \param client_fd Will contain the connected client socket * \param client_ip Will contain the client IP address * Must be at least 4 bytes, or 16 if IPv6 is supported * * \return 0 if successful, POLARSSL_ERR_NET_ACCEPT_FAILED, or * POLARSSL_ERR_NET_WANT_READ is bind_fd was set to * non-blocking and accept() is blocking. * * \note With UDP, connects the bind_fd to the client and just copy * its descriptor to client_fd. New clients will not be able * to connect until you close the socket and bind a new one. */ int net_accept( int bind_fd, int *client_fd, void *client_ip ); /** * \brief Set the socket blocking * * \param fd Socket to set * * \return 0 if successful, or a non-zero error code */ int net_set_block( int fd ); /** * \brief Set the socket non-blocking * * \param fd Socket to set * * \return 0 if successful, or a non-zero error code */ int net_set_nonblock( int fd ); #if defined(POLARSSL_HAVE_TIME) /** * \brief Portable usleep helper * * \param usec Amount of microseconds to sleep * * \note Real amount of time slept will not be less than * select()'s timeout granularity (typically, 10ms). */ void net_usleep( unsigned long usec ); #endif /** * \brief Read at most 'len' characters. If no error occurs, * the actual amount read is returned. * * \param ctx Socket * \param buf The buffer to write to * \param len Maximum length of the buffer * * \return This function returns the number of bytes received, * or a non-zero error code; POLARSSL_ERR_NET_WANT_READ * indicates read() is blocking. */ int net_recv( void *ctx, unsigned char *buf, size_t len ); /** * \brief Write at most 'len' characters. If no error occurs, * the actual amount read is returned. * * \param ctx Socket * \param buf The buffer to read from * \param len The length of the buffer * * \return This function returns the number of bytes sent, * or a non-zero error code; POLARSSL_ERR_NET_WANT_WRITE * indicates write() is blocking. */ int net_send( void *ctx, const unsigned char *buf, size_t len ); #if defined(POLARSSL_HAVE_TIME) /** * \brief Read at most 'len' characters, blocking for at most * 'timeout' seconds. If no error occurs, the actual amount * read is returned. * * \param ctx Socket * \param buf The buffer to write to * \param len Maximum length of the buffer * \param timeout Maximum number of milliseconds to wait for data * * \return This function returns the number of bytes received, * or a non-zero error code: * POLARSSL_ERR_NET_TIMEOUT if the operation timed out, * POLARSSL_ERR_NET_WANT_READ if interrupted by a signal. * * \note This function will block (until data becomes available or * timeout is reached) even if the socket is set to * non-blocking. Handling timeouts with non-blocking reads * requires a different strategy. */ int net_recv_timeout( void *ctx, unsigned char *buf, size_t len, uint32_t timeout ); #endif /* POLARSSL_HAVE_TIME */ /** * \brief Gracefully shutdown the connection * * \param fd The socket to close */ void net_close( int fd ); #ifdef __cplusplus } #endif #endif /* net.h */