| Home | Libraries | People | FAQ | More

# boost::asio::socket_acceptor_service< Protocol > Class Template Reference

Inherits boost::asio::io_service::service.

Inheritance diagram for boost::asio::socket_acceptor_service< Protocol >:

List of all members.

## Detailed Description

### template<typename Protocol>
class boost::asio::socket_acceptor_service< Protocol >

Default service implementation for a socket acceptor.

## Public Types

typedef Protocol | protocol_type
| The protocol type.
typedef protocol_type::endpoint | endpoint_type
| The endpoint type.
typedef implementation_defined | implementation_type
| The native type of the socket acceptor.
typedef implementation_defined | native_type
| The native acceptor type.

## Public Member Functions

| socket_acceptor_service (boost::asio::io_service &io_service)
| Construct a new socket acceptor service for the specified io_service.
void | shutdown_service ()
| Destroy all user-defined handler objects owned by the service.
void | construct (implementation_type &impl)
| Construct a new socket acceptor implementation.
void | destroy (implementation_type &impl)
| Destroy a socket acceptor implementation.
template<typename Error_Handler>
void | open (implementation_type &impl, const protocol_type &protocol, Error_Handler error_handler)
| Open a new socket acceptor implementation.
template<typename Error_Handler>
void | assign (implementation_type &impl, const protocol_type &protocol, const native_type &native_acceptor, Error_Handler error_handler)
| Assign an existing native acceptor to a socket acceptor.
template<typename Error_Handler>
void | bind (implementation_type &impl, const endpoint_type &endpoint, Error_Handler error_handler)
| Bind the socket acceptor to the specified local endpoint.
template<typename Error_Handler>
void | listen (implementation_type &impl, int backlog, Error_Handler error_handler)
| Place the socket acceptor into the state where it will listen for new connections.
template<typename Error_Handler>
void | close (implementation_type &impl, Error_Handler error_handler)
| Close a socket acceptor implementation.
native_type | native (implementation_type &impl)
| Get the native acceptor implementation.
template<typename Option, typename Error_Handler>
void | set_option (implementation_type &impl, const Option &option, Error_Handler error_handler)
| Set a socket option.
template<typename Option, typename Error_Handler>
void | get_option (implementation_type &impl, Option &option, Error_Handler error_handler)
| Set a socket option.
template<typename Error_Handler>
endpoint_type | local_endpoint (const implementation_type &impl, Error_Handler error_handler) const
| Get the local endpoint.
template<typename Socket_Service, typename Error_Handler>
void | accept (implementation_type &impl, basic_socket< protocol_type, Socket_Service > &peer, Error_Handler error_handler)
| Accept a new connection.
template<typename Socket_Service, typename Error_Handler>
void | accept_endpoint (implementation_type &impl, basic_socket< protocol_type, Socket_Service > &peer, endpoint_type &peer_endpoint, Error_Handler error_handler)
| Accept a new connection.
template<typename Socket_Service, typename Handler>
void | async_accept (implementation_type &impl, basic_socket< protocol_type, Socket_Service > &peer, Handler handler)
| Start an asynchronous accept.
template<typename Socket_Service, typename Handler>
void | async_accept_endpoint (implementation_type &impl, basic_socket< protocol_type, Socket_Service > &peer, endpoint_type &peer_endpoint, Handler handler)
| Start an asynchronous accept.
io_service & | owner ()
| Get the io_service object that owns the service.

## Member Typedef Documentation

template<typename Protocol>

typedef Protocol boost::asio::socket_acceptor_service< Protocol >::protocol_type

The protocol type.

template<typename Protocol>

typedef protocol_type::endpoint boost::asio::socket_acceptor_service< Protocol >::endpoint_type

The endpoint type.

template<typename Protocol>

typedef implementation_defined boost::asio::socket_acceptor_service< Protocol >::implementation_type

The native type of the socket acceptor.

template<typename Protocol>

typedef implementation_defined boost::asio::socket_acceptor_service< Protocol >::native_type

The native acceptor type.

## Constructor & Destructor Documentation

template<typename Protocol>

boost::asio::socket_acceptor_service< Protocol >::socket_acceptor_service | ( | boost::asio::io_service & | io_service | ) | `[explicit]`

Construct a new socket acceptor service for the specified io_service.

## Member Function Documentation

template<typename Protocol>

void boost::asio::socket_acceptor_service< Protocol >::shutdown_service | ( |  | ) | `[virtual]`

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

Implements boost::asio::io_service::service.

template<typename Protocol>

