NeoMutt
Teaching an old dog new tricks
DOXYGEN
Loading...
Searching...
No Matches
socket.h File Reference

Low-level socket handling. More...

#include <time.h>
+ Include dependency graph for socket.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define MUTT_SOCK_LOG_CMD   2
 
#define MUTT_SOCK_LOG_HDR   3
 
#define MUTT_SOCK_LOG_FULL   5
 
#define mutt_socket_readln(buf, buflen, conn)   mutt_socket_readln_d(buf, buflen, conn, MUTT_SOCK_LOG_CMD)
 
#define mutt_socket_send(conn, buf)   mutt_socket_send_d(conn, buf, MUTT_SOCK_LOG_CMD)
 
#define mutt_socket_send_d(conn, buf, dbg)   mutt_socket_write_d(conn, buf, mutt_str_len(buf), dbg)
 
#define mutt_socket_write_n(conn, buf, len)   mutt_socket_write_d(conn, buf, len, MUTT_SOCK_LOG_CMD)
 
#define mutt_socket_buffer_readln(buf, conn)   mutt_socket_buffer_readln_d(buf, conn, MUTT_SOCK_LOG_CMD)
 

Enumerations

enum  ConnectionType { MUTT_CONNECTION_SIMPLE , MUTT_CONNECTION_TUNNEL , MUTT_CONNECTION_SSL }
 Type of connection. More...
 

Functions

int mutt_socket_close (struct Connection *conn)
 Close a socket.
 
void mutt_socket_empty (struct Connection *conn)
 Clear out any queued data.
 
struct Connectionmutt_socket_new (enum ConnectionType type)
 Allocate and initialise a new connection.
 
int mutt_socket_open (struct Connection *conn)
 Simple wrapper.
 
int mutt_socket_poll (struct Connection *conn, time_t wait_secs)
 Checks whether reads would block.
 
int mutt_socket_read (struct Connection *conn, char *buf, size_t len)
 Read from a Connection.
 
int mutt_socket_readchar (struct Connection *conn, char *c)
 Simple read buffering to speed things up.
 
int mutt_socket_readln_d (char *buf, size_t buflen, struct Connection *conn, int dbg)
 Read a line from a socket.
 
int mutt_socket_write (struct Connection *conn, const char *buf, size_t len)
 Write to a Connection.
 
int mutt_socket_write_d (struct Connection *conn, const char *buf, int len, int dbg)
 Write data to a socket.
 
int mutt_socket_buffer_readln_d (struct Buffer *buf, struct Connection *conn, int dbg)
 Read a line from a socket into a Buffer.
 

Detailed Description

Low-level socket handling.

Authors
  • Brandon Long
  • Brendan Cully

This program 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 this program. If not, see http://www.gnu.org/licenses/.

Definition in file socket.h.

Macro Definition Documentation

◆ MUTT_SOCK_LOG_CMD

#define MUTT_SOCK_LOG_CMD   2

Definition at line 54 of file socket.h.

◆ MUTT_SOCK_LOG_HDR

#define MUTT_SOCK_LOG_HDR   3

Definition at line 55 of file socket.h.

◆ MUTT_SOCK_LOG_FULL

#define MUTT_SOCK_LOG_FULL   5

Definition at line 56 of file socket.h.

◆ mutt_socket_readln

#define mutt_socket_readln (   buf,
  buflen,
  conn 
)    mutt_socket_readln_d(buf, buflen, conn, MUTT_SOCK_LOG_CMD)

Definition at line 58 of file socket.h.

◆ mutt_socket_send

#define mutt_socket_send (   conn,
  buf 
)    mutt_socket_send_d(conn, buf, MUTT_SOCK_LOG_CMD)

Definition at line 59 of file socket.h.

◆ mutt_socket_send_d

#define mutt_socket_send_d (   conn,
  buf,
  dbg 
)    mutt_socket_write_d(conn, buf, mutt_str_len(buf), dbg)

Definition at line 60 of file socket.h.

◆ mutt_socket_write_n

#define mutt_socket_write_n (   conn,
  buf,
  len 
)    mutt_socket_write_d(conn, buf, len, MUTT_SOCK_LOG_CMD)

Definition at line 61 of file socket.h.

◆ mutt_socket_buffer_readln

