SASLSocket Class Reference
A socket which provides data integrity and/or privacy protection. More...
Public Member Functions | |
| SASLSocket (ref< SASLSession > sess, ref< net::socket > wrapped) | |
| ~SASLSocket () | |
| void | connect (const string &address, const port_t port) |
| void | disconnect () |
| bool | isConnected () const |
| void | receive (string &buffer) |
| size_type | receiveRaw (char *buffer, const size_type count) |
| void | send (const string &buffer) |
| void | sendRaw (const char *buffer, const size_type count) |
| size_type | getBlockSize () const |
Detailed Description
A socket which provides data integrity and/or privacy protection.
Constructor & Destructor Documentation
| SASLSocket | ( | ref< SASLSession > | sess, | |
| ref< net::socket > | wrapped | |||
| ) |
| ~SASLSocket | ( | ) |
Member Function Documentation
Connect to the specified address and port.
- Parameters:
-
address server address (this can be a full qualified domain name or an IP address, doesn't matter) port server port
Implements socket.
| void disconnect | ( | ) | [virtual] |
Disconnect from the server.
Implements socket.
| SASLSocket::size_type getBlockSize | ( | ) | const [virtual] |
Return the preferred maximum block size when reading from or writing to this stream.
- Returns:
- block size, in bytes
Implements socket.
| bool isConnected | ( | ) | const [virtual] |
Test whether this socket is connected.
- Returns:
- true if the socket is connected, false otherwise
Implements socket.
| void receive | ( | string & | buffer | ) | [virtual] |
Receive (text) data from the socket.
- Parameters:
-
buffer buffer in which to write received data
Implements socket.
References SASLSocket::receiveRaw().
| SASLSocket::size_type receiveRaw | ( | char * | buffer, | |
| const size_type | count | |||
| ) | [virtual] |
Receive (raw) data from the socket.
- Parameters:
-
buffer buffer in which to write received data count maximum number of bytes to receive (size of buffer)
- Returns:
- number of bytes received/written into output buffer
Implements socket.
Referenced by SASLSocket::receive().
| void send | ( | const string & | buffer | ) | [virtual] |
Send (text) data to the socket.
- Parameters:
-
buffer data to send
Implements socket.
References SASLSocket::sendRaw().
| void sendRaw | ( | const char * | buffer, | |
| const size_type | count | |||
| ) | [virtual] |
Send (raw) data to the socket.
- Parameters:
-
buffer data to send count number of bytes to send (size of buffer)
Implements socket.
Referenced by SASLSocket::send().
The documentation for this class was generated from the following files:
