OPCUAServerEndPoint | NodeOPCUA reference documentation

OPCUAServerEndPoint a Server EndPoint. A sever end point is listening to one port note: see OPCUA Release 1.03 part 4 page 108 7.1 ApplicationDescription

Hierarchy

EventEmitter
- OPCUAServerEndPoint

Implements

ServerSecureChannelParent

Index

Constructors

constructor

Properties

Accessors

Constructors

constructor

new OPCUAServerEndPoint(options: OPCUAServerEndPointOptions): OPCUAServerEndPoint

- Defined in packages/node-opcua-server/dist/server_end_point.d.ts:91
Parameters
- options: OPCUAServerEndPointOptions
Returns OPCUAServerEndPoint

Properties

Optional _on_close_channel

_on_close_channel: (channel: ServerSecureChannelLayer) => void

Type declaration

- (channel: ServerSecureChannelLayer): void
- Parameters
  - channel: ServerSecureChannelLayer
  Returns void

Optional _on_connectionRefused

_on_connectionRefused: (socketData: any) => void

Type declaration

- (socketData: any): void
- Parameters
  - socketData: any
  Returns void

Optional _on_new_channel

_on_new_channel: (channel: ServerSecureChannelLayer) => void

Type declaration

- (channel: ServerSecureChannelLayer): void
- Parameters
  - channel: ServerSecureChannelLayer
  Returns void

Optional _on_openSecureChannelFailure

_on_openSecureChannelFailure: (socketData: any, channelData: any) => void

Type declaration

- (socketData: any, channelData: any): void
- Parameters
  - socketData: any
  - channelData: any
  Returns void

bytesReadInOldChannels

bytesReadInOldChannels: number

bytesWrittenInOldChannels

bytesWrittenInOldChannels: number

certificateManager

certificateManager: OPCUACertificateManager

defaultSecureTokenLifetime

defaultSecureTokenLifetime: number

maxConnections

maxConnections: number

objectFactory

objectFactory: any

port

port: number

the tcp port

securityTokenCountOldChannels

securityTokenCountOldChannels: number

serverInfo

serverInfo: ApplicationDescription

timeout

timeout: number

transactionsCountOldChannels

transactionsCountOldChannels: number

Readonly Static captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

defaultMaxListeners: number

Readonly Static errorMonitor

errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Accessors

activeChannelCount

get activeChannelCount(): number

- Defined in packages/node-opcua-server/dist/server_end_point.d.ts:150
Returns number

bytesRead

get bytesRead(): number

- Defined in packages/node-opcua-server/dist/server_end_point.d.ts:147
Returns number

bytesWritten

get bytesWritten(): number

- Defined in packages/node-opcua-server/dist/server_end_point.d.ts:146
Returns number

currentChannelCount

get currentChannelCount(): number

- Defined in packages/node-opcua-server/dist/server_end_point.d.ts:111
The number of active channel on this end point.

Returns number

securityTokenCount

get securityTokenCount(): number

- Defined in packages/node-opcua-server/dist/server_end_point.d.ts:149
Returns number

transactionsCount

get transactionsCount(): number

- Defined in packages/node-opcua-server/dist/server_end_point.d.ts:148
Returns number

Methods

abruptlyInterruptChannels

abruptlyInterruptChannels(): void

- Defined in packages/node-opcua-server/dist/server_end_point.d.ts:134
Returns void

addEndpointDescription

addEndpointDescription(securityMode: MessageSecurityMode, securityPolicy: SecurityPolicy, options?: EndpointDescriptionParams): void

- Defined in packages/node-opcua-server/dist/server_end_point.d.ts:119
Parameters
- securityMode: MessageSecurityMode
- securityPolicy: SecurityPolicy
- Optional options: EndpointDescriptionParams
Returns void

addListener

addListener(event: string | symbol, listener: (...args: any[]) => void): OPCUAServerEndPoint

- Defined in node_modules/@types/node/events.d.ts:62
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns OPCUAServerEndPoint

addRestrictedEndpointDescription

addRestrictedEndpointDescription(options: EndpointDescriptionParams): void

- Defined in packages/node-opcua-server/dist/server_end_point.d.ts:120
Parameters
- options: EndpointDescriptionParams
Returns void

addStandardEndpointDescriptions

addStandardEndpointDescriptions(options?: AddStandardEndpointDescriptionsParam): void

