1 /*

     2  * Hedgewars, a free turn based strategy game

     3  * Copyright (C) 2012 Simeon Maxein <smaxein@googlemail.com>

     4  *

     5  * This program is free software; you can redistribute it and/or

     6  * modify it under the terms of the GNU General Public License

     7  * as published by the Free Software Foundation; either version 2

     8  * of the License, or (at your option) any later version.

     9  *

    10  * This program is distributed in the hope that it will be useful,

    11  * but WITHOUT ANY WARRANTY; without even the implied warranty of

    12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    13  * GNU General Public License for more details.

    14  *

    15  * You should have received a copy of the GNU General Public License

    16  * along with this program; if not, write to the Free Software

    17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

    18  */

    19 

    20 /*

    21  * Sockets for TCP networking.

    22  *

    23  * This layer offers some functionality over what SDL_net offers directly: listening

    24  * sockets (called acceptors here) can be bound to port 0, which will make them listen

    25  * on a random unused port, if one can be found. To support this feature, you can also

    26  * query the local port that an acceptor is listening on.

    27  *

    28  * Further, we support nonblocking reads here.

    29  */

    30 

    31 #ifndef SOCKET_H_

    32 #define SOCKET_H_

    33 

    34 #include <stdbool.h>

    35 #include <stdint.h>

    36 

    37 typedef struct _flib_tcpsocket flib_tcpsocket;

    38 typedef struct _flib_acceptor flib_acceptor;

    39 

    40 /**

    41  * Create a new acceptor which will listen for incoming TCP connections

    42  * on the given port. If port is 0, this will listen on a random

    43  * unused port which can then be queried with flib_acceptor_listenport.

    44  *

    45  * Returns NULL on error.

    46  */

    47 flib_acceptor *flib_acceptor_create(uint16_t port);

    48 

    49 /**

    50  * Return the port on which the acceptor is listening.

    51  */

    52 uint16_t flib_acceptor_listenport(flib_acceptor *acceptor);

    53 

    54 /**

    55  * Close the acceptor and free its memory. NULL-safe.

    56  */

    57 void flib_acceptor_close(flib_acceptor *acceptor);

    58 

    59 /**

    60  * Try to accept a connection from an acceptor (listening socket).

    61  * if localOnly is true, this will only accept connections which came from 127.0.0.1

    62  * Returns NULL if nothing can be accepted.

    63  */

    64 flib_tcpsocket *flib_socket_accept(flib_acceptor *acceptor, bool localOnly);

    65 

    66 /**

    67  * Try to connect to the server at the given address.

    68  */

    69 flib_tcpsocket *flib_socket_connect(const char *host, uint16_t port);

    70 

    71 /**

    72  * Close the socket and free its memory. NULL-safe.

    73  */

    74 void flib_socket_close(flib_tcpsocket *socket);

    75 

    76 /**

    77  * Attempt to receive up to maxlen bytes from the socket, but does not

    78  * block if nothing is available.

    79  * Returns the ammount of data received, 0 if there was nothing to receive,

    80  * or a negative number if the connection was closed or an error occurred.

    81  */

    82 int flib_socket_nbrecv(flib_tcpsocket *sock, void *data, int maxlen);

    83 

    84 /**

    85  * Blocking send all the data in the data buffer. Returns the actual ammount

    86  * of data sent, or a negative value on error. If the value returned here

    87  * is less than len, either the connection closed or an error occurred.

    88  */

    89 int flib_socket_send(flib_tcpsocket *sock, const void *data, int len);

    90 

    91 #endif /* SOCKET_H_ */