sockets.h

Go to the documentation of this file.

/*
 * $Id: sockets.h,v 1.16 2005/10/04 13:31:27 cbiere Exp $
 *
 * Copyright (c) 2001-2003, Raphael Manfredi
 * Copyright (c) 2000 Daniel Walker (dwalker@cats.ucsc.edu)
 *
 *----------------------------------------------------------------------
 * This file is part of gtk-gnutella.
 *
 *  gtk-gnutella 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.
 *
 *  gtk-gnutella 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 gtk-gnutella; if not, write to the Free Software
 *  Foundation, Inc.:
 *      59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *----------------------------------------------------------------------
 */

#ifndef _core_sockets_h_
#define _core_sockets_h_

#include "common.h"

#include "if/core/wrap.h"           /* For wrap_io_t */
#include "if/core/sockets.h"

#include "lib/inputevt.h"

#ifdef HAS_GNUTLS
#include <gnutls/gnutls.h>

enum socket_tls_stage {
    SOCK_TLS_NONE           = 0,
    SOCK_TLS_INITIALIZED    = 1,
    SOCK_TLS_ESTABLISHED    = 2
};

struct socket_tls_ctx {
    gnutls_session          session;
    gboolean                enabled;
    enum socket_tls_stage   stage;
    size_t snarf;           
    inputevt_cond_t         cb_cond;
    inputevt_handler_t      cb_handler;
    gpointer                cb_data;
};

#define SOCKET_WITH_TLS(s) \
    ((s)->tls.enabled && (s)->tls.stage >= SOCK_TLS_INITIALIZED)
#define SOCKET_USES_TLS(s) \
    ((s)->tls.enabled && (s)->tls.stage >= SOCK_TLS_ESTABLISHED)
#else /* !HAS_GNUTLS */
#define SOCKET_WITH_TLS(s) ((void) (s), 0)
#define SOCKET_USES_TLS(s) ((void) (s), 0)
#endif /* HAS_GNUTLS */

struct sockaddr;

/*
 * Connection directions.
 */

enum socket_direction {
    SOCK_CONN_INCOMING,
    SOCK_CONN_OUTGOING,
    SOCK_CONN_LISTENING,
    SOCK_CONN_PROXY_OUTGOING
};

enum socket_type {
    SOCK_TYPE_UNKNOWN = 0,
    SOCK_TYPE_CONTROL,
    SOCK_TYPE_DOWNLOAD,
    SOCK_TYPE_UPLOAD,
    SOCK_TYPE_HTTP,
    SOCK_TYPE_SHELL,
    SOCK_TYPE_CONNBACK,
    SOCK_TYPE_PPROXY,
    SOCK_TYPE_DESTROYING,
    SOCK_TYPE_UDP
};

struct gnutella_socket {
    gint file_desc;         
    guint32 flags;          
    guint gdk_tag;          
    enum socket_direction direction;
    enum socket_type type;
    enum net_type net;
    gboolean corked;
    gboolean was_shutdown;  
    gint adns;              
    gchar *adns_msg;        
    host_addr_t addr;       
    guint16 port;           
    guint16 local_port;     
    time_t last_update;     
    struct wrap_io wio;     
#ifdef HAS_GNUTLS
    struct socket_tls_ctx tls;
#endif

    union {
        struct gnutella_node *node;
        struct download *download;
        struct upload *upload;
        struct pproxy *pproxy;
        struct cproxy *cproxy;
        gpointer handle;
    } resource;

    struct getline *getline;    
    gchar buffer[SOCK_BUFSZ];   
    size_t pos;                 
};

/*
 * Operating flags
 */

#define SOCK_F_ESTABLISHED      0x00000001 
#define SOCK_F_EOF              0x00000002 
#define SOCK_F_UDP              0x40000000 
#define SOCK_F_TCP              0x80000000 
#define sock_is_corked(x)       ((x)->corked)

#define udp_active()    (enable_udp && NULL != s_udp_listen)



/*
 * Global Data
 */

extern struct gnutella_socket *s_tcp_listen;
extern struct gnutella_socket *s_udp_listen;

/*
 * Global Functions
 */

void socket_init(void);
void socket_register_fd_reclaimer(reclaim_fd_t callback);
void socket_eof(struct gnutella_socket *s);
void socket_free(struct gnutella_socket *);
struct gnutella_socket *socket_connect(const host_addr_t, guint16,
        enum socket_type, guint32 flags);
struct gnutella_socket *socket_connect_by_name(
    const gchar *host, guint16, enum socket_type, guint32 flags);
struct gnutella_socket *socket_tcp_listen(const host_addr_t, guint16,
        enum socket_type);
struct gnutella_socket *socket_udp_listen(const host_addr_t, guint16);
void socket_evt_set(struct gnutella_socket *s,
    inputevt_cond_t cond, inputevt_handler_t handler, gpointer data);
void socket_evt_clear(struct gnutella_socket *s);

void sock_cork(struct gnutella_socket *s, gboolean on);
void sock_send_buf(struct gnutella_socket *s, gint size, gboolean shrink);
void sock_recv_buf(struct gnutella_socket *s, gint size, gboolean shrink);
void sock_nodelay(struct gnutella_socket *s, gboolean on);
void sock_tx_shutdown(struct gnutella_socket *s);
void socket_tos_default(const struct gnutella_socket *s);
void socket_tos_throughput(const struct gnutella_socket *s);
void socket_tos_lowdelay(const struct gnutella_socket *s);
void socket_tos_normal(const struct gnutella_socket *s);
gboolean socket_bad_hostname(struct gnutella_socket *s);

void socket_timer(time_t now);
void socket_shutdown(void);

ssize_t safe_readv(wrap_io_t *wio, struct iovec *iov, gint iovcnt);
ssize_t safe_writev(wrap_io_t *wio, struct iovec *iov, gint iovcnt);
ssize_t safe_writev_fd(gint fd, struct iovec *iov, gint iovcnt);

#endif /* _core_sockets_h_ */

/* vi: set ts=4 sw=4 cindent: */

---