Home Manual Reference Source Test 
import Stream from 'atscm/src/lib/server/Stream.js'
public class | source

Stream

Expression Extends:

class Stream extends throughStreamClass({ objectMode: true })

Direct Subclass:

QueueStream

Indirect Subclass:

CallMethodStream, CallScriptStream, CreateNodeStream, ImportStream

An object transform stream connected to atvise server.

Test:

Constructor Summary

Public Constructor
public

constructor(options: Object)

Creates a new Stream and starts opening a new session to atvise server.

Member Summary

Private Members
private

true if the stream's atvise server session should be kept alive once the stream ends.

Method Summary

Private Methods
private

_flush(callback: function(err: ?Error, data: Object))

Called just before the stream is closed: Closes the open session.

Public Constructors

public constructor(options: Object) source

Creates a new Stream and starts opening a new session to atvise server.

Params:

NameTypeAttributeDescription
options Object
  • optional

The options to use. See the through2 documentation for details.
options.keepSessionAlive boolean
  • optional
  • default: false

If the ativse server session should be closed one the stream ends.

Emit:

Session

Emits an session-open event once the session is open, passing the Session instance.

Test:

See:

Private Members

private _keepSessionAlive: Boolean source

true if the stream's atvise server session should be kept alive once the stream ends.

Private Methods

private _flush(callback: function(err: ?Error, data: Object)) source

Called just before the stream is closed: Closes the open session.

Params:

NameTypeAttributeDescription
callback function(err: ?Error, data: Object)

Called once the session is closed.