Realistic 3D camera system
3D camera system components
Public Types | Public Member Functions | List of all members
asio::basic_socket_iostream< Protocol, StreamSocketService, Time, TimeTraits, TimerService > Class Template Reference

Iostream interface for a socket. More...

#include <basic_socket_iostream.hpp>

Inheritance diagram for asio::basic_socket_iostream< Protocol, StreamSocketService, Time, TimeTraits, TimerService >:
asio::detail::socket_iostream_base< Protocol, StreamSocketService, Time, TimeTraits, TimerService >

Public Types

typedef Protocol::endpoint endpoint_type
 The endpoint type. More...
 
typedef traits_helper::time_type time_type
 
typedef traits_helper::duration_type duration_type
 

Public Member Functions

 basic_socket_iostream ()
 Construct a basic_socket_iostream without establishing a connection. More...
 
void close ()
 Close the connection. More...
 
basic_socket_streambuf< Protocol, StreamSocketService, Time, TimeTraits, TimerService > * rdbuf () const
 Return a pointer to the underlying streambuf. More...
 
const asio::error_code & error () const
 Get the last error associated with the stream. More...
 
time_type expires_at () const
 Get the stream's expiry time as an absolute time. More...
 
void expires_at (const time_type &expiry_time)
 Set the stream's expiry time as an absolute time. More...
 
duration_type expires_from_now () const
 Get the timer's expiry time relative to now. More...
 
void expires_from_now (const duration_type &expiry_time)
 Set the stream's expiry time relative to now. More...
 

Detailed Description

template<typename Protocol, typename StreamSocketService = stream_socket_service<Protocol>, typename Time = steady_timer::clock_type, typename TimeTraits = steady_timer::traits_type, typename TimerService = steady_timer::service_type>
class asio::basic_socket_iostream< Protocol, StreamSocketService, Time, TimeTraits, TimerService >

Iostream interface for a socket.

Definition at line 109 of file basic_socket_iostream.hpp.

Member Typedef Documentation

template<typename Protocol , typename StreamSocketService = stream_socket_service<Protocol>, typename Time = steady_timer::clock_type, typename TimeTraits = steady_timer::traits_type, typename TimerService = steady_timer::service_type>
typedef traits_helper::duration_type asio::basic_socket_iostream< Protocol, StreamSocketService, Time, TimeTraits, TimerService >::duration_type

Definition at line 135 of file basic_socket_iostream.hpp.

template<typename Protocol , typename StreamSocketService = stream_socket_service<Protocol>, typename Time = steady_timer::clock_type, typename TimeTraits = steady_timer::traits_type, typename TimerService = steady_timer::service_type>
typedef Protocol::endpoint asio::basic_socket_iostream< Protocol, StreamSocketService, Time, TimeTraits, TimerService >::endpoint_type

The endpoint type.

Definition at line 125 of file basic_socket_iostream.hpp.

template<typename Protocol , typename StreamSocketService = stream_socket_service<Protocol>, typename Time = steady_timer::clock_type, typename TimeTraits = steady_timer::traits_type, typename TimerService = steady_timer::service_type>
typedef traits_helper::time_type asio::basic_socket_iostream< Protocol, StreamSocketService, Time, TimeTraits, TimerService >::time_type

Definition at line 134 of file basic_socket_iostream.hpp.

Constructor & Destructor Documentation

template<typename Protocol , typename StreamSocketService = stream_socket_service<Protocol>, typename Time = steady_timer::clock_type, typename TimeTraits = steady_timer::traits_type, typename TimerService = steady_timer::service_type>
asio::basic_socket_iostream< Protocol, StreamSocketService, Time, TimeTraits, TimerService >::basic_socket_iostream ( )
inline

Construct a basic_socket_iostream without establishing a connection.

Definition at line 139 of file basic_socket_iostream.hpp.

Member Function Documentation

template<typename Protocol , typename StreamSocketService = stream_socket_service<Protocol>, typename Time = steady_timer::clock_type, typename TimeTraits = steady_timer::traits_type, typename TimerService = steady_timer::service_type>
void asio::basic_socket_iostream< Protocol, StreamSocketService, Time, TimeTraits, TimerService >::close ( )
inline

