Annotation of embedaddon/libpdel/net/tcp_server.h, revision 1.1

1.1     ! misho       1: 
        !             2: /*
        !             3:  * Copyright (c) 2001-2002 Packet Design, LLC.
        !             4:  * All rights reserved.
        !             5:  * 
        !             6:  * Subject to the following obligations and disclaimer of warranty,
        !             7:  * use and redistribution of this software, in source or object code
        !             8:  * forms, with or without modifications are expressly permitted by
        !             9:  * Packet Design; provided, however, that:
        !            10:  * 
        !            11:  *    (i)  Any and all reproductions of the source or object code
        !            12:  *         must include the copyright notice above and the following
        !            13:  *         disclaimer of warranties; and
        !            14:  *    (ii) No rights are granted, in any manner or form, to use
        !            15:  *         Packet Design trademarks, including the mark "PACKET DESIGN"
        !            16:  *         on advertising, endorsements, or otherwise except as such
        !            17:  *         appears in the above copyright notice or in the software.
        !            18:  * 
        !            19:  * THIS SOFTWARE IS BEING PROVIDED BY PACKET DESIGN "AS IS", AND
        !            20:  * TO THE MAXIMUM EXTENT PERMITTED BY LAW, PACKET DESIGN MAKES NO
        !            21:  * REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING
        !            22:  * THIS SOFTWARE, INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED
        !            23:  * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE,
        !            24:  * OR NON-INFRINGEMENT.  PACKET DESIGN DOES NOT WARRANT, GUARANTEE,
        !            25:  * OR MAKE ANY REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS
        !            26:  * OF THE USE OF THIS SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY,
        !            27:  * RELIABILITY OR OTHERWISE.  IN NO EVENT SHALL PACKET DESIGN BE
        !            28:  * LIABLE FOR ANY DAMAGES RESULTING FROM OR ARISING OUT OF ANY USE
        !            29:  * OF THIS SOFTWARE, INCLUDING WITHOUT LIMITATION, ANY DIRECT,
        !            30:  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, PUNITIVE, OR CONSEQUENTIAL
        !            31:  * DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, LOSS OF
        !            32:  * USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY THEORY OF
        !            33:  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
        !            34:  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
        !            35:  * THE USE OF THIS SOFTWARE, EVEN IF PACKET DESIGN IS ADVISED OF
        !            36:  * THE POSSIBILITY OF SUCH DAMAGE.
        !            37:  *
        !            38:  * Author: Archie Cobbs <archie@freebsd.org>
        !            39:  */
        !            40: 
        !            41: #ifndef _PDEL_IO_TCP_SERVER_H_
        !            42: #define _PDEL_IO_TCP_SERVER_H_
        !            43: 
        !            44: struct tcp_server;
        !            45: struct tcp_connection;
        !            46: struct pevent_ctx;
        !            47: 
        !            48: /*
        !            49:  * Application handlers for a single connection. The setup method
        !            50:  * should return a non-NULL cookie if successful, which will be
        !            51:  * available from tcp_server_get_conn_cookie().
        !            52:  */
        !            53: typedef void   *tcp_setup_t(struct tcp_connection *conn);
        !            54: typedef void   tcp_handler_t(struct tcp_connection *conn);
        !            55: typedef void   tcp_teardown_t(struct tcp_connection *conn);
        !            56: 
        !            57: __BEGIN_DECLS
        !            58: 
        !            59: /* Functions */
        !            60: extern struct  tcp_server *tcp_server_start(struct pevent_ctx *ctx,
        !            61:                        void *cookie, const char *mtype, struct in_addr ip,
        !            62:                        u_int16_t port, u_int max_conn, u_int conn_timeout,
        !            63:                        tcp_setup_t *setup, tcp_handler_t *handler,
        !            64:                        tcp_teardown_t *teardown);
        !            65: extern void    tcp_server_stop(struct tcp_server **servp);
        !            66: extern void    *tcp_server_get_cookie(struct tcp_server *serv);
        !            67: 
        !            68: extern struct  tcp_server *tcp_connection_get_server(
        !            69:                        struct tcp_connection *conn);
        !            70: extern void    *tcp_connection_get_cookie(struct tcp_connection *conn);
        !            71: extern int     tcp_connection_get_fd(struct tcp_connection *conn);
        !            72: extern FILE    *tcp_connection_get_fp(struct tcp_connection *conn);
        !            73: extern struct  tcp_connection *tcp_connection_first(struct tcp_server *serv);
        !            74: extern struct  tcp_connection *tcp_connection_next(
        !            75:                        struct tcp_connection *conn);
        !            76: extern void    tcp_connection_get_peer(struct tcp_connection *conn,
        !            77:                        struct sockaddr_in *sin);
        !            78: 
        !            79: __END_DECLS
        !            80: 
        !            81: #endif /* _PDEL_IO_TCP_SERVER_H_ */
        !            82: 

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>