Function std.net.curl.byLineAsync

A range of lines is returned immediately and the request that fetches the lines is performed in another thread. If the method or other request properties is to be customized then set the conn parameter with a HTTP/FTP instance that has these properties set.

If postData is non-null the method will be set to post for HTTP requests.

The background thread will buffer up to transmitBuffers number of lines before it stops receiving data from network. When the main thread reads the lines from the range it frees up buffers and allows for the background thread to receive more data from the network.

If no data is available and the main thread accesses the range it will block until data becomes available. An exception to this is the wait(Duration) method on the AsyncLineInputRange. This method will wait at maximum for the specified duration and return true if data is available.

Prototypes

auto byLineAsync(Conn, Terminator, Char, PostUnit)(
  const(char)[] url,
  const(PostUnit)[] postData,
  KeepTerminator keepTerminator = KeepTerminator.no,
  Terminator terminator = '\x0a',
  size_t transmitBuffers = 10,
  Conn conn = Conn()
)
if (isCurlConn!Conn && isSomeChar!Char && isSomeChar!Terminator);

auto byLineAsync(Conn, Terminator, Char)(
  const(char)[] url,
  KeepTerminator keepTerminator = KeepTerminator.no,
  Terminator terminator = '\x0a',
  size_t transmitBuffers = 10,
  Conn conn = Conn()
);

Example

import std.net.curl, std.stdio;
// Get some pages in the background
auto range1 = byLineAsync("www.google.com");
auto range2 = byLineAsync("www.wikipedia.org");
foreach (line; byLineAsync("dlang.org"))
    writeln(line);

// Lines already fetched in the background and ready
foreach (line; range1) writeln(line);
foreach (line; range2) writeln(line);

import std.net.curl, std.stdio;
// Get a line in a background thread and wait in
// main thread for 2 seconds for it to arrive.
auto range3 = byLineAsync("dlang.com");
if (range.wait(dur!"seconds"(2)))
    writeln(range.front);
else
    writeln("No line received after 2 seconds!");

Parameters

Returns

A range of Char[] with the content of the resource pointer to by the URL.