Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CoreServer

CoreServer extends OPCUAServer with all the features coming from the CoreAAS Information Model. Use this class instead of OPCUAServer of node-opcua to create your OPC UA Server supporting the Asset Administration Shell metamodel implemented in CoreAAS. example:

import { coreaasXmlFile, OPCUACertificateManager, nodesets, CoreServer } from "node-opcua-coreaas";
let xmlFiles = [nodesets.standard, coreaasXmlFile]
 let server = new CoreServer({
     nodeset_filename: xmlFiles,
     port: 4848,
     serverCertificateManager: new OPCUACertificateManager({
         automaticallyAcceptUnknownCertificate: true,
         rootFolder: path.join(__dirname, "../certs")
     })
 })

Hierarchy

  • OPCUAServer
    • CoreServer

Implements

  • ICertificateKeyPairProvider

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new CoreServer(options?: OPCUAServerOptions): CoreServer
  • Use the same parameters of OPCUAServer.

    Parameters

    • Optional options: OPCUAServerOptions

    Returns CoreServer

Properties

allowAnonymous

allowAnonymous: boolean

false if anonymouse connection are not allowed

capabilitiesForMDNS

capabilitiesForMDNS: string[]

certificateFile

certificateFile: string

coreaas

The extension part of the CoreServer providing all the methods to create instances of ObjectType coming from the CoreAAS information Model. Furthermore it provides access to Structured DataType Constructors and several utility methods. More details in CoreAASExtension.

discoveryServerEndpointUrl

discoveryServerEndpointUrl: string

endpoints

endpoints: OPCUAServerEndPoint[]

engine

engine: ServerEngine

maxAllowedSessionNumber

maxAllowedSessionNumber: number

the maximum number of concurrent sessions allowed on the server

maxConnectionsPerEndpoint

maxConnectionsPerEndpoint: number

the maximum number for concurrent connection per end point

Protected options

options: OPCUABaseServerOptions

privateKeyFile

privateKeyFile: string

Optional registerServerManager

registerServerManager: IRegisterServerManager

registerServerMethod

registerServerMethod: RegisterServerMethod

serverCertificateManager

serverCertificateManager: OPCUACertificateManager

serverInfo

serverInfo: ApplicationDescription

userCertificateManager

userCertificateManager: OPCUACertificateManager

userManager

userManager: UserManagerOptions

the user manager

Static MAX_SUBSCRIPTION

MAX_SUBSCRIPTION: number

the maximum number of subscription that can be created per server

Static fallbackSessionName

fallbackSessionName: string

Static makeServiceFault

makeServiceFault: makeServiceFault

Static registry

registry: ObjectRegistry

Static requestExactEndpointUrl

requestExactEndpointUrl: boolean

if requestExactEndpointUrl is set to true the server will only accept createSession that have a endpointUrl that strictly matches one of the provided endpoint. This mean that if the server expose a endpoint with url such as opc.tcp://MYHOSTNAME:1234, client will not be able to reach the server with the ip address of the server. requestExactEndpointUrl = true => emulates the Prosys Server behavior whereas requestExactEndpointUrl = false => emulates the Unified Automation behavior.

Accessors

buildInfo

  • get buildInfo(): BuildInfo
  • The server build info

    Returns BuildInfo

bytesRead

  • get bytesRead(): number
  • total number of bytes read by the server since startup

    Returns number

bytesWritten

  • get bytesWritten(): number
  • total number of bytes written by the server since startup

    Returns number

currentChannelCount

  • get currentChannelCount(): number
  • the number of connected channel on all existing end points

    Returns number

currentSessionCount

  • get currentSessionCount(): number
  • the number of sessions currently active

    Returns number

currentSubscriptionCount

  • get currentSubscriptionCount(): number
  • The number of active subscriptions from all sessions

    Returns number

initialized

  • get initialized(): boolean
  • true if the server has been initialized

    Returns boolean

isAuditing

  • get isAuditing(): boolean
  • is the server auditing ?

    Returns boolean

publishingIntervalCount

  • get publishingIntervalCount(): number
  • the publishing interval count

    Returns number

rejectedRequestsCount

  • get rejectedRequestsCount(): number
  • the number of request that have been rejected

    Returns number

rejectedSessionCount

  • get rejectedSessionCount(): number
  • the number of session activation requests that have been rejected

    Returns number

serverType

  • get serverType(): ApplicationType
  • The type of server

    Returns ApplicationType

