PumpCallbackArgs
> PumpCallbackArgs

Argument passed to the callback each time the pump operation has new data to deliver.

A callback with bytesProcessed set to -1 indicates the end of the pump operation, either because of an error or because the end of the stream has been reached.

  • 1.7
  • 1.7
  • 1.7

NOTE This is an abstract type. Any object meeting this description can be used where this type is used.

Defined By

Properties

PumpCallbackArgs
buffer : Titanium.Buffer

Buffer object holding the data currently being pumped to the handler method.

Buffer object holding the data currently being pumped to the handler method.

PumpCallbackArgs
bytesProcessed : Number

Number of bytes being passed to this invocation of the handler, or -1 in the event of an error or end of stream.

Number of bytes being passed to this invocation of the handler, or -1 in the event of an error or end of stream.

PumpCallbackArgs
: Number
Error code. ...

Error code. Returns 0 if success is true.

Error code will be 0 if success is true, nonzero otherwise. If the error was generated by the operating system, that system's error value is used. Otherwise, this value will be -1.

  • 3.1.0
  • 3.1.0
  • 3.1.0

Overrides: ErrorResponse.code

PumpCallbackArgs
error : String

Error message, if any returned.

Error message, if any returned.

Will be undefined if success is true.

  • 3.1.0
  • 3.1.0
  • 3.1.0

Overrides: ErrorResponse.error

PumpCallbackArgs
: Stringdeprecated
Text description of the error. ...

Text description of the error.

deprecated since 3.1.0

PumpCallbackArgs
: Numberdeprecated
Whether an error was encountered. ...

Whether an error was encountered. Set to 1 in the case of an error, 0 otherwise.

deprecated since 3.1.0

  • 1.7
PumpCallbackArgs
source : Titanium.IOStream

Stream being read from.

Stream being read from.

PumpCallbackArgs
success : Boolean

Indicates if the operation succeeded.

Indicates if the operation succeeded.

Returns true if request succeeded, false otherwise.

  • 3.1.0
  • 3.1.0
  • 3.1.0

Overrides: ErrorResponse.success

PumpCallbackArgs
totalBytesProcessed : Number

Total number of bytes read from the stream so far, including the data passed to this current invocation of the handler.

Total number of bytes read from the stream so far, including the data passed to this current invocation of the handler.