All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Types | Public Member Functions | Private Types | Private Attributes
asio::serial_port_service Class Reference

Default service implementation for a serial port. More...

#include <serial_port_service.hpp>

Inheritance diagram for asio::serial_port_service:
Inheritance graph
[legend]

List of all members.

Public Types

typedef
service_impl_type::implementation_type 
implementation_type
 The type of a serial port implementation.
typedef
service_impl_type::native_type 
native_type
 The native handle type.

Public Member Functions

asio::error_code assign (implementation_type &impl, const native_type &native_handle, asio::error_code &ec)
 Assign an existing native handle to a serial port.
template<typename MutableBufferSequence , typename ReadHandler >
void async_read_some (implementation_type &impl, const MutableBufferSequence &buffers, ReadHandler handler)
 Start an asynchronous read.
template<typename ConstBufferSequence , typename WriteHandler >
void async_write_some (implementation_type &impl, const ConstBufferSequence &buffers, WriteHandler handler)
 Start an asynchronous write.
asio::error_code cancel (implementation_type &impl, asio::error_code &ec)
 Cancel all asynchronous operations associated with the handle.
asio::error_code close (implementation_type &impl, asio::error_code &ec)
 Close a serial port implementation.
void construct (implementation_type &impl)
 Construct a new serial port implementation.
void destroy (implementation_type &impl)
 Destroy a serial port implementation.
template<typename GettableSerialPortOption >
asio::error_code get_option (const implementation_type &impl, GettableSerialPortOption &option, asio::error_code &ec) const
 Get a serial port option.
bool is_open (const implementation_type &impl) const
 Determine whether the handle is open.
native_type native (implementation_type &impl)
 Get the native handle implementation.
asio::error_code open (implementation_type &impl, const std::string &device, asio::error_code &ec)
 Open a serial port.
template<typename MutableBufferSequence >
std::size_t read_some (implementation_type &impl, const MutableBufferSequence &buffers, asio::error_code &ec)
 Read some data from the stream.
asio::error_code send_break (implementation_type &impl, asio::error_code &ec)
 Send a break sequence to the serial port.
 serial_port_service (asio::io_service &io_service)
 Construct a new serial port service for the specified io_service.
template<typename SettableSerialPortOption >
asio::error_code set_option (implementation_type &impl, const SettableSerialPortOption &option, asio::error_code &ec)
 Set a serial port option.
void shutdown_service ()
 Destroy all user-defined handler objects owned by the service.
template<typename ConstBufferSequence >
std::size_t write_some (implementation_type &impl, const ConstBufferSequence &buffers, asio::error_code &ec)
 Write the given data to the stream.

Private Types

typedef
detail::reactive_serial_port_service
< detail::select_reactor
< false > > 
service_impl_type

Private Attributes

service_impl_typeservice_impl_

Detailed Description

Default service implementation for a serial port.

Definition at line 45 of file serial_port_service.hpp.


Member Typedef Documentation

The type of a serial port implementation.

Definition at line 81 of file serial_port_service.hpp.

The native handle type.

Definition at line 88 of file serial_port_service.hpp.

Definition at line 73 of file serial_port_service.hpp.


Constructor & Destructor Documentation

Construct a new serial port service for the specified io_service.

Definition at line 92 of file serial_port_service.hpp.


Member Function Documentation

Assign an existing native handle to a serial port.

Definition at line 123 of file serial_port_service.hpp.

template<typename MutableBufferSequence , typename ReadHandler >
void asio::serial_port_service::async_read_some ( implementation_type impl,
const MutableBufferSequence &  buffers,
ReadHandler  handler 
) [inline]

Start an asynchronous read.

Definition at line 204 of file serial_port_service.hpp.

template<typename ConstBufferSequence , typename WriteHandler >
void asio::serial_port_service::async_write_some ( implementation_type impl,
const ConstBufferSequence &  buffers,
WriteHandler  handler 
) [inline]

Start an asynchronous write.

Definition at line 188 of file serial_port_service.hpp.

Cancel all asynchronous operations associated with the handle.

Definition at line 149 of file serial_port_service.hpp.

Close a serial port implementation.

Definition at line 136 of file serial_port_service.hpp.

Construct a new serial port implementation.

Definition at line 104 of file serial_port_service.hpp.

Destroy a serial port implementation.

Definition at line 110 of file serial_port_service.hpp.

template<typename GettableSerialPortOption >
asio::error_code asio::serial_port_service::get_option ( const implementation_type impl,
GettableSerialPortOption &  option,
asio::error_code ec 
) const [inline]

Get a serial port option.

Definition at line 165 of file serial_port_service.hpp.

bool asio::serial_port_service::is_open ( const implementation_type impl) const [inline]

Determine whether the handle is open.

Definition at line 130 of file serial_port_service.hpp.

Get the native handle implementation.

Definition at line 143 of file serial_port_service.hpp.

asio::error_code asio::serial_port_service::open ( implementation_type impl,
const std::string &  device,
asio::error_code ec 
) [inline]

Open a serial port.

Definition at line 116 of file serial_port_service.hpp.

template<typename MutableBufferSequence >
std::size_t asio::serial_port_service::read_some ( implementation_type impl,
const MutableBufferSequence &  buffers,
asio::error_code ec 
) [inline]

Read some data from the stream.

Definition at line 196 of file serial_port_service.hpp.

Send a break sequence to the serial port.

Definition at line 172 of file serial_port_service.hpp.

template<typename SettableSerialPortOption >
asio::error_code asio::serial_port_service::set_option ( implementation_type impl,
const SettableSerialPortOption &  option,
asio::error_code ec 
) [inline]

Set a serial port option.

Definition at line 157 of file serial_port_service.hpp.

void asio::serial_port_service::shutdown_service ( ) [inline, virtual]

Destroy all user-defined handler objects owned by the service.

Implements asio::io_service::service.

Definition at line 99 of file serial_port_service.hpp.

template<typename ConstBufferSequence >
std::size_t asio::serial_port_service::write_some ( implementation_type impl,
const ConstBufferSequence &  buffers,
asio::error_code ec 
) [inline]

Write the given data to the stream.

Definition at line 180 of file serial_port_service.hpp.


Member Data Documentation

Definition at line 212 of file serial_port_service.hpp.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines


Castor
Author(s): Carpe Noctem
autogenerated on Fri Nov 8 2013 11:05:41