sessionAbortCount

  • get sessionAbortCount(): number
  • the number of sessions that have been aborted

    Returns number

transactionsCount

  • get transactionsCount(): number
  • Number of transactions processed by the server since startup

    Returns number

Methods

Private _apply_on_SessionObject

  • _apply_on_SessionObject(ResponseClass: any, message: Message, channel: ServerSecureChannelLayer, action_to_perform: function): Promise<void>
  • ensure that action is performed on a valid session object,

    method

    _apply_on_SessionObject

    Parameters

    • ResponseClass: any

      the constructor of the response Class

    • message: Message
    • channel: ServerSecureChannelLayer
    • action_to_perform: function
        • (session: ServerSession, sendResponse: function, sendError: function): void | Promise<void>
        • Parameters

          • session: ServerSession
          • sendResponse: function
              • (response: Response): void
              • Parameters

                • response: Response

                Returns void

          • sendError: function
              • (statusCode: StatusCode): void
              • Parameters

                • statusCode: StatusCode

                Returns void

          Returns void | Promise<void>

    Returns Promise<void>

Private _apply_on_Subscription

  • _apply_on_Subscription(ResponseClass: any, message: Message, channel: ServerSecureChannelLayer, action_to_perform: function): Promise<void>
  • method

    _apply_on_Subscription

    Parameters

    • ResponseClass: any
    • message: Message
    • channel: ServerSecureChannelLayer
    • action_to_perform: function
        • (session: ServerSession, subscription: Subscription, sendResponse: function, sendError: function): Promise<void>
        • Parameters

          • session: ServerSession
          • subscription: Subscription
          • sendResponse: function
              • (response: Response): void
              • Parameters

                • response: Response

                Returns void

          • sendError: function
              • (statusCode: StatusCode): void
              • Parameters

                • statusCode: StatusCode

                Returns void

          Returns Promise<void>

    Returns Promise<void>

Private _apply_on_SubscriptionIds

  • _apply_on_SubscriptionIds<T>(ResponseClass: SetPublishingModeResponse | TransferSubscriptionsResponse | DeleteSubscriptionsResponse, message: Message, channel: ServerSecureChannelLayer, action_to_perform: function): void
  • method

    _apply_on_SubscriptionIds

    Type parameters

    • T

    Parameters

    • ResponseClass: SetPublishingModeResponse | TransferSubscriptionsResponse | DeleteSubscriptionsResponse
    • message: Message
    • channel: ServerSecureChannelLayer
    • action_to_perform: function
        • (session: ServerSession, subscriptionId: number): Promise<T>
        • Parameters

          • session: ServerSession
          • subscriptionId: number

          Returns Promise<T>

    Returns void

Private _apply_on_Subscriptions

  • _apply_on_Subscriptions(ResponseClass: SetPublishingModeResponse, message: Message, channel: ServerSecureChannelLayer, action_to_perform: function): void
  • method

    _apply_on_Subscriptions

    Parameters

    • ResponseClass: SetPublishingModeResponse
    • message: Message
    • channel: ServerSecureChannelLayer
    • action_to_perform: function
        • (session: ServerSession, subscription: Subscription): Promise<StatusCode>
        • Parameters

          • session: ServerSession
          • subscription: Subscription

          Returns Promise<StatusCode>

    Returns void

_get_endpoints

  • _get_endpoints(endpointUrl: string | null): EndpointDescription[]
  • Parameters

    • endpointUrl: string | null

    Returns EndpointDescription[]

Private _on_ActivateSessionRequest

  • _on_ActivateSessionRequest(message: Message, channel: ServerSecureChannelLayer): void
  • method

    _on_ActivateSessionRequest

    Parameters

    • message: Message
    • channel: ServerSecureChannelLayer

    Returns void

Protected _on_AddNodes

  • _on_AddNodes(message: Message, channel: ServerSecureChannelLayer): void
  • Parameters

    • message: Message
    • channel: ServerSecureChannelLayer

    Returns void

Protected _on_AddReferences

  • _on_AddReferences(message: Message, channel: ServerSecureChannelLayer): void
  • Parameters

    • message: Message
    • channel: ServerSecureChannelLayer

    Returns void

Private _on_BrowseNextRequest

  • _on_BrowseNextRequest(message: Message, channel: ServerSecureChannelLayer): void
  • method

    _on_BrowseNextRequest

    Parameters

    • message: Message
    • channel: ServerSecureChannelLayer

    Returns void

