NeoMutt  2023-05-17-33-gce4425
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 983 of file gnutls.c.

984{
985 struct TlsSockData *data = conn->sockdata;
986 if (!data)
987 return -1;
988
989 if (gnutls_record_check_pending(data->session))
990 return 1;
991
992 return raw_socket_poll(conn, wait_secs);
993}
int raw_socket_poll(struct Connection *conn, time_t wait_secs)
Checks whether reads would block - Implements Connection::poll() -.
Definition: raw.c:340
void * sockdata
Backend-specific socket data.
Definition: connection.h:56
TLS socket data -.
Definition: gnutls.c:78
gnutls_session_t session
Definition: gnutls.c:79
+ 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 1296 of file openssl.c.

1297{
1298 if (!conn)
1299 return -1;
1300
1301 if (SSL_has_pending(sockdata(conn)->ssl))
1302 return 1;
1303
1304 return raw_socket_poll(conn, wait_secs);
1305}
static struct SslSockData * sockdata(struct Connection *conn)
Get a Connection's socket data.
Definition: openssl.c:1182
+ 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 340 of file raw.c.

341{
342 if (conn->fd < 0)
343 return -1;
344
345 fd_set rfds;
346 struct timeval tv;
347
348 uint64_t wait_millis = wait_secs * 1000UL;
349
350 while (true)
351 {
352 tv.tv_sec = wait_millis / 1000;
353 tv.tv_usec = (wait_millis % 1000) * 1000;
354
355 FD_ZERO(&rfds);
356 FD_SET(conn->fd, &rfds);
357
358 uint64_t pre_t = mutt_date_now_ms();
359 const int rc = select(conn->fd + 1, &rfds, NULL, NULL, &tv);
360 uint64_t post_t = mutt_date_now_ms();
361
362 if ((rc > 0) || ((rc < 0) && (errno != EINTR)))
363 return rc;
364
365 if (SigInt)
367
368 wait_millis += pre_t;
369 if (wait_millis <= post_t)
370 return 0;
371 wait_millis -= post_t;
372 }
373}
void mutt_query_exit(void)
Ask the user if they want to leave NeoMutt.
Definition: curs_lib.c:336
SIG_ATOMIC_VOLATILE_T SigInt
true after SIGINT is received
Definition: globals.c:59
uint64_t mutt_date_now_ms(void)
Return the number of milliseconds since the Unix epoch.
Definition: date.c:455
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 581 of file sasl.c.

582{
583 struct SaslSockData *sasldata = conn->sockdata;
584 int rc;
585
586 conn->sockdata = sasldata->sockdata;
587 rc = sasldata->poll(conn, wait_secs);
588 conn->sockdata = sasldata;
589
590 return rc;
591}
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 194 of file tunnel.c.

195{
196 struct TunnelSockData *tunnel = conn->sockdata;
197 int ofd;
198 int rc;
199
200 ofd = conn->fd;
201 conn->fd = tunnel->fd_read;
202 rc = raw_socket_poll(conn, wait_secs);
203 conn->fd = ofd;
204
205 return rc;
206}
A network tunnel (pair of sockets)
Definition: tunnel.c:49
int fd_read
File descriptor to read from.
Definition: tunnel.c:51
+ 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: logging2.h:84
@ LL_DEBUG5
Log at debug level 5.
Definition: logging2.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.