#define mutt_socket_buffer_readln (   buf,
  conn 
)    mutt_socket_buffer_readln_d(buf, conn, MUTT_SOCK_LOG_CMD)

Definition at line 63 of file socket.h.

Enumeration Type Documentation

◆ ConnectionType

Type of connection.

Enumerator
MUTT_CONNECTION_SIMPLE 

Simple TCP socket connection.

MUTT_CONNECTION_TUNNEL 

Tunnelled connection.

MUTT_CONNECTION_SSL 

SSL/TLS-encrypted connection.

Definition at line 35 of file socket.h.

36{
40};
@ MUTT_CONNECTION_SSL
SSL/TLS-encrypted connection.
Definition: socket.h:39
@ MUTT_CONNECTION_SIMPLE
Simple TCP socket connection.
Definition: socket.h:37
@ MUTT_CONNECTION_TUNNEL
Tunnelled connection.
Definition: socket.h:38

Function Documentation

◆ mutt_socket_close()

int mutt_socket_close ( struct Connection conn)

Close a socket.

Parameters
connConnection to a server
Return values
0Success
-1Error

Definition at line 101 of file socket.c.

102{
103 if (!conn)
104 return 0;
105
106 int rc = -1;
107
108 if (conn->fd < 0)
109 mutt_debug(LL_DEBUG1, "Attempt to close closed connection\n");
110 else
111 rc = conn->close(conn);
112
113 conn->fd = -1;
114 conn->ssf = 0;
115 conn->bufpos = 0;
116 conn->available = 0;
117
118 return rc;
119}
#define mutt_debug(LEVEL,...)
Definition: logging2.h:89
@ LL_DEBUG1
Log at debug level 1.
Definition: logging2.h:43
unsigned int ssf
Security strength factor, in bits (see notes)
Definition: connection.h:51
int bufpos
Current position in the buffer.
Definition: connection.h:53
int(* close)(struct Connection *conn)
Definition: connection.h:117
int available
Amount of data waiting to be read.
Definition: connection.h:55
int fd
Socket file descriptor.
Definition: connection.h:54
+ Here is the caller graph for this function:

◆ mutt_socket_empty()

void mutt_socket_empty ( struct Connection conn)

Clear out any queued data.

Parameters
connConnection to a server

The internal buffer is emptied and any data that has already arrived at this machine (in kernel buffers) is read and dropped.

Definition at line 320 of file socket.c.

321{
322 if (!conn)
323 return;
324
325 char buf[1024] = { 0 };
326 int bytes;
327
328 while ((bytes = mutt_socket_poll(conn, 0)) > 0)
329 {
330 mutt_socket_read(conn, buf, MIN(bytes, sizeof(buf)));
331 }
332}
#define MIN(a, b)
Definition: memory.h:32
int mutt_socket_poll(struct Connection *conn, time_t wait_secs)
Checks whether reads would block.
Definition: socket.c:196
int mutt_socket_read(struct Connection *conn, char *buf, size_t len)
Read from a Connection.
Definition: socket.c:129
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_socket_new()

struct Connection * mutt_socket_new ( enum ConnectionType  type)

Allocate and initialise a new connection.

Parameters
typeType of the new Connection
Return values
ptrNew Connection

Definition at line 286 of file socket.c.

