@aptpod/iscp-ts
Version:
iSCP 2.0 client library for TypeScript
87 lines (86 loc) • 4.91 kB
TypeScript
/**
* RESULT_CODEは、要求の処理結果を表す識別コードです。
*
* RESULT_CODEは、以下の値を取ります。
* @category Enum
* @enum
*/
export declare const RESULT_CODE: {
/** 処理が正常に成功したことを表します。 */
readonly SUCCEEDED: 0;
/** 正常にコネクションが閉じられたことを表します。 */
readonly NORMAL_CLOSURE: 0;
/** ノードとブローカーのバージョンに互換性が無いことを表します。 */
readonly INCOMPATIBLE_VERSION: 1;
/** データIDエイリアス値の数が上限に達し、データIDエイリアス値を新たに割り当てることができないことを表します。 */
readonly MAXIMUM_DATA_ID_ALIAS: 2;
/** アップストリームエイリアス値の数が上限に達し、アップストリームエイリアス値を新たに割り当てることができないことを表します。 */
readonly MAXIMUM_UPSTREAM_ALIAS: 3;
/** 種類を規定しないエラーです。予期しないエラーが発生した場合に使用されます。 */
readonly UNSPECIFIED_ERROR: 64;
/** 接続時にノードIDを指定していないことを表します。 */
readonly NO_NODE_ID: 65;
/** 認証や認可の処理に失敗したことを表します。 */
readonly AUTH_FAILED: 66;
/** 妥当な時間までに、通信の開始シーケンスが完了しなかったことを表します。 */
readonly CONNECT_TIMEOUT: 67;
/** 不正な形式のメッセージを受信したことを表します。 */
readonly MALFORMED_MESSAGE: 68;
/** プロトコル違反を表します。 */
readonly PROTOCOL_ERROR: 69;
/** ACKの返却までに時間がかかりすぎて、送信側よりネットワークが切断されたことを表します。 */
readonly ACK_TIMEOUT: 70;
/** ペイロードの形式が不正であることを表します。 */
readonly INVALID_PAYLOAD: 71;
/** データIDが不正であることを表します。 */
readonly INVALID_DATA_ID: 72;
/** データIDエイリアスが不正であることを表します。 */
readonly INVALID_DATA_ID_ALIAS: 73;
/** データフィルタが不正であることを表します。 */
readonly INVALID_DATA_FILTER: 74;
/** 受信者が保持している情報の中に、対象のストリームが含まれないことを表します。 */
readonly STREAM_NOT_FOUND: 75;
/** 再開しようとしたストリームが接続中であることを表します。 */
readonly RESUME_REQUEST_CONFLICT: 76;
/** 処理が失敗したことを表します。 */
readonly PROCESS_FAILED: 77;
/** 要求されたQoSをサポートしていないことを表します。 */
readonly DESIRED_QOS_NOT_SUPPORTED: 78;
/** Pingのタイムアウトが発生したことを表します。 */
readonly PING_TIMEOUT: 79;
/** メッセージのサイズが大きすぎることを表します。 */
readonly TOO_LARGE_MESSAGE_SIZE: 80;
/** データIDエイリアスが多すぎることを表します。 */
readonly TOO_MANY_DATA_ID_ALIASES: 81;
/** ストリームが多すぎることを表します。 */
readonly TOO_MANY_STREAMS: 82;
/** ACKの返却間隔が長すぎることを表します。 */
readonly TOO_LONG_ACK_INTERVAL: 83;
/** ダウンストリームフィルタが多すぎることを表します。 */
readonly TOO_MANY_DOWNSTREAM_FILTERS: 84;
/** データフィルタが多すぎることを表します。 */
readonly TOO_MANY_DATA_FILTERS: 85;
/** 有効期限が長すぎることを表します。 */
readonly TOO_LONG_EXPIRY_INTERVAL: 86;
/** Pingタイムアウト値が大きすぎることを表します。 */
readonly TOO_LONG_PING_TIMEOUT: 87;
/** Ping間隔が短すぎることを表します。 */
readonly TOO_SHORT_PING_INTERVAL: 88;
/** Pingタイムアウトが短すぎることを表します。 */
readonly TOO_SHORT_PING_TIMEOUT: 89;
/** レートリミットに到達したことを表します。 */
readonly RATE_LIMIT_REACHED: 90;
/** すでに永続化されているセッションの生成元ノードと、新たに永続化しようとするノードが異なることを表します。 */
readonly NODE_ID_MISMATCH: 128;
/** セッションが見つからなかったことを表します。 */
readonly SESSION_NOT_FOUND: 129;
/** セッションがすでに閉じられていることを表します。 */
readonly SESSION_ALREADY_CLOSED: 130;
/** セッションを閉じることができないことを表します。 */
readonly SESSION_CANNOT_CLOSED: 131;
};
/**
* {@link RESULT_CODE}の型です。
* @category Enum
*/
export type ResultCode = (typeof RESULT_CODE)[keyof typeof RESULT_CODE];