Display the source code in std/net/curl.d from which this page was generated on github.

If you spot a problem with this page, click here to create a Bugzilla issue.

Quickly fork, edit online, and submit a pull request for this page. Requires a signed-in GitHub account. This works well for small changes. If you'd like to make larger changes you may want to consider using local clone.

Function `std.net.curl.byLineAsync`

HTTP/FTP fetch content as a range of lines asynchronously.


						
				auto auto byLineAsync(Conn, Terminator, Char, PostUnit)
				(
				

				  const(char)[] url,
				

				  const(PostUnit)[] postData,
				

				  KeepTerminator keepTerminator = No.keepTerminator,
				

				  Terminator terminator = '\x0a',
				

				  size_t transmitBuffers = 10,
				

				  Conn conn = Conn()
				

				)
				

				if (isCurlConn!Conn && isSomeChar!Char && isSomeChar!Terminator);
				

				

				auto auto byLineAsync(Conn, Terminator, Char)
				(
				

				  const(char)[] url,
				

				  KeepTerminator keepTerminator = No.keepTerminator,
				

				  Terminator terminator = '\x0a',
				

				  size_t transmitBuffers = 10,
				

				  Conn conn = Conn()
				

				);

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 LineInputRange. This method will wait at maximum for the specified duration and return true if data is available.

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 (range3.wait(dur!"seconds"(2)))
    writeln(range3.front);
else
    writeln("No line received after 2 seconds!");

Parameters

Name	Description
url	The url to receive content from
postData	Data to HTTP Post
keepTerminator	`Yes.keepTerminator` signals that the line terminator should be returned as part of the lines in the range.
terminator	The character that terminates a line
transmitBuffers	The number of lines buffered asynchronously
conn	The connection to use e.g. HTTP or FTP.

Returns

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

Authors

Jonas Drewsen. Some of the SMTP code contributed by Jimmy Cao.

License

Boost License 1.0.