asio 0.3.8rc3 | Home | Reference | Tutorial | Examples | Design

Reference | Class Hierarchy | Class Index | Member Index

# asio::ssl::stream< Stream, Service > Class Template Reference

Inherits asio::ssl::stream_base.

Inheritance diagram for asio::ssl::stream< Stream, Service >:

List of all members.

## Detailed Description

### template<typename Stream, typename Service = stream_service>
class asio::ssl::stream< Stream, Service >

Provides stream-oriented functionality using SSL.

The stream class template provides asynchronous and blocking stream-oriented functionality using SSL.

Thread Safety
  Distinct objects: Safe.
  Shared objects: Unsafe.

Example
  To use the SSL stream template with a stream_socket, you would write:

       asio::io_service io_service;
       asio::ssl::context context(io_service, asio::ssl::context::sslv23);
       asio::ssl::stream<asio::stream_socket> sock(io_service, context);

Concepts:
  Async_Object, Async_Read_Stream, Async_Write_Stream, Error_Source, Stream, Sync_Read_Stream, Sync_Write_Stream.

## Public Types

typedef boost::remove_reference< Stream >::type | next_layer_type
| The type of the next layer.
typedef next_layer_type::lowest_layer_type | lowest_layer_type
| The type of the lowest layer.
typedef Service | service_type
| The type of the service that will be used to provide stream operations.
typedef service_type::impl_type | impl_type
| The native implementation type of the stream.
enum | handshake_type { client, server }
| Different handshake types. More...

## Public Member Functions

template<typename Arg, typename Context_Service>
| stream (Arg &arg, basic_context< Context_Service > &context)
| Construct a stream.
| ~stream ()
| Destructor.
asio::io_service & | io_service ()
| Get the io_service associated with the object.
next_layer_type & | next_layer ()
| Get a reference to the next layer.
lowest_layer_type & | lowest_layer ()
| Get a reference to the lowest layer.
impl_type | impl ()
| Get the underlying implementation in the native type.
void | handshake (handshake_type type)
| Perform SSL handshaking.
asio::error_code | handshake (handshake_type type, asio::error_code &ec)
| Perform SSL handshaking.
template<typename HandshakeHandler>
void | async_handshake (handshake_type type, HandshakeHandler handler)
| Start an asynchronous SSL handshake.
void | shutdown ()
| Shut down SSL on the stream.
asio::error_code | shutdown (asio::error_code &ec)
| Shut down SSL on the stream.
template<typename ShutdownHandler>
void | async_shutdown (ShutdownHandler handler)
| Asynchronously shut down SSL on the stream.
template<typename ConstBufferSequence>
std::size_t | write_some (const ConstBufferSequence &buffers)
| Write some data to the stream.
template<typename ConstBufferSequence>
std::size_t | write_some (const ConstBufferSequence &buffers, asio::error_code &ec)
| Write some data to the stream.
template<typename ConstBufferSequence, typename WriteHandler>
void | async_write_some (const ConstBufferSequence &buffers, WriteHandler handler)
| Start an asynchronous write.
template<typename MutableBufferSequence>
std::size_t | read_some (const MutableBufferSequence &buffers)
| Read some data from the stream.
template<typename MutableBufferSequence>
std::size_t | read_some (const MutableBufferSequence &buffers, asio::error_code &ec)
| Read some data from the stream.
template<typename MutableBufferSequence, typename ReadHandler>
void | async_read_some (const MutableBufferSequence &buffers, ReadHandler handler)
| Start an asynchronous read.
template<typename MutableBufferSequence>
std::size_t | peek (const MutableBufferSequence &buffers)
| Peek at the incoming data on the stream.
template<typename MutableBufferSequence>
std::size_t | peek (const MutableBufferSequence &buffers, asio::error_code &ec)
| Peek at the incoming data on the stream.
std::size_t | in_avail ()
| Determine the amount of data that may be read without blocking.
std::size_t | in_avail (asio::error_code &ec)
| Determine the amount of data that may be read without blocking.

## Private Attributes

Stream | next_layer_
| The next layer.
service_type & | service_
| The backend service implementation.
impl_type | impl_
| The underlying native implementation.

## Member Typedef Documentation

template<typename Stream, typename Service = stream_service>

typedef boost::remove_reference<Stream>::type asio::ssl::stream< Stream, Service >::next_layer_type

