ストリーム

ソースコード： ：source： `Lib / asyncio / streams.py`

ストリームは、ネットワーク接続で機能する高レベルの非同期/待機対応プリミティブです。ストリームを使用すると、コールバックや低レベルのプロトコルやトランスポートを使用せずにデータを送受信できます。

asyncioストリームを使用して記述されたTCPエコークライアントの例を次に示します。

import asyncio

async def tcp_echo_client(message):
    reader, writer = await asyncio.open_connection(
        '127.0.0.1', 8888)

    print(f'Send: {message!r}')
    writer.write(message.encode())
    await writer.drain()

    data = await reader.read(100)
    print(f'Received: {data.decode()!r}')

    print('Close the connection')
    writer.close()
    await writer.wait_closed()

asyncio.run(tcp_echo_client('Hello World!'))

以下の例セクションも参照してください。

流れ関数

次のトップレベルの非同期関数を使用して、ストリームを作成および操作できます。

Unixソケット

StreamReader

class asyncio.StreamReader

IOストリームからデータを読み取るためのAPIを提供するリーダーオブジェクトを表します。

StreamReader オブジェクトを直接インスタンス化することはお勧めしません。代わりにopen_connection()とstart_server()を使用してください。

at_eof(): バッファが空でfeed_eof()が呼び出された場合は、Trueを返します。

StreamWriter

class asyncio.StreamWriter

IOストリームにデータを書き込むためのAPIを提供するライターオブジェクトを表します。

StreamWriter オブジェクトを直接インスタンス化することはお勧めしません。代わりにopen_connection()とstart_server()を使用してください。

write(data)

このメソッドは、 data を基になるソケットにすぐに書き込もうとします。それが失敗した場合、データは送信できるようになるまで内部書き込みバッファのキューに入れられます。

この方法は、drain()方法と一緒に使用する必要があります。

stream.write(data)
await stream.drain()

writelines(data)

このメソッドは、バイトのリスト（または反復可能なもの）を基になるソケットにすぐに書き込みます。それが失敗した場合、データは送信できるようになるまで内部書き込みバッファのキューに入れられます。

この方法は、drain()方法と一緒に使用する必要があります。

stream.writelines(lines)
await stream.drain()

close()

このメソッドは、ストリームと基になるソケットを閉じます。

この方法は、wait_closed()方法と一緒に使用する必要があります。

stream.close()
await stream.wait_closed()

can_write_eof(): 基になるトランスポートが write_eof（）メソッドをサポートしている場合はTrueを返し、そうでない場合はFalseを返します。

write_eof(): バッファリングされた書き込みデータがフラッシュされた後、ストリームの書き込み終了を閉じます。

transport: 基になる非同期トランスポートを返します。

get_extra_info(name, default=None): オプションの輸送情報にアクセスします。詳細については、 BaseTransport.get_extra_info（）を参照してください。

is_closing(): ストリームが閉じている場合、または閉じている途中の場合は、Trueを返します。

バージョン3.7の新機能。

例