Private _on_BrowseRequest

  • _on_BrowseRequest(message: Message, channel: ServerSecureChannelLayer): void
  • method

    _on_BrowseRequest

    Parameters

    • message: Message
    • channel: ServerSecureChannelLayer

    Returns void

Protected _on_CallRequest

  • _on_CallRequest(message: Message, channel: ServerSecureChannelLayer): void
  • Parameters

    • message: Message
    • channel: ServerSecureChannelLayer

    Returns void

Protected _on_Cancel

  • _on_Cancel(message: Message, channel: ServerSecureChannelLayer): void
  • Parameters

    • message: Message
    • channel: ServerSecureChannelLayer

    Returns void

Private _on_CloseSessionRequest

  • _on_CloseSessionRequest(message: Message, channel: ServerSecureChannelLayer): void
  • method

    _on_CloseSessionRequest

    Parameters

    • message: Message
    • channel: ServerSecureChannelLayer

    Returns void

Protected _on_CreateMonitoredItemsRequest

  • _on_CreateMonitoredItemsRequest(message: Message, channel: ServerSecureChannelLayer): void
  • Parameters

    • message: Message
    • channel: ServerSecureChannelLayer

    Returns void

Protected _on_CreateSessionRequest

  • _on_CreateSessionRequest(message: Message, channel: ServerSecureChannelLayer): void
  • Parameters

    • message: Message
    • channel: ServerSecureChannelLayer

    Returns void

Protected _on_CreateSubscriptionRequest

  • _on_CreateSubscriptionRequest(message: Message, channel: ServerSecureChannelLayer): void
  • Parameters

    • message: Message
    • channel: ServerSecureChannelLayer

    Returns void

Protected _on_DeleteMonitoredItemsRequest

  • _on_DeleteMonitoredItemsRequest(message: Message, channel: ServerSecureChannelLayer): void
  • Parameters

    • message: Message
    • channel: ServerSecureChannelLayer

    Returns void

Protected _on_DeleteNodes

  • _on_DeleteNodes(message: Message, channel: ServerSecureChannelLayer): void
  • Parameters

    • message: Message
    • channel: ServerSecureChannelLayer

    Returns void

Protected _on_DeleteReferences

  • _on_DeleteReferences(message: Message, channel: ServerSecureChannelLayer): void
  • Parameters

    • message: Message
    • channel: ServerSecureChannelLayer

    Returns void

Protected _on_DeleteSubscriptionsRequest

  • _on_DeleteSubscriptionsRequest(message: Message, channel: ServerSecureChannelLayer): void
  • Parameters

    • message: Message
    • channel: ServerSecureChannelLayer

    Returns void

Private _on_FindServersRequest

  • _on_FindServersRequest(message: Message, channel: ServerSecureChannelLayer): void
  • Parameters

    • message: Message
    • channel: ServerSecureChannelLayer

    Returns void

Private _on_GetEndpointsRequest

  • _on_GetEndpointsRequest(message: Message, channel: ServerSecureChannelLayer): void
  • Parameters

    • message: Message
    • channel: ServerSecureChannelLayer

    Returns void

Protected _on_HistoryReadRequest

  • _on_HistoryReadRequest(message: Message, channel: ServerSecureChannelLayer): void
  • Parameters

    • message: Message
    • channel: ServerSecureChannelLayer

    Returns void

Protected _on_HistoryUpdate

  • _on_HistoryUpdate(message: Message, channel: ServerSecureChannelLayer): void
  • Parameters

    • message: Message
    • channel: ServerSecureChannelLayer

    Returns void

Protected _on_ModifyMonitoredItemsRequest

  • _on_ModifyMonitoredItemsRequest(message: Message, channel: ServerSecureChannelLayer): void
  • Parameters

    • message: Message
    • channel: ServerSecureChannelLayer

    Returns void

Protected _on_ModifySubscriptionRequest

  • _on_ModifySubscriptionRequest(message: Message, channel: ServerSecureChannelLayer): void
  • Parameters

    • message: Message
    • channel: ServerSecureChannelLayer

    Returns void

Protected _on_PublishRequest

  • _on_PublishRequest(message: Message, channel: ServerSecureChannelLayer): void
  • Parameters

    • message: Message
    • channel: ServerSecureChannelLayer

    Returns void

Protected _on_QueryFirst

  • _on_QueryFirst(message: Message, channel: ServerSecureChannelLayer): void
  • Parameters

    • message: Message
    • channel: ServerSecureChannelLayer

    Returns void

