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

Reference | Class Hierarchy | Class Index | Member Index

# asio::async_read_until

## Functions

template<typename AsyncReadStream, typename Allocator, typename ReadHandler>
void | asio::async_read_until (AsyncReadStream &s, asio::basic_streambuf< Allocator > &b, char delim, ReadHandler handler)
| Start an asynchronous operation to read data into a streambuf until a delimiter is encountered.
template<typename AsyncReadStream, typename Allocator, typename ReadHandler>
void | asio::async_read_until (AsyncReadStream &s, asio::basic_streambuf< Allocator > &b, const std::string &delim, ReadHandler handler)
| Start an asynchronous operation to read data into a streambuf until a delimiter is encountered.
template<typename AsyncReadStream, typename Allocator, typename ReadHandler>
void | asio::async_read_until (AsyncReadStream &s, asio::basic_streambuf< Allocator > &b, const boost::regex &expr, ReadHandler handler)
| Start an asynchronous operation to read data into a streambuf until a regular expression is located.

## Function Documentation

template<typename AsyncReadStream, typename Allocator, typename ReadHandler>

void asio::async_read_until | ( | AsyncReadStream & | s,
|  | asio::basic_streambuf< Allocator > & | b,
|  | char | delim,
|  | ReadHandler | handler |
| ) |  |  |

Start an asynchronous operation to read data into a streambuf until a delimiter is encountered.

This function is used to asynchronously read data into the specified streambuf until the streambuf's get area contains the specified delimiter. The function call always returns immediately. The asynchronous operation will continue until one of the following conditions is true:

- The get area of the streambuf contains the specified delimiter.

- An error occurred.

This operation is implemented in terms of zero or more calls to the stream's async_read_some function. If the streambuf's get area already contains the delimiter, the asynchronous operation completes immediately.

Parameters:

  | s | The stream from which the data is to be read. The type must support the AsyncReadStream concept.
  | b | A streambuf object into which the data will be read. Ownership of the streambuf is retained by the caller, which must guarantee that it remains valid until the handler is called.
  | delim | The delimiter character.
  | handler | The handler to be called when the read operation completes. Copies will be made of the handler as required. The function signature of the handler must be:
       void handler(
         const asio::error_code& error,         // Result of operation.

         std::size_t bytes_transferred          // The number of bytes in the
                                                // streambuf's get area up to
                                                // and including the delimiter.
                                                // 0 if an error occurred.
       );
  Regardless of whether the asynchronous operation completes immediately or not, the handler will not be invoked from within this function. Invocation of the handler will be performed in a manner equivalent to using asio::io_service::post().

Example
  To asynchronously read data into a streambuf until a newline is encountered:

       asio::streambuf b;
       ...
       void handler(const asio::error_code& e, std::size_t size)
       {
         if (!e)
         {
           std::istream is(&b);
           std::string line;
           std::getline(is, line);
           ...
         }
       }
       ...
       asio::async_read_until(s, b, '\n', handler);

template<typename AsyncReadStream, typename Allocator, typename ReadHandler>

void asio::async_read_until | ( | AsyncReadStream & | s,
|  | asio::basic_streambuf< Allocator > & | b,
|  | const std::string & | delim,
|  | ReadHandler | handler |
| ) |  |  |

Start an asynchronous operation to read data into a streambuf until a delimiter is encountered.

This function is used to asynchronously read data into the specified streambuf until the streambuf's get area contains the specified delimiter. The function call always returns immediately. The asynchronous operation will continue until one of the following conditions is true:

- The get area of the streambuf contains the specified delimiter.

- An error occurred.

This operation is implemented in terms of zero or more calls to the stream's async_read_some function. If the streambuf's get area already contains the delimiter, the asynchronous operation completes immediately.

Parameters:

  | s | The stream from which the data is to be read. The type must support the AsyncReadStream concept.
  | b | A streambuf object into which the data will be read. Ownership of the streambuf is retained by the caller, which must guarantee that it remains valid until the handler is called.
  | delim | The delimiter string.
  | handler | The handler to be called when the read operation completes. Copies will be made of the handler as required. The function signature of the handler must be:
       void handler(
         const asio::error_code& error,         // Result of operation.

         std::size_t bytes_transferred          // The number of bytes in the
                                                // streambuf's get area up to
                                                // and including the delimiter.
                                                // 0 if an error occurred.
       );
  Regardless of whether the asynchronous operation completes immediately or not, the handler will not be invoked from within this function. Invocation of the handler will be performed in a manner equivalent to using asio::io_service::post().

Example
  To asynchronously read data into a streambuf until a newline is encountered:

       asio::streambuf b;
       ...
       void handler(const asio::error_code& e, std::size_t size)
       {
         if (!e)
         {
           std::istream is(&b);
           std::string line;
           std::getline(is, line);
           ...
         }
       }
       ...
       asio::async_read_until(s, b, "\r\n", handler);

template<typename AsyncReadStream, typename Allocator, typename ReadHandler>

void asio::async_read_until | ( | AsyncReadStream & | s,
|  | asio::basic_streambuf< Allocator > & | b,
|  | const boost::regex & | expr,
|  | ReadHandler | handler |
| ) |  |  |

Start an asynchronous operation to read data into a streambuf until a regular expression is located.

This function is used to asynchronously read data into the specified streambuf until the streambuf's get area contains some data that matches a regular expression. The function call always returns immediately. The asynchronous operation will continue until one of the following conditions is true:

- A substring of the streambuf's get area matches the regular expression.

- An error occurred.

This operation is implemented in terms of zero or more calls to the stream's async_read_some function. If the streambuf's get area already contains data that matches the regular expression, the function returns immediately.

Parameters:

  | s | The stream from which the data is to be read. The type must support the AsyncReadStream concept.
  | b | A streambuf object into which the data will be read. Ownership of the streambuf is retained by the caller, which must guarantee that it remains valid until the handler is called.
  | expr | The regular expression.
  | handler | The handler to be called when the read operation completes. Copies will be made of the handler as required. The function signature of the handler must be:
       void handler(
         const asio::error_code& error,         // Result of operation.

         std::size_t bytes_transferred          // The number of bytes in the
                                                // streambuf's get area up to
                                                // and including the substring
                                                // that matches the regular.
                                                // expression. 0 if an error
                                                // occurred.
       );
  Regardless of whether the asynchronous operation completes immediately or not, the handler will not be invoked from within this function. Invocation of the handler will be performed in a manner equivalent to using asio::io_service::post().

Example
  To asynchronously read data into a streambuf until a CR-LF sequence is encountered:

       asio::streambuf b;
       ...
       void handler(const asio::error_code& e, std::size_t size)
       {
         if (!e)
         {
           std::istream is(&b);
           std::string line;
           std::getline(is, line);
           ...
         }
       }
       ...
       asio::async_read_until(s, b, boost::regex("\r\n"), handler);

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