OPCUAServerEndPoint | node-opcua-client

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 node-opcua-server/source/server_end_point.ts:169
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_new_channel

_on_new_channel: function

Type declaration

- (channel: ServerSecureChannelLayer): void
- Parameters
  - channel: ServerSecureChannelLayer
  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

Accessors

activeChannelCount

get activeChannelCount(): number

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

bytesRead

get bytesRead(): number

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

bytesWritten

get bytesWritten(): number

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

currentChannelCount

get currentChannelCount(): number

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

Returns number

securityTokenCount

get securityTokenCount(): number

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

transactionsCount

get transactionsCount(): number

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

Methods

abruptlyInterruptChannels

abruptlyInterruptChannels(): void

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

addEndpointDescription

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

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

addListener

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

Inherited from EventEmitter.addListener

Overrides EventEmitter.addListener
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:11
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

addRestrictedEndpointDescription

addRestrictedEndpointDescription(options: EndpointDescriptionParams): void

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

addStandardEndpointDescriptions

addStandardEndpointDescriptions(options?: AddStandardEndpointDescriptionsParam): void

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

dispose

dispose(): void

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

emit

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

Inherited from EventEmitter.emit

Overrides EventEmitter.emit
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:23
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

endpointDescriptions

endpointDescriptions(): EndpointDescription[]

- Defined in node-opcua-server/source/server_end_point.ts:413
returns the list of end point descriptions.

Returns EndpointDescription[]

eventNames

eventNames(): Array<string | symbol>

Inherited from EventEmitter.eventNames

Overrides EventEmitter.eventNames
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:24
Returns Array<string | symbol>

getCertificate

getCertificate(): Certificate

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

Returns Certificate

getCertificateChain

getCertificateChain(): Certificate

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

Returns Certificate

getChannels

getChannels(): ServerSecureChannelLayer[]

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

getEndpointDescription

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

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

getEndpointDescription

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

endpoint_description {EndpointDescription|null}

getMaxListeners

getMaxListeners(): number

Inherited from EventEmitter.getMaxListeners

Overrides EventEmitter.getMaxListeners
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:20
Returns number

getPrivateKey

getPrivateKey(): PrivateKeyPEM

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

Returns PrivateKeyPEM

killClientSockets

killClientSockets(callback: function): void

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

listen

listen(callback: function): void

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

listen

async

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

listenerCount

listenerCount(type: string | symbol): number

Inherited from EventEmitter.listenerCount

Overrides EventEmitter.listenerCount
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:25
Parameters
- type: string | symbol
Returns number

listeners

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

Inherited from EventEmitter.listeners

Overrides EventEmitter.listeners
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:21
Parameters
- event: string | symbol
Returns Function[]

off

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

Inherited from EventEmitter.off

Overrides EventEmitter.off
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:17
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 EventEmitter.on

Overrides EventEmitter.on
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:12
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 EventEmitter.once

Overrides EventEmitter.once
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:13
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 EventEmitter.prependListener

Overrides EventEmitter.prependListener
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:14
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 EventEmitter.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:15
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 EventEmitter.rawListeners

Overrides EventEmitter.rawListeners
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:22
Parameters
- event: string | symbol
Returns Function[]

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from EventEmitter.removeAllListeners

Overrides EventEmitter.removeAllListeners
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:18
Parameters
- Optional event: string | symbol
Returns this

removeListener

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

Inherited from EventEmitter.removeListener

Overrides EventEmitter.removeListener
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:16
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

restoreConnection

restoreConnection(callback: function): void

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

setMaxListeners

setMaxListeners(n: number): this

Inherited from EventEmitter.setMaxListeners

Overrides EventEmitter.setMaxListeners
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:19
Parameters
- n: number
Returns this

shutdown

shutdown(callback: function): void

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

shutdown

async

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

start

start(callback: function): void

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

start

async

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

suspendConnection

suspendConnection(callback: function): void

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

toString

toString(): string

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

Static listenerCount

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

Inherited from EventEmitter.listenerCount
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:8
deprecated

since v4.0.0

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

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_new_channel

Type declaration

Parameters

channel: ServerSecureChannelLayer

Returns void

bytesReadInOldChannels

bytesWrittenInOldChannels

certificateManager

defaultSecureTokenLifetime

maxConnections

objectFactory

port

securityTokenCountOldChannels

serverInfo

timeout

transactionsCountOldChannels

Static defaultMaxListeners

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

Returns void

addStandardEndpointDescriptions

Parameters

Optional options: AddStandardEndpointDescriptionsParam

Returns void

dispose

Returns void

emit

Parameters

event: string | symbol

Rest ...args: any[]

Returns boolean