iscp

type Conn struct {

	// コネクションの設定
	Config ConnConfig
	// contains filtered or unexported fields
}

type ConnConfig struct {
	// アドレス
	//
	// ホスト:ポート（e.g. 127.0.0.1:8080）という形式で指定します。
	Address string

	// iSCPメッセージのトランスポート
	Transport TransportName

	// WebSocketの設定
	//
	// WebSocketのときにのみ有効な設定です。
	WebSocketConfig *websocket.DialerConfig

	// QUICの設定
	//
	// QUICのときにのみ有効な設定です。
	QUICConfig *quic.DialerConfig

	// WebTransportの設定
	//
	// WebTransportのときにのみ有効な設定です。
	WebTransportConfig *webtransport.DialerConfig

	// ロガー
	Logger log.Logger

	// iSCPメッセージのエンコーディング
	Encoding EncodingName

	// トランスポートの圧縮設定
	CompressConfig compress.Config

	// ノードID
	NodeID string

	// Pingを送信する間隔
	PingInterval time.Duration

	// Pingタイムアウト
	//
	// タイムアウトするとコネクションは強制的に閉じられます。
	PingTimeout time.Duration

	// ProjectのUUID
	ProjectUUID uuid.UUID

	// トークンソース
	TokenSource TokenSource

	// 再接続が完了した時のイベントハンドラ
	ReconnectedEventHandler ReconnectedEventHandler

	// コネクションが切断されたときのイベントハンドラ
	DisconnectedEventHandler DisconnectedEventHandler
	// contains filtered or unexported fields
}

type ConnOption func(*ConnConfig)

type DataPointGroup struct {
	// データID
	DataID *message.DataID

	// データポイント
	DataPoints DataPoints
}

type DataPointGroups []*DataPointGroup

type DataPoints []*message.DataPoint

type DisconnectedEvent struct {
	// 切断したコネクションの設定
	Config ConnConfig
}

type DisconnectedEventHandler interface {
	OnDisconnected(ev *DisconnectedEvent)
}

type DisconnectedEventHandlerFunc func(ev *DisconnectedEvent)

type Downstream struct {
	ID         uuid.UUID        // ID
	ServerTime time.Time        // DownstreamOpenResponseで返却されたサーバー時刻
	Config     DownstreamConfig // Downstreamの設定
	// contains filtered or unexported fields
}

type DownstreamCall struct {
	CallID       string // コールID
	SourceNodeID string // 送信元ノードID
	Name         string // 名称
	Type         string // 型
	Payload      []byte // ペイロード
}

type DownstreamChunk struct {
	// シーケンス番号
	SequenceNumber uint32
	// データポイントグループ
	DataPointGroups DataPointGroups
	// アップストリーム情報
	UpstreamInfo *message.UpstreamInfo
}

type DownstreamClosedEvent struct {
	// 切断したダウンストリームの設定
	Config DownstreamConfig
	// 切断したダウンストリームの状態
	State DownstreamState
	// 切断に失敗した場合のエラー情報
	Err error
}

type DownstreamClosedEventHandler interface {
	OnDownstreamClosed(ev *DownstreamClosedEvent)
}

type DownstreamClosedEventHandlerFunc func(ev *DownstreamClosedEvent)

type DownstreamConfig struct {
	Filters          []*message.DownstreamFilter // ダウンストリームフィルター
	QoS              message.QoS                 // QoS
	ExpiryInterval   time.Duration               // 有効期限
	DataIDs          []*message.DataID           // データIDエイリアス
	AckFlushInterval *time.Duration              // Ackのフラッシュインターバル

	// ダウンストリームがクローズされたときのイベントハンドラ
	ClosedEventHandler DownstreamClosedEventHandler
	// ダウンストリームが再開されたときのイベントハンドラ
	ResumedEventHandler DownstreamResumedEventHandler
	// 空チャンク省略フラグ。trueの場合、StreamChunk内のDataPointGroupが空の時、DownstreamChunkの送信を省略します。
	OmitEmptyChunk bool
}

type DownstreamMetadata struct {
	// 送信元ノードID
	SourceNodeID string
	// メタデータ
	Metadata message.Metadata
}

type DownstreamOption func(conf *DownstreamConfig)

type DownstreamReplyCall struct {
	CallID        string // コールID
	RequestCallID string // リクエストコールID
	SourceNodeID  string // リプライコールの送信元ノードID
	Name          string // 名称
	Type          string // 型
	Payload       []byte // ペイロード
}

type DownstreamResumedEvent struct {
	// 再開したダウンストリームのID
	ID uuid.UUID
	// 再開したダウンストリームの設定
	Config DownstreamConfig
	// 再開したダウンストリームの状態
	State DownstreamState
}

type DownstreamResumedEventHandler interface {
	OnDownstreamResumed(ev *DownstreamResumedEvent)
}

type DownstreamResumedEventHandlerFunc func(ev *DownstreamResumedEvent)

type DownstreamState struct {
	// データIDエイリアスとデータIDのマップ
	DataIDAliases map[uint32]*message.DataID

	// 最後に払い出されたデータIDエイリアス
	LastIssuedDataIDAlias uint32

	// アップストリームエイリアスとアップストリーム情報のマップ
	UpstreamInfos map[uint32]*message.UpstreamInfo

	// 最後に払い出されたアップストリーム情報のエイリアス
	LastIssuedUpstreamInfoAlias uint32

	// 最後に払い出されたAckのID
	LastIssuedChunkAckID uint32
}

