Class ClientFile

Implements

IClientFile

Index

Constructors

Properties

fileHandle nodeId session useGlobalMethod

Accessors

Methods

browseName close ensureInitialized extractMethodsIds getPosition open openCount read setPosition size write

Constructors

constructor

new ClientFile(session: IBasicSessionAsync, nodeId: NodeId): ClientFile
Parameters
- session: IBasicSessionAsync
- nodeId: NodeId
Returns ClientFile
- Defined in node-opcua-file-transfer/source/client/client_file.ts:67

Properties

fileHandle

fileHandle: number = 0

`Readonly`nodeId

nodeId: NodeId

session

session: IBasicSessionAsync

`Static`useGlobalMethod

useGlobalMethod: boolean = false

Accessors

`Protected`fileNodeId

get fileNodeId(): NodeId
Returns NodeId

Deprecated
use nodeId instead
- Defined in node-opcua-file-transfer/source/client/client_file.ts:75

Methods

browseName

browseName(): Promise<QualifiedName>
Returns Promise<QualifiedName>
- Defined in node-opcua-file-transfer/source/client/client_file.ts:79

close

close(): Promise<void>
Returns Promise<void>
Implementation of IClientFile.close
- Defined in node-opcua-file-transfer/source/client/client_file.ts:108

`Protected`ensureInitialized

ensureInitialized(): Promise<void>
Returns Promise<void>
- Defined in node-opcua-file-transfer/source/client/client_file.ts:311

`Protected`extractMethodsIds

extractMethodsIds(): Promise<void>
Returns Promise<void>
- Defined in node-opcua-file-transfer/source/client/client_file.ts:239

getPosition

getPosition(): Promise<UInt64>
Returns Promise<UInt64>
Implementation of IClientFile.getPosition
- Defined in node-opcua-file-transfer/source/client/client_file.ts:127

open

open(mode: OpenFileMode): Promise<number>
Parameters
- mode: OpenFileMode
Returns Promise<number>
Implementation of IClientFile.open
- Defined in node-opcua-file-transfer/source/client/client_file.ts:84

openCount

openCount(): Promise<number>
Returns Promise<number>
Implementation of IClientFile.openCount
- Defined in node-opcua-file-transfer/source/client/client_file.ts:219

read

read(bytesToRead: number | UInt64 | Int64): Promise<Buffer<ArrayBufferLike>>
Parameters
- bytesToRead: number | UInt64 | Int64
Returns Promise<Buffer<ArrayBufferLike>>
Implementation of IClientFile.read
- Defined in node-opcua-file-transfer/source/client/client_file.ts:170

setPosition

setPosition(position: number | UInt64): Promise<void>
Parameters
- position: number | UInt64
Returns Promise<void>
Implementation of IClientFile.setPosition
- Defined in node-opcua-file-transfer/source/client/client_file.ts:144

size

size(): Promise<UInt64>
Returns Promise<UInt64>
Implementation of IClientFile.size
- Defined in node-opcua-file-transfer/source/client/client_file.ts:231

write

write(data: Buffer): Promise<void>
Parameters
- data: Buffer
Returns Promise<void>
Implementation of IClientFile.write
- Defined in node-opcua-file-transfer/source/client/client_file.ts:196