kronos-endpoint

Named communication (end)-points inside of kronos

!request forwarding{:height="310pt" width="325pt"}

API

$3

* DummyReceiveEndpoint
* receive
* isIn
* isOpen
* isDummy
* ConnectionState
* Endpoint
* Parameters
* displayName
* isDefault
* isDummy
* toStringAttributes
* connectionNamesWithStates
* Parameters
* isIn
* isOut
* direction
* jsonAttributes
* toJSONWithOptions
* Parameters
* hasInterceptors
* connectable
* Parameters
* hasConnections
* isConnected
* Parameters
* openConnection
* Parameters
* closeConnection
* Parameters
* openConnections
* closeConnections
* connections
* addConnection
* Parameters
* removeConnection
* Parameters
* getConnectionState
* Parameters
* setConnectionState
* Parameters
* didConnect
* Parameters
* isEndpoint
* Parameters
* instanciateInterceptors
* Parameters
* MultiConnectionEndpoint
* Parameters
* getConnectionState
* Parameters
* setConnectionState
* Parameters
* removeConnection
* Parameters
* isConnected
* Parameters
* connections
* connections
* MultiSendEndpoint
* Parameters
* isOut
* ReceivableEndpoint
* Parameters
* isIn
* ReceiveEndpointDefault
* isDefault
* ReceiveEndpointSelfConnectedDefault
* removeConnection
* Parameters
* ReceiveEndpoint
* Parameters
* isIn
* SendEndpointDefault
* isDefault
* SendEndpoint
* Parameters
* isOut
* addConnection
* Parameters
* removeConnection
* Parameters
* SendReceiveEndpoint
* isIn

DummyReceiveEndpoint

Extends Endpoint

Dummy endpoints are used during construction of the endpoint mesh.
The will be replaces by real endpoints during the resolving phase.

$3

dummy does nothing by intention.

$3

Returns boolean true

$3

Returns boolean true

$3

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.

$3

* name string endpoint name
* owner Object of the endpoint (service)
* options Object

$3

Name as presented for humans.

Returns string

$3

Indicate whatever we are a default endpoint.
Default means buildin.

Returns boolean false

$3

Indicate whatever we are a dummy endpoint.
Dummy endpoints are used duiring construction of the endpoint mesh.

Returns boolean false

$3

Mapping of properties used in toString.

Returns Object

$3

#### Parameters

* options Object (optional, default {includeRuntimeInfo:true})

* options.includeRuntimeInfo boolean?

$3

Returns boolean false

$3

Returns boolean false

$3

Deliver data flow direction.

Returns (string | undefined) delivers data flow direction 'in', 'out', 'inout' or undefined

$3

Additional attributes to present in json output.

$3

#### Parameters

* options Object?

Returns Object

$3

Returns boolean true if there is at least one interceptor assigned

$3

Can we form a connection to the other side.
in to out and out to in.

#### Parameters

* other Endpoint

Returns boolean true if we can be connected to the other endpoint

$3

Returns boolean true if there is at least one connection

$3

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

$3

Actually start with the communication.

#### Parameters

* other Endpoint
* backpointer boolean? true if this is the call from back call from the other side

$3

Actually stop the communication.

#### Parameters

* other Endpoint
* backpointer boolean? true if this is the call from back call from the other side

$3

Opens all connections.

$3

Closes all connections.

$3

Returns Iterable<Endpoint>

$3

#### Parameters

* connection Endpoint
* backpointer boolean? true if this is the call form back call from the other side

$3

Actually stop the communication.

#### Parameters

* other Endpoint
* backpointer boolean? true if this is the call form back call from the other side

$3

Deliver state for a given connection.

#### Parameters

* other Endpoint

Returns ConnectionState

$3

Set state for a given connection.

#### Parameters

* other Endpoint
* state ConnectionState

$3

#### Parameters

* endpoint Endpoint
* other Endpoint

isEndpoint

Check for Endpoint.

$3

* object any to be checked

Returns boolean true if object is an Endpoint

instanciateInterceptors

Instanciate interceptors from its definitions.

$3

* interceptors (Array\ | Array<string> | undefined)
* owner Object

Returns Array\

MultiConnectionEndpoint

Extends ReceivableEndpoint

Multiple connection endpoint.
Can hold several connections.

$3

* name
* owner
* options

$3

Deliver connection state.

#### Parameters

* other Endpoint

Returns any our state for the connection to other

$3

Set connection state.

#### Parameters

* other Endpoint
* state any for the connection to other

$3

Actually stop the communication.

#### Parameters

* other Endpoint
* backpointer boolean?? true if this is the call form back call from the other side

$3

Check connectivity.

#### Parameters

* other Endpoint

Returns boolean true if we are connected with other

$3

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

$3

* name string endpoint name
* owner Object of the endpoint (service)
* options Object

* options.connected Endpoint? where te requests are delivered to
* options.didConnect Function? called after receiver is present

$3

We are always out

Returns boolean always true

ReceivableEndpoint

Extends Endpoint

$3

* name string endpoint name
* owner Object of the endpoint (service)
* options Object

$3

Returns boolean true is receive function is present

ReceiveEndpointDefault

Extends ReceiveEndpoint

Receive Endpoint acting as a default endpoints.

$3

We are a default endpoint

Returns boolean always true

ReceiveEndpointSelfConnectedDefault

Extends ReceiveEndpointDefault

Receiving endpoint wich can also send to itself.

$3

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

$3

* name string endpoint name
* owner Object of the endpoint (service)
* options Object

* options.receive Function? reciever function
* options.connected Endpoint? sending side

$3

We are always in

Returns boolean always true

SendEndpointDefault

Extends SendEndpoint

Send Endpoint acting as a default endpoints.

$3

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

$3

* name string endpoint name
* owner Object of the endpoint (service)
* options Object

$3

We are always out

Returns boolean always true

$3

Add a connection.

#### Parameters

* other Endpoint
* backpointer boolean? true if this is the call form back call from the other side

$3

Actually stop the communication.

#### Parameters

* other Endpoint
* backpointer boolean? true if this is the call form back call from the other side

SendReceiveEndpoint

Extends SendEndpoint

bi directional endpint

$3

Always receiving.

Returns boolean true

install

With npm do:

``shell
npm install kronos-endpoint
``

license

BSD-2-Clause