kronos-endpoint
Named communication (end)-points inside of kronos
{:height="310pt" width="325pt"}
API
Table of Contents
DummyReceiveEndpoint
Extends Endpoint
Dummy endpoints are used during construction of the endpoint mesh.
receive
dummy does nothing by intention.
isIn
Returns boolean true
isOpen
Returns boolean true
isDummy
Indicate whatever we are a dummy endpoint.
Dummy endpoints are used duiring construction of the endpoint mesh.
Returns boolean true
ConnectionState
Type: Object
Endpoint
Connection endpoint.
Parameters
displayName
Name as presented for humans.
Returns string
isDefault
Indicate whatever we are a default endpoint.
Default means buildin.
Returns boolean false
isDummy
Indicate whatever we are a dummy endpoint.
Dummy endpoints are used duiring construction of the endpoint mesh.
Returns boolean false
toStringAttributes
Mapping of properties used in toString.
Returns Object
connectionNamesWithStates
Parameters
options
Object (optional, default {includeRuntimeInfo:true}
)
isIn
Returns boolean false
isOut
Returns boolean false
direction
Deliver data flow direction.
Returns (string | undefined) delivers data flow direction 'in', 'out', 'inout' or undefined
jsonAttributes
Additional attributes to present in json output.
hasInterceptors
Returns boolean true if there is at least one interceptor assigned
connectable
Can we form a connection to the other side.
in to out and out to in.
Parameters
Returns boolean true if we can be connected to the other endpoint
hasConnections
Returns boolean true if there is at least one connection
isConnected
Are we connected to a endpoint.
Parameters
other
Endpoint to check for the connection
Returns boolean true if there is a connection to the other endpoint
openConnection
Actually start with the communication.
Parameters
other
Endpoint backpointer
boolean? true if this is the call from back call from the other side
closeConnection
Actually stop the communication.
Parameters
other
Endpoint backpointer
boolean? true if this is the call from back call from the other side
openConnections
Opens all connections.
closeConnections
Closes all connections.
connections
Returns Iterable<any>
getConnectionState
Deliver state for a given connection.
Parameters
Returns ConnectionState
setConnectionState
Set state for a given connection.
Parameters
isEndpoint
Check for Endpoint.
Parameters
Returns boolean true if object is an Endpoint
instanciateInterceptors
Instanciate interceptors from its definitions.
Parameters
Returns Array<Interceptor>
MultiConnectionEndpoint
Extends ReceivableEndpoint
Multiple connection endpoint.
Can hold several connections.
Parameters
getConnectionState
Deliver connection state.
Parameters
Returns any our state for the connection to other
setConnectionState
Set connection state.
Parameters
other
Endpoint state
any for the connection to other
isConnected
Check connectivity.
Parameters
Returns boolean true if we are connected with other
connections
All connections
connections
Type: Map<Endpoint, any>
MultiSendEndpoint
Extends MultiConnectionEndpoint
Multiple Sending Endpoint.
Can hold several connections.
Back connections to any further endpoints will not be established
Parameters
isOut
We are always out
Returns boolean always true
ReceivableEndpoint
Extends Endpoint
Parameters
isIn
Returns boolean true is receive function is present
receive
Get the receive function.
Returns Function
receive
Set the receive function.
Parameters
ReceiveEndpointDefault
Extends ReceiveEndpoint
Receive Endpoint acting as a default endpoints.
isDefault
We are a default endpoint
Returns boolean always true
ReceiveEndpointSelfConnectedDefault
Extends ReceiveEndpointDefault
Receiving endpoint wich can also send to itself.
removeConnection
Actually stop the communication.
Parameters
other
Endpoint backpointer
boolean? true if this is the call form back call from the other side
ReceiveEndpoint
Extends MultiConnectionEndpoint
Receiving Endpoint.
Can receive from several endpoints.
By default a dummy rejecting receiver is assigned
Parameters
isIn
We are always in
Returns boolean always true
SendEndpointDefault
Extends SendEndpoint
Send Endpoint acting as a default endpoints.
isDefault
We are a default endpoint.
Returns boolean always true
SendEndpoint
Extends ReceivableEndpoint
Sending Endpoint.
Can only hold one connection.
Back connections to any further endpoints will not be established
Parameters
isOut
We are always out
Returns boolean always true
isIn
Always receiving.
Returns boolean true
install
With npm do:
npm install kronos-endpoint
license
BSD-2-Clause