Virtual Method

ValentChanneldownload

unstable since: 1.0

Declaration [src]

GIOStream*
download (
  ValentChannel* channel,
  JsonNode* packet,
  GCancellable* cancellable,
  GError** error
)

Description [src]

Open an auxiliary connection, usually to download data.

Implementations should use information from the payloadTransferInfo field to open a connection and wait for it to be accepted. In most cases the remote device will write data to the stream and then close it when finished.

For example, a TCP-based implementation could connect to a port in the payloadTransferInfo dictionary on the same host as the channel. When the connection is accepted the caller can perform operations on it as required.

Available since: 1.0

Parameters

packet

Type: JsonNode

A KDE Connect packet.

The data is owned by the caller of the method.
cancellable

Type: GCancellable

A GCancellable.

The argument can be NULL.
The data is owned by the caller of the method.
error

Type: GError **

The return location for a recoverable error.

The argument can be NULL.
If the return location is not NULL, then you must initialize it to a NULL GError*.
The argument will be left initialized to NULL by the virtual function if there are no errors.
In case of error, the argument will be set to a newly allocated GError; the caller will take ownership of the data, and be responsible for freeing it.

Return value

Type: GIOStream

A GIOStream.

The caller of the method takes ownership of the returned data, and is responsible for freeing it.
The return value can be NULL.