Class StubOptions

Options for stub which is associated with a service.

Hierarchy

StubOptions
- StubOptions

Index

Constructors

Accessors

distSystemName managerNumber managerType replica serviceHostingType

Methods

withGlobalService withManagerSpecificService

Constructors

constructor

new StubOptions(): StubOptions
Creates an instance of VrpcStubOptions.

Returns StubOptions
Overrides StubOptions.constructor

Accessors

distSystemName

get distSystemName(): string
The name of the system where the service is hosted.

Returns string
Remarks
Empty string means the local system.

Inherited from StubOptions.distSystemName

managerNumber

get managerNumber(): number
The number of the manager which is hosting the service.

Returns number
Remarks
The property is only relevant if the service is manager-specific.

Inherited from StubOptions.managerNumber

managerType

get managerType(): number
The type of the manager which is hosting the service.

Returns number
Remarks
The property is only relevant if the service is manager-specific.

Inherited from StubOptions.managerType

replica

get replica(): ServiceHostingReplica
The replica of the manager which is hosting the service.

Returns ServiceHostingReplica
Remarks
The replica is only relevant for manager-specific services hosted in non-redundant managers in redundant projects.

Inherited from StubOptions.replica

serviceHostingType

get serviceHostingType(): ServiceHostingType
The hosting type of the service.

Returns ServiceHostingType
Remarks
Determines how the service is hosted (e.g. global or manager-specific).

Inherited from StubOptions.serviceHostingType

Methods

withGlobalService

withGlobalService(): void
Associates the stub with a global service.

Returns void
Inherited from StubOptions.withGlobalService

withManagerSpecificService

withManagerSpecificService(
    managerType: number,
    managerNumber: number,
    replica?: ServiceHostingReplica,
): void
Associates the stub with a manager-specific service.
Parameters
- managerType: number
  The service hosting manager type.
- managerNumber: number
  The service hosting manager number.
- Optionalreplica: ServiceHostingReplica
  The service hosting manager replica, for identifying a non-redundant manager in a redundant systems. The replica is only relevant for manager-specific services hosted in non-redundant managers in redundant projects.
Returns void
Inherited from StubOptions.withManagerSpecificService