LocationService | @tmtsoftware/esw-ts

A Location Service Client API. This model provides promise based APIs for managing service registrations.

interface

Hierarchy

LocationService

Index

Methods

find

find(connection: Connection): Promise<Option<Location>>

- Defined in src/clients/location/LocationService.ts:64
Find a location for the given Connection.

Parameters
- connection: Connection
  
  The connection to be located
Returns Promise<Option<Location>>

Location as Promise if available

list

list(): Promise<Location[]>

- Defined in src/clients/location/LocationService.ts:24
List the registered components in location service.

Returns Promise<Location[]>

Location[] as Promise

listByComponentType

listByComponentType(componentType: ComponentType): Promise<Location[]>

- Defined in src/clients/location/LocationService.ts:32
List the registered components based on this component type.

Parameters
- componentType: ComponentType
  
  list components of this componentType
Returns Promise<Location[]>

Location[] as Promise

listByConnectionType

listByConnectionType(connectionType: ConnectionType): Promise<Location[]>

- Defined in src/clients/location/LocationService.ts:48
List the registered components based on the connection type.

Parameters
- connectionType: ConnectionType
  
  list components of this connection type
Returns Promise<Location[]>

Location[] as Promise

listByHostname

listByHostname(hostname: string): Promise<Location[]>

- Defined in src/clients/location/LocationService.ts:40
List the registered components based on the hostname. Hostname can be IP or URL.

Parameters
- hostname: string
  
  list components of this hostname
Returns Promise<Location[]>

Location[] as Promise

listByPrefix

listByPrefix(prefix: Prefix): Promise<Location[]>

- Defined in src/clients/location/LocationService.ts:56
List the registered components based on the prefix.

Parameters
- prefix: Prefix
  
  list components of this prefix
Returns Promise<Location[]>

Location[] as Promise

resolve

resolve(connection: Connection, within: number, unit: TimeUnit): Promise<Option<Location>>

- Defined in src/clients/location/LocationService.ts:83
Resolves the location for a connection, if not found waits for the event to arrive within specified time limit. Returns undefined if both failed.

Parameters
- connection: Connection
  
  The Connection to be located
- within: number
  
  Time within which the connection to be resolved
- unit: TimeUnit
  
  TimeUnit Ex: millis, seconds, hours, etc.
Returns Promise<Option<Location>>

Location as Promise if available

track

track(connection: Connection): (onEvent: (trackingEvent: TrackingEvent) => void, onError?: (error: ServiceError) => void, onClose?: () => void) => Subscription

- Defined in src/clients/location/LocationService.ts:95
Tracks the connection and send events for modification or removal of its location.

Parameters
- connection: Connection
  
  The Connection to be tracked
Returns (onEvent: (trackingEvent: TrackingEvent) => void, onError?: (error: ServiceError) => void, onClose?: () => void) => Subscription

Subscription which provides a handle to cancel the subscription
- - (onEvent: (trackingEvent: TrackingEvent) => void, onError?: (error: ServiceError) => void, onClose?: () => void): Subscription
  - Tracks the connection and send events for modification or removal of its location.
    
    Parameters
    - onEvent: (trackingEvent: TrackingEvent) => void
      
      A function which gets triggered whenever a tracking event is received
      - (trackingEvent: TrackingEvent): void
        
        A function which gets triggered whenever a tracking event is received
        
        Parameters
        
        trackingEvent: TrackingEvent
        
        Returns void
    - Optional onError: (error: ServiceError) => void
      
      a optional error callback which gets called on receiving error. it can be Parsing error or a Runtime error [for ex. Gateway exception]
      - (error: ServiceError): void
        
        a optional error callback which gets called on receiving error. it can be Parsing error or a Runtime error [for ex. Gateway exception]
        
        Parameters
        
        error: ServiceError
        
        Returns void
    - Optional onClose: () => void
      
      a optional close callback which gets called when the connection is closed.
      - (): void
        
        a optional close callback which gets called when the connection is closed.
        
        Returns void
    Returns Subscription
    
    Subscription which provides a handle to cancel the subscription

unregister

unregister(connection: Connection): Promise<"Done">

- Defined in src/clients/location/LocationService.ts:72
A secured API which unregisters a connection from the location service.

Parameters
- connection: Connection
  
  The connection to be unregistered
Returns Promise<"Done">

Done as Promise

Hierarchy

Index

Methods

Methods

find

Parameters

connection: Connection

Returns Promise<Option<Location>>

list

Returns Promise<Location[]>

listByComponentType

Parameters

componentType: ComponentType

Returns Promise<Location[]>

listByConnectionType

Parameters

connectionType: ConnectionType

Returns Promise<Location[]>

listByHostname

Parameters

hostname: string

Returns Promise<Location[]>

listByPrefix

Parameters

prefix: Prefix

Returns Promise<Location[]>

resolve

Parameters

connection: Connection

within: number

unit: TimeUnit

Returns Promise<Option<Location>>

track

Parameters

connection: Connection

Returns (onEvent: (trackingEvent: TrackingEvent) => void, onError?: (error: ServiceError) => void, onClose?: () => void) => Subscription

Parameters

onEvent: (trackingEvent: TrackingEvent) => void

Parameters

trackingEvent: TrackingEvent

Returns void

Optional onError: (error: ServiceError) => void

Parameters

error: ServiceError

Returns void

Optional onClose: () => void

Returns void

Returns Subscription

unregister

Parameters

connection: Connection

Returns Promise<"Done">