2021年09月18日くいなちゃん


プログラミング言語Kuin」の実行環境がexe用のAPIリファレンスページです。
netライブラリは現在、動作環境(-eオプション)が「exe」のときのみ使えます。 他の環境向けに使用するとコンパイルエラーになります。

 net@Http

HTTP通信でデータを受信するクラスです。

 net@Http.fin



データの受信を終了するメソッドです。

fin()

既に受信を終了しているとき、このメソッドは何もしません。
受信はnet@Httpクラスのインスタンスが解放されるときに自動で終了します。 このメソッドは、終了するタイミングを明示的に制御したいときにお使いください。

 net@Http.get



データを受信するメソッドです。

func get(): []char

戻り値受信したデータ。 受信が完了していない場合はnullが返る

 net@Tcp

TCP通信を行うクラスです。

 net@Tcp.connecting



接続状態かどうかを取得するメソッドです。

func connecting(): bool

戻り値接続した状態ならtrue、切断されたならfalse

 net@Tcp.fin



接続を切断するメソッドです。

func fin()

既に切断されているとき、このメソッドは何もしません。
接続はnet@Tcpクラスのインスタンスが解放されるときに自動で切断されます。 このメソッドは、切断するタイミングを明示的に制御したいときにお使いください。

 net@Tcp.receive



データを受信するメソッドです。

func receive(size: int): []bit8

size受信するデータのサイズ
戻り値受信したデータ。 通信が切断されているときや、size分のデータが受信できなかったときはnullが返る
net@Tcpクラスのインスタンスは内部に1MBのバッファを保持しており、受信可能なデータがあるとこのバッファに溜めていきます。 receiveメソッドは、このバッファにsize分のデータがあれば切り取って返し、なければ何もせずにnullを返します。
このため、1MBを超えるデータを一度に取得することはできません。 1MB以下の単位で分割取得してください。
発生条件ビルド例外コード
sizeが0以上1024*1024以下の範囲外dbgのみ0xE9170006

 net@Tcp.receivedSize



受信したデータのサイズを取得するメソッドです。

func receivedSize(): int

戻り値受信したデータのサイズ
通信が切断されているときは、0が返ります。

 net@Tcp.send



データを送信するメソッドです。

func send(data: []bit8)

data送信するデータ。 nullであってはならない
通信が切断されているときは、このメソッドは何もせずに抜けます。

 net@TcpServer

TCPサーバの処理を行うクラスです。

 net@TcpServer.fin



接続の待ち受けを終了するメソッドです。

func fin()

既に待ち受けを終了しているとき、このメソッドは何もしません。
待ち受けはnet@TcpServerクラスのインスタンスが解放されるときに自動で終了します。 このメソッドは、終了するタイミングを明示的に制御したいときにお使いください。

 net@TcpServer.get



TCPクライアントとの接続を取得するメソッドです。

func get(): tcp@Tcp

戻り値TCPクライアントとの通信を行うクラスのインスタンス。 待ち受け状態になっていないときや、TCPクライアントからの接続がなければnullが返る
net@TcpServerクラスのインスタンスは待ち受け状態のときに、常にTCPクライアントからの接続要求を監視しています。 接続要求があると直ちに通信を開始し、その情報を記録しつつ、引き続き接続要求の待ち受けを続けます。
getメソッドを呼ぶと、記録したTCPクライアントの情報を1つ切り取って、データが送受信できるインスタンスの形で返します。 記録した情報が1つもなければ何もせずにnullを返します。

 net@makeHttp

HTTP通信を開始する関数です。

func makeHttp(url: []char, post: bool, agent: []char): net@Http

urlデータを取得するURL
postPOSTならtrue、GETならfalse
agentサーバに送るユーザエージェント。 nullを指定すると空文字が送られる
戻り値データを受信するクラス

 net@makeTcpClient

TCPクライアントを作成する関数です。

func makeTcpClient(host: []char, port: int): net@Tcp

hostサーバのホスト名またはIPアドレス
port接続するポート番号
戻り値TCP通信を行うクラスのインスタンス。 接続に失敗した場合はnullが返る
発生条件ビルド例外コード
portが0以上65535以下の範囲外dbgのみ0xE9170006

 net@makeTcpServer

TCPサーバを作成する関数です。

func makeTcpServer(port: int): net@TcpServer

port接続を待ち受けるポート番号
戻り値TCPサーバ。 設定に失敗した場合はnullが返る
この関数を呼び出した時点で接続の待ち受けが開始されます。
49152以上のポート番号は動的に決定されることを前提としており、明示的に設定することはできません。
発生条件ビルド例外コード
portが0以上49152未満の範囲外dbgのみ0xE9170006
1631937825jaf