node-opcua-file-transfer 2.97.0 → 2.98.1

package/dist/client/client_file.d.ts

@@ -1,92 +1,92 @@
-/// <reference types="node" />
-/**
- * @module node-opcua-file-transfer
- */
-import { Int32, Int64, UInt16, UInt32, UInt64 } from "node-opcua-basic-types";
-import { NodeId } from "node-opcua-nodeid";
-import { IBasicSession } from "node-opcua-pseudo-session";
-import { OpenFileMode } from "../open_mode";
-export { OpenFileMode } from "../open_mode";
-export interface IClientFile {
-    fileHandle: number;
-    open(mode: OpenFileMode): Promise<number>;
-    close(): Promise<void>;
-    getPosition(): Promise<UInt64>;
-    setPosition(position: UInt64 | UInt32): Promise<void>;
-    read(bytesToRead: UInt32 | Int32 | Int64 | UInt64): Promise<Buffer>;
-    write(data: Buffer): Promise<void>;
-    openCount(): Promise<UInt16>;
-    size(): Promise<UInt64>;
-    session: IBasicSession;
-}
-export interface IClientFilePriv extends IClientFile {
-    readonly fileNodeId: NodeId;
-    openMethodNodeId?: NodeId;
-    closeMethodNodeId?: NodeId;
-    setPositionNodeId?: NodeId;
-    getPositionNodeId?: NodeId;
-    readNodeId?: NodeId;
-    writeNodeId?: NodeId;
-    openCountNodeId?: NodeId;
-    sizeNodeId?: NodeId;
-    ensureInitialized(): Promise<void>;
-}
-/**
- *
- *
- */
-export declare class ClientFile implements IClientFile {
-    static useGlobalMethod: boolean;
-    fileHandle: number;
-    session: IBasicSession;
-    protected readonly fileNodeId: NodeId;
-    private openMethodNodeId?;
-    private closeMethodNodeId?;
-    private setPositionNodeId?;
-    private getPositionNodeId?;
-    private readNodeId?;
-    private writeNodeId?;
-    private openCountNodeId?;
-    private sizeNodeId?;
-    constructor(session: IBasicSession, nodeId: NodeId);
-    open(mode: OpenFileMode): Promise<number>;
-    close(): Promise<void>;
-    getPosition(): Promise<UInt64>;
-    setPosition(position: UInt64 | UInt32): Promise<void>;
-    read(bytesToRead: UInt32 | Int32 | Int64 | UInt64): Promise<Buffer>;
-    write(data: Buffer): Promise<void>;
-    openCount(): Promise<UInt16>;
-    size(): Promise<UInt64>;
-    protected extractMethodsIds(): Promise<void>;
-    protected ensureInitialized(): Promise<void>;
-}
-/**
- * 5.2.10 UserRolePermissions
- *
- * The optional UserRolePermissions Attribute specifies the Permissions that apply to a Node for
- * all Roles granted to current Session. The value of the Attribute is an array of
- * RolePermissionType Structures (see Table 8).
- * Clients may determine their effective Permissions by logically ORing the Permissions for each
- * Role in the array.
- *  The value of this Attribute is derived from the rules used by the Server to map Sessions to
- * Roles. This mapping may be vendor specific or it may use the standard Role model defined in 4.8.
- * This Attribute shall not be writeable.
- * If not specified, the value of DefaultUserRolePermissions Property from the Namespace
- * Metadata Object associated with the Node is used instead. If the NamespaceMetadata Object
- * does not define the Property or does not exist, then the Server does not publish any information
- * about Roles mapped to the current Session.
- *
- *
- * 5.2.11 AccessRestrictions
- * The optional AccessRestrictions Attribute specifies the AccessRestrictions that apply to a Node.
- * Its data type is defined in 8.56. If a Server supports AccessRestrictions for a particular
- * Namespace it adds the DefaultAccessRestrictions Property to the NamespaceMetadata Object
- * for that Namespace (see Figure 8). If a particular Node in the Namespace needs to override
- * the default value the Server adds the AccessRestrictions Attribute to the Node.
- * If a Server implements a vendor specific access restriction model for a Namespace, it does not
- * add the DefaultAccessRestrictions Property to the NamespaceMetadata Object.
- *
- *
- * DefaultAccessRestrictions
- *
- */
+/// <reference types="node" />
+/**
+ * @module node-opcua-file-transfer
+ */
+import { Int32, Int64, UInt16, UInt32, UInt64 } from "node-opcua-basic-types";
+import { NodeId } from "node-opcua-nodeid";
+import { IBasicSession } from "node-opcua-pseudo-session";
+import { OpenFileMode } from "../open_mode";
+export { OpenFileMode } from "../open_mode";
+export interface IClientFile {
+    fileHandle: number;
+    open(mode: OpenFileMode): Promise<number>;
+    close(): Promise<void>;
+    getPosition(): Promise<UInt64>;
+    setPosition(position: UInt64 | UInt32): Promise<void>;
+    read(bytesToRead: UInt32 | Int32 | Int64 | UInt64): Promise<Buffer>;
+    write(data: Buffer): Promise<void>;
+    openCount(): Promise<UInt16>;
+    size(): Promise<UInt64>;
+    session: IBasicSession;
+}
+export interface IClientFilePriv extends IClientFile {
+    readonly fileNodeId: NodeId;
+    openMethodNodeId?: NodeId;
+    closeMethodNodeId?: NodeId;
+    setPositionNodeId?: NodeId;
+    getPositionNodeId?: NodeId;
+    readNodeId?: NodeId;
+    writeNodeId?: NodeId;
+    openCountNodeId?: NodeId;
+    sizeNodeId?: NodeId;
+    ensureInitialized(): Promise<void>;
+}
+/**
+ *
+ *
+ */
+export declare class ClientFile implements IClientFile {
+    static useGlobalMethod: boolean;
+    fileHandle: number;
+    session: IBasicSession;
+    protected readonly fileNodeId: NodeId;
+    private openMethodNodeId?;
+    private closeMethodNodeId?;
+    private setPositionNodeId?;
+    private getPositionNodeId?;
+    private readNodeId?;
+    private writeNodeId?;
+    private openCountNodeId?;
+    private sizeNodeId?;
+    constructor(session: IBasicSession, nodeId: NodeId);
+    open(mode: OpenFileMode): Promise<number>;
+    close(): Promise<void>;
+    getPosition(): Promise<UInt64>;
+    setPosition(position: UInt64 | UInt32): Promise<void>;
+    read(bytesToRead: UInt32 | Int32 | Int64 | UInt64): Promise<Buffer>;
+    write(data: Buffer): Promise<void>;
+    openCount(): Promise<UInt16>;
+    size(): Promise<UInt64>;
+    protected extractMethodsIds(): Promise<void>;
+    protected ensureInitialized(): Promise<void>;
+}
+/**
+ * 5.2.10 UserRolePermissions
+ *
+ * The optional UserRolePermissions Attribute specifies the Permissions that apply to a Node for
+ * all Roles granted to current Session. The value of the Attribute is an array of
+ * RolePermissionType Structures (see Table 8).
+ * Clients may determine their effective Permissions by logically ORing the Permissions for each
+ * Role in the array.
+ *  The value of this Attribute is derived from the rules used by the Server to map Sessions to
+ * Roles. This mapping may be vendor specific or it may use the standard Role model defined in 4.8.
+ * This Attribute shall not be writeable.
+ * If not specified, the value of DefaultUserRolePermissions Property from the Namespace
+ * Metadata Object associated with the Node is used instead. If the NamespaceMetadata Object
+ * does not define the Property or does not exist, then the Server does not publish any information
+ * about Roles mapped to the current Session.
+ *
+ *
+ * 5.2.11 AccessRestrictions
+ * The optional AccessRestrictions Attribute specifies the AccessRestrictions that apply to a Node.
+ * Its data type is defined in 8.56. If a Server supports AccessRestrictions for a particular
+ * Namespace it adds the DefaultAccessRestrictions Property to the NamespaceMetadata Object
+ * for that Namespace (see Figure 8). If a particular Node in the Namespace needs to override
+ * the default value the Server adds the AccessRestrictions Attribute to the Node.
+ * If a Server implements a vendor specific access restriction model for a Namespace, it does not
+ * add the DefaultAccessRestrictions Property to the NamespaceMetadata Object.
+ *
+ *
+ * DefaultAccessRestrictions
+ *
+ */