type EncodingName string

type FlushPolicy interface {
	// Tickerは、時間間隔によるフラッシュを行うためのTickerを取得します。
	//
	// tickチャンネルが時間を返す度にフラッシュを行います。
	Ticker() (tick <-chan time.Time, stop func())

	// IsFlushは、内部バッファのサイズからフラッシュするかどうかを判定します。
	//
	// 内部バッファのサイズは蓄積されたデータポイントのペイロードサイズの合計値です。
	IsFlush(size uint32) bool
}

type ReceiveAckHooker interface {
	// HookAfterは、Ackを受信した直後に呼び出されます。
	HookAfter(streamID uuid.UUID, result UpstreamChunkResult)
}

type ReceiveAckHookerFunc func(streamID uuid.UUID, result UpstreamChunkResult)

type ReconnectedEvent struct {
	// 再接続したコネクションの設定
	Config ConnConfig
}

type ReconnectedEventHandler interface {
	OnReconnected(ev *ReconnectedEvent)
}

type ReconnectedEventHandlerFunc func(ev *ReconnectedEvent)

type SendDataPointsHooker interface {
	// HookBeforeは、データを送信する直前に呼び出されます。
	HookBefore(streamID uuid.UUID, chunk UpstreamChunk)
}

type SendDataPointsHookerFunc func(streamID uuid.UUID, chunk UpstreamChunk)

type SendMetadataOption func(opts *sendMetadataOptions)

type StaticTokenSource struct {
	// contains filtered or unexported fields
}

type Token string

type TokenSource interface {
	// Tokenはトークンを取得します。
	//
	// iSCPコネクションを開くたびに（再接続時を含む）、このメソッドをコールします。
	// このメソッドから毎回新しいトークンを返却することで、トークンの有効期限切れを回避することができます。
	Token() (Token, error)
}

type TokenSourceFunc func() (Token, error)

type TransportName string

type Upstream struct {
	ID         uuid.UUID      // ストリームID
	ServerTime time.Time      // UpstreamOpenResponseで返却されたサーバー時刻
	Config     UpstreamConfig // Upstreamの設定
	// contains filtered or unexported fields
}

type UpstreamCall struct {
	DestinationNodeID string // ノードID
	Name              string // 名称
	Type              string // 型
	Payload           []byte // ペイロード
}

type UpstreamChunk struct {
	// シーケンス番号
	SequenceNumber uint32
	// データポイントグループ
	DataPointGroups DataPointGroups
}

type UpstreamChunkResult struct {
	// シーケンス番号
	SequenceNumber uint32
	// 結果コード
	ResultCode message.ResultCode
	// 結果文字列
	ResultString string
}

type UpstreamCloseOption func(opts *upstreamCloseOptions)

type UpstreamClosedEvent struct {
	// 切断したアップストリームの設定
	Config UpstreamConfig
	// 切断したアップストリームの状態
	State UpstreamState
	// 切断に失敗した場合のエラー情報
	Err error
}

type UpstreamClosedEventHandler interface {
	OnUpstreamClosed(ev *UpstreamClosedEvent)
}

type UpstreamClosedEventHandlerFunc func(ev *UpstreamClosedEvent)

type UpstreamConfig struct {
	SessionID      string            // セッションID
	AckInterval    *time.Duration    // Ackの返却間隔
	CloseTimeout   *time.Duration    // Close時のタイムアウト
	ExpiryInterval time.Duration     // 有効期限
	DataIDs        []*message.DataID // データIDリスト
	QoS            message.QoS       // QoS
	Persist        bool              // 永続化するかどうか
	FlushPolicy    FlushPolicy
	AckTimeout     time.Duration // Ackのタイムアウト。この時間を過ぎてAckが返却された場合はコネクションを切断します。

	// Ack受信時のフック
	ReceiveAckHooker ReceiveAckHooker
	// データポイント送信時のフック
	SendDataPointsHooker SendDataPointsHooker

	// アップストリームがクローズされたときのイベントハンドラ
	ClosedEventHandler UpstreamClosedEventHandler
	// アップストリームが再開されたときのイベントハンドラ
	ResumedEventHandler UpstreamResumedEventHandler
}

type UpstreamOption func(conf *UpstreamConfig)

type UpstreamReplyCall struct {
	RequestCallID     string // 受信したDownstreamCallのコールID
	DestinationNodeID string // リプライ先のNodeID
	Name              string // 名称
	Type              string // 型
	Payload           []byte // ペイロード
}

type UpstreamResumedEvent struct {
	// 再開したアップストリームのID
	ID uuid.UUID
	// 再開したアップストリームの設定
	Config UpstreamConfig
	// 再開したアップストリームの状態
	State UpstreamState
}

type UpstreamResumedEventHandler interface {
	OnUpstreamResumed(ev *UpstreamResumedEvent)
}

type UpstreamResumedEventHandlerFunc func(ev *UpstreamResumedEvent)

type UpstreamState struct {
	DataIDAliases            map[uint32]*message.DataID // データIDとエイリアスのマップ
	TotalDataPoints          uint64                     // 総送信データポイント数
	LastIssuedSequenceNumber uint32                     // 最後に払い出されたシーケンス番号
	DataPointsBuffer         DataPointGroups            // 内部に保存しているデータポイントバッファ
}