Protected _on_QueryNext

  • _on_QueryNext(message: Message, channel: ServerSecureChannelLayer): void
  • Parameters

    • message: Message
    • channel: ServerSecureChannelLayer

    Returns void

Protected _on_ReadRequest

  • _on_ReadRequest(message: Message, channel: ServerSecureChannelLayer): void
  • Parameters

    • message: Message
    • channel: ServerSecureChannelLayer

    Returns void

Protected _on_RegisterNodesRequest

  • _on_RegisterNodesRequest(message: Message, channel: ServerSecureChannelLayer): void
  • Parameters

    • message: Message
    • channel: ServerSecureChannelLayer

    Returns void

Protected _on_RepublishRequest

  • _on_RepublishRequest(message: Message, channel: ServerSecureChannelLayer): void
  • Parameters

    • message: Message
    • channel: ServerSecureChannelLayer

    Returns void

Protected _on_SetMonitoringModeRequest

  • _on_SetMonitoringModeRequest(message: Message, channel: ServerSecureChannelLayer): void
  • Parameters

    • message: Message
    • channel: ServerSecureChannelLayer

    Returns void

Protected _on_SetPublishingModeRequest

  • _on_SetPublishingModeRequest(message: Message, channel: ServerSecureChannelLayer): void
  • Parameters

    • message: Message
    • channel: ServerSecureChannelLayer

    Returns void

Protected _on_TransferSubscriptionsRequest

  • _on_TransferSubscriptionsRequest(message: Message, channel: ServerSecureChannelLayer): void
  • Parameters

    • message: Message
    • channel: ServerSecureChannelLayer

    Returns void

Protected _on_TranslateBrowsePathsToNodeIdsRequest

  • _on_TranslateBrowsePathsToNodeIdsRequest(message: Message, channel: ServerSecureChannelLayer): void
  • Parameters

    • message: Message
    • channel: ServerSecureChannelLayer

    Returns void

Protected _on_UnregisterNodesRequest

  • _on_UnregisterNodesRequest(message: Message, channel: ServerSecureChannelLayer): void
  • Parameters

    • message: Message
    • channel: ServerSecureChannelLayer

    Returns void

Protected _on_WriteRequest

  • _on_WriteRequest(message: Message, channel: ServerSecureChannelLayer): void
  • Parameters

    • message: Message
    • channel: ServerSecureChannelLayer

    Returns void

addListener

  • addListener(event: string | symbol, listener: function): this
  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

Protected computeServerSignature

  • computeServerSignature(channel: ServerSecureChannelLayer, clientCertificate: Certificate, clientNonce: Nonce): SignatureData | undefined
  • internal

    Parameters

    • channel: ServerSecureChannelLayer
    • clientCertificate: Certificate
    • clientNonce: Nonce

    Returns SignatureData | undefined

Protected createSession

  • createSession(options: any): ServerSession
  • create and register a new session

    internal

    Parameters

    • options: any

    Returns ServerSession

dispose

  • dispose(): void
  • Returns void

emit

  • emit(event: string | symbol, ...args: any[]): boolean
  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): Array<string | symbol>
  • Returns Array<string | symbol>

getCertificate

  • getCertificate(): Certificate
  • Returns Certificate

getCertificateChain

  • getCertificateChain(): Certificate
  • Returns Certificate

Protected getChannels

  • getChannels(): ServerSecureChannelLayer[]
  • returns a array of currently active channels

    Returns ServerSecureChannelLayer[]

getDiscoveryUrls

  • getDiscoveryUrls(): string[]
  • Returns string[]

getMaxListeners

  • getMaxListeners(): number
  • Returns number

getPrivateKey

  • getPrivateKey(): PrivateKeyPEM
  • Returns PrivateKeyPEM

getServers

  • getServers(channel: ServerSecureChannelLayer): ApplicationDescription[]
  • Parameters

    • channel: ServerSecureChannelLayer

    Returns ApplicationDescription[]

Protected getSession

  • getSession(authenticationToken: NodeId, activeOnly?: undefined | false | true): ServerSession | null
  • retrieve a session by authentication token

    internal

    Parameters

    • authenticationToken: NodeId
    • Optional activeOnly: undefined | false | true

    Returns ServerSession | null

initialize

  • initialize(): Promise<void>
  • initialize(done: function): void
  • Returns Promise<void>

  • Parameters

    • done: function
        • (): void
        • Returns void

    Returns void