The type of the next layer.

template<typename Stream, typename Service = stream_service>

typedef next_layer_type::lowest_layer_type asio::ssl::stream< Stream, Service >::lowest_layer_type

The type of the lowest layer.

template<typename Stream, typename Service = stream_service>

typedef Service asio::ssl::stream< Stream, Service >::service_type

The type of the service that will be used to provide stream operations.

template<typename Stream, typename Service = stream_service>

typedef service_type::impl_type asio::ssl::stream< Stream, Service >::impl_type

The native implementation type of the stream.

## Member Enumeration Documentation

enum asio::ssl::stream_base::handshake_type`[inherited]`

Different handshake types.

Enumerator:

  client | Perform handshaking as a client.
  server | Perform handshaking as a server.

## Constructor & Destructor Documentation

template<typename Stream, typename Service = stream_service>
template<typename Arg, typename Context_Service>

asio::ssl::stream< Stream, Service >::stream | ( | Arg & | arg,
|  | basic_context< Context_Service > & | context |
| ) |  |  | `[explicit]`

Construct a stream.

This constructor creates a stream and initialises the underlying stream object.

Parameters:

  | arg | The argument to be passed to initialise the underlying stream.
  | context | The SSL context to be used for the stream.

template<typename Stream, typename Service = stream_service>

asio::ssl::stream< Stream, Service >::~stream | ( |  | ) |

Destructor.

## Member Function Documentation

template<typename Stream, typename Service = stream_service>

asio::io_service& asio::ssl::stream< Stream, Service >::io_service | ( |  | ) |

Get the io_service associated with the object.

This function may be used to obtain the io_service object that the stream uses to dispatch handlers for asynchronous operations.

Returns:
  A reference to the io_service object that stream will use to dispatch handlers. Ownership is not transferred to the caller.

template<typename Stream, typename Service = stream_service>

next_layer_type& asio::ssl::stream< Stream, Service >::next_layer | ( |  | ) |

Get a reference to the next layer.

This function returns a reference to the next layer in a stack of stream layers.

Returns:
  A reference to the next layer in the stack of stream layers. Ownership is not transferred to the caller.

template<typename Stream, typename Service = stream_service>

lowest_layer_type& asio::ssl::stream< Stream, Service >::lowest_layer | ( |  | ) |

Get a reference to the lowest layer.

This function returns a reference to the lowest layer in a stack of stream layers.

Returns:
  A reference to the lowest layer in the stack of stream layers. Ownership is not transferred to the caller.

template<typename Stream, typename Service = stream_service>

impl_type asio::ssl::stream< Stream, Service >::impl | ( |  | ) |

Get the underlying implementation in the native type.

This function may be used to obtain the underlying implementation of the context. This is intended to allow access to stream functionality that is not otherwise provided.

template<typename Stream, typename Service = stream_service>

void asio::ssl::stream< Stream, Service >::handshake | ( | handshake_type | type | ) |

Perform SSL handshaking.

This function is used to perform SSL handshaking on the stream. The function call will block until handshaking is complete or an error occurs.

Parameters:

  | type | The type of handshaking to be performed, i.e. as a client or as a server.

Exceptions:

  | asio::system_error | Thrown on failure.

template<typename Stream, typename Service = stream_service>

asio::error_code asio::ssl::stream< Stream, Service >::handshake | ( | handshake_type | type,
|  | asio::error_code & | ec |
| ) |  |  |

Perform SSL handshaking.

This function is used to perform SSL handshaking on the stream. The function call will block until handshaking is complete or an error occurs.

Parameters:

  | type | The type of handshaking to be performed, i.e. as a client or as a server.
  | ec | Set to indicate what error occurred, if any.

template<typename Stream, typename Service = stream_service>
template<typename HandshakeHandler>

void asio::ssl::stream< Stream, Service >::async_handshake | ( | handshake_type | type,
|  | HandshakeHandler | handler |
| ) |  |  |

Start an asynchronous SSL handshake.

This function is used to asynchronously perform an SSL handshake on the stream. This function call always returns immediately.

Parameters:

  | type | The type of handshaking to be performed, i.e. as a client or as a server.
  | handler | The handler to be called when the handshake operation completes. Copies will be made of the handler as required. The equivalent function signature of the handler must be:
       void handler(
         const asio::error_code& error // Result of operation.
       );

