Class CallerPort<A, R>

A caller port sends arguments of type T and receives a response of type R.

Type Parameters

  • A
  • R

Hierarchy (view full)

Implements

Constructors

constructor

Properties

_key manager reactions receivers remotePort runtime tag value pathSeparator

Methods

_getContainer _getFullyQualifiedName _getName _isContainedBy _isContainedByContainerOf _isRegistered _linkToRuntimeObject _receiveRuntimeObject get getContainer getManager invoke isPresent set toString keyOfMatchingBank keyOfMatchingEntry keyOfMatchingMultiport

Constructors

constructor

Properties

Protected_key

_key: symbol = ...

A symbol that identifies this component, and it also used to selectively grant access to its privileged functions.

Protectedmanager

manager: TriggerManager = ...

Protectedreactions

reactions: Set<Reaction<Variable[]>> = ...

Reactions to trigger.

Protectedreceivers

receivers: Set<WritablePort<R>> = ...

remotePort

remotePort: undefined | CalleePort<A, R>

Protectedruntime

runtime: Runtime

Protectedtag

tag: undefined | Tag

The tag associated with this port's value, or undefined is there is none.

Protectedvalue

value: undefined | R

The current value associated with this port.

StaticpathSeparator

pathSeparator: string = "."

Methods

Protected_getContainer

_getFullyQualifiedName

  • _getFullyQualifiedName(): string

  • Return a string that identifies this component. The name is a path constructed as [App]/[..]/[Container]/[This].

    Returns string

_getName

  • _getName(): string

  • Return a string that identifies this component within its container. If no such string was found, return the name of the constructor.

    Returns string

_isContainedBy

  • _isContainedBy(reactor): boolean

  • Confirm whether or not this component is contained by the given reactor.

    Parameters

    • reactor: Reactor

      The presumptive container of this component.

    Returns boolean

_isContainedByContainerOf

  • _isContainedByContainerOf(reactor): boolean

  • Confirm whether or not this component is contained by the container of the given reactor.

    Parameters

    • reactor: Reactor

      The container presumptive container of the container of this component.

    Returns boolean

_isRegistered

  • _isRegistered(): boolean

  • Report whether this component has been registered with its container or not. In principle, all components should have a container, but at the time of their construction there is a brief period where they are not. This is the only moment that a component is allowed register with its container.

    Returns boolean

Protected_linkToRuntimeObject

  • _linkToRuntimeObject(): void

  • Request the container to pass down its runtime object to this component. This function is to be called once and only once upon the construction of an object that subclasses Component. If it is called more than once a runtime error results.

    Returns void

_receiveRuntimeObject

get

getContainer

getManager

invoke

  • invoke(value): undefined | R

  • Parameters

    • value: A

    Returns undefined | R

isPresent

  • isPresent(): boolean

  • Returns true if the connected port's value has been set; false otherwise

    Returns boolean

set

toString

  • toString(): string

  • Returns a string representation of an object.

    Returns string

StatickeyOfMatchingBank

StatickeyOfMatchingEntry

  • keyOfMatchingEntry(component, object): string

  • Given a component and its container (the global object if the component is an App), return the key of the entry that matches the component.

    Parameters

    • component: Component

      a component of which the object is assumed to be its container

    • object: object

      the assumed container of the component

    Returns string

    the key of the entry that matches the component

StatickeyOfMatchingMultiport

  • keyOfMatchingMultiport(port, reactor): string

  • Given a port and its containing reactor, return the key of the entry that matches a multiport found in the reactor that matches the port.

    Parameters

    • port: Component

      a port that is assumed to be a constituent of a multiport declared on the given reactor

    • reactor: Reactor

      a reactor that is assumed to have a multiport of which one of the constituents is the given port

    Returns string

    an identifier for the port based on its location in a matching multiport

Settings

Member Visibility

On This Page

Constructors
Properties
Methods