import CallScriptStream from 'atscm/src/lib/server/scripts/CallScriptStream.js'

public class | source

CallScriptStream

Extends:

Stream → QueueStream → CallMethodStream → CallScriptStream

Direct Subclass:

CreateNodeStream

A stream that calls atvise server scripts for all passed nodes.

Test:

CallScriptStream

Member Summary

Public Members
public get	methodId: NodeId The id of the callScript method.
public get	scriptBaseId: NodeId Id of the script's base object.
public get abstract	scriptId: NodeId Must be implemented by all subclasses: The id of the script to call.

Method Summary

Public Methods
public	inputArguments(file: AtviseFile): node-opcua~Variant[] Creates the raw method input arguments for the given file.
public	processChunk(file: vinyl~File, handleErrors: function(err: Error, status: node-opcua~StatusCodes, success: function)) Calls the script specified in CallScriptStream#scriptId.
public	processErrorMessage(file: AtviseFile): string Returns the error message logged if running the script fails.
public	scriptParameters(file: AtviseFile): Object Returns the parameters to call the script with for the given file.

Inherited Summary

From class Stream
private	_keepSessionAlive: Boolean `true` if the stream's atvise server session should be kept alive once the stream ends.
private	_flush(callback: function(err: ?Error, data: Object)) Called just before the stream is closed: Closes the open session.

From class QueueStream
public get	hasPending: boolean `true` if there are queued operations or an operation is running right now.
public get	opsPerSecond: number The number of processed chunks per second.
public get	processed: number The number of chunks already processed.
public get	queueEmpty: boolean `true` if there are no queued operations.
private	_maxParallel: number The maximum of parallel tasks to execute
private	_processed: Number The number of chunks processed so far.
private	_processing: Number The number of running operations.
private	_queued: *[] The queued chunks.
private	_start: Number The timestamp of the date when the stream was created.
public abstract	processChunk(chunk: *, handleErrors: function(err: Error, statusCode: node-opcua~StatusCodes, onSuccess: function)) The function to call when a chunk is ready to be processed.
public abstract	processErrorMessage(chunk: *): string The error message to use when processing a chunk fails.
private	_enqueueChunk(chunk: *) Enqueues the given chunk for processing.
private	_flush(callback: Function) Waits for pending operations to complete.
private	_processChunk(chunk: *) Calls QueueStream#processChunk and handles errors and invalid status codes.
private	_transform(chunk: *, enc: string, callback: Function) Calls QueueStream#_enqueueChunk as soon as the stream's session is opened.

From class CallMethodStream
public get	methodBaseId: NodeId The NodeId of the object from which the method should get called.
public get	methodId: NodeId Must be implemented in all subclasses: The NodeId of the method to call.
public	callRequest(file: vinyl~File): node-opcua~CallMethodRequest Creates a call method request object for a file.
public	handleOutputArguments(file: vinyl~File, outputArgs: node-opcua~Variant[], callback: function(err: Error)) Must be implemented by all subclasses: If the method call returns a status code of node-opcua~StatusCodes.Good, this method decides if the output matches the expected results.
public	inputArguments(file: vinyl~File): node-opcua~Variant[] The input arguments the method should be called with for a file.
public	processChunk(file: vinyl~File, handleErrors: function(err: Error, status: node-opcua~StatusCodes, success: function)) Performs an opcua method call for the given file.
public	processErrorMessage(file: vinyl~File): string Returns an error message specifically for the given file.

Public Members

public get methodId: NodeId source

The id of the callScript method.

Override:

CallMethodStream#methodId

Test:

CallScriptStream #methodId

public get scriptBaseId: NodeId source

Id of the script's base object.

public get abstract scriptId: NodeId source

Must be implemented by all subclasses: The id of the script to call.

Test:

CallScriptStream #scriptId

Public Methods

public inputArguments(file: AtviseFile): node-opcua~Variant[] source

Creates the raw method input arguments for the given file.

Override:

CallMethodStream#inputArguments

Params:

Name	Type	Attribute	Description
file	AtviseFile		The processed file.

Return:

node-opcua~Variant[] (nullable: true)

Input arguments for the callScript method.

Test:

CallScriptStream #inputArguments

public processChunk(file: vinyl~File, handleErrors: function(err: Error, status: node-opcua~StatusCodes, success: function)) source

Calls the script specified in CallScriptStream#scriptId. If the script does not exist but could be imported by running atscm import a special status description is returned.

Override:

CallMethodStream#processChunk

Params:

Name	Type	Attribute	Description
file	vinyl~File		The file being processed.
handleErrors	function(err: Error, status: node-opcua~StatusCodes, success: function)		The error handler to call. See QueueStream#processChunk for details.