template<typename Stream, typename Service = stream_service>

void asio::ssl::stream< Stream, Service >::shutdown | ( |  | ) |

Shut down SSL on the stream.

This function is used to shut down SSL on the stream. The function call will block until SSL has been shut down or an error occurs.

Exceptions:

  | asio::system_error | Thrown on failure.

template<typename Stream, typename Service = stream_service>

asio::error_code asio::ssl::stream< Stream, Service >::shutdown | ( | asio::error_code & | ec | ) |

Shut down SSL on the stream.

This function is used to shut down SSL on the stream. The function call will block until SSL has been shut down or an error occurs.

Parameters:

  | ec | Set to indicate what error occurred, if any.

template<typename Stream, typename Service = stream_service>
template<typename ShutdownHandler>

void asio::ssl::stream< Stream, Service >::async_shutdown | ( | ShutdownHandler | handler | ) |

Asynchronously shut down SSL on the stream.

This function is used to asynchronously shut down SSL on the stream. This function call always returns immediately.

Parameters:

  | handler | The handler to be called when the handshake operation completes. Copies will be made of the handler as required. The equivalent function signature of the handler must be:
       void handler(
         const asio::error_code& error // Result of operation.
       );

template<typename Stream, typename Service = stream_service>
template<typename ConstBufferSequence>

std::size_t asio::ssl::stream< Stream, Service >::write_some | ( | const ConstBufferSequence & | buffers | ) |

Write some data to the stream.

This function is used to write data on the stream. The function call will block until one or more bytes of data has been written successfully, or until an error occurs.

Parameters:

  | buffers | The data to be written.

Returns:
  The number of bytes written.

Exceptions:

  | asio::system_error | Thrown on failure.

Note:
  The write_some operation may not transmit all of the data to the peer. Consider using the asio::write function if you need to ensure that all data is written before the blocking operation completes.

template<typename Stream, typename Service = stream_service>
template<typename ConstBufferSequence>

std::size_t asio::ssl::stream< Stream, Service >::write_some | ( | const ConstBufferSequence & | buffers,
|  | asio::error_code & | ec |
| ) |  |  |

Write some data to the stream.

This function is used to write data on the stream. The function call will block until one or more bytes of data has been written successfully, or until an error occurs.

Parameters:

  | buffers | The data to be written to the stream.
  | ec | Set to indicate what error occurred, if any.

Returns:
  The number of bytes written. Returns 0 if an error occurred.

Note:
  The write_some operation may not transmit all of the data to the peer. Consider using the asio::write function if you need to ensure that all data is written before the blocking operation completes.

template<typename Stream, typename Service = stream_service>
template<typename ConstBufferSequence, typename WriteHandler>

void asio::ssl::stream< Stream, Service >::async_write_some | ( | const ConstBufferSequence & | buffers,
|  | WriteHandler | handler |
| ) |  |  |

Start an asynchronous write.

This function is used to asynchronously write one or more bytes of data to the stream. The function call always returns immediately.

Parameters:

  | buffers | The data to be written to the stream. Although the buffers object may be copied as necessary, ownership of the underlying buffers is retained by the caller, which must guarantee that they remain valid until the handler is called.
  | handler | The handler to be called when the write operation completes. Copies will be made of the handler as required. The equivalent function signature of the handler must be:
       void handler(
         const asio::error_code& error, // Result of operation.
         std::size_t bytes_transferred           // Number of bytes written.
       );

Note:
  The async_write_some operation may not transmit all of the data to the peer. Consider using the asio::async_write function if you need to ensure that all data is written before the blocking operation completes.

template<typename Stream, typename Service = stream_service>
template<typename MutableBufferSequence>

std::size_t asio::ssl::stream< Stream, Service >::read_some | ( | const MutableBufferSequence & | buffers | ) |

Read some data from the stream.

This function is used to read data from the stream. The function call will block until one or more bytes of data has been read successfully, or until an error occurs.

Parameters:

  | buffers | The buffers into which the data will be read.

Returns:
  The number of bytes read.

Exceptions:

  | asio::system_error | Thrown on failure.

Note:
  The read_some operation may not read all of the requested number of bytes. Consider using the asio::read function if you need to ensure that the requested amount of data is read before the blocking operation completes.

