WacDataPipe
Extends:
Constructor Summary
Public Constructor | ||
public |
|
Member Summary
Public Members | ||
public |
|
|
public |
|
|
public |
internalId: * |
|
public |
status: * |
Method Summary
Public Methods | ||
public |
async connect(): * |
|
public |
async disconnect(): * |
|
public |
async reject(): * |
|
public |
async send(data: *): * |
Inherited Summary
From class DataPipe | ||
public get |
Gets a unique identifier for the pipe |
|
public get |
Return label associated with this DataPipe. |
|
public get |
Gets the identities of the peers attached to this pipe |
|
public get |
Gets the identities of the remote peers attached to this pipe |
|
public get |
Retrieves the current status of this pipe. |
|
public get |
type: DataPipe.TYPE Gets pipe type |
|
public |
[priv.id]: * |
|
public |
|
|
public |
[priv.label]: * |
|
public |
|
|
public |
[priv.stack]: * |
|
public |
|
|
public |
[priv.type]: * |
|
public |
addParticipant(identity: String): Promise<DataPipe, Error> Adds a participant to this pipe. |
|
public |
Attempts to reach the pipe recipient and establish a connection. |
|
public |
disconnect(): Promise<DataPipe, Error> Ends an active pipe. |
|
public |
Called when a user does not wish to accept an incoming pipe. |
|
public |
removeParticipant(identity: String): Promise<DataPipe, Error> Removes a participant from this pipe. |
|
public |
Sends data to the DataPipe recipients |
|
public |
when(status: DataPipeStatus): Promise<DataPipe, Error> Returns a Promise resolved when pipe reaches provided state |
Public Constructors
public constructor() source
Public Members
public datapipeService: * source
public gatewayUsername: * source
public internalId: * source
Public Methods
public async connect(): * source
Attempts to reach the pipe recipient and establish a connection. For an incoming pipe, calling this method explicitly joins/accepts the pipe.
When this method fails returned {Promise} is rejected with one of next {Error}
- 'unimplemented'
- 'invalid-state' error when called on state different than "unconnected" state
- 'disconnected' pipe reaches disconnected state without being connected
Override:
DataPipe#connectReturn:
* |
public async disconnect(): * source
Ends an active pipe.
When this method fails returned {Promise} is rejected with one of next {Error}
- 'unimplemented'
- 'invalid-state' error when called on state different than "connected" state
Override:
DataPipe#disconnectReturn:
* |
public async reject(): * source
Called when a user does not wish to accept an incoming pipe.
When this method fails returned {Promise} is rejected with one of next {Error}
- 'unimplemented'
- 'invalid-state' error when called on state different than "unconnected" state
- 'invalid-state' error when called on outgoing pipes
Override:
DataPipe#rejectReturn:
* |
public async send(data: *): * source
Sends data to the DataPipe recipients
When this method fails returned {Promise} is rejected with one of next {Error}
- 'unimplemented'
- 'invalid-state' error when called on state different than "connected" state
Override:
DataPipe#sendParams:
Name | Type | Attribute | Description |
data | * |
Return:
* |