Close the connection.

Definition at line 194 of file basic_socket_iostream.hpp.

template<typename Protocol , typename StreamSocketService = stream_socket_service<Protocol>, typename Time = steady_timer::clock_type, typename TimeTraits = steady_timer::traits_type, typename TimerService = steady_timer::service_type>
const asio::error_code& asio::basic_socket_iostream< Protocol, StreamSocketService, Time, TimeTraits, TimerService >::error ( ) const
inline

Get the last error associated with the stream.

Returns
An error_code corresponding to the last error from the stream.
Example
To print the error associated with a failure to establish a connection:
tcp::iostream s("www.boost.org", "http");
if (!s)
{
std::cout << "Error: " << s.error().message() << std::endl;
}

Definition at line 223 of file basic_socket_iostream.hpp.

template<typename Protocol , typename StreamSocketService = stream_socket_service<Protocol>, typename Time = steady_timer::clock_type, typename TimeTraits = steady_timer::traits_type, typename TimerService = steady_timer::service_type>
time_type asio::basic_socket_iostream< Protocol, StreamSocketService, Time, TimeTraits, TimerService >::expires_at ( ) const
inline

Get the stream's expiry time as an absolute time.

Returns
An absolute time value representing the stream's expiry time.

Definition at line 232 of file basic_socket_iostream.hpp.

template<typename Protocol , typename StreamSocketService = stream_socket_service<Protocol>, typename Time = steady_timer::clock_type, typename TimeTraits = steady_timer::traits_type, typename TimerService = steady_timer::service_type>
void asio::basic_socket_iostream< Protocol, StreamSocketService, Time, TimeTraits, TimerService >::expires_at ( const time_type &  expiry_time)
inline

Set the stream's expiry time as an absolute time.

This function sets the expiry time associated with the stream. Stream operations performed after this time (where the operations cannot be completed using the internal buffers) will fail with the error asio::error::operation_aborted.

Parameters
expiry_timeThe expiry time to be used for the stream.

Definition at line 246 of file basic_socket_iostream.hpp.

template<typename Protocol , typename StreamSocketService = stream_socket_service<Protocol>, typename Time = steady_timer::clock_type, typename TimeTraits = steady_timer::traits_type, typename TimerService = steady_timer::service_type>
duration_type asio::basic_socket_iostream< Protocol, StreamSocketService, Time, TimeTraits, TimerService >::expires_from_now ( ) const
inline

Get the timer's expiry time relative to now.

Returns
A relative time value representing the stream's expiry time.

Definition at line 255 of file basic_socket_iostream.hpp.

template<typename Protocol , typename StreamSocketService = stream_socket_service<Protocol>, typename Time = steady_timer::clock_type, typename TimeTraits = steady_timer::traits_type, typename TimerService = steady_timer::service_type>
void asio::basic_socket_iostream< Protocol, StreamSocketService, Time, TimeTraits, TimerService >::expires_from_now ( const duration_type &  expiry_time)
inline

Set the stream's expiry time relative to now.

This function sets the expiry time associated with the stream. Stream operations performed after this time (where the operations cannot be completed using the internal buffers) will fail with the error asio::error::operation_aborted.

Parameters
expiry_timeThe expiry time to be used for the timer.

Definition at line 269 of file basic_socket_iostream.hpp.

template<typename Protocol , typename StreamSocketService = stream_socket_service<Protocol>, typename Time = steady_timer::clock_type, typename TimeTraits = steady_timer::traits_type, typename TimerService = steady_timer::service_type>
basic_socket_streambuf<Protocol, StreamSocketService, Time, TimeTraits, TimerService>* asio::basic_socket_iostream< Protocol, StreamSocketService, Time, TimeTraits, TimerService >::rdbuf ( ) const
inline

Return a pointer to the underlying streambuf.

Definition at line 202 of file basic_socket_iostream.hpp.

The documentation for this class was generated from the following file:
Generated by   doxygen 1.8.11