Files: b507f49239a73767abbee979b4e637a6ca469764 / docs / portManager.md
<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
Table of Contents
constructor
The port manager manages the the ports. This inculdes creation, deletion fetching and waiting on ports
Parameters
opts
Object
start
starts the port manager. This fetchs the ports from the state and maps them to thier names
Returns Promise
bind
binds a port to a name
Parameters
queue
queues a message on a port
Parameters
message
Message
get
gets a port given it's name
Parameters
name
String
Returns Object
delete
deletes a port given its name
Parameters
name
String
isValidPort
check if a port object is still valid
Parameters
port
Object
Returns Boolean
create
creates a new Port given the container type
Parameters
type
String
Returns Object the newly created port
wait
waits till all ports have reached a threshold tick count
Parameters
threshold
Integer the number of ticks to waitfromPort
Object the port requesting the wait (optional, defaultthis.entryPort
)ports
Array the ports to wait on (optional, default[...this._portMap]
)
Returns Promise
getNextMessage
gets the next canonical message given the an array of ports to choose from
Parameters
ports
Array (optional, default[...this._portMap]
)
Returns Promise
Built with git-ssb-web