- Defined in packages/node-opcua-server/dist/server_end_point.d.ts:121
Parameters
- Optional options: AddStandardEndpointDescriptionsParam
Returns void

dispose

dispose(): void

- Defined in packages/node-opcua-server/dist/server_end_point.d.ts:93
Returns void

emit

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

- Defined in node_modules/@types/node/events.d.ts:72
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

endpointDescriptions

endpointDescriptions(): EndpointDescription[]

- Defined in packages/node-opcua-server/dist/server_end_point.d.ts:125
returns the list of end point descriptions.

Returns EndpointDescription[]

eventNames

eventNames(): (string | symbol)[]

- Defined in node_modules/@types/node/events.d.ts:77
Returns (string | symbol)[]

getCertificate

getCertificate(): Buffer

Implementation of ServerSecureChannelParent.getCertificate
- Defined in packages/node-opcua-server/dist/server_end_point.d.ts:99
Returns the X509 DER form of the server certificate

Returns Buffer

getCertificateChain

getCertificateChain(): Buffer

Implementation of ServerSecureChannelParent.getCertificateChain
- Defined in packages/node-opcua-server/dist/server_end_point.d.ts:103
Returns the X509 DER form of the server certificate

Returns Buffer

getChannels

getChannels(): ServerSecureChannelLayer[]

- Defined in packages/node-opcua-server/dist/server_end_point.d.ts:95
Returns ServerSecureChannelLayer[]

getEndpointDescription

getEndpointDescription(securityMode: MessageSecurityMode, securityPolicy: SecurityPolicy, endpointUrl: string): EndpointDescription

Implementation of ServerSecureChannelParent.getEndpointDescription
- Defined in packages/node-opcua-server/dist/server_end_point.d.ts:118
method

getEndpointDescription

Parameters
- securityMode: MessageSecurityMode
- securityPolicy: SecurityPolicy
- endpointUrl: string
Returns EndpointDescription

endpoint_description {EndpointDescription|null}

getMaxListeners

getMaxListeners(): number

- Defined in node_modules/@types/node/events.d.ts:69
Returns number

getPrivateKey

getPrivateKey(): string

Implementation of ServerSecureChannelParent.getPrivateKey
- Defined in packages/node-opcua-server/dist/server_end_point.d.ts:107
the private key

Returns string

killClientSockets

killClientSockets(callback: (err?: Error) => void): void

- Defined in packages/node-opcua-server/dist/server_end_point.d.ts:131
Parameters
- callback: (err?: Error) => void
  - - (err?: Error): void
    - Parameters
      - Optional err: Error
      Returns void
Returns void

listen

listen(callback: (err?: Error) => void): void

- Defined in packages/node-opcua-server/dist/server_end_point.d.ts:130
method

listen

async

Parameters
- callback: (err?: Error) => void
  - - (err?: Error): void
    - Parameters
      - Optional err: Error
      Returns void
Returns void

listenerCount

listenerCount(event: string | symbol): number

- Defined in node_modules/@types/node/events.d.ts:73
Parameters
- event: string | symbol
Returns number

listeners

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

- Defined in node_modules/@types/node/events.d.ts:70
Parameters
- event: string | symbol
Returns Function[]

off

off(event: string | symbol, listener: (...args: any[]) => void): OPCUAServerEndPoint

- Defined in node_modules/@types/node/events.d.ts:66
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns OPCUAServerEndPoint

on

on(event: string | symbol, listener: (...args: any[]) => void): OPCUAServerEndPoint

- Defined in node_modules/@types/node/events.d.ts:63
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns OPCUAServerEndPoint

once

once(event: string | symbol, listener: (...args: any[]) => void): OPCUAServerEndPoint

- Defined in node_modules/@types/node/events.d.ts:64
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns OPCUAServerEndPoint

prependListener

prependListener(event: string | symbol, listener: (...args: any[]) => void): OPCUAServerEndPoint

- Defined in node_modules/@types/node/events.d.ts:75
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns OPCUAServerEndPoint

prependOnceListener

prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): OPCUAServerEndPoint

- Defined in node_modules/@types/node/events.d.ts:76
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns OPCUAServerEndPoint

rawListeners

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

- Defined in node_modules/@types/node/events.d.ts:71
Parameters
- event: string | symbol
Returns Function[]

removeAllListeners

