Return to stream_tcp.h CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / strongswan / src / libstrongswan / networking / streams

Annotation of embedaddon/strongswan/src/libstrongswan/networking/streams/stream_tcp.h, revision 1.1.1.1

1.1       misho       1: /*
                      2:  * Copyright (C) 2013 Martin Willi
                      3:  * Copyright (C) 2013 revosec AG
                      4:  *
                      5:  * This program is free software; you can redistribute it and/or modify it
                      6:  * under the terms of the GNU General Public License as published by the
                      7:  * Free Software Foundation; either version 2 of the License, or (at your
                      8:  * option) any later version.  See <http://www.fsf.org/copyleft/gpl.txt>.
                      9:  *
                     10:  * This program is distributed in the hope that it will be useful, but
                     11:  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
                     12:  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
                     13:  * for more details.
                     14:  */
                     15: 
                     16: /**
                     17:  * @defgroup stream_tcp stream_tcp
                     18:  * @{ @ingroup streams
                     19:  */
                     20: 
                     21: #ifndef STREAM_TCP_H_
                     22: #define STREAM_TCP_H_
                     23: 
                     24: #include <library.h>
                     25: 
                     26: /**
                     27:  * Create a stream for TCP sockets.
                     28:  *
                     29:  * TCP URIs start with tcp://, followed by a hostname (FQDN or IP), followed
                     30:  * by a colon separated port. A full TCP uri looks something like:
                     31:  *
                     32:  *   tcp://srv.example.com:5555
                     33:  *   tcp://0.0.0.0:1234
                     34:  *   tcp://[fec2::1]:7654
                     35:  *
                     36:  * There is no default port, so a colon after tcp:// is mandatory.
                     37:  *
                     38:  * @param uri          TCP socket specific URI, must start with "tcp://"
                     39:  * @return                     stream instance, NULL on failure
                     40:  */
                     41: stream_t *stream_create_tcp(char *uri);
                     42: 
                     43: /**
                     44:  * Helper function to parse a tcp:// URI to a sockaddr
                     45:  *
                     46:  * @param uri          URI
                     47:  * @param addr         sockaddr, large enough for URI
                     48:  * @return                     length of sockaddr, -1 on error
                     49:  */
                     50: int stream_parse_uri_tcp(char *uri, struct sockaddr *addr);
                     51: 
                     52: #endif /** STREAM_TCP_H_ @}*/