Protected isUserAuthorized

  • isUserAuthorized(channel: ServerSecureChannelLayer, session: ServerSession, userIdentityToken: UserIdentityToken, callback: function): void
  • internal

    Parameters

    • channel: ServerSecureChannelLayer
    • session: ServerSession
    • userIdentityToken: UserIdentityToken
    • callback: function
        • (err: Error | null, isAuthorized?: undefined | false | true): void
        • Parameters

          • err: Error | null
          • Optional isAuthorized: undefined | false | true

          Returns void

    Returns void

Protected isValidUserIdentityToken

  • isValidUserIdentityToken(channel: ServerSecureChannelLayer, session: ServerSession, userIdentityToken: UserIdentityToken, userTokenSignature: any, endpointDescription: EndpointDescription, callback: function): void
  • internal

    Parameters

    • channel: ServerSecureChannelLayer
    • session: ServerSession
    • userIdentityToken: UserIdentityToken
    • userTokenSignature: any
    • endpointDescription: EndpointDescription
    • callback: function
        • (err: Error | null, statusCode?: StatusCode): void
        • Parameters

          • err: Error | null
          • Optional statusCode: StatusCode

          Returns void

    Returns void

Protected isValidUserNameIdentityToken

  • isValidUserNameIdentityToken(channel: ServerSecureChannelLayer, session: ServerSession, userTokenPolicy: any, userIdentityToken: UserNameIdentityToken, userTokenSignature: any, callback: function): void
  • Parameters

    • channel: ServerSecureChannelLayer
    • session: ServerSession
    • userTokenPolicy: any
    • userIdentityToken: UserNameIdentityToken
    • userTokenSignature: any
    • callback: function
        • (err: Error | null, statusCode?: StatusCode): void
        • Parameters

          • err: Error | null
          • Optional statusCode: StatusCode

          Returns void

    Returns void

Protected isValidX509IdentityToken

  • isValidX509IdentityToken(channel: ServerSecureChannelLayer, session: ServerSession, userTokenPolicy: any, userIdentityToken: X509IdentityToken, userTokenSignature: any, callback: function): void
  • Parameters

    • channel: ServerSecureChannelLayer
    • session: ServerSession
    • userTokenPolicy: any
    • userIdentityToken: X509IdentityToken
    • userTokenSignature: any
    • callback: function
        • (err: Error | null, statusCode?: StatusCode): void
        • Parameters

          • err: Error | null
          • Optional statusCode: StatusCode

          Returns void

    Returns void

listenerCount

  • listenerCount(event: string | symbol): number
  • Parameters

    • event: string | symbol

    Returns number

listeners

  • listeners(event: string | symbol): Function[]
  • Parameters

    • event: string | symbol

    Returns Function[]

Protected makeServerNonce

  • makeServerNonce(): Nonce
  • Returns Nonce

off

  • off(event: string | symbol, listener: function): this
  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

on

  • on(event: string | symbol, listener: function): this
  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

on_request

  • on_request(message: Message, channel: ServerSecureChannelLayer): void
  • Parameters

    • message: Message
    • channel: ServerSecureChannelLayer

    Returns void

once

  • once(event: string | symbol, listener: function): this
  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

Protected prepare

  • prepare(message: Message, channel: ServerSecureChannelLayer): void
  • Parameters

    • message: Message
    • channel: ServerSecureChannelLayer

    Returns void

prependListener

  • prependListener(event: string | symbol, listener: function): this
  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: function): this
  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

raiseEvent

  • raiseEvent(eventType: "AuditSessionEventType", options: RaiseEventAuditSessionEventData): void
  • raiseEvent(eventType: "AuditCreateSessionEventType", options: RaiseEventAuditCreateSessionEventData): void
  • raiseEvent(eventType: "AuditActivateSessionEventType", options: RaiseEventAuditActivateSessionEventData): void
  • raiseEvent(eventType: "AuditCreateSessionEventType", options: RaiseEventData): void
  • raiseEvent(eventType: "AuditConditionCommentEventType", options: RaiseEventAuditConditionCommentEventData): void
  • raiseEvent(eventType: "AuditUrlMismatchEventType", options: RaiseEventAuditUrlMismatchEventTypeData): void
  • raiseEvent(eventType: "TransitionEventType", options: RaiseEventTransitionEventData): void
  • internal

    Parameters

    • eventType: "AuditSessionEventType"
    • options: RaiseEventAuditSessionEventData

    Returns void

  • Parameters

    • eventType: "AuditCreateSessionEventType"
    • options: RaiseEventAuditCreateSessionEventData

    Returns void

  • Parameters

    • eventType: "AuditActivateSessionEventType"
    • options: RaiseEventAuditActivateSessionEventData

    Returns void

  • Parameters

    • eventType: "AuditCreateSessionEventType"
    • options: RaiseEventData

    Returns void

  • Parameters

    • eventType: "AuditConditionCommentEventType"
    • options: RaiseEventAuditConditionCommentEventData

    Returns void

  • Parameters

    • eventType: "AuditUrlMismatchEventType"
    • options: RaiseEventAuditUrlMismatchEventTypeData

    Returns void

  • Parameters

    • eventType: "TransitionEventType"
    • options: RaiseEventTransitionEventData

    Returns void