287{
288 struct Connection *conn = mutt_mem_calloc(1, sizeof(struct Connection));
289 conn->fd = -1;
290
291 if (type == MUTT_CONNECTION_TUNNEL)
292 {
294 }
295 else if (type == MUTT_CONNECTION_SSL)
296 {
297 int rc = mutt_ssl_socket_setup(conn);
298 if (rc < 0)
299 FREE(&conn);
300 }
301 else
302 {
303 conn->read = raw_socket_read;
304 conn->write = raw_socket_write;
305 conn->open = raw_socket_open;
306 conn->close = raw_socket_close;
307 conn->poll = raw_socket_poll;
308 }
309
310 return conn;
311}
void mutt_tunnel_socket_setup(struct Connection *conn)
Sets up tunnel connection functions.
Definition: tunnel.c:241
int mutt_ssl_socket_setup(struct Connection *conn)
Set up SSL socket mulitplexor.
Definition: gnutls.c:1122
int raw_socket_close(struct Connection *conn)
Close a socket - Implements Connection::close() -.
Definition: raw.c:379
int raw_socket_open(struct Connection *conn)
Open a socket - Implements Connection::open() -.
Definition: raw.c:130
int raw_socket_poll(struct Connection *conn, time_t wait_secs)
Checks whether reads would block - Implements Connection::poll() -.
Definition: raw.c:341
int raw_socket_read(struct Connection *conn, char *buf, size_t len)
Read data from a socket - Implements Connection::read() -.
Definition: raw.c:281
int raw_socket_write(struct Connection *conn, const char *buf, size_t count)
Write data to a socket - Implements Connection::write() -.
Definition: raw.c:311
void * mutt_mem_calloc(size_t nmemb, size_t size)
Allocate zeroed memory on the heap.
Definition: memory.c:50
#define FREE(x)
Definition: memory.h:45
int(* poll)(struct Connection *conn, time_t wait_secs)
Definition: connection.h:106
int(* write)(struct Connection *conn, const char *buf, size_t count)
Definition: connection.h:93
int(* open)(struct Connection *conn)
Definition: connection.h:67
int(* read)(struct Connection *conn, char *buf, size_t count)
Definition: connection.h:80
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_socket_open()

int mutt_socket_open ( struct Connection conn)

Simple wrapper.

Parameters
connConnection to a server
Return values
0Success
-1Error

Definition at line 77 of file socket.c.

78{
79 int rc;
80
82 return -1;
83
84 rc = conn->open(conn);
85
86 if (rc >= 0)
87 {
88 mutt_debug(LL_DEBUG2, "Connected to %s:%d on fd=%d\n", conn->account.host,
89 conn->account.port, conn->fd);
90 }
91
92 return rc;
93}
@ LL_DEBUG2
Log at debug level 2.
Definition: logging2.h:44
static int socket_preconnect(void)
Execute a command before opening a socket.
Definition: socket.c:51
char host[128]
Server to login to.
Definition: connaccount.h:54
unsigned short port
Port to connect to.
Definition: connaccount.h:58
struct ConnAccount account
Account details: username, password, etc.
Definition: connection.h:50
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_socket_poll()

int mutt_socket_poll ( struct Connection conn,
time_t  wait_secs 
)

Checks whether reads would block.

Parameters
connConnection to a server
wait_secsHow long to wait for a response
Return values
>0There is data to read
0Read would block
-1Connection doesn't support polling

Definition at line 196 of file socket.c.

197{
198 if (conn->bufpos < conn->available)
199 return conn->available - conn->bufpos;
200
201 if (conn->poll)
202 return conn->poll(conn, wait_secs);
203
204 return -1;
205}
+ Here is the caller graph for this function:

◆ mutt_socket_read()

int mutt_socket_read ( struct Connection conn,
char *  buf,
size_t  len 
)

Read from a Connection.

Parameters
connConnection a server
bufBuffer to store read data
lenlength of the buffer
Return values
>0Success, number of bytes read
-1Error, see errno

Definition at line 129 of file socket.c.

130{
131 return conn->read(conn, buf, len);
132}
+ Here is the caller graph for this function:

◆ mutt_socket_readchar()

int mutt_socket_readchar ( struct Connection conn,
char *  c 
)

Simple read buffering to speed things up.

Parameters
[in]connConnection to a server
[out]cCharacter that was read
Return values
1Success
-1Error

Definition at line 214 of file socket.c.

215{
216 if (conn->bufpos >= conn->available)
217 {
218 if (conn->fd >= 0)
219 {
220 conn->available = conn->read(conn, conn->inbuf, sizeof(conn->inbuf));
221 }
222 else
223 {
224 mutt_debug(LL_DEBUG1, "attempt to read from closed connection\n");
225 return -1;
226 }
227 conn->bufpos = 0;
228 if (conn->available == 0)
229 {
230 mutt_error(_("Connection to %s closed"), conn->account.host);
231 }
232 if (conn->available <= 0)
233 {
234 mutt_socket_close(conn);
235 return -1;
236 }
237 }
238 *c = conn->inbuf[conn->bufpos];
239 conn->bufpos++;
240 return 1;
241}
#define mutt_error(...)
Definition: logging2.h:92
#define _(a)
Definition: message.h:28
int mutt_socket_close(struct Connection *conn)
Close a socket.
Definition: socket.c:101
char inbuf[1024]
Buffer for incoming traffic.
Definition: connection.h:52
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_socket_readln_d()

