⚠️ You are reading documentation for an OLD version (v2.0.0). The current released version is v2.173.1. View latest documentation →

Class ClientFile

Hierarchy

ClientFile

Index

Constructors

constructor

Properties

fileHandle

Methods

Constructors

constructor

new ClientFile(session: IBasicSession, nodeId: NodeId): ClientFile

- Defined in node-opcua-file-transfer/source/client/client_file.ts:37
Parameters
- session: IBasicSession
- nodeId: NodeId
Returns ClientFile

Properties

fileHandle

fileHandle: number = 0

Methods

close

close(): Promise<void>

- Defined in node-opcua-file-transfer/source/client/client_file.ts:71
Returns Promise<void>

getPosition

getPosition(): Promise<UInt64>

- Defined in node-opcua-file-transfer/source/client/client_file.ts:92
Returns Promise<UInt64>

open

open(mode: OpenFileMode): Promise<number>

- Defined in node-opcua-file-transfer/source/client/client_file.ts:44
Parameters
- mode: OpenFileMode
Returns Promise<number>

openCount

openCount(): Promise<UInt16>

- Defined in node-opcua-file-transfer/source/client/client_file.ts:186
Returns Promise<UInt16>

read

read(bytesToRead: Int32): Promise<Buffer>

- Defined in node-opcua-file-transfer/source/client/client_file.ts:137
Parameters
- bytesToRead: Int32
Returns Promise<Buffer>

setPosition

setPosition(position: UInt64 | UInt32): Promise<void>

- Defined in node-opcua-file-transfer/source/client/client_file.ts:111
Parameters
- position: UInt64 | UInt32
Returns Promise<void>

size

size(): Promise<UInt64>

- Defined in node-opcua-file-transfer/source/client/client_file.ts:197
Returns Promise<UInt64>

write

write(data: Buffer): Promise<void>

- Defined in node-opcua-file-transfer/source/client/client_file.ts:163
Parameters
- data: Buffer
Returns Promise<void>

Generated using TypeDoc