Class NopeRpcManager<T>

A Dispatcher to perform a function on a Remote Dispatcher. Therefore a Task is created and forwarded to the remote.

For a detailled description please checkout INopeRpcManager

Export

Type Parameters

T extends IServiceOptions = IServiceOptions

Hierarchy

NopeRpcManager

Implements

INopeRpcManager

Constructors

constructor

new NopeRpcManager<T>(options, _generateObservable, _defaultSelector, _id?, _connectivityManager?): NopeRpcManager<T>
Creates an instance of NopeRpcManager.
Type Parameters
- T extends IServiceOptions<any, T> = IServiceOptions<any>
Parameters
- options: INopeDispatcherOptions
  
  The Options, used by the rpc-manager.
- _generateObservable: (<T>() => INopeObservable<T, T, T, IEventAdditionalData>)
  
  helper to generate an nope observable. might be used to replace the default observable.
  - - <T>(): INopeObservable<T, T, T, IEventAdditionalData>
    - Type Parameters
      
      T
      
      Returns INopeObservable<T, T, T, IEventAdditionalData>
- _defaultSelector: ValidSelectorFunction
  
  Default selector see performCall
- Optional _id: string = null
  
  A Provided a for the rpc-manager
- Optional _connectivityManager: INopeConnectivityManager = null
  
  A INopeConnectivityManager used to listen for new and dead dispatchers
Returns NopeRpcManager<T>
- Defined in lib/dispatcher/RpcManager/NopeRpcManager.ts:196

Properties

methodInterface

methodInterface: {
[index: string]: (<T>(...args) => INopePromise<T>);
}

Proxy for accessing the Methods. This proxy provides additional options, which can be used to detail the calls.

Author

M.Karkowski

Memberof

NopeRpcManager

Type declaration

[index: string]: (<T>(...args) => INopePromise<T>)
- - <T>(...args): INopePromise<T>
  - Type Parameters
    - T
    Parameters
    - Rest ...args: any
    Returns INopePromise<T>

methodInterfaceWithOptions

methodInterfaceWithOptions: {
[index: string]: (<T>(options, ...args) => INopePromise<T>);
}

Proxy for accessing the Methods. This proxy provides additional options, which can be used to detail the calls.

Author

M.Karkowski

Memberof

NopeRpcManager

Type declaration

[index: string]: (<T>(options, ...args) => INopePromise<T>)
- - <T>(options, ...args): INopePromise<T>
  - Type Parameters
    - T
    Parameters
    - options: Partial<ICallOptions>
    - Rest ...args: any
    Returns INopePromise<T>

`Readonly` onCancelTask

onCancelTask: INopeEventEmitter<ITaskCancelationMsg, ITaskCancelationMsg, ITaskCancelationMsg, IEventAdditionalData>

An event Emitter, which will be called when a task is getting canceled.

Author

M.Karkowski

Memberof

NopeRpcManager

options

options: INopeDispatcherOptions

The Options, used by the rpc-manager.

`Readonly` ready

ready: INopeObservable<boolean, boolean, boolean, IEventAdditionalData>

Flag to indicate, that the system is ready.

Author

M.Karkowski

Memberof

NopeRpcManager

`Readonly` services

services: IMapBasedMergeData<string, IAvailableServicesMsg, string, T>

Element showing the available services. Its more or less a map, that maps the services with their dispatchers.

OriginalKey = Dispatcher ID (string)
OriginalValue = Original Message (IAvailableServicesMsg)
ExtractedKey = Function ID (string);`
ExtractedValue = FunctionOptions (T)

Author

M.Karkowski

Memberof

INopeRpcManager

Methods

adaptServiceId

adaptServiceId(name): string
Parameters
- name: string
Returns string
- Defined in lib/dispatcher/RpcManager/NopeRpcManager.ts:801

cancelRequestedTasksOfDispatcher

cancelRequestedTasksOfDispatcher(dispatcher, reason): Promise<void>
Helper to cancel all Tasks which have been requested by a Dispatcher.

Author
M.Karkowski

Memberof
NopeRpcManager
Parameters
- dispatcher: string
- reason: Error
Returns Promise<void>
- Defined in lib/dispatcher/RpcManager/NopeRpcManager.ts:695

cancelRunningTasksOfDispatcher

cancelRunningTasksOfDispatcher(dispatcher, reason): Promise<void>
Cancels all Tasks of the given Dispatcher. see cancelTask

Author
M.Karkowski

Memberof
NopeRpcManager
Parameters
- dispatcher: string
- reason: Error
Returns Promise<void>
Implementation of INopeRpcManager.cancelRunningTasksOfDispatcher
- Defined in lib/dispatcher/RpcManager/NopeRpcManager.ts:722

cancelTask

cancelTask(taskId, reason, quiet?): Promise<boolean>
Function to cancel an indivual Task. This might be the case, if a connection to a specific dispatcher is lost or might have a user-based reason.

Returns
Flag, that indicates, whether cancelation was sucessfull or not.

Memberof
nopeDispatcher
Parameters
- taskId: string
  
  The Id of the Task. Which should be canceled.
- reason: Error
  
  The Reason, why the Task should be canceled (In general shoudl be something meaning full)
- quiet: boolean = false
Returns Promise<boolean>
Implementation of INopeRpcManager.cancelTask
- Defined in lib/dispatcher/RpcManager/NopeRpcManager.ts:621

clearTasks

clearTasks(): void
Function to clear all pending tasks

Memberof
nopeDispatcher

Returns void
Implementation of INopeRpcManager.clearTasks
- Defined in lib/dispatcher/RpcManager/NopeRpcManager.ts:1100

dispose

dispose(): Promise<void>
Disposes the StatusManager and thereby,

Author
M.Karkowski

Returns

Memberof
INopeRpcManager

Returns Promise<void>
Implementation of INopeRpcManager.dispose
- Defined in lib/dispatcher/RpcManager/NopeRpcManager.ts:1139

isProviding

isProviding(id): boolean
Simple checker, to test, if this rpc-mananger is providing a service with the given id.

Returns
The result
Parameters
- id: string
  
  The id of the service, which is used during registration
Returns boolean
Implementation of INopeRpcManager.isProviding
- Defined in lib/dispatcher/RpcManager/NopeRpcManager.ts:757

performCall

performCall<T>(serviceName, params, options?): INopePromise<T, any>
Function which is used to perform a call on the remote. Please see performCall for more Info.
Type Parameters
- T
Parameters
- serviceName: string | string[]
- params: unknown[]
- Optional options: ValidCallOptions | ValidCallOptions[]
Returns INopePromise<T, any>
Implementation of INopeRpcManager.performCall
- Defined in lib/dispatcher/RpcManager/NopeRpcManager.ts:1068

registerService

registerService(func, options): Promise<((...args) => Promise<any>)>
Function to register a Function in the Dispatcher

Returns
The registered Function

Memberof
nopeDispatcher
Parameters
- func: ((...args) => Promise<any>)
  
  The function which should be called if a request is mapped to the Function.
  - - (...args): Promise<any>
    - Parameters
      
      Rest ...args: any[]
      
      Returns Promise<any>
- options: {
  addNopeServiceIdPrefix?: boolean;
  } & T
  
  Options to enhance the registered ID and enabling unregistering the Element after calling it.
Returns Promise<((...args) => Promise<any>)>
Implementation of INopeRpcManager.registerService
- Defined in lib/dispatcher/RpcManager/NopeRpcManager.ts:821

removeDispatcher

removeDispatcher(dispatcher): void
Helper to remove a dispatcher. This leads to closing all open task related to this dispatcher -> Exceptions should be thrown. Additional, internal task, requested by the dispatcher will be canceled.

Author
M.Karkowski

Memberof
NopeRpcManager
Parameters
- dispatcher: string
Returns void
Implementation of INopeRpcManager.removeDispatcher
- Defined in lib/dispatcher/RpcManager/NopeRpcManager.ts:591

reset

reset(): void
Function to reset the Dispatcher.

Memberof
nopeDispatcher

Returns void
Implementation of INopeRpcManager.reset
- Defined in lib/dispatcher/RpcManager/NopeRpcManager.ts:1129

serviceExists

serviceExists(id): boolean
Function to test if a specific Service exists.

Returns
The result of the Test. True if either local or remotly a service is known.

Memberof
nopeDispatcher
Parameters
- id: string
  
  The Id of the Serivce
Returns boolean
Implementation of INopeRpcManager.serviceExists
- Defined in lib/dispatcher/RpcManager/NopeRpcManager.ts:747

toDescription

toDescription(): {
    services: {
        all: T[];
        internal: {
            func: ((...args) => Promise<any>);
            options: T;
        }[];
    };
    task: {
        executing: string[];
        requested: {
            id: string;
            service: string;
            target: string;
            timeout: any;
        }[];
    };
}
Describes the Data.

Returns

Returns {
    services: {
        all: T[];
        internal: {
            func: ((...args) => Promise<any>);
            options: T;
        }[];
    };
    task: {
        executing: string[];
        requested: {
            id: string;
            service: string;
            target: string;
            timeout: any;
        }[];
    };
}
- services: {
      all: T[];
      internal: {
          func: ((...args) => Promise<any>);
          options: T;
      }[];
  }
  - all: T[]
  - internal: {
    func: ((...args) => Promise<any>);
    options: T;
    }[]
- task: {
      executing: string[];
      requested: {
          id: string;
          service: string;
          target: string;
          timeout: any;
      }[];
  }
  - executing: string[]
  - requested: {
        id: string;
        service: string;
        target: string;
        timeout: any;
    }[]
Implementation of INopeRpcManager.toDescription
- Defined in lib/dispatcher/RpcManager/NopeRpcManager.ts:1148

unregisterAll

unregisterAll(): void
Function to unregister all Functions of the Dispatcher.

Memberof
nopeDispatcher

Returns void
Implementation of INopeRpcManager.unregisterAll
- Defined in lib/dispatcher/RpcManager/NopeRpcManager.ts:1111

unregisterService

unregisterService(func): Promise<boolean>
Function to unregister a Function from the Dispatcher

Returns
Flag, whether the element was removed (only if found) or not.

Memberof
nopeDispatcher
Parameters
- func: string | ((...args) => void)
  
  The Function to unregister
Returns Promise<boolean>
Implementation of INopeRpcManager.unregisterService
- Defined in lib/dispatcher/RpcManager/NopeRpcManager.ts:780

updateDispatcher

updateDispatcher(msg): void
Function, which will be called, if an dispatcher is updated. This may leads to service that has been removed or added. This change emitted on see services

Author
M.Karkowski

Memberof
NopeRpcManager
Parameters
- msg: IAvailableServicesMsg
  
  The Update Message see IAvailableServicesMsg
Returns void
Implementation of INopeRpcManager.updateDispatcher
- Defined in lib/dispatcher/RpcManager/NopeRpcManager.ts:278

Class NopeRpcManager<T>

Export

Type Parameters

T extends IServiceOptions = IServiceOptions

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

T extends IServiceOptions<any, T> = IServiceOptions<any>

Parameters

options: INopeDispatcherOptions

_generateObservable: (<T>() => INopeObservable<T, T, T, IEventAdditionalData>)

Type Parameters

T

Returns INopeObservable<T, T, T, IEventAdditionalData>

_defaultSelector: ValidSelectorFunction

Optional _id: string = null

Optional _connectivityManager: INopeConnectivityManager = null

Returns NopeRpcManager<T>

Properties

methodInterface

Author

Memberof

Type declaration

[index: string]: (<T>(...args) => INopePromise<T>)

Type Parameters

T

Parameters

Rest ...args: any

Returns INopePromise<T>

methodInterfaceWithOptions

Author

Memberof

Type declaration

[index: string]: (<T>(options, ...args) => INopePromise<T>)

Type Parameters

T

Parameters

options: Partial<ICallOptions>

Rest ...args: any

Returns INopePromise<T>

Readonly onCancelTask

Author

Memberof

options

Readonly ready

Author

Memberof

Readonly services

Author

Memberof

Methods

adaptServiceId

Parameters

name: string

Returns string

cancelRequestedTasksOfDispatcher

Author

Memberof

Parameters

dispatcher: string

reason: Error

Returns Promise<void>

cancelRunningTasksOfDispatcher

Author

Memberof

Parameters

dispatcher: string

reason: Error

Returns Promise<void>

cancelTask

Returns

Memberof

Parameters

taskId: string

`Optional` _id: string = null

`Optional` _connectivityManager: INopeConnectivityManager = null

`Rest` ...args: any

`Rest` ...args: any

`Readonly` onCancelTask

`Readonly` ready

`Readonly` services

`Optional` options: ValidCallOptions | ValidCallOptions[]

`Rest` ...args: any[]

options: {
addNopeServiceIdPrefix?: boolean;
} & T

Returns {
services: {
all: T[];
internal: {
func: ((...args) => Promise<any>);
options: T;
}[];
};
task: {
executing: string[];
requested: {
id: string;
service: string;
target: string;
timeout: any;
}[];
};
}

services: {
all: T[];
internal: {
func: ((...args) => Promise<any>);
options: T;
}[];
}

internal: {
func: ((...args) => Promise<any>);
options: T;
}[]

task: {
executing: string[];
requested: {
id: string;
service: string;
target: string;
timeout: any;
}[];
}

requested: {
id: string;
service: string;
target: string;
timeout: any;
}[]