Olympe SDK

Class: Manager

olympe.net. Manager

Net manager abstract class.

<abstract> new Manager(logger, hostManager)

Parameters:
Name Type Description
logger olympe.logging.Channel

Logging channel
hostManager olympe.host.Manager

Members

<protected> elementUniqueId :number

Type:
  • number

<protected, non-null> hostManager :olympe.host.Manager

Type:
  • olympe.host.Manager

<protected, non-null> logger :olympe.logging.Channel

Type:
  • olympe.logging.Channel

<protected, nullable> online :olympe.df.FlowSource.<!olympe.df.OBoolean>

Type:

Methods

createMqttClient(url [, options])

Create and return the mqtt client.

Parameters:
Name Type Argument Description
url string

The URL for bus connection
options olympe.net.Mqtt.MQTTConnectionOptions <optional>

The connection options
Returns:

The mqtt client

Type
olympe.net.Mqtt

<abstract> downloadFile(fileOrContent [, name] [, type])

Saves data into a local file. The data can come from a remote file, a string or a binary blob.

Parameters:
Name Type Argument Description
fileOrContent olympe.df.File | olympe.df.Proxy.<olympe.df.File> | olympe.df.POString | string | Blob

File or content.
name string <optional>

Downloaded file name (by default, uses the original file name).
type string <optional>

The MIME type.

<abstract, protected> getHttpRequestHandler()

Return the HttpRequest handler attached to this net manager.

Returns:
Type
olympe.net.impl.HttpRequestHandler

<abstract> getImplementationDescription()

Returns a description of the native implementation

Returns:
Type
string

<abstract> httpRequest(request, callback)

Handles a HttpRequest.

Parameters:
Name Type Description
request olympe.net.HttpRequest

The request.
callback olympe.net.Manager.HttpResponseCallback

The callback to invoke with the result.

<abstract> isOnline()

Returns whether the VM is currently connected to internet.

Returns:
Type
olympe.df.POBoolean

<abstract> openWebSocket(request)

Creates a WebSocket matching a WebSocketRequest.

Parameters:
Name Type Description
request olympe.net.WebSocketRequest

The request.
Returns:

The opened WebSocket.

Type
olympe.net.WebSocket

<protected> registerHttpRequest(id, callback)

Register the http request in the handler to cancel it if the creator execution is destroyed before the end of its process.

Parameters:
Name Type Description
id number
callback olympe.net.Manager.HttpResponseCallback
Returns:

boundCallback

Type
olympe.net.Manager.HttpResponseCallback

Type Definitions

HttpResponseCallback(response)

Parameters:
Name Type Description
response olympe.net.HttpResponse