ReadCallbackArgs
> ReadCallbackArgs

Argument passed to the read callback when an asynchronous read operation finishes.

  • 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

ReadCallbackArgs
bytesProcessed : Number

Number of bytes processed, or -1 in the event of an error or end of stream.

Number of bytes processed, or -1 in the event of an error or end of stream.

ReadCallbackArgs
: 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

ReadCallbackArgs
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

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

Text description of the error.

deprecated since 3.1.0

ReadCallbackArgs
: 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
ReadCallbackArgs
source : Titanium.IOStream

Stream being read.

Stream being read.

ReadCallbackArgs
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