---
product: Chilkat
product_version: 11.7.0
language: ckperl
language_label: Perl
class: Stream
class_name: CkStream
license: free
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/perlCkStreamRef.html
---
# Chilkat Stream — Perl — v11.7.0

> Chilkat 11.7.0 · language=ckperl · class=Stream (CkStream)
> Other versions: replace `11.7.0` in this URL. Other languages: `https://www.chilkatsoft.com/ai-docs/v/11.7.0/<lang>/classes/Stream.md`.
> Language-wide rules (install, unlock, error model, strings/bytes): `https://www.chilkatsoft.com/ai-docs/v/11.7.0/ckperl/guide.md`.

## Purpose

**Read, write, pipe, monitor, and control byte or text streams.**

`Chilkat.Stream` is a general-purpose streaming object for moving data between sources and sinks without requiring the entire payload to be handled at once. A stream can read from files, byte arrays, strings, or other sources; write to files, memory, `BinData`, `StringBuilder`, or other sinks; handle binary and text data; apply character-set rules for strings; process file parts; track bytes sent and received; and support timeouts, polling, aborts, async task integration, and end-of-stream handling.

**File and memory sources**

Stream from a source file, byte array, string, or selected file part without manually loading or copying all data first.

**File and object sinks**

Write streamed data to a sink file, append to an existing file, or output to `BinData`, `StringBuilder`, bytes, or strings.

**Binary reads and writes**

Read or write raw bytes, fixed byte counts, encoded byte strings, individual bytes, or `BinData` content.

**Text streaming**

Read and write strings using `StringCharset`, optionally use a BOM, and read text until CRLF or a matching delimiter.

**Timeouts and polling**

Control read and write wait behavior, poll for immediately available data, and inspect read or write failure reasons.

**Progress and lifecycle**

Track bytes sent and received, detect end-of-stream or write-closed state, reset streams, close writing, and abort long-running operations.

**Common pattern:** Configure the stream's source and sink, set the character set or chunk size if needed, then read or write using the method that matches the data type: bytes, encoded bytes, strings, `BinData`, or `StringBuilder`. Check `EndOfStream`, `ReadFailReason`, `WriteFailReason`, `NumReceived`, `NumSent`, and `LastErrorText` to understand stream progress and failures.

**Timeout note:** For `ReadTimeoutMs`, a value of `0` means a polling read, not an infinite timeout. For `WriteTimeoutMs`, `0` means return immediately if the stream cannot be written to right away.

## Object creation, unlocking and error handling

**Object Creation**

```perl
$obj = chilkat::CkStream->new();
```

Call `Global.UnlockBundle` once at the start of the program, before using this or any other Chilkat class. Any string unlocks a fully functional 30-day trial; a purchased unlock code is used in production. See `guide.md` for the exact code in Perl.

How failure is reported depends on the method's return type and is stated in the note under each method below. In every case the diagnostic text is in the `LastErrorText` property of the object whose method was called.

## Members common to every Chilkat class

Documented once per language in `common-members.md`; listed here so this page is self-contained.

