Class OPCUAServerEndPoint

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

Constructors

constructor

Properties

Accessors

Constructors

constructor

new OPCUAServerEndPoint(options: OPCUAServerEndPointOptions): OPCUAServerEndPoint

Overrides ClientMonitoredItemBase.constructor
- Defined in packages/node-opcua-server/source/server_end_point.ts:219
Parameters
- options: OPCUAServerEndPointOptions
Returns OPCUAServerEndPoint

Properties

Optional _on_close_channel

_on_close_channel: function

Type declaration

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

Optional _on_connectionRefused

_on_connectionRefused: function

Type declaration

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

Optional _on_new_channel

_on_new_channel: function

Type declaration

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

Optional _on_openSecureChannelFailure

_on_openSecureChannelFailure: function

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

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: unique symbol

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/source/server_end_point.ts:621
Returns number

bytesRead

get bytesRead(): number

- Defined in packages/node-opcua-server/source/server_end_point.ts:591
Returns number

bytesWritten

get bytesWritten(): number

- Defined in packages/node-opcua-server/source/server_end_point.ts:581
Returns number

currentChannelCount

get currentChannelCount(): number

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

Returns number

securityTokenCount

get securityTokenCount(): number

- Defined in packages/node-opcua-server/source/server_end_point.ts:611
Returns number

transactionsCount

get transactionsCount(): number

- Defined in packages/node-opcua-server/source/server_end_point.ts:601
Returns number

Methods

abruptlyInterruptChannels

abruptlyInterruptChannels(): void

- Defined in packages/node-opcua-server/source/server_end_point.ts:532
Returns void

addEndpointDescription

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

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

addListener

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

Inherited from UAStateVariable.addListener
- Defined in node_modules/@types/node/events.d.ts:62
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

addRestrictedEndpointDescription

addRestrictedEndpointDescription(options: EndpointDescriptionParams): void

- Defined in packages/node-opcua-server/source/server_end_point.ts:413
Parameters
- options: EndpointDescriptionParams
Returns void

addStandardEndpointDescriptions

addStandardEndpointDescriptions(options?: AddStandardEndpointDescriptionsParam): void

- Defined in packages/node-opcua-server/source/server_end_point.ts:419
Parameters
- Optional options: AddStandardEndpointDescriptionsParam
Returns void

dispose

dispose(): void

- Defined in packages/node-opcua-server/source/server_end_point.ts:262
Returns void

emit

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

Inherited from UAStateVariable.emit
- 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/source/server_end_point.ts:463
returns the list of end point descriptions.

Returns EndpointDescription[]

eventNames

eventNames(): Array<string | symbol>

Inherited from UAStateVariable.eventNames
- Defined in node_modules/@types/node/events.d.ts:77
Returns Array<string | symbol>

getCertificate

getCertificate(): Certificate

- Defined in packages/node-opcua-server/source/server_end_point.ts:304
Returns the X509 DER form of the server certificate

Returns Certificate

getCertificateChain

getCertificateChain(): Certificate

- Defined in packages/node-opcua-server/source/server_end_point.ts:311
Returns the X509 DER form of the server certificate

Returns Certificate

getChannels

getChannels(): ServerSecureChannelLayer[]

- Defined in packages/node-opcua-server/source/server_end_point.ts:297
Returns ServerSecureChannelLayer[]

getEndpointDescription

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

- Defined in packages/node-opcua-server/source/server_end_point.ts:335
method

getEndpointDescription

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

endpoint_description {EndpointDescription|null}

getMaxListeners

getMaxListeners(): number

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

getPrivateKey

getPrivateKey(): PrivateKeyPEM

- Defined in packages/node-opcua-server/source/server_end_point.ts:318
the private key

Returns PrivateKeyPEM

killClientSockets

killClientSockets(callback: function): void

- Defined in packages/node-opcua-server/source/server_end_point.ts:497
Parameters
- callback: function
  - - (err?: Error): void
    - Parameters
      - Optional err: Error
      Returns void
Returns void

listen

listen(callback: function): void

- Defined in packages/node-opcua-server/source/server_end_point.ts:471
method

listen

async

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

listenerCount

listenerCount(event: string | symbol): number

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

listeners

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

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

off

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

Inherited from UAStateVariable.off
- Defined in node_modules/@types/node/events.d.ts:66
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

Inherited from NonHierarchicalReferences.on
- Defined in node_modules/@types/node/events.d.ts:63
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

once

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

Inherited from NonHierarchicalReferences.once
- Defined in node_modules/@types/node/events.d.ts:64
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependListener

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

Inherited from UAStateVariable.prependListener
- Defined in node_modules/@types/node/events.d.ts:75
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

Inherited from UAStateVariable.prependOnceListener
- Defined in node_modules/@types/node/events.d.ts:76
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

rawListeners

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

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

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from UAStateVariable.removeAllListeners
- Defined in node_modules/@types/node/events.d.ts:67
Parameters
- Optional event: string | symbol
Returns this

removeListener

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

Inherited from UAStateVariable.removeListener
- Defined in node_modules/@types/node/events.d.ts:65
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

restoreConnection

restoreConnection(callback: function): void

- Defined in packages/node-opcua-server/source/server_end_point.ts:528
Parameters
- callback: function
  - - (err?: Error): void
    - Parameters
      - Optional err: Error
      Returns void
Returns void

setMaxListeners

setMaxListeners(n: number): this

Inherited from UAStateVariable.setMaxListeners
- Defined in node_modules/@types/node/events.d.ts:68
Parameters
- n: number
Returns this

shutdown

shutdown(callback: function): void

- Defined in packages/node-opcua-server/source/server_end_point.ts:543
method

shutdown

async

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

start

start(callback: function): void

- Defined in packages/node-opcua-server/source/server_end_point.ts:576
method

start

async

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

suspendConnection

suspendConnection(callback: function): void

- Defined in packages/node-opcua-server/source/server_end_point.ts:509
Parameters
- callback: function
  - - (err?: Error): void
    - Parameters
      - Optional err: Error
      Returns void
Returns void

toString

toString(): string

- Defined in packages/node-opcua-server/source/server_end_point.ts:280
Returns string

Static listenerCount

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

Inherited from ConditionSnapshot.listenerCount
- Defined in node_modules/@types/node/events.d.ts:44
deprecated

since v4.0.0

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

Class OPCUAServerEndPoint

Hierarchy

Implements

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

Static defaultMaxListeners

Static Readonly 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: function

Parameters

Rest ...args: any[]

Returns void

Returns this

addRestrictedEndpointDescription

Parameters

options: EndpointDescriptionParams