Main DSLink API for Browsers

Constants

unspecified Unspecified

Marks something as being unspecified.

const Unspecified()

Typedefs

InvokeCallback(Map params, Responder responder, InvokeResponse response, LocalNode parentNode) InvokeResponse

NodeFactory(String path) LocalNode

OnInvokeClosed(InvokeResponse response) → void

OnInvokeSend(InvokeResponse response, Map m) → void

OnReqParams(Map m) → bool

return true if params are valid

ResponseTraceCallback(ResponseTrace update) → dynamic

SimpleNodeFactory(String path) SimpleNode

Properties

defaultProfileMap → Map

read / write

Functions

buildActionIO(Map<String, String> types) → List<Map<String, dynamic>>

buildEnumType(Iterable<String> values) → String

getPrivateKey({DataStorage storage}) → Future<PrivateKey>

Get a Private Key using the specified storage strategy. If storage is not specified, it uses the LocalDataStorage class.

parseEnumType(String type) → List<String>

updateLogLevel(String name) → void

Updates the log level to the level specified name.

Classes

AsyncTableResult

An Asynchronous Table Result This can be used to return asynchronous tables from actions.

Base Class for Links

a client link for websocket

a client link for both http and ws

BrowserUtils

ByteDataUtil

Base Class for Client Link implementations.

Configs

ConfigSetting

Connection

ConnectionAckGroup

ConnectionChannel

ConnectionHandler

ConnectionProcessor

DataStorage

A Storage System for DSA Data

DefaultDefNodes

DefinitionNode

definition nodes are serializable node that won"t change the only change will be a global upgrade

DSError

DSLinkJSON

DummyPermissionManager

ErrorPhase

Interval

InvokeController

InvokeResponse

IPermissionManager

IStorageManager

general purpose storage class

ISubscriptionNodeStorage

the storage of one value

ISubscriptionResponderStorage

a storage container for one dslink different dslink will have different ISubscriptionResponderStorage

IValueStorage

basic value storage

IValueStorageBucket

a storage class for general purpose key/value pair

LinkProvider

DSLink Provider for the Browser

ListController

ListDefListener

ListResponse

LiveTable

A Live-Updating Table

LiveTableRow

LocalDataStorage

Storage for DSA in Local Storage

LocalNode

Base Class for responder-side nodes.

LocalNodeImpl

MutableNodeProvider

Interface for node providers that are mutable.

Node

Base Class for any and all nodes in the SDK. If you are writing a link, please look at the dslink.responder.SimpleNode class.

NodeProvider

Provides Nodes for a responder. A single node provider can be reused by multiple responder.

NodeProviderImpl

PassiveChannel

Path

Utility class for node and config/attribute paths.

Permission

PermissionList

PrivateKey

ProcessorResult

generate message right before sending to get the latest update return messages and the processors that need ack callback

RemoteDefNode

RemoteNode

RemoteNodeCache

manage cached nodes for requester TODO: cleanup nodes that are no longer in use

RemoveController

ReqSubscribeController

ReqSubscribeListener

Request

request class handles raw response from responder

Requester

RequesterInvokeUpdate

RequesterListUpdate

RequesterUpdate

RequestUpdater

Responder

a responder for one connection

Response

ResponseTrace

RespSubscribeController

RespSubscribeListener

Scheduler

Schedule Tasks

SerializableNodeProvider

Interface for node providers that are serializable.

Base Class for Server Link implementations.

ServerLinkManager

SetController

SimpleHiddenNode

A hidden node.

SimpleNode

A Simple Node Implementation A flexible node implementation that should fit most use cases.

SimpleNodeProvider

SimpleTableResult

A simple table result. This is used to return simple tables from an action.

StreamStatus

DSA Stream Status

SubscribeController

only a place holder for reconnect and disconnect real logic is in SubscribeRequest itself

SubscribeRequest

SubscribeResponse

SynchronousDataStorage

A Synchronous Storage System for DSA Data

Table

TableColumn

TableColumns

TableMetadata

Unspecified

Unspecified means that something has never been set.

ValueUpdate

Represents an update to a value subscription.

WaitForMe

WebSocketConnection