Documentation
¶
Overview ¶
Package tai provides the server-side SDK for communicating with Tai nodes over the Tai Transport Protocol v2.
Tai is a closed-source binary installed on every computer. This SDK implements the server side of the transport layer, enabling any server (e.g. Yao) to accept Tai connections, manage nodes, and run sessions.
Quick start:
server, err := tai.NewServer(&tai.ServerConfig{
TransportPort: 6099,
HTTPPort: 5099,
Auth: auth.DefaultAuth(privateKey),
})
server.Start(ctx)
Index ¶
- Constants
- Variables
- type AudioConfig
- type AuthProvider
- type ControlMsg
- type MotionConfig
- type Node
- type NodeInfo
- type NodeRuntime
- type OpenSessionRequest
- type PoolSettings
- type Provider
- type Providers
- type RealtimeRequest
- type RealtimeUpdateOptions
- type RemoteNode
- type Server
- type ServerConfig
- type Session
- type SessionMsg
- type SessionRequest
- type TLSConfig
- type TLSInfo
- type ToolDefinition
- type ToolHandler
- type UserMessage
- type VADConfig
- type WellKnownResponse
Constants ¶
const ( NamespaceControl = types.NamespaceControl NamespaceSession = types.NamespaceSession )
Re-export constants.
const DefaultShutdownTimeout = 5 * time.Second
DefaultShutdownTimeout is how long Close waits for in-flight requests.
Variables ¶
var (
ErrNodeNotFound = types.ErrNodeNotFound
)
Re-export errors.
var ErrNotImplemented = errors.New("tai: not implemented")
ErrNotImplemented is returned by Server methods not yet available.
Functions ¶
This section is empty.
Types ¶
type AudioConfig ¶
type AudioConfig = types.AudioConfig
Re-export types from sub-packages for backward compatibility.
type AuthProvider ¶
type AuthProvider = types.AuthProvider
Re-export types from sub-packages for backward compatibility.
type ControlMsg ¶
type ControlMsg = types.ControlMsg
Re-export types from sub-packages for backward compatibility.
type MotionConfig ¶
type MotionConfig = types.MotionConfig
Re-export types from sub-packages for backward compatibility.
type NodeRuntime ¶
type NodeRuntime = types.NodeRuntime
Re-export types from sub-packages for backward compatibility.
type OpenSessionRequest ¶
type OpenSessionRequest = types.OpenSessionRequest
Re-export types from sub-packages for backward compatibility.
type PoolSettings ¶
type PoolSettings struct {
LightMin uint32
LightMax uint32
LightMaxStreams uint32
LightIdleTimeoutSec uint32
HeavyMin uint32
HeavyMax uint32
HeavyMaxIdle uint32
HeavyIdleTimeoutSec uint32
HeavyHealthCheckSec uint32
}
PoolSettings configures the Light and Heavy pools.
type RealtimeRequest ¶
type RealtimeRequest = types.RealtimeRequest
Re-export types from sub-packages for backward compatibility.
type RealtimeUpdateOptions ¶
type RealtimeUpdateOptions = types.RealtimeUpdateOptions
Re-export types from sub-packages for backward compatibility.
type RemoteNode ¶
type RemoteNode = types.RemoteNode
Re-export types from sub-packages for backward compatibility.
type Server ¶
type Server interface {
Start(ctx context.Context) error
Addr() string
RegisterTool(tool *ToolDefinition) error
UnregisterTool(name string) error
Close() error
WaitReady(ctx context.Context) error
// Remote Tool / Plugin registration (design §14 / wasm Part I §4).
SetRemoteTools(tools []*remotetool.Tool) error
RegisterRemoteTool(tool *remotetool.Tool) error
UnregisterRemoteTool(name string) error
RegisterPlugin(entry *pb.PluginEntry) error
UnregisterPlugin(name, version string) error
SetRemotePlugins(entries []*pb.PluginEntry) error
RemoteToolRegistry() *remotetool.Registry
PluginRegistry() *plugin.Registry
}
Server is a Tai transport server that accepts and manages Tai node connections.
func NewServer ¶
func NewServer(cfg *ServerConfig) (Server, error)
NewServer creates a transport server from cfg.
type ServerConfig ¶
type ServerConfig struct {
TransportPort int
HTTPPort int
TLS *TLSConfig
Auth AuthProvider
MaxFrameSize int
UnauthTimeout time.Duration
QUIC *quic.Config
ShutdownTimeout time.Duration
Pool *PoolSettings
}
ServerConfig holds configuration for a Tai transport server.
type SessionMsg ¶
type SessionMsg = types.SessionMsg
Re-export types from sub-packages for backward compatibility.
type SessionRequest ¶
type SessionRequest = types.SessionRequest
Re-export types from sub-packages for backward compatibility.
type ToolDefinition ¶
type ToolDefinition = types.ToolDefinition
Re-export types from sub-packages for backward compatibility.
type ToolHandler ¶
type ToolHandler = types.ToolHandler
Re-export types from sub-packages for backward compatibility.
type UserMessage ¶
type UserMessage = types.UserMessage
Re-export types from sub-packages for backward compatibility.
type WellKnownResponse ¶
type WellKnownResponse = types.WellKnownResponse
Re-export types from sub-packages for backward compatibility.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package auth provides the default JWT-based AuthProvider implementation.
|
Package auth provides the default JWT-based AuthProvider implementation. |
|
Package mock provides test doubles for the Tai SDK.
|
Package mock provides test doubles for the Tai SDK. |
|
Package node manages connected Tai nodes and provides the RemoteNode behavioral wrapper.
|
Package node manages connected Tai nodes and provides the RemoteNode behavioral wrapper. |
|
Package plugin maintains the SDK-side Plugin registry and artifact store.
|
Package plugin maintains the SDK-side Plugin registry and artifact store. |
|
Package remotetool implements the SDK-side Remote Tool registry and Handler.
|
Package remotetool implements the SDK-side Remote Tool registry and Handler. |
|
Package session — recovery_buffer.go provides a per-Session ring buffer that stores received events by seq number.
|
Package session — recovery_buffer.go provides a per-Session ring buffer that stores received events by seq number. |
|
Package toolserver serves the Remote Tool H2 endpoints.
|
Package toolserver serves the Remote Tool H2 endpoints. |
|
Package transport implements the Tai Transport Protocol v2 server: TCP (HTTP/2), QUIC (HTTP/3, WebTransport), and the Tai frame protocol.
|
Package transport implements the Tai Transport Protocol v2 server: TCP (HTTP/2), QUIC (HTTP/3, WebTransport), and the Tai frame protocol. |
|
Package types defines shared data types for the Tai SDK.
|
Package types defines shared data types for the Tai SDK. |
|
Package workspace provides remote workspace access via the Tai transport layer.
|
Package workspace provides remote workspace access via the Tai transport layer. |
