@kronos-integration/endpoint

kronos-endpoint

Named communication (end)-points inside of kronos

{:height="310pt" width="325pt"}

API

Table of Contents

• 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.

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

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

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})

  • options.includeRuntimeInfo boolean?

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.

toJSONWithOptions

Parameters

• options Object?

Returns Object

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

• other Endpoint

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<Endpoint>

addConnection

Parameters

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

removeConnection

Actually stop the communication.

Parameters

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

getConnectionState

Deliver state for a given connection.

Parameters

• other Endpoint

Returns ConnectionState

setConnectionState

Set state for a given connection.

Parameters

• other Endpoint
• state ConnectionState

didConnect

Parameters

• endpoint Endpoint
• other Endpoint

isEndpoint

Check for Endpoint.

Parameters

• object any to be checked

Returns boolean true if object is an Endpoint

instanciateInterceptors

Instanciate interceptors from its definitions.

Parameters

• interceptors (Array<Interceptor> | Array<string> | undefined)
• owner Object

Returns Array<Interceptor>

MultiConnectionEndpoint

Extends ReceivableEndpoint

Multiple connection endpoint. Can hold several connections.

Parameters

• name
• owner
• options

getConnectionState

Deliver connection state.

Parameters

• other Endpoint

Returns any our state for the connection to other

setConnectionState

Set connection state.

Parameters

• other Endpoint
• state any for the connection to other

removeConnection

Actually stop the communication.

Parameters

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

isConnected

Check connectivity.

Parameters

• other Endpoint

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

• 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

isOut

We are always out

Returns boolean always true

ReceivableEndpoint

Extends Endpoint

Parameters

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

isIn

Returns boolean true is receive function is present

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

• name string endpoint name

• owner Object of the endpoint (service)

• options Object

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

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

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

isOut

We are always out

Returns boolean always true

addConnection

Add a connection.

Parameters

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

removeConnection

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

isIn

Always receiving.

Returns boolean true

install

With npm do:

npm install kronos-endpoint

license

BSD-2-Clause