int mutt_socket_readln_d ( char *  buf,
size_t  buflen,
struct Connection conn,
int  dbg 
)

Read a line from a socket.

Parameters
bufBuffer to store the line
buflenLength of data to write
connConnection to a server
dbgDebug level for logging
Return values
>0Success, number of bytes read
-1Error

Definition at line 252 of file socket.c.

253{
254 char ch;
255 int i;
256
257 for (i = 0; i < buflen - 1; i++)
258 {
259 if (mutt_socket_readchar(conn, &ch) != 1)
260 {
261 buf[i] = '\0';
262 return -1;
263 }
264
265 if (ch == '\n')
266 break;
267 buf[i] = ch;
268 }
269
270 /* strip \r from \r\n termination */
271 if (i && (buf[i - 1] == '\r'))
272 i--;
273 buf[i] = '\0';
274
275 mutt_debug(dbg, "%d< %s\n", conn->fd, buf);
276
277 /* number of bytes read, not strlen */
278 return i + 1;
279}
int mutt_socket_readchar(struct Connection *conn, char *c)
Simple read buffering to speed things up.
Definition: socket.c:214
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_socket_write()

int mutt_socket_write ( struct Connection conn,
const char *  buf,
size_t  len 
)

Write to a Connection.

Parameters
connConnection to a server
bufBuffer with data to write
lenLength of data to write
Return values
>0Number of bytes written
-1Error

Definition at line 142 of file socket.c.

143{
144 return conn->write(conn, buf, len);
145}

◆ mutt_socket_write_d()

int mutt_socket_write_d ( struct Connection conn,
const char *  buf,
int  len,
int  dbg 
)

Write data to a socket.

Parameters
connConnection to a server
bufBuffer with data to write
lenLength of data to write
dbgDebug level for logging
Return values
>0Number of bytes written
-1Error

Definition at line 156 of file socket.c.

157{
158 int sent = 0;
159
160 mutt_debug(dbg, "%d> %s", conn->fd, buf);
161
162 if (conn->fd < 0)
163 {
164 mutt_debug(LL_DEBUG1, "attempt to write to closed connection\n");
165 return -1;
166 }
167
168 while (sent < len)
169 {
170 const int rc = conn->write(conn, buf + sent, len - sent);
171 if (rc < 0)
172 {
173 mutt_debug(LL_DEBUG1, "error writing (%s), closing socket\n", strerror(errno));
174 mutt_socket_close(conn);
175
176 return -1;
177 }
178
179 if (rc < len - sent)
180 mutt_debug(LL_DEBUG3, "short write (%d of %d bytes)\n", rc, len - sent);
181
182 sent += rc;
183 }
184
185 return sent;
186}
@ LL_DEBUG3
Log at debug level 3.
Definition: logging2.h:45
+ Here is the call graph for this function:

◆ mutt_socket_buffer_readln_d()

int mutt_socket_buffer_readln_d ( struct Buffer buf,
struct Connection conn,
int  dbg 
)

Read a line from a socket into a Buffer.

Parameters
bufBuffer to store the line
connConnection to a server
dbgDebug level for logging
Return values
>0Success, number of bytes read
-1Error

Definition at line 342 of file socket.c.

343{
344 char ch;
345 bool has_cr = false;
346
347 buf_reset(buf);
348
349 while (true)
350 {
351 if (mutt_socket_readchar(conn, &ch) != 1)
352 return -1;
353
354 if (ch == '\n')
355 break;
356
357 if (has_cr)
358 {
359 buf_addch(buf, '\r');
360 has_cr = false;
361 }
362
363 if (ch == '\r')
364 has_cr = true;
365 else
366 buf_addch(buf, ch);
367 }
368
369 mutt_debug(dbg, "%d< %s\n", conn->fd, buf_string(buf));
370 return 0;
371}
void buf_reset(struct Buffer *buf)
Reset an existing Buffer.
Definition: buffer.c:88
size_t buf_addch(struct Buffer *buf, char c)
Add a single character to a Buffer.
Definition: buffer.c:253
static const char * buf_string(const struct Buffer *buf)
Convert a buffer to a const char * "string".
Definition: buffer.h:93
+ Here is the call graph for this function: