close()

Close a socket Connection. More...

Collaboration diagram for close():

Functions
static int	tls_socket_close (struct Connection *conn)
	Close a TLS socket - Implements Connection::close() -.
static int	tls_starttls_close (struct Connection *conn)
	Close a TLS connection - Implements Connection::close() -.
static int	ssl_socket_close_and_restore (struct Connection *conn)
	Close an SSL Connection and restore Connection callbacks - Implements Connection::close() -.
static int	ssl_socket_close (struct Connection *conn)
	Close an SSL connection - Implements Connection::close() -.
int	raw_socket_close (struct Connection *conn)
	Close a socket - Implements Connection::close() -.
static int	mutt_sasl_conn_close (struct Connection *conn)
	Close SASL connection - Implements Connection::close() -.
static int	tunnel_socket_close (struct Connection *conn)
	Close a tunnel socket - Implements Connection::close() -.
static int	zstrm_close (struct Connection *conn)
	Close a socket - Implements Connection::close() -.

Variables
int(*	SaslSockData::close )(struct Connection *conn)
	Close a socket Connection - Implements Connection::close() -.

Detailed Description

Close a socket Connection.

Parameters

conn	Connection to a server

Return values

0	Success
-1	Error, see errno

Function Documentation

tls_socket_close()

int tls_socket_close ( struct Connection * conn )

static

Close a TLS socket - Implements Connection::close() -.

Definition at line 1021 of file gnutls.c.

{
  struct TlsSockData *data = conn->sockdata;
  if (data)
  {
    /* shut down only the write half to avoid hanging waiting for the remote to respond.
     *
     * RFC5246 7.2.1. "Closure Alerts"
     *
     * It is not required for the initiator of the close to wait for the
     * responding close_notify alert before closing the read side of the
     * connection.  */
    gnutls_bye(data->session, GNUTLS_SHUT_WR);
 
    gnutls_certificate_free_credentials(data->xcred);
    gnutls_deinit(data->session);
    FREE(&conn->sockdata);
  }
 
  return raw_socket_close(conn);
}

Here is the call graph for this function:

Here is the caller graph for this function:

tls_starttls_close()

int tls_starttls_close ( struct Connection * conn )

static

Close a TLS connection - Implements Connection::close() -.

Definition at line 1137 of file gnutls.c.

{
  int rc;
 
  rc = tls_socket_close(conn);
  conn->read = raw_socket_read;
  conn->write = raw_socket_write;
  conn->close = raw_socket_close;
  conn->poll = raw_socket_poll;
 
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

ssl_socket_close_and_restore()

int ssl_socket_close_and_restore ( struct Connection * conn )

static

Close an SSL Connection and restore Connection callbacks - Implements Connection::close() -.

Definition at line 623 of file openssl.c.

{
  int rc = ssl_socket_close(conn);
  conn->read = raw_socket_read;
  conn->write = raw_socket_write;
  conn->close = raw_socket_close;
  conn->poll = raw_socket_poll;
 
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

ssl_socket_close()

int ssl_socket_close ( struct Connection * conn )

static

Close an SSL connection - Implements Connection::close() -.

Definition at line 1407 of file openssl.c.

{
  struct SslSockData *data = sockdata(conn);
 
  if (data)
  {
    if (data->is_open && (raw_socket_poll(conn, 0) >= 0))
      SSL_shutdown(data->ssl);
 
    SSL_free(data->ssl);
    data->ssl = NULL;
    SSL_CTX_free(data->sctx);
    data->sctx = NULL;
    FREE(&conn->sockdata);
  }
 
  return raw_socket_close(conn);
}

Here is the call graph for this function:

Here is the caller graph for this function:

raw_socket_close()

int raw_socket_close

(

struct Connection *

conn

)

Close a socket - Implements Connection::close() -.

Definition at line 393 of file raw.c.

{
  return close(conn->fd);
}

Here is the caller graph for this function:

mutt_sasl_conn_close()

int mutt_sasl_conn_close ( struct Connection * conn )

static

Close SASL connection - Implements Connection::close() -.

Calls underlying close function and disposes of the sasl_conn_t object, then restores connection to pre-sasl state

Definition at line 448 of file sasl.c.

{
  struct SaslSockData *sasldata = conn->sockdata;
 
  /* restore connection's underlying methods */
  conn->sockdata = sasldata->sockdata;
  conn->open = sasldata->open;
  conn->read = sasldata->read;
  conn->write = sasldata->write;
  conn->poll = sasldata->poll;
  conn->close = sasldata->close;
 
  /* release sasl resources */
  sasl_dispose(&sasldata->saslconn);
  FREE(&sasldata);
 
  /* call underlying close */
  int rc = conn->close(conn);
 
  return rc;
}

Here is the caller graph for this function:

tunnel_socket_close()

int tunnel_socket_close ( struct Connection * conn )

static

Close a tunnel socket - Implements Connection::close() -.

Definition at line 214 of file tunnel.c.

{
  struct TunnelSockData *tunnel = conn->sockdata;
  if (!tunnel)
  {
    return 0;
  }
 
  int status = 0;
 
  close(tunnel->fd_read);
  close(tunnel->fd_write);
  waitpid(tunnel->pid, &status, 0);
  if (!WIFEXITED(status) || WEXITSTATUS(status))
  {
    mutt_error(_("Tunnel to %s returned error %d (%s)"), conn->account.host,
               WEXITSTATUS(status), NONULL(mutt_str_sysexit(WEXITSTATUS(status))));
  }
  FREE(&conn->sockdata);
 
  return 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

zstrm_close()

int zstrm_close ( struct Connection * conn )

static

Close a socket - Implements Connection::close() -.

Definition at line 101 of file zstrm.c.

{
  struct ZstrmContext *zctx = conn->sockdata;
 
  int rc = zctx->next_conn.close(&zctx->next_conn);
 
  double read_ratio = (zctx->read.z.total_in != 0) ?
                          (double) zctx->read.z.total_out /
                              (double) zctx->read.z.total_in :
                          0.0;
  double write_ratio = (zctx->write.z.total_out != 0) ?
                           (double) zctx->write.z.total_in /
                               (double) zctx->write.z.total_out :
                           0.0;
  mutt_debug(LL_DEBUG5, "read %lu->%lu (%.1fx) wrote %lu<-%lu (%.1fx)\n",
             zctx->read.z.total_in, zctx->read.z.total_out, read_ratio,
             zctx->write.z.total_in, zctx->write.z.total_out, write_ratio);
 
  // Restore the Connection's original functions
  conn->sockdata = zctx->next_conn.sockdata;
  conn->open = zctx->next_conn.open;
  conn->close = zctx->next_conn.close;
  conn->read = zctx->next_conn.read;
  conn->write = zctx->next_conn.write;
  conn->poll = zctx->next_conn.poll;
 
  inflateEnd(&zctx->read.z);
  deflateEnd(&zctx->write.z);
  FREE(&zctx->read.buf);
  FREE(&zctx->write.buf);
  FREE(&zctx);
 
  return rc;
}

Here is the caller graph for this function:

Variable Documentation

close

int(* SaslSockData::close) (struct Connection *conn)

Close a socket Connection - Implements Connection::close() -.

Definition at line 101 of file sasl.c.