| Property | Signature | Access | Meaning |
|---|---|---|---|
| `DebugLogFilePath` | `# $strVal is a string # $ckStr is a CkString $stream->get_DebugLogFilePath($ckStr); $strVal = $stream->debugLogFilePath(); $stream->put_DebugLogFilePath($strVal);` | read/write | If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. |
| `LastErrorHtml` | `# $strVal is a string # $ckStr is a CkString $stream->get_LastErrorHtml($ckStr); $strVal = $stream->lastErrorHtml();` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `# $strVal is a string # $ckStr is a CkString $stream->get_LastErrorText($ckStr); $strVal = $stream->lastErrorText();` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `# $strVal is a string # $ckStr is a CkString $stream->get_LastErrorXml($ckStr); $strVal = $stream->lastErrorXml();` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `# $boolVal is a boolean $boolVal = $stream->get_LastMethodSuccess(); $stream->put_LastMethodSuccess($boolVal);` | read/write | Indicates the success or failure of the most recent method call: `1` means success, `0` means failure. |
| `Utf8` | `# $boolVal is a boolean $boolVal = $stream->get_Utf8(); $stream->put_Utf8($boolVal);` | read/write | When set to `1`, all `string` arguments and return values are interpreted as UTF-8 strings. |
| `VerboseLogging` | `# $boolVal is a boolean $boolVal = $stream->get_VerboseLogging(); $stream->put_VerboseLogging($boolVal);` | read/write | If set to `1`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `# $strVal is a string # $ckStr is a CkString $stream->get_Version($ckStr); $strVal = $stream->version();` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `AbortCurrent` | property, read/write | `# $boolVal is a boolean $boolVal = $stream->get_AbortCurrent(); $stream->put_AbortCurrent($boolVal);` |
| `CanRead` | property, read-only | `# $boolVal is a boolean $boolVal = $stream->get_CanRead();` |
| `CanWrite` | property, read-only | `# $boolVal is a boolean $boolVal = $stream->get_CanWrite();` |
| `DataAvailable` | property, read-only | `# $boolVal is a boolean $boolVal = $stream->get_DataAvailable();` |
| `DefaultChunkSize` | property, read/write | `# $intVal is an integer $intVal = $stream->get_DefaultChunkSize(); $stream->put_DefaultChunkSize($intVal);` |
| `EndOfStream` | property, read-only | `# $boolVal is a boolean $boolVal = $stream->get_EndOfStream();` |
| `IsWriteClosed` | property, read-only | `# $boolVal is a boolean $boolVal = $stream->get_IsWriteClosed();` |
| `Length` | property, read/write | `# $int64Val is a 64-bit integer $int64Val = $stream->get_Length(); $stream->put_Length($int64Val);` |
| `Length32` | property, read/write | `# $intVal is an integer $intVal = $stream->get_Length32(); $stream->put_Length32($intVal);` |
| `NumReceived` | property, read-only | `# $int64Val is a 64-bit integer $int64Val = $stream->get_NumReceived();` |
| `NumSent` | property, read-only | `# $int64Val is a 64-bit integer $int64Val = $stream->get_NumSent();` |
| `ReadFailReason` | property, read-only | `# $intVal is an integer $intVal = $stream->get_ReadFailReason();` |
| `ReadTimeoutMs` | property, read/write | `# $intVal is an integer $intVal = $stream->get_ReadTimeoutMs(); $stream->put_ReadTimeoutMs($intVal);` |
| `SinkFile` | property, read/write | `# $strVal is a string # $ckStr is a CkString $stream->get_SinkFile($ckStr); $strVal = $stream->sinkFile(); $stream->put_SinkFile($strVal);` |
| `SinkFileAppend` | property, read/write | `# $boolVal is a boolean $boolVal = $stream->get_SinkFileAppend(); $stream->put_SinkFileAppend($boolVal);` |
| `SourceFile` | property, read/write | `# $strVal is a string # $ckStr is a CkString $stream->get_SourceFile($ckStr); $strVal = $stream->sourceFile(); $stream->put_SourceFile($strVal);` |
| `SourceFilePart` | property, read/write | `# $intVal is an integer $intVal = $stream->get_SourceFilePart(); $stream->put_SourceFilePart($intVal);` |
| `SourceFilePartSize` | property, read/write | `# $intVal is an integer $intVal = $stream->get_SourceFilePartSize(); $stream->put_SourceFilePartSize($intVal);` |
| `StringBom` | property, read/write | `# $boolVal is a boolean $boolVal = $stream->get_StringBom(); $stream->put_StringBom($boolVal);` |
| `StringCharset` | property, read/write | `# $strVal is a string # $ckStr is a CkString $stream->get_StringCharset($ckStr); $strVal = $stream->stringCharset(); $stream->put_StringCharset($strVal);` |
| `WriteFailReason` | property, read-only | `# $intVal is an integer $intVal = $stream->get_WriteFailReason();` |
| `WriteTimeoutMs` | property, read/write | `# $intVal is an integer $intVal = $stream->get_WriteTimeoutMs(); $stream->put_WriteTimeoutMs($intVal);` |
| `LoadTaskCaller` | method | `# $task is a CkTask $status = $stream->LoadTaskCaller($task);` |
| `ReadBd` | method | `# $binData is a CkBinData $status = $stream->ReadBd($binData);` |
| `ReadBytesENC` | method | `# $encoding is a string # $outStr is a CkString (output) $status = $stream->ReadBytesENC($encoding, $outStr); $retStr = $stream->readBytesENC($encoding);` |
| `ReadNBytesENC` | method | `# $numBytes is an integer # $encoding is a string # $outStr is a CkString (output) $status = $stream->ReadNBytesENC($numBytes, $encoding, $outStr); $retStr = $stream->readNBytesENC($numBytes, $encoding);` |
| `ReadSb` | method | `# $sb is a CkStringBuilder $status = $stream->ReadSb($sb);` |
| `ReadString` | method | `# $outStr is a CkString (output) $status = $stream->ReadString($outStr); $retStr = $stream->readString();` |
| `ReadToCRLF` | method | `# $outStr is a CkString (output) $status = $stream->ReadToCRLF($outStr); $retStr = $stream->readToCRLF();` |
| `ReadUntilMatch` | method | `# $matchStr is a string # $outStr is a CkString (output) $status = $stream->ReadUntilMatch($matchStr, $outStr); $retStr = $stream->readUntilMatch($matchStr);` |
| `Reset` | method | `$stream->Reset();` |
| `SetSourceString` | method | `# $srcStr is a string # $charset is a string $status = $stream->SetSourceString($srcStr, $charset);` |
| `WriteBd` | method | `# $binData is a CkBinData $status = $stream->WriteBd($binData);` |
| `WriteByte` | method | `# $byteVal is an integer $status = $stream->WriteByte($byteVal);` |
| `WriteBytesENC` | method | `# $byteData is a string # $encoding is a string $status = $stream->WriteBytesENC($byteData, $encoding);` |
| `WriteClose` | method | `$status = $stream->WriteClose();` |
| `WriteSb` | method | `# $sb is a CkStringBuilder $status = $stream->WriteSb($sb);` |
| `WriteString` | method | `# $str is a string $status = $stream->WriteString($str);` |

