camel/camel-tcp-stream.c

   1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
   2 /*
   3  *  Authors: Jeffrey Stedfast <fejj@ximian.com>
   4  *
   5  *  Copyright 2001 Ximian, Inc. (www.ximian.com)
   6  *
   7  * This program is free software; you can redistribute it and/or
   8  * modify it under the terms of version 2 of the GNU Lesser General Public
   9  * License as published by the Free Software Foundation.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this program; if not, write to the
  18  * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  19  * Boston, MA 02110-1301, USA.
  20  *
  21  */
  22
  23 #ifdef HAVE_CONFIG_H
  24 #include <config.h>
  25 #endif
  26
  27 #include <string.h>
  28
  29 #include "camel-tcp-stream.h"
  30
  31 #define w(x)
  32
  33 static CamelStreamClass *parent_class = NULL;
  34
  35 /* Returns the class for a CamelTcpStream */
  36 #define CTS_CLASS(so) CAMEL_TCP_STREAM_CLASS (CAMEL_OBJECT_GET_CLASS(so))
  37
  38 static int tcp_connect    (CamelTcpStream *stream, struct addrinfo *host);
  39 static int tcp_getsockopt (CamelTcpStream *stream, CamelSockOptData *data);
  40 static int tcp_setsockopt (CamelTcpStream *stream, const CamelSockOptData *data);
  41 static struct sockaddr *tcp_get_local_address (CamelTcpStream *stream, socklen_t *len);
  42 static struct sockaddr *tcp_get_remote_address (CamelTcpStream *stream, socklen_t *len);
  43
  44 static void
  45 camel_tcp_stream_class_init (CamelTcpStreamClass *camel_tcp_stream_class)
  46 {
  47         /*CamelStreamClass *camel_stream_class = CAMEL_STREAM_CLASS (camel_tcp_stream_class);*/
  48
  49         parent_class = CAMEL_STREAM_CLASS (camel_type_get_global_classfuncs (CAMEL_STREAM_TYPE));
  50
  51         /* tcp stream methods */
  52         camel_tcp_stream_class->connect            = tcp_connect;
  53         camel_tcp_stream_class->getsockopt         = tcp_getsockopt;
  54         camel_tcp_stream_class->setsockopt         = tcp_setsockopt;
  55         camel_tcp_stream_class->get_local_address  = tcp_get_local_address;
  56         camel_tcp_stream_class->get_remote_address = tcp_get_remote_address;
  57 }
  58
  59 static void
  60 camel_tcp_stream_init (void *o)
  61 {
  62         ;
  63 }
  64
  65 CamelType
  66 camel_tcp_stream_get_type (void)
  67 {
  68         static CamelType type = CAMEL_INVALID_TYPE;
  69
  70         if (type == CAMEL_INVALID_TYPE) {
  71                 type = camel_type_register (CAMEL_STREAM_TYPE,
  72                                             "CamelTcpStream",
  73                                             sizeof (CamelTcpStream),
  74                                             sizeof (CamelTcpStreamClass),
  75                                             (CamelObjectClassInitFunc) camel_tcp_stream_class_init,
  76                                             NULL,
  77                                             (CamelObjectInitFunc) camel_tcp_stream_init,
  78                                             NULL);
  79         }
  80
  81         return type;
  82 }
  83
  84
  85 static int
  86 tcp_connect (CamelTcpStream *stream, struct addrinfo *host)
  87 {
  88         w(g_warning ("CamelTcpStream::connect called on default implementation"));
  89         return -1;
  90 }
  91
  92 /**
  93  * camel_tcp_stream_connect:
  94  * @stream: a #CamelTcpStream object
  95  * @host: a linked list of addrinfo structures to try to connect, in
  96  * the order of most likely to least likely to work.
  97  *
  98  * Create a socket and connect based upon the data provided.
  99  *
 100  * Returns %0 on success or %-1 on fail
 101  **/
 102 int
 103 camel_tcp_stream_connect (CamelTcpStream *stream, struct addrinfo *host)
 104 {
 105         g_return_val_if_fail (CAMEL_IS_TCP_STREAM (stream), -1);
 106
 107         return CTS_CLASS (stream)->connect (stream, host);
 108 }
 109
 110 static int
 111 tcp_getsockopt (CamelTcpStream *stream, CamelSockOptData *data)
 112 {
 113         w(g_warning ("CamelTcpStream::getsockopt called on default implementation"));
 114         return -1;
 115 }
 116
 117 /**
 118  * camel_tcp_stream_getsockopt:
 119  * @stream: a #CamelTcpStream object
 120  * @data: socket option data
 121  *
 122  * Get the socket options set on the stream and populate @data.
 123  *
 124  * Returns %0 on success or %-1 on fail
 125  **/
 126 int
 127 camel_tcp_stream_getsockopt (CamelTcpStream *stream, CamelSockOptData *data)
 128 {
 129         g_return_val_if_fail (CAMEL_IS_TCP_STREAM (stream), -1);
 130
 131         return CTS_CLASS (stream)->getsockopt (stream, data);
 132 }
 133
 134 static int
 135 tcp_setsockopt (CamelTcpStream *stream, const CamelSockOptData *data)
 136 {
 137         w(g_warning ("CamelTcpStream::setsockopt called on default implementation"));
 138         return -1;
 139 }
 140
 141 /**
 142  * camel_tcp_stream_setsockopt:
 143  * @stream: a #CamelTcpStream object
 144  * @data: socket option data
 145  *
 146  * Set the socket options contained in @data on the stream.
 147  *
 148  * Returns %0 on success or %-1 on fail
 149  **/
 150 int
 151 camel_tcp_stream_setsockopt (CamelTcpStream *stream, const CamelSockOptData *data)
 152 {
 153         g_return_val_if_fail (CAMEL_IS_TCP_STREAM (stream), -1);
 154
 155         return CTS_CLASS (stream)->setsockopt (stream, data);
 156 }
 157
 158 static struct sockaddr *
 159 tcp_get_local_address (CamelTcpStream *stream, socklen_t *len)
 160 {
 161         w(g_warning ("CamelTcpStream::get_local_address called on default implementation"));
 162         return NULL;
 163 }
 164
 165 /**
 166  * camel_tcp_stream_get_local_address:
 167  * @stream: a #CamelTcpStream object
 168  * @len: pointer to address length which must be supplied
 169  *
 170  * Get the local address of @stream.
 171  *
 172  * Returns the stream's local address (which must be freed with
 173  * #g_free) if the stream is connected, or %NULL if not
 174  **/
 175 struct sockaddr *
 176 camel_tcp_stream_get_local_address (CamelTcpStream *stream, socklen_t *len)
 177 {
 178         g_return_val_if_fail (CAMEL_IS_TCP_STREAM (stream), NULL);
 179         g_return_val_if_fail(len != NULL, NULL);
 180
 181         return CTS_CLASS (stream)->get_local_address (stream, len);
 182 }
 183
 184 static struct sockaddr *
 185 tcp_get_remote_address (CamelTcpStream *stream, socklen_t *len)
 186 {
 187         w(g_warning ("CamelTcpStream::get_remote_address called on default implementation"));
 188         return NULL;
 189 }
 190
 191 /**
 192  * camel_tcp_stream_get_remote_address:
 193  * @stream: a #CamelTcpStream object
 194  * @len: pointer to address length, which must be supplied
 195  *
 196  * Get the remote address of @stream.
 197  *
 198  * Returns the stream's remote address (which must be freed with
 199  * #g_free) if the stream is connected, or %NULL if not.
 200  **/
 201 struct sockaddr *
 202 camel_tcp_stream_get_remote_address (CamelTcpStream *stream, socklen_t *len)
 203 {
 204         g_return_val_if_fail (CAMEL_IS_TCP_STREAM (stream), NULL);
 205         g_return_val_if_fail(len != NULL, NULL);
 206
 207         return CTS_CLASS (stream)->get_remote_address (stream, len);
 208 }