rawListeners

  • rawListeners(event: string | symbol): Function[]
  • Parameters

    • event: string | symbol

    Returns Function[]

removeAllListeners

  • removeAllListeners(event?: string | symbol): this
  • Parameters

    • Optional event: string | symbol

    Returns this

removeListener

  • removeListener(event: string | symbol, listener: function): this
  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

resumeEndPoints

  • resumeEndPoints(): Promise<void>
  • resumeEndPoints(callback: function): void
  • set all the end point into a state where they do accept connections note: this method is useful for testing purpose

    Returns Promise<void>

  • Parameters

    • callback: function
        • (err?: Error): void
        • Parameters

          • Optional err: Error

          Returns void

    Returns void

setMaxListeners

  • setMaxListeners(n: number): this
  • Parameters

    • n: number

    Returns this

shutdown

  • shutdown(timeout?: undefined | number): Promise<void>
  • shutdown(callback: function): void
  • shutdown(timeout: number, callback: function): void
  • shutdown all server endpoints

    method

    shutdown

    async
    example
       // shutdown immediately
       server.shutdown(function(err) {
       });
      // in typescript with promises
      server.shutdown(10000).then(()=>{
         console.log("Server has shutdown");
      });
       // shutdown within 10 seconds
       server.engine .shutdownReason = coerceLocalizedText("Shutdown for maintenance");
       server.shutdown(10000,function(err) {
       });

    Parameters

    • Optional timeout: undefined | number

      the timeout (in ms) before the server is actually shutdown

    Returns Promise<void>

  • Parameters

    • callback: function
        • (err?: Error): void
        • Parameters

          • Optional err: Error

          Returns void

    Returns void

  • Parameters

    • timeout: number
    • callback: function
        • (err?: Error): void
        • Parameters

          • Optional err: Error

          Returns void

    Returns void

shutdownChannels

  • shutdownChannels(): Promise<void>
  • shutdownChannels(callback: function): void
  • Returns Promise<void>

  • Parameters

    • callback: function
        • (err?: Error | null): void
        • Parameters

          • Optional err: Error | null

          Returns void

    Returns void

start

  • start(): Promise<void>
  • start(done: function): void
  • Initiate the server by starting all its endpoints

    async

    Returns Promise<void>

  • Parameters

    • done: function
        • (): void
        • Returns void

    Returns void

suspendEndPoints

  • suspendEndPoints(): Promise<void>
  • suspendEndPoints(callback: function): void
  • set all the end point into a state where they do not accept further connections

    note: this method is useful for testing purpose

    Returns Promise<void>

  • Parameters

    • callback: function
        • (err?: Error): void
        • Parameters

          • Optional err: Error

          Returns void

    Returns void

Protected userNameIdentityTokenAuthenticateUser

  • userNameIdentityTokenAuthenticateUser(channel: ServerSecureChannelLayer, session: ServerSession, userTokenPolicy: any, userIdentityToken: UserNameIdentityToken, callback: function): void
  • internal

    Parameters

    • channel: ServerSecureChannelLayer
    • session: ServerSession
    • userTokenPolicy: any
    • userIdentityToken: UserNameIdentityToken
    • callback: function
        • (err: Error | null, isAuthorized?: undefined | false | true): void
        • Parameters

          • err: Error | null
          • Optional isAuthorized: undefined | false | true

          Returns void

    Returns void

Protected verifyClientSignature

  • verifyClientSignature(session: ServerSession, channel: ServerSecureChannelLayer, clientSignature: SignatureData): boolean
  • internal

    Parameters

    • session: ServerSession
    • channel: ServerSecureChannelLayer
    • clientSignature: SignatureData

    Returns boolean

Generated using TypeDoc