void boost::asio::socket_acceptor_service< Protocol >::construct | ( | implementation_type & | impl | ) |

Construct a new socket acceptor implementation.

template<typename Protocol>

void boost::asio::socket_acceptor_service< Protocol >::destroy | ( | implementation_type & | impl | ) |

Destroy a socket acceptor implementation.

template<typename Protocol>
template<typename Error_Handler>

void boost::asio::socket_acceptor_service< Protocol >::open | ( | implementation_type & | impl,
|  | const protocol_type & | protocol,
|  | Error_Handler | error_handler |
| ) |  |  |

Open a new socket acceptor implementation.

template<typename Protocol>
template<typename Error_Handler>

void boost::asio::socket_acceptor_service< Protocol >::assign | ( | implementation_type & | impl,
|  | const protocol_type & | protocol,
|  | const native_type & | native_acceptor,
|  | Error_Handler | error_handler |
| ) |  |  |

Assign an existing native acceptor to a socket acceptor.

template<typename Protocol>
template<typename Error_Handler>

void boost::asio::socket_acceptor_service< Protocol >::bind | ( | implementation_type & | impl,
|  | const endpoint_type & | endpoint,
|  | Error_Handler | error_handler |
| ) |  |  |

Bind the socket acceptor to the specified local endpoint.

template<typename Protocol>
template<typename Error_Handler>

void boost::asio::socket_acceptor_service< Protocol >::listen | ( | implementation_type & | impl,
|  | int | backlog,
|  | Error_Handler | error_handler |
| ) |  |  |

Place the socket acceptor into the state where it will listen for new connections.

template<typename Protocol>
template<typename Error_Handler>

void boost::asio::socket_acceptor_service< Protocol >::close | ( | implementation_type & | impl,
|  | Error_Handler | error_handler |
| ) |  |  |

Close a socket acceptor implementation.

template<typename Protocol>

native_type boost::asio::socket_acceptor_service< Protocol >::native | ( | implementation_type & | impl | ) |

Get the native acceptor implementation.

template<typename Protocol>
template<typename Option, typename Error_Handler>

void boost::asio::socket_acceptor_service< Protocol >::set_option | ( | implementation_type & | impl,
|  | const Option & | option,
|  | Error_Handler | error_handler |
| ) |  |  |

Set a socket option.

template<typename Protocol>
template<typename Option, typename Error_Handler>

void boost::asio::socket_acceptor_service< Protocol >::get_option | ( | implementation_type & | impl,
|  | Option & | option,
|  | Error_Handler | error_handler |
| ) |  |  |

Set a socket option.

template<typename Protocol>
template<typename Error_Handler>

endpoint_type boost::asio::socket_acceptor_service< Protocol >::local_endpoint | ( | const implementation_type & | impl,
|  | Error_Handler | error_handler |
| ) |  |  | const

Get the local endpoint.

template<typename Protocol>
template<typename Socket_Service, typename Error_Handler>

void boost::asio::socket_acceptor_service< Protocol >::accept | ( | implementation_type & | impl,
|  | basic_socket< protocol_type, Socket_Service > & | peer,
|  | Error_Handler | error_handler |
| ) |  |  |

Accept a new connection.

template<typename Protocol>
template<typename Socket_Service, typename Error_Handler>

void boost::asio::socket_acceptor_service< Protocol >::accept_endpoint | ( | implementation_type & | impl,
|  | basic_socket< protocol_type, Socket_Service > & | peer,
|  | endpoint_type & | peer_endpoint,
|  | Error_Handler | error_handler |
| ) |  |  |

Accept a new connection.

template<typename Protocol>
template<typename Socket_Service, typename Handler>

void boost::asio::socket_acceptor_service< Protocol >::async_accept | ( | implementation_type & | impl,
|  | basic_socket< protocol_type, Socket_Service > & | peer,
|  | Handler | handler |
| ) |  |  |

Start an asynchronous accept.

template<typename Protocol>
template<typename Socket_Service, typename Handler>

void boost::asio::socket_acceptor_service< Protocol >::async_accept_endpoint | ( | implementation_type & | impl,
|  | basic_socket< protocol_type, Socket_Service > & | peer,
|  | endpoint_type & | peer_endpoint,
|  | Handler | handler |
| ) |  |  |

Start an asynchronous accept.

io_service & boost::asio::io_service::service::owner | ( |  | ) | `[inherited]`

Get the io_service object that owns the service.

| Copyright © 2003 - 2006 Christopher M. Kohlhoff