template<typename Stream, typename Service = stream_service>
template<typename MutableBufferSequence>

std::size_t asio::ssl::stream< Stream, Service >::read_some | ( | const MutableBufferSequence & | buffers,
|  | asio::error_code & | ec |
| ) |  |  |

Read some data from the stream.

This function is used to read data from the stream. The function call will block until one or more bytes of data has been read successfully, or until an error occurs.

Parameters:

  | buffers | The buffers into which the data will be read.
  | ec | Set to indicate what error occurred, if any.

Returns:
  The number of bytes read. Returns 0 if an error occurred.

Note:
  The read_some operation may not read all of the requested number of bytes. Consider using the asio::read function if you need to ensure that the requested amount of data is read before the blocking operation completes.

template<typename Stream, typename Service = stream_service>
template<typename MutableBufferSequence, typename ReadHandler>

void asio::ssl::stream< Stream, Service >::async_read_some | ( | const MutableBufferSequence & | buffers,
|  | ReadHandler | handler |
| ) |  |  |

Start an asynchronous read.

This function is used to asynchronously read one or more bytes of data from the stream. The function call always returns immediately.

Parameters:

  | buffers | The buffers into which the data will be read. Although the buffers object may be copied as necessary, ownership of the underlying buffers is retained by the caller, which must guarantee that they remain valid until the handler is called.
  | handler | The handler to be called when the read operation completes. Copies will be made of the handler as required. The equivalent function signature of the handler must be:
       void handler(
         const asio::error_code& error, // Result of operation.
         std::size_t bytes_transferred           // Number of bytes read.
       );

Note:
  The async_read_some operation may not read all of the requested number of bytes. Consider using the asio::async_read function if you need to ensure that the requested amount of data is read before the asynchronous operation completes.

template<typename Stream, typename Service = stream_service>
template<typename MutableBufferSequence>

std::size_t asio::ssl::stream< Stream, Service >::peek | ( | const MutableBufferSequence & | buffers | ) |

Peek at the incoming data on the stream.

This function is used to peek at the incoming data on the stream, without removing it from the input queue. The function call will block until data has been read successfully or an error occurs.

Parameters:

  | buffers | The buffers into which the data will be read.

Returns:
  The number of bytes read.

Exceptions:

  | asio::system_error | Thrown on failure.

template<typename Stream, typename Service = stream_service>
template<typename MutableBufferSequence>

std::size_t asio::ssl::stream< Stream, Service >::peek | ( | const MutableBufferSequence & | buffers,
|  | asio::error_code & | ec |
| ) |  |  |

Peek at the incoming data on the stream.

This function is used to peek at the incoming data on the stream, withoutxi removing it from the input queue. The function call will block until data has been read successfully or an error occurs.

Parameters:

  | buffers | The buffers into which the data will be read.
  | ec | Set to indicate what error occurred, if any.

Returns:
  The number of bytes read. Returns 0 if an error occurred.

template<typename Stream, typename Service = stream_service>

std::size_t asio::ssl::stream< Stream, Service >::in_avail | ( |  | ) |

Determine the amount of data that may be read without blocking.

This function is used to determine the amount of data, in bytes, that may be read from the stream without blocking.

Returns:
  The number of bytes of data that can be read without blocking.

Exceptions:

  | asio::system_error | Thrown on failure.

template<typename Stream, typename Service = stream_service>

std::size_t asio::ssl::stream< Stream, Service >::in_avail | ( | asio::error_code & | ec | ) |

Determine the amount of data that may be read without blocking.

This function is used to determine the amount of data, in bytes, that may be read from the stream without blocking.

Parameters:

  | ec | Set to indicate what error occurred, if any.

Returns:
  The number of bytes of data that can be read without blocking.

## Member Data Documentation

template<typename Stream, typename Service = stream_service>

Stream asio::ssl::stream< Stream, Service >::next_layer_`[private]`

The next layer.

template<typename Stream, typename Service = stream_service>

service_type& asio::ssl::stream< Stream, Service >::service_`[private]`

The backend service implementation.

template<typename Stream, typename Service = stream_service>

impl_type asio::ssl::stream< Stream, Service >::impl_`[private]`

The underlying native implementation.

asio 0.3.8rc3 | Home | Reference | Tutorial | Examples | Design