removeAllListeners(event?: string | symbol): OPCUAServerEndPoint

- Defined in node_modules/@types/node/events.d.ts:67
Parameters
- Optional event: string | symbol
Returns OPCUAServerEndPoint

removeListener

removeListener(event: string | symbol, listener: (...args: any[]) => void): OPCUAServerEndPoint

- Defined in node_modules/@types/node/events.d.ts:65
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns OPCUAServerEndPoint

restoreConnection

restoreConnection(callback: (err?: Error) => void): void

- Defined in packages/node-opcua-server/dist/server_end_point.d.ts:133
Parameters
- callback: (err?: Error) => void
  - - (err?: Error): void
    - Parameters
      - Optional err: Error
      Returns void
Returns void

setMaxListeners

setMaxListeners(n: number): OPCUAServerEndPoint

- Defined in node_modules/@types/node/events.d.ts:68
Parameters
- n: number
Returns OPCUAServerEndPoint

shutdown

shutdown(callback: (err?: Error) => void): void

- Defined in packages/node-opcua-server/dist/server_end_point.d.ts:139
method

shutdown

async

Parameters
- callback: (err?: Error) => void
  - - (err?: Error): void
    - Parameters
      - Optional err: Error
      Returns void
Returns void

start

start(callback: (err?: Error) => void): void

- Defined in packages/node-opcua-server/dist/server_end_point.d.ts:145
method

start

async

Parameters
- callback: (err?: Error) => void
  - - (err?: Error): void
    - Parameters
      - Optional err: Error
      Returns void
Returns void

suspendConnection

suspendConnection(callback: (err?: Error) => void): void

- Defined in packages/node-opcua-server/dist/server_end_point.d.ts:132
Parameters
- callback: (err?: Error) => void
  - - (err?: Error): void
    - Parameters
      - Optional err: Error
      Returns void
Returns void

toString

toString(): string

- Defined in packages/node-opcua-server/dist/server_end_point.d.ts:94
Returns string

Static listenerCount

listenerCount(emitter: EventEmitter, event: string | symbol): number

- Defined in node_modules/@types/node/events.d.ts:31
deprecated

since v4.0.0

Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Static on

on(emitter: EventEmitter, event: string): AsyncIterableIterator<any>

- Defined in node_modules/@types/node/events.d.ts:28
Parameters
- emitter: EventEmitter
- event: string
Returns AsyncIterableIterator<any>

Static once

once(emitter: NodeEventTarget, event: string | symbol): Promise<any[]>
once(emitter: DOMEventTarget, event: string): Promise<any[]>

- Defined in node_modules/@types/node/events.d.ts:26
Parameters
- emitter: NodeEventTarget
- event: string | symbol
Returns Promise<any[]>
- Defined in node_modules/@types/node/events.d.ts:27
Parameters
- emitter: DOMEventTarget
- event: string
Returns Promise<any[]>

subscribe now with sterfive to access the online-user manual

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: OPCUAServerEndPointOptions

Returns OPCUAServerEndPoint

Properties

Optional _on_close_channel

Type declaration

Parameters

channel: ServerSecureChannelLayer

Returns void

Optional _on_connectionRefused

Type declaration

Parameters

socketData: any

Returns void

Optional _on_new_channel

Type declaration

Parameters

channel: ServerSecureChannelLayer

Returns void

Optional _on_openSecureChannelFailure

Type declaration

Parameters

socketData: any

channelData: any

Returns void

bytesReadInOldChannels

bytesWrittenInOldChannels

certificateManager

defaultSecureTokenLifetime

maxConnections

objectFactory

port

securityTokenCountOldChannels

serverInfo

timeout

transactionsCountOldChannels

Readonly Static captureRejectionSymbol

Static captureRejections

Static defaultMaxListeners

Readonly Static errorMonitor

Accessors

activeChannelCount

Returns number

bytesRead

Returns number

bytesWritten

Returns number

currentChannelCount

Returns number

securityTokenCount

Returns number

transactionsCount

Returns number

Methods

abruptlyInterruptChannels

Returns void

addEndpointDescription

Parameters

securityMode: MessageSecurityMode

securityPolicy: SecurityPolicy

Optional options: EndpointDescriptionParams

Returns void

addListener

Parameters

event: string | symbol

listener: (...args: any[]) => void

Parameters

Rest ...args: any[]

Returns void

Returns OPCUAServerEndPoint