iscp.Connector - 下位プロトコルのコネクター

コネクターを表す抽象クラス

class Connector[ソース]

iSCPコネクターのインターフェースです。

abstract async connect(address, negotiation_params)[ソース]

iSCPを使って接続します。

パラメータ:
  • address (str) -- 接続先のアドレス。127.0.0.1:8080 形式。

  • negotiation_params (iscp.NegotiationParams) -- ネゴシエーションパラメータ

戻り値:

iSCPのトランスポート

戻り値の型:

iscp.Transport

class Transport[ソース]

iSCPのトランスポートインターフェースです。

abstract address()[ソース]

接続先アドレスを取得します。

戻り値:

接続先アドレス

戻り値の型:

str

abstract async close()[ソース]

トランスポートを閉じます。

abstract name()[ソース]

トランスポートの名前を取得します。

戻り値:

トランスポートの名前

戻り値の型:

iscp.TransportName

abstract negotiation_params()[ソース]

ネゴシエーションパラメータを取得します。

戻り値:

ネゴシエーションパラメータ

戻り値の型:

iscp.NegotiationParams

class NegotiationParams[ソース]

ネゴシエーションパラメータを表します。

enc

エンコーディング名です。

Type:

iscp.EncodingName

encode_to_binary()[ソース]

バイナリ形式にエンコードします。

戻り値:

バイナリ形式にエンコードされたネゴシエーションパラメータ

戻り値の型:

bytes

encode_to_url_values()[ソース]

URLパラメータにエンコードします。

戻り値:

URLパラメータにエンコードされたネゴシエーションパラメータ

戻り値の型:

str

コネクターを実装した具象クラス

class WebSocketConnector(*, keep_alive_interval=10, enable_tls=True, path='api/iscp/connect')[ソース]

WebSocketのiSCPコネクターです。

パラメータ:
  • enable_tls (bool) -- TLS有効化フラグ。Trueの場合は wss://${address}/${path} ,Falseの場合は ws://${address}/${path} でアクセスを試みます。

  • path (str) -- 接続先のaddressに続くパス

class QuicConnector(insecure=False)[ソース]

QUICのiSCPコネクターです。

パラメータ:

insecure (bool) -- Trueの場合、SSL証明書の検証を行いません。