Options
All
  • Public
  • Public/Protected
  • All
Menu

Class StorageService

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected _endpoint

_endpoint: string

Protected _socket

_socket: Socket

Methods

addRemoteServer

  • addRemoteServer(store: RemoteStorage, callback?: (error: Error | null) => void): Promise<void>

  • Add a remote storage server.

    Parameters

    • store: RemoteStorage

      the remote storage information object

    • Optional callback: (error: Error | null) => void

      the callback function

        • (error: Error | null): void

        • Parameters

          • error: Error | null

          Returns void

    Returns Promise<void>

configure

getRemoteServers

  • Retrieve a list of the currently registered remote storage servers.

    Parameters

    • Optional callback: (error: Error, storages?: RemoteStorage[]) => void

      the callback function

    Returns Promise<RemoteStorage[]>

getStatus

removeRemoteServer

  • removeRemoteServer(store: string | RemoteStorage, callback?: (error: Error | null, removed?: boolean) => void): Promise<void>

  • Remove a remote storage server. On success, the second callback argument will be true if and only if the remote storage existed before the call.

    Parameters

    • store: string | RemoteStorage

      the storage's AE title or the storage object.

    • Optional callback: (error: Error | null, removed?: boolean) => void

      the callback function

        • (error: Error | null, removed?: boolean): void

        • Parameters

          • error: Error | null
          • Optional removed: boolean

          Returns void

    Returns Promise<void>

start

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

  • 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>

  • 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