NodeOPCUA API Documentation
    Preparing search index...

    Interface IBasicSession

    interface IBasicSession {
        getMaxRequestBodySize?: () => number;
        getTransportSettings?: () => IBasicTransportSettings;
        browse(nodeToBrowse: BrowseDescriptionLike): Promise<BrowseResult>;
        browse(nodesToBrowse: BrowseDescriptionLike[]): Promise<BrowseResult[]>;
        browse(
            nodeToBrowse: BrowseDescriptionLike,
            callback: ResponseCallback<BrowseResult>,
        ): void;
        browse(
            nodesToBrowse: BrowseDescriptionLike[],
            callback: ResponseCallback<BrowseResult[]>,
        ): void;
        browseNext(
            continuationPoint: Buffer,
            releaseContinuationPoints: boolean,
        ): Promise<BrowseResult>;
        browseNext(
            continuationPoints: Buffer<ArrayBufferLike>[],
            releaseContinuationPoints: boolean,
        ): Promise<BrowseResult[]>;
        browseNext(
            continuationPoint: Buffer,
            releaseContinuationPoints: boolean,
            callback: ResponseCallback<BrowseResult>,
        ): void;
        browseNext(
            continuationPoints: Buffer<ArrayBufferLike>[],
            releaseContinuationPoints: boolean,
            callback: ResponseCallback<BrowseResult[]>,
        ): void;
        call(methodToCall: CallMethodRequestOptions): Promise<CallMethodResult>;
        call(
            methodsToCall: CallMethodRequestOptions[],
        ): Promise<CallMethodResult[]>;
        call(
            methodToCall: CallMethodRequestOptions,
            callback: (err: Error | null, result?: CallMethodResult) => void,
        ): void;
        call(
            methodsToCall: CallMethodRequestOptions[],
            callback: (err: Error | null, results?: CallMethodResult[]) => void,
        ): void;
        getArgumentDefinition(methodId: NodeIdLike): Promise<ArgumentDefinition>;
        getArgumentDefinition(
            methodId: NodeIdLike,
            callback: (err: Error | null, args?: ArgumentDefinition) => void,
        ): void;
        read(nodeToRead: ReadValueIdOptions, maxAge?: number): Promise<DataValue>;
        read(
            nodesToRead: ReadValueIdOptions[],
            maxAge?: number,
        ): Promise<DataValue[]>;
        read(
            nodeToRead: ReadValueIdOptions,
            maxAge: number,
            callback: ResponseCallback<DataValue>,
        ): void;
        read(
            nodesToRead: ReadValueIdOptions[],
            maxAge: number,
            callback: ResponseCallback<DataValue[]>,
        ): void;
        read(
            nodeToRead: ReadValueIdOptions,
            callback: ResponseCallback<DataValue>,
        ): void;
        read(
            nodesToRead: ReadValueIdOptions[],
            callback: ResponseCallback<DataValue[]>,
        ): void;
        translateBrowsePath(
            browsePath: BrowsePathOptions,
        ): Promise<BrowsePathResult>;
        translateBrowsePath(
            browsePaths: BrowsePathOptions[],
        ): Promise<BrowsePathResult[]>;
        translateBrowsePath(
            browsesPath: BrowsePathOptions[],
            callback: ResponseCallback<BrowsePathResult[]>,
        ): void;
        translateBrowsePath(
            browsePath: BrowsePathOptions,
            callback: ResponseCallback<BrowsePathResult>,
        ): void;
        write(nodeToWrite: WriteValueOptions): Promise<StatusCode>;
        write(nodesToWrite: WriteValueOptions[]): Promise<StatusCode[]>;
        write(
            nodeToWrite: WriteValueOptions,
            callback: ResponseCallback<StatusCode>,
        ): void;
        write(
            nodesToWrite: WriteValueOptions[],
            callback: ResponseCallback<StatusCode[]>,
        ): void;
    }

    Hierarchy (View Summary)

    Implemented by

    Index
    getMaxRequestBodySize?: () => number

    the largest request body the channel can send in one message, or 0 when unknown or unlimited: the server's maxMessageSize and maxChunkCount with every chunk's headers, signature and padding already paid for. A client packing many items into one request budgets against this rather than against maxMessageSize alone, which over-fills a message by exactly those per-chunk bytes and is refused with BadTcpMessageTooLarge.

    getTransportSettings?: () => IBasicTransportSettings
    • Parameters

      • continuationPoint: Buffer
      • releaseContinuationPoints: boolean

        a Boolean parameter with the following values: * true passed continuationPoints shall be reset to free resources in the Server. The continuation points are released and the results and diagnosticInfos arrays are empty. * false passed continuationPoints shall be used to get the next set of browse information.

        A Client shall always use the continuation point returned by a Browse or BrowseNext response to free the resources for the continuation point in the Server. If the Client does not want to get the next set of browse information, BrowseNext shall be called with this parameter set to true.

      Returns Promise<BrowseResult>

    • Parameters

      • continuationPoints: Buffer<ArrayBufferLike>[]
      • releaseContinuationPoints: boolean

      Returns Promise<BrowseResult[]>

    • Parameters

      Returns void

    • Parameters

      Returns void

    • Parameters

      Returns Promise<CallMethodResult>

      const methodToCall = {
      objectId: "ns=2;i=12",
      methodId: "ns=2;i=13",
      inputArguments: [
      new Variant({...}),
      new Variant({...}),
      ]
      }
      session.call(methodToCall,function(err,callResult) {
      if (!err) {
      console.log(" statusCode = ",callResult.statusCode);
      console.log(" inputArgumentResults[0] = ",callResult.inputArgumentResults[0].toString());
      console.log(" inputArgumentResults[1] = ",callResult.inputArgumentResults[1].toString());
      console.log(" outputArgument[0] = ",callResult.outputArgument[0].toString()); // array of variant
      }
      });
      const methodsToCall = [ {
      objectId: "ns=2;i=12",
      methodId: "ns=2;i=13",
      inputArguments: [
      new Variant({...}),
      new Variant({...}),
      ]
      }];
      session.call(methodsToCall,function(err,callResults) {
      if (!err) {
      const callResult = callResults[0];
      console.log(" statusCode = ",rep.statusCode);
      console.log(" inputArgumentResults[0] = ",callResult.inputArgumentResults[0].toString());
      console.log(" inputArgumentResults[1] = ",callResult.inputArgumentResults[1].toString());
      console.log(" outputArgument[0] = ",callResult.outputArgument[0].toString()); // array of variant
      }
      });
    • Parameters

      Returns Promise<CallMethodResult[]>

    • Parameters

      Returns void

    • Parameters

      Returns void