Deprecated members are listed at the end of this file with their replacements; do not use them in new code.

## Properties

### Stream.AbortCurrent

`Chilkat 11.7.0 · ckperl · Stream · AbortCurrent · property · read/write · since 9.5.0.58`

```perl
# $boolVal is a boolean

$boolVal = $stream->get_AbortCurrent();

$stream->put_AbortCurrent($boolVal);
```

When set to `1`, causes the currently running method to abort. Methods that always finish quickly (i.e.have no length file operations or network communications) are not affected. If no method is running, then this property is automatically reset to `0` when the next method is called. When the abort occurs, this property is reset to `0`. Both synchronous and asynchronous method calls can be aborted. (A synchronous method call could be aborted by setting this property from a separate thread.)

### Stream.CanRead

`Chilkat 11.7.0 · ckperl · Stream · CanRead · property · read-only · since 9.5.0.56`

```perl
# $boolVal is a boolean

$boolVal = $stream->get_CanRead();
```

`1` if the stream supports reading. Otherwise `0`.

**Note:** A stream that supports reading, which has already reached the end-of-stream, will still have a CanRead value of `1`. This property indicates the stream's inherent ability, and not whether or not the stream can be read at a particular moment in time.

### Stream.CanWrite

`Chilkat 11.7.0 · ckperl · Stream · CanWrite · property · read-only · since 9.5.0.56`

```perl
# $boolVal is a boolean

$boolVal = $stream->get_CanWrite();
```

`1` if the stream supports writing. Otherwise `0`.

**Note:** A stream that supports writing, which has already been closed for write, will still have a CanWrite value of `1`. This property indicates the stream's inherent ability, and not whether or not the stream can be written at a particular moment in time.

### Stream.DataAvailable

`Chilkat 11.7.0 · ckperl · Stream · DataAvailable · property · read-only · since 9.5.0.56`

```perl
# $boolVal is a boolean

$boolVal = $stream->get_DataAvailable();
```

`1` if it is known for sure that data is ready and waiting to be read. `0` if it is not known for sure (it may be that data is immediately available, but reading the stream with a ReadTimeoutMs of 0, which is to poll the stream, is the way to find out).

### Stream.DefaultChunkSize

`Chilkat 11.7.0 · ckperl · Stream · DefaultChunkSize · property · read/write · since 9.5.0.56`

```perl
# $intVal is an integer

$intVal = $stream->get_DefaultChunkSize();

$stream->put_DefaultChunkSize($intVal);
```

The default internal chunk size for reading or writing. The default value is 65536. If this property is set to 0, it will cause the default chunk size (65536) to be used. Note: The chunk size can have significant performance impact. If performance is an issue, be sure to experiment with different chunk sizes.

### Stream.EndOfStream

`Chilkat 11.7.0 · ckperl · Stream · EndOfStream · property · read-only · since 9.5.0.56`

```perl
# $boolVal is a boolean

$boolVal = $stream->get_EndOfStream();
```

`1` if the end-of-stream has already been reached. When the stream has already ended, all calls to Read\* methods will return `0` with the ReadFailReason set to 3 (already at end-of-stream).

### Stream.IsWriteClosed

`Chilkat 11.7.0 · ckperl · Stream · IsWriteClosed · property · read-only · since 9.5.0.56`

```perl
# $boolVal is a boolean

$boolVal = $stream->get_IsWriteClosed();
```

`1` if the stream is closed for writing. Once closed, no more data may be written to the stream.

### Stream.Length

`Chilkat 11.7.0 · ckperl · Stream · Length · property · read/write · since 9.5.0.56`

```perl
# $int64Val is a 64-bit integer

$int64Val = $stream->get_Length();

$stream->put_Length($int64Val);
```

The length (in bytes) of the stream's source. If unknown, then this property will have a value of -1. This property may be set by the application if it knows in advance the length of the stream.

### Stream.Length32

`Chilkat 11.7.0 · ckperl · Stream · Length32 · property · read/write · since 9.5.0.58`

```perl
# $intVal is an integer

$intVal = $stream->get_Length32();

$stream->put_Length32($intVal);
```

The length (in bytes) of the stream's source. If unknown, then this property will have a value of -1. This property may be set by the application if it knows in advance the length of the stream.

Setting this property also sets the Length property (which is a 64-bit integer).

### Stream.NumReceived

`Chilkat 11.7.0 · ckperl · Stream · NumReceived · property · read-only · since 9.5.0.56`

```perl
# $int64Val is a 64-bit integer

$int64Val = $stream->get_NumReceived();
```

The number of bytes received by the stream.

### Stream.NumSent

`Chilkat 11.7.0 · ckperl · Stream · NumSent · property · read-only · since 9.5.0.56`

```perl
# $int64Val is a 64-bit integer

$int64Val = $stream->get_NumSent();
```

The number of bytes sent by the stream.

### Stream.ReadFailReason

`Chilkat 11.7.0 · ckperl · Stream · ReadFailReason · property · read-only · since 9.5.0.56`

```perl
# $intVal is an integer

$intVal = $stream->get_ReadFailReason();
```

This property is automatically set when a Read\* method is called. It indicates the reason for failure. Possible values are:

0>
0. No failure (success)
1. Timeout, or no data is immediately available for a polling read.
2. Aborted by an application callback.
3. Already at end-of-stream.
4. Fatal stream error.
5. Out-of-memory error (this is very unlikely).

### Stream.ReadTimeoutMs

`Chilkat 11.7.0 · ckperl · Stream · ReadTimeoutMs · property · read/write · since 9.5.0.56`

```perl
# $intVal is an integer

$intVal = $stream->get_ReadTimeoutMs();

$stream->put_ReadTimeoutMs($intVal);
```

The maximum number of seconds to wait while reading. The default value is 30 seconds (i.e. 30000ms). A value of 0 indicates a poll. (A polling read is to return with a timeout if no data is immediately available.)

**Important:** For most Chilkat timeout related properties, a value of 0 indicates an infinite timeout. For this property, a value of 0 indicates a poll. If setting a timeout related property (or method argument) to zero, be sure to understand if 0 means `wait forever` or `poll`.

The timeout value is not a total timeout. It is the maximum time to wait while no additional data is forthcoming.

### Stream.SinkFile

`Chilkat 11.7.0 · ckperl · Stream · SinkFile · property · read/write · since 9.5.0.56`

```perl
# $strVal is a string

# $ckStr is a CkString

$stream->get_SinkFile($ckStr);

$strVal = $stream->sinkFile();

$stream->put_SinkFile($strVal);
```

Sets the sink to the path of a file. The file does not need to exist at the time of setting this property. The sink file will be automatically opened on demand, when the stream is first written.

**Note:** This property takes priority over other potential sinks. Make sure this property is set to an empty string if the stream's sink is to be something else.

### Stream.SinkFileAppend

`Chilkat 11.7.0 · ckperl · Stream · SinkFileAppend · property · read/write · since 9.5.0.83`

```perl
# $boolVal is a boolean

$boolVal = $stream->get_SinkFileAppend();

$stream->put_SinkFileAppend($boolVal);
```

If `1`, the stream appends to the SinkFile rather than truncating and re-writing the sink file. The default value is `0`.

### Stream.SourceFile

`Chilkat 11.7.0 · ckperl · Stream · SourceFile · property · read/write · since 9.5.0.56`

```perl
# $strVal is a string

# $ckStr is a CkString

$stream->get_SourceFile($ckStr);

$strVal = $stream->sourceFile();

$stream->put_SourceFile($strVal);
```

Sets the source to the path of a file. The file does not need to exist at the time of setting this property. The source file will be automatically opened on demand, when the stream is first read.

**Note:** This property takes priority over other potential sources. Make sure this property is set to an empty string if the stream's source is to be something else.

### Stream.SourceFilePart

`Chilkat 11.7.0 · ckperl · Stream · SourceFilePart · property · read/write · since 9.5.0.59`

```perl
# $intVal is an integer

$intVal = $stream->get_SourceFilePart();

$stream->put_SourceFilePart($intVal);
```

If the source is a file, then this property can be used to stream one part of the file. The SourceFilePartSize property defines the size (in bytes) of each part. The SourceFilePart and SourceFilePartSize have default values of 0, which means the entire SourceFile is streamed.

This property is a 0-based index. For example, if the SourceFilePartSize is 1000, then part 0 is for bytes 0 to 999, part 1 is for bytes 1000 to 1999, etc.

### Stream.SourceFilePartSize

`Chilkat 11.7.0 · ckperl · Stream · SourceFilePartSize · property · read/write · since 9.5.0.59`

```perl
# $intVal is an integer

$intVal = $stream->get_SourceFilePartSize();

$stream->put_SourceFilePartSize($intVal);
```

If the source is a file, then this property, in conjunction with the SourceFilePart property, can be used to stream a single part of the file. This property defines the size (in bytes) of each part. The SourceFilePart and SourceFilePartSize have default values of 0, which means that by default, the entire SourceFile is streamed.

### Stream.StringBom

`Chilkat 11.7.0 · ckperl · Stream · StringBom · property · read/write · since 9.5.0.56`

```perl
# $boolVal is a boolean

$boolVal = $stream->get_StringBom();

$stream->put_StringBom($boolVal);
```

If `1`, then include the BOM when creating a string source via SetSourceString where the charset is utf-8, utf-16, etc. (The term `BOM` stands for Byte Order Mark, also known as the preamble.) Also, if `1`, then include the BOM when writing a string via the WriteString method. The default value of this property is `0`.

### Stream.StringCharset

`Chilkat 11.7.0 · ckperl · Stream · StringCharset · property · read/write · since 9.5.0.56`

```perl
# $strVal is a string

# $ckStr is a CkString

$stream->get_StringCharset($ckStr);

$strVal = $stream->stringCharset();

$stream->put_StringCharset($strVal);
```

Indicates the expected character encoding, such as utf-8, windows-1256, utf-16, etc. for methods that read text such as: ReadString, ReadToCRLF, ReadUntilMatch. Also controls the character encoding when writing strings with the WriteString method. The supported charsets are indicated at the link below.

The default value is `utf-8`.

See also:

- [Charsets Supported by Chilkat](http://www.cknotes.com/chilkat-charsets-character-encodings-supported/)

### Stream.WriteFailReason

`Chilkat 11.7.0 · ckperl · Stream · WriteFailReason · property · read-only · since 9.5.0.56`

```perl
# $intVal is an integer

$intVal = $stream->get_WriteFailReason();
```

This property is automatically set when a Write\* method is called. It indicates the reason for failure. Possible values are:

0>
0. No failure (success)
1. Timeout, or unable to immediately write when the WriteTimeoutMs is 0.
2. Aborted by an application callback.
3. The stream has already ended.
4. Fatal stream error.
5. Out-of-memory error (this is very unlikely).

### Stream.WriteTimeoutMs

`Chilkat 11.7.0 · ckperl · Stream · WriteTimeoutMs · property · read/write · since 9.5.0.56`

```perl
# $intVal is an integer

$intVal = $stream->get_WriteTimeoutMs();

$stream->put_WriteTimeoutMs($intVal);
```

The maximum number of seconds to wait while writing. The default value is 30 seconds (i.e. 30000ms). A value of 0 indicates to return immediately if it is not possible to write to the sink immediately.

## Methods

### Stream.LoadTaskCaller

`Chilkat 11.7.0 · ckperl · Stream · LoadTaskCaller · method · since 9.5.0.80`

```perl
# $task is a CkTask

$status = $stream->LoadTaskCaller($task);
```

Loads the caller of the task's async method.

Returns 1 for success, 0 for failure.

### Stream.ReadBd

`Chilkat 11.7.0 · ckperl · Stream · ReadBd · method · since 9.5.0.67`

```perl
# $binData is a CkBinData

$status = $stream->ReadBd($binData);
```

Read as much data as is immediately available on the stream. If no data is immediately available, it waits up to ReadTimeoutMs milliseconds for data to arrive. The incoming data is appended to `binData`.

Returns 1 for success, 0 for failure.

Async variant: `ReadBdAsync` — same arguments, returns a `Task` (see Async variants below).

### Stream.ReadBytesENC

`Chilkat 11.7.0 · ckperl · Stream · ReadBytesENC · method · since 9.5.0.56`

```perl
# $encoding is a string

# $outStr is a CkString (output)

$status = $stream->ReadBytesENC($encoding, $outStr);

$retStr = $stream->readBytesENC($encoding);
```

**Full documentation for this method (same in every language):** [Binary Encodings Supported by Chilkat](https://www.chilkatsoft.com/ai-docs/v/11.7.0/articles/binary_encodings.md)

The same as ReadBytes, except returns the received bytes in encoded string form. The `encoding` argument indicates the encoding, which can be `base64`, `hex`, or any of the multitude of encodings indicated in the link below.

Returns 1 for success, 0 for failure.

Async variant: `ReadBytesENCAsync` — same arguments, returns a `Task` (see Async variants below).

### Stream.ReadNBytesENC

`Chilkat 11.7.0 · ckperl · Stream · ReadNBytesENC · method · since 9.5.0.56`

```perl
# $numBytes is an integer

# $encoding is a string

# $outStr is a CkString (output)

$status = $stream->ReadNBytesENC($numBytes, $encoding, $outStr);

$retStr = $stream->readNBytesENC($numBytes, $encoding);
```

**Full documentation for this method (same in every language):** [Binary Encodings Supported by Chilkat](https://www.chilkatsoft.com/ai-docs/v/11.7.0/articles/binary_encodings.md)

The same as ReadNBytes, except returns the received bytes in encoded string form. The `encoding` argument indicates the encoding, which can be `base64`, `hex`, or any of the multitude of encodings indicated in the link below.

Returns 1 for success, 0 for failure.

Async variant: `ReadNBytesENCAsync` — same arguments, returns a `Task` (see Async variants below).

### Stream.ReadSb

`Chilkat 11.7.0 · ckperl · Stream · ReadSb · method · since 9.5.0.67`

```perl
# $sb is a CkStringBuilder

$status = $stream->ReadSb($sb);
```

Read as much data as is immediately available on the stream. If no data is immediately available, it waits up to ReadTimeoutMs milliseconds for data to arrive. The data is appended to `sb`. The incoming bytes are interpreted according to the StringCharset property. For example, if utf-8 bytes are expected, then StringCharset should be set to `utf-8` prior to calling ReadSb.

Returns 1 for success, 0 for failure.

Async variant: `ReadSbAsync` — same arguments, returns a `Task` (see Async variants below).

### Stream.ReadString

`Chilkat 11.7.0 · ckperl · Stream · ReadString · method · since 9.5.0.56`

```perl
# $outStr is a CkString (output)

$status = $stream->ReadString($outStr);

$retStr = $stream->readString();
```

Read as much data as is immediately available on the stream. If no data is immediately available, it waits up to ReadTimeoutMs milliseconds for data to arrive. The data is returned as a string. The incoming bytes are interpreted according to the StringCharset property. For example, if utf-8 bytes are expected, then StringCharset should be set to `utf-8` prior to calling ReadString.

Returns 1 for success, 0 for failure.

Async variant: `ReadStringAsync` — same arguments, returns a `Task` (see Async variants below).

### Stream.ReadToCRLF

`Chilkat 11.7.0 · ckperl · Stream · ReadToCRLF · method · since 9.5.0.56`

```perl
# $outStr is a CkString (output)

$status = $stream->ReadToCRLF($outStr);

$retStr = $stream->readToCRLF();
```

Reads the stream until a CRLF is received. If no data is immediately available, it waits up to ReadTimeoutMs milliseconds for data to arrive. The data is returned as a string. The incoming bytes are interpreted according to the StringCharset property. For example, if utf-8 bytes are expected, then StringCharset should be set to `utf-8` prior to calling ReadString.

Note: If the end-of-stream is reached prior to receiving the CRLF, then the remaining data is returned, and the ReadFailReason property will be set to 3 (to indicate end-of-file). This is the only case where as string would be returned that does not end with CRLF.

Returns 1 for success, 0 for failure.

Async variant: `ReadToCRLFAsync` — same arguments, returns a `Task` (see Async variants below).

### Stream.ReadUntilMatch

`Chilkat 11.7.0 · ckperl · Stream · ReadUntilMatch · method · since 9.5.0.56`

```perl
# $matchStr is a string

# $outStr is a CkString (output)

$status = $stream->ReadUntilMatch($matchStr, $outStr);

$retStr = $stream->readUntilMatch($matchStr);
```

Reads the stream until the string indicated by `matchStr` is received. If no data is immediately available, it waits up to ReadTimeoutMs milliseconds for data to arrive. The data is returned as a string. The incoming bytes are interpreted according to the StringCharset property. For example, if utf-8 bytes are expected, then StringCharset should be set to `utf-8` prior to calling ReadString.

Note: If the end-of-stream is reached prior to receiving the match string, then the remaining data is returned, and the ReadFailReason property will be set to 3 (to indicate end-of-file). This is the only case where as string would be returned that does not end with the desired match string.

Returns 1 for success, 0 for failure.

Async variant: `ReadUntilMatchAsync` — same arguments, returns a `Task` (see Async variants below).

### Stream.Reset

`Chilkat 11.7.0 · ckperl · Stream · Reset · method · since 9.5.0.56`

```perl
$stream->Reset();
```

Resets the stream. If a source or sink is open, then it is closed. Properties such as EndOfStream and IsWriteClose are reset to default values.

### Stream.SetSourceString

`Chilkat 11.7.0 · ckperl · Stream · SetSourceString · method · since 9.5.0.56`

```perl
# $srcStr is a string

# $charset is a string

$status = $stream->SetSourceString($srcStr, $charset);
```

Sets the stream's source to the contents of `srcStr`. The `charset` indicates the character encoding to be used for the byte representation of the `srcStr`.

Returns 1 for success, 0 for failure.

### Stream.WriteBd

`Chilkat 11.7.0 · ckperl · Stream · WriteBd · method · since 9.5.0.67`

```perl
# $binData is a CkBinData

$status = $stream->WriteBd($binData);
```

Writes the contents of `binData` to the stream.

Returns 1 for success, 0 for failure.

Async variant: `WriteBdAsync` — same arguments, returns a `Task` (see Async variants below).

### Stream.WriteByte

`Chilkat 11.7.0 · ckperl · Stream · WriteByte · method · since 9.5.0.56`

```perl
# $byteVal is an integer

$status = $stream->WriteByte($byteVal);
```

Writes a single byte to the stream. The `byteVal` must have a value from 0 to 255.

Returns 1 for success, 0 for failure.

Async variant: `WriteByteAsync` — same arguments, returns a `Task` (see Async variants below).

### Stream.WriteBytesENC

`Chilkat 11.7.0 · ckperl · Stream · WriteBytesENC · method · since 9.5.0.56`

```perl
# $byteData is a string

# $encoding is a string

$status = $stream->WriteBytesENC($byteData, $encoding);
```

**Full documentation for this method (same in every language):** [Binary Encodings Supported by Chilkat](https://www.chilkatsoft.com/ai-docs/v/11.7.0/articles/binary_encodings.md)

Writes binary bytes to a stream. The byte data is passed in encoded string form, where the `encoding` can be `base64`, `hex`, or any of the supported binary encodings listed at the link below.

Returns 1 for success, 0 for failure.

Async variant: `WriteBytesENCAsync` — same arguments, returns a `Task` (see Async variants below).

### Stream.WriteClose

`Chilkat 11.7.0 · ckperl · Stream · WriteClose · method · since 9.5.0.56`

```perl
$status = $stream->WriteClose();
```

Indicates that no more data will be written to the stream.

Returns 1 for success, 0 for failure.

### Stream.WriteSb

`Chilkat 11.7.0 · ckperl · Stream · WriteSb · method · since 9.5.0.67`

```perl
# $sb is a CkStringBuilder

$status = $stream->WriteSb($sb);
```

Writes the contents of `sb` to the stream. The actual bytes written are the byte representation of the string as indicated by the StringCharset property. For example, to write utf-8 bytes, first set StringCharset equal to `utf-8` and then call WriteSb.

Returns 1 for success, 0 for failure.

Async variant: `WriteSbAsync` — same arguments, returns a `Task` (see Async variants below).

### Stream.WriteString

`Chilkat 11.7.0 · ckperl · Stream · WriteString · method · since 9.5.0.56`

```perl
# $str is a string

$status = $stream->WriteString($str);
```

Writes a string to a stream. The actual bytes written are the byte representation of the string as indicated by the StringCharset property. For example, to write utf-8 bytes, first set StringCharset equal to `utf-8` and then call WriteString.

Returns 1 for success, 0 for failure.

Async variant: `WriteStringAsync` — same arguments, returns a `Task` (see Async variants below).

## Events and callbacks

This binding has no event callbacks. For progress, percent-done or cancellation use the `*Async` variant of a method and poll the returned `Task` (`PercentDone`, `Finished`, `Cancel`).

## Async variants

Each returns a `Task` instead of the result and takes the same arguments as the synchronous method; run the task, wait for `Finished`, then read the result from the task. No new Async methods are added from 11.7.0 on.

```perl
# returns a CkTask

# $binData is a CkBinData

$ret_task = $stream->ReadBdAsync($binData);
# returns a CkTask

# $encoding is a string

$ret_task = $stream->ReadBytesENCAsync($encoding);
# returns a CkTask

# $numBytes is an integer

# $encoding is a string

$ret_task = $stream->ReadNBytesENCAsync($numBytes, $encoding);
# returns a CkTask

# $sb is a CkStringBuilder

$ret_task = $stream->ReadSbAsync($sb);
# returns a CkTask

$ret_task = $stream->ReadStringAsync();
# returns a CkTask

$ret_task = $stream->ReadToCRLFAsync();
# returns a CkTask

# $matchStr is a string

$ret_task = $stream->ReadUntilMatchAsync($matchStr);
# returns a CkTask

# $binData is a CkBinData

$ret_task = $stream->WriteBdAsync($binData);
# returns a CkTask

# $byteVal is an integer

$ret_task = $stream->WriteByteAsync($byteVal);
# returns a CkTask

# $byteData is a string

# $encoding is a string

$ret_task = $stream->WriteBytesENCAsync($byteData, $encoding);
# returns a CkTask

# $sb is a CkStringBuilder

$ret_task = $stream->WriteSbAsync($sb);
# returns a CkTask

# $str is a string

$ret_task = $stream->WriteStringAsync($str);
```

## Deprecated members — do not use in new code

| Member | Kind | Deprecated in | Use instead |
|---|---|---|---|
| `ReadBytes` | method | before 11.6.1 | — |
| `ReadNBytes` | method | before 11.6.1 | — |
| `SetSourceBytes` | method | before 11.6.1 | — |
| `WriteBytes` | method | before 11.6.1 | — |

## Related classes

[`BinData`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/ckperl/classes/BinData.md), [`StringBuilder`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/ckperl/classes/StringBuilder.md), [`Task`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/ckperl/classes/Task.md)