Files: 80537e8058ad78a6a1619e7b40eeff757a9a8751 / docs / portManager.md
<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
Table of Contents
- constructor
- bind
- unbind
- delete
- clearUnboundedPorts
- isBound
- queue
- get
- create
- createChannel
- getNextMessage
constructor
The port manager manages the the ports. This inculdes creation, deletion fetching and waiting on ports
Parameters
bind
binds a port to a name
Parameters
unbind
unbinds a port given its name
Parameters
name
string
Returns Promise
delete
delete an port given the name it is bound to
Parameters
name
string
clearUnboundedPorts
clears any unbounded ports referances
isBound
check if a port object is still valid
Parameters
port
Object
Returns Boolean
queue
queues a message on a port
Parameters
name
message
Message
get
gets a port given it's name
Parameters
name
String
Returns Object
create
creates a new container. Returning a port to it.
Parameters
type
Stringdata
any the data to populate the initail state with
Returns Object
createChannel
creates a channel returns the created ports in an Array
Returns array
getNextMessage
Waits for the the next message if any
Returns Promise
Built with git-ssb-web