read()

Read from a socket Connection. More...

Collaboration diagram for read():

Functions
static int	tls_socket_read (struct Connection *conn, char *buf, size_t count)
	Read data from a TLS socket - Implements Connection::read() -.
static int	ssl_socket_read (struct Connection *conn, char *buf, size_t count)
	Read data from an SSL socket - Implements Connection::read() -.
int	raw_socket_read (struct Connection *conn, char *buf, size_t count)
	Read data from a socket - Implements Connection::read() -.
static int	mutt_sasl_conn_read (struct Connection *conn, char *buf, size_t count)
	Read data from an SASL connection - Implements Connection::read() -.
static int	tunnel_socket_read (struct Connection *conn, char *buf, size_t count)
	Read data from a tunnel socket - Implements Connection::read() -.
static int	zstrm_read (struct Connection *conn, char *buf, size_t len)
	Read compressed data from a socket - Implements Connection::read() -.

Variables
int(*	SaslSockData::read )(struct Connection *conn, char *buf, size_t count)
	Read from a socket Connection - Implements Connection::read() -.

Detailed Description

Read from a socket Connection.

Parameters

conn	Connection to a server
buf	Buffer to store the data
count	Number of bytes to read

Return values

>0	Success, number of bytes read
-1	Error, see errno

Function Documentation

tls_socket_read()

static int tls_socket_read ( struct Connection * conn, char * buf, size_t count )

static

Read data from a TLS socket - Implements Connection::read() -.

Definition at line 1060 of file gnutls.c.

{
  struct TlsSockData *data = conn->sockdata;
  if (!data)
  {
    mutt_error(_("Error: no TLS socket open"));
    return -1;
  }
 
  int rc;
  do
  {
    rc = gnutls_record_recv(data->session, buf, count);
    if (rc == GNUTLS_E_AGAIN)
    {
      // Socket would block, wait for data to become available
      if (!tls_socket_poll_with_timeout(conn))
        return -1;
    }
  } while ((rc == GNUTLS_E_AGAIN) || (rc == GNUTLS_E_INTERRUPTED));
 
  if (rc < 0)
  {
    mutt_error("tls_socket_read (%s)", gnutls_strerror(rc));
    return -1;
  }
 
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

ssl_socket_read()

static int ssl_socket_read ( struct Connection * conn, char * buf, size_t count )

static

Read data from an SSL socket - Implements Connection::read() -.

Definition at line 1330 of file openssl.c.

{
  struct SslSockData *data = sockdata(conn);
  int rc;
 
retry:
  rc = SSL_read(data->ssl, buf, count);
  if (rc > 0)
    return rc;
 
  // User hit Ctrl-C
  if (SigInt && (errno == EINTR))
  {
    rc = -1;
  }
  else if (BIO_should_retry(SSL_get_rbio(data->ssl)))
  {
    // Temporary failure, e.g. signal received
    if (raw_socket_poll(conn, 0) >= 0)
    {
      goto retry;
    }
  }
 
  data->isopen = 0;
  ssl_err(data, rc);
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

raw_socket_read()

int raw_socket_read	(	struct Connection *	conn,
		char *	buf,
		size_t	count )

Read data from a socket - Implements Connection::read() -.

Definition at line 295 of file raw.c.

{
  int rc;
 
  mutt_sig_allow_interrupt(true);
  do
  {
    rc = read(conn->fd, buf, count);
  } while (rc < 0 && (errno == EINTR));
 
  if (rc < 0)
  {
    mutt_error(_("Error talking to %s (%s)"), conn->account.host, strerror(errno));
    SigInt = false;
  }
  mutt_sig_allow_interrupt(false);
 
  if (SigInt)
  {
    mutt_error(_("Connection to %s has been aborted"), conn->account.host);
    SigInt = false;
    rc = -1;
  }
 
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_sasl_conn_read()

static int mutt_sasl_conn_read ( struct Connection * conn, char * buf, size_t count )

static

Read data from an SASL connection - Implements Connection::read() -.

Definition at line 463 of file sasl.c.

{
  int rc;
  unsigned int olen;
 
  struct SaslSockData *sasldata = conn->sockdata;
 
  /* if we still have data in our read buffer, copy it into buf */
  if (sasldata->blen > sasldata->bpos)
  {
    olen = ((sasldata->blen - sasldata->bpos) > count) ?
               count :
               sasldata->blen - sasldata->bpos;
 
    memcpy(buf, sasldata->buf + sasldata->bpos, olen);
    sasldata->bpos += olen;
 
    return olen;
  }
 
  conn->sockdata = sasldata->sockdata;
 
  sasldata->bpos = 0;
  sasldata->blen = 0;
 
  /* and decode the result, if necessary */
  if (*sasldata->ssf != 0)
  {
    do
    {
      /* call the underlying read function to fill the buffer */
      rc = sasldata->read(conn, buf, count);
      if (rc <= 0)
        goto out;
 
      rc = sasl_decode(sasldata->saslconn, buf, rc, &sasldata->buf, &sasldata->blen);
      if (rc != SASL_OK)
      {
        mutt_debug(LL_DEBUG1, "SASL decode failed: %s\n", sasl_errstring(rc, NULL, NULL));
        goto out;
      }
    } while (sasldata->blen == 0);
 
    olen = ((sasldata->blen - sasldata->bpos) > count) ?
               count :
               sasldata->blen - sasldata->bpos;
 
    memcpy(buf, sasldata->buf, olen);
    sasldata->bpos += olen;
 
    rc = olen;
  }
  else
  {
    rc = sasldata->read(conn, buf, count);
  }
 
out:
  conn->sockdata = sasldata;
 
  return rc;
}

Here is the caller graph for this function:

tunnel_socket_read()

static int tunnel_socket_read ( struct Connection * conn, char * buf, size_t count )

static

Read data from a tunnel socket - Implements Connection::read() -.

Definition at line 146 of file tunnel.c.

{
  struct TunnelSockData *tunnel = conn->sockdata;
  int rc;
 
  do
  {
    rc = read(tunnel->fd_read, buf, count);
  } while (rc < 0 && errno == EINTR);
 
  if (rc < 0)
  {
    mutt_error(_("Tunnel error talking to %s: %s"), conn->account.host, strerror(errno));
    return -1;
  }
 
  return rc;
}

Here is the caller graph for this function:

zstrm_read()

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

static

Read compressed data from a socket - Implements Connection::read() -.

Definition at line 138 of file zstrm.c.

{
  struct ZstrmContext *zctx = conn->sockdata;
  int rc = 0;
  int zrc = 0;
 
retry:
  if (zctx->read.stream_eof)
    return 0;
 
  /* when avail_out was 0 on last call, we need to call inflate again, because
   * more data might be available using the current input, so avoid calling
   * read on the underlying stream in that case (for it might block) */
  if ((zctx->read.pos == 0) && !zctx->read.conn_eof)
  {
    rc = zctx->next_conn.read(&zctx->next_conn, zctx->read.buf, zctx->read.len);
    mutt_debug(LL_DEBUG5, "consuming data from next stream: %d bytes\n", rc);
    if (rc < 0)
      return rc;
    else if (rc == 0)
      zctx->read.conn_eof = true;
    else
      zctx->read.pos += rc;
  }
 
  zctx->read.z.avail_in = (uInt) zctx->read.pos;
  zctx->read.z.next_in = (Bytef *) zctx->read.buf;
  zctx->read.z.avail_out = (uInt) len;
  zctx->read.z.next_out = (Bytef *) buf;
 
  zrc = inflate(&zctx->read.z, Z_SYNC_FLUSH);
  mutt_debug(LL_DEBUG5, "rc=%d, consumed %u/%u bytes, produced %zu/%zu bytes\n",
             zrc, zctx->read.pos - zctx->read.z.avail_in, zctx->read.pos,
             len - zctx->read.z.avail_out, len);
 
  /* shift any remaining input data to the front of the buffer */
  if ((Bytef *) zctx->read.buf != zctx->read.z.next_in)
  {
    memmove(zctx->read.buf, zctx->read.z.next_in, zctx->read.z.avail_in);
    zctx->read.pos = zctx->read.z.avail_in;
  }
 
  switch (zrc)
  {
    case Z_OK:                            /* progress has been made */
      zrc = len - zctx->read.z.avail_out; /* "returned" bytes */
      if (zrc == 0)
      {
        /* there was progress, so must have been reading input */
        mutt_debug(LL_DEBUG5, "inflate just consumed\n");
        goto retry;
      }
      break;
 
    case Z_STREAM_END: /* everything flushed, nothing remaining */
      mutt_debug(LL_DEBUG5, "inflate returned Z_STREAM_END\n");
      zrc = len - zctx->read.z.avail_out; /* "returned" bytes */
      zctx->read.stream_eof = true;
      break;
 
    case Z_BUF_ERROR: /* no progress was possible */
      if (!zctx->read.conn_eof)
      {
        mutt_debug(LL_DEBUG5, "inflate returned Z_BUF_ERROR. retrying\n");
        goto retry;
      }
      zrc = 0;
      break;
 
    default:
      /* bail on other rcs, such as Z_DATA_ERROR, or Z_MEM_ERROR */
      mutt_debug(LL_DEBUG5, "inflate returned %d. aborting\n", zrc);
      zrc = -1;
      break;
  }
 
  return zrc;
}

Here is the caller graph for this function:

Variable Documentation

read

int(* SaslSockData::read) (struct Connection *conn, char *buf, size_t count)

Read from a socket Connection - Implements Connection::read() -.

Definition at line 84 of file sasl.c.