NeoMutt  2022-04-29-323-g5fcc6c
Teaching an old dog new tricks
DOXYGEN

Check whether a socket read would block. More...

+ Collaboration diagram for poll():

Functions

static int tls_socket_poll (struct Connection *conn, time_t wait_secs)
 Check whether a socket read would block - Implements Connection::poll() -. More...
 
static int ssl_socket_poll (struct Connection *conn, time_t wait_secs)
 Check whether a socket read would block - Implements Connection::poll() -. More...
 
int raw_socket_poll (struct Connection *conn, time_t wait_secs)
 Checks whether reads would block - Implements Connection::poll() -. More...
 
static int mutt_sasl_conn_poll (struct Connection *conn, time_t wait_secs)
 Check an SASL connection for data - Implements Connection::poll() -. More...
 
static int tunnel_socket_poll (struct Connection *conn, time_t wait_secs)
 Checks whether tunnel reads would block - Implements Connection::poll() -. More...
 
static int zstrm_poll (struct Connection *conn, time_t wait_secs)
 Checks whether reads would block - Implements Connection::poll() -. More...
 

Variables

int(* SaslSockData::poll )(struct Connection *conn, time_t wait_secs)
 Check whether a socket read would block - Implements Connection::poll() -. More...
 

Detailed Description

Check whether a socket read 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

Function Documentation

◆ tls_socket_poll()

static int tls_socket_poll ( struct Connection conn,
time_t  wait_secs 
)
static

Check whether a socket read would block - Implements Connection::poll() -.

Definition at line 986 of file gnutls.c.

987{
988 struct TlsSockData *data = conn->sockdata;
989 if (!data)
990 return -1;
991
992 if (gnutls_record_check_pending(data->state))
993 return 1;
994
995 return raw_socket_poll(conn, wait_secs);
996}
int raw_socket_poll(struct Connection *conn, time_t wait_secs)
Checks whether reads would block - Implements Connection::poll() -.
Definition: raw.c:324
void * sockdata
Backend-specific socket data.
Definition: connection.h:56
TLS socket data -.
Definition: gnutls.c:81
gnutls_session_t state
Definition: gnutls.c:82
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ ssl_socket_poll()

static int ssl_socket_poll ( struct Connection conn,
time_t  wait_secs 
)
static

Check whether a socket read would block - Implements Connection::poll() -.

Definition at line 1297 of file openssl.c.

1298{
1299 if (!conn)
1300 return -1;
1301
1302 if (SSL_has_pending(sockdata(conn)->ssl))
1303 return 1;
1304
1305 return raw_socket_poll(conn, wait_secs);
1306}
static struct SslSockData * sockdata(struct Connection *conn)
Get a Connection's socket data.
Definition: openssl.c:1183
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ raw_socket_poll()

int raw_socket_poll ( struct Connection conn,
time_t  wait_secs 
)

Checks whether reads would block - Implements Connection::poll() -.

Definition at line 324 of file raw.c.

325{
326 if (conn->fd < 0)
327 return -1;
328
329 fd_set rfds;
330 struct timeval tv;
331
332 uint64_t wait_millis = wait_secs * 1000UL;
333
334 while (true)
335 {
336 tv.tv_sec = wait_millis / 1000;
337 tv.tv_usec = (wait_millis % 1000) * 1000;
338
339 FD_ZERO(&rfds);
340 FD_SET(conn->fd, &rfds);
341
342 uint64_t pre_t = mutt_date_epoch_ms();
343 const int rc = select(conn->fd + 1, &rfds, NULL, NULL, &tv);
344 uint64_t post_t = mutt_date_epoch_ms();
345
346 if ((rc > 0) || ((rc < 0) && (errno != EINTR)))
347 return rc;
348
349 if (SigInt)
351
352 wait_millis += pre_t;
353 if (wait_millis <= post_t)
354 return 0;
355 wait_millis -= post_t;
356 }
357}
void mutt_query_exit(void)
Ask the user if they want to leave NeoMutt.
Definition: curs_lib.c:335
uint64_t mutt_date_epoch_ms(void)
Return the number of milliseconds since the Unix epoch.
Definition: date.c:437
SIG_ATOMIC_VOLATILE_T SigInt
true after SIGINT is received
Definition: mutt_globals.h:69
int fd
Socket file descriptor.
Definition: connection.h:54
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_sasl_conn_poll()

static int mutt_sasl_conn_poll ( struct Connection conn,
time_t  wait_secs 
)
static

Check an SASL connection for data - Implements Connection::poll() -.

Definition at line 577 of file sasl.c.

578{
579 struct SaslSockData *sasldata = conn->sockdata;
580 int rc;
581
582 conn->sockdata = sasldata->sockdata;
583 rc = sasldata->poll(conn, wait_secs);
584 conn->sockdata = sasldata;
585
586 return rc;
587}
int(* poll)(struct Connection *conn, time_t wait_secs)
Check whether a socket read would block - Implements Connection::poll() -.
Definition: sasl.c:92
SASL authentication API -.
Definition: sasl.c:62
void * sockdata
Underlying socket data.
Definition: sasl.c:72
+ Here is the caller graph for this function:

◆ tunnel_socket_poll()

static int tunnel_socket_poll ( struct Connection conn,
time_t  wait_secs 
)
static

Checks whether tunnel reads would block - Implements Connection::poll() -.

Definition at line 187 of file tunnel.c.

188{
189 struct TunnelSockData *tunnel = conn->sockdata;
190 int ofd;
191 int rc;
192
193 ofd = conn->fd;
194 conn->fd = tunnel->fd_read;
195 rc = raw_socket_poll(conn, wait_secs);
196 conn->fd = ofd;
197
198 return rc;
199}
A network tunnel (pair of sockets)
Definition: tunnel.c:48
int fd_read
File descriptor to read from.
Definition: tunnel.c:50
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ zstrm_poll()

static int zstrm_poll ( struct Connection conn,
time_t  wait_secs 
)
static

Checks whether reads would block - Implements Connection::poll() -.

Definition at line 211 of file zstrm.c.

212{
213 struct ZstrmContext *zctx = conn->sockdata;
214
215 mutt_debug(LL_DEBUG5, "%s\n",
216 (zctx->read.z.avail_out == 0) || (zctx->read.pos > 0) ?
217 "last read wrote full buffer" :
218 "falling back on next stream");
219 if ((zctx->read.z.avail_out == 0) || (zctx->read.pos > 0))
220 return 1;
221
222 return zctx->next_conn.poll(&zctx->next_conn, wait_secs);
223}
#define mutt_debug(LEVEL,...)
Definition: logging.h:84
@ LL_DEBUG5
Log at debug level 5.
Definition: logging.h:44
int(* poll)(struct Connection *conn, time_t wait_secs)
Definition: connection.h:106
Data compression layer.
Definition: zstrm.c:55
struct ZstrmDirection read
Data being read and de-compressed.
Definition: zstrm.c:56
struct Connection next_conn
Underlying stream.
Definition: zstrm.c:58
unsigned int pos
Current position.
Definition: zstrm.c:46
z_stream z
zlib compression handle
Definition: zstrm.c:43
+ Here is the caller graph for this function:

Variable Documentation

◆ poll

int(* SaslSockData::poll) (struct Connection *conn, time_t wait_secs)

Check whether a socket read would block - Implements Connection::poll() -.

Definition at line 92 of file sasl.c.