Class BaseService

Hierarchy

BaseService
- StorageService
- QueryRetrieveService

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new BaseService(socket: Socket, endpoint: string): BaseService

- Defined in service.ts:74
Parameters
- socket: Socket
- endpoint: string
Returns BaseService

Properties

Protected _endpoint

_endpoint: string

Protected _socket

_socket: Socket

Methods

configure

configure(config: ServiceConfiguration, callback?: (error: Error | null, outcome: ServiceChangeOutcome | undefined) => void): Promise<ServiceChangeOutcome>

- Defined in service.ts:96
Define the base configurations of this service.

Parameters
- config: ServiceConfiguration
  
  a set of properties to configure
- Optional callback: (error: Error | null, outcome: ServiceChangeOutcome | undefined) => void
  
  the callback function
  - - (error: Error | null, outcome: ServiceChangeOutcome | undefined): void
    - Parameters
      - error: Error | null
      - outcome: ServiceChangeOutcome | undefined
      Returns void
Returns Promise<ServiceChangeOutcome>

getStatus

getStatus(callback?: (error: Error | null, conf?: ServiceStatus) => void): Promise<ServiceStatus>

- Defined in service.ts:85
Obtain information about this DICOM service.

Parameters
- Optional callback: (error: Error | null, conf?: ServiceStatus) => void
  
  the callback function
  - - (error: Error | null, conf?: ServiceStatus): void
    - Parameters
      - error: Error | null
      - Optional conf: ServiceStatus
      Returns void
Returns Promise<ServiceStatus>

start

start(callback?: (error: Error | null) => void): Promise<void>

- Defined in service.ts:107
Start the DICOM service.

Parameters
- Optional callback: (error: Error | null) => void
  
  the callback function
  - - (error: Error | null): void
    - Parameters
      - error: Error | null
      Returns void
Returns Promise<void>

stop

stop(callback?: (error: Error | null) => void): Promise<void>

- Defined in service.ts:116
Stop the DICOM service.

Parameters
- Optional callback: (error: Error | null) => void
  
  the callback function
  - - (error: Error | null): void
    - Parameters
      - error: Error | null
      Returns void
Returns Promise<void>

Generated using TypeDoc