webrtc

Documentation

Overview

Package webrtc provides WebRTC upstream integration.

Index

• func NewUpstream(poolManager *pool.Manager) upstream.Upstream
• type Upstream
  • func (u *Upstream) CheckHealth(ctx context.Context) error
  • func (u *Upstream) Register(ctx context.Context, serviceConfig *configv1.UpstreamServiceConfig, ...) (string, []*configv1.ToolDefinition, []*configv1.ResourceDefinition, error)
  • func (u *Upstream) Shutdown(_ context.Context) error

Functions

func NewUpstream

func NewUpstream(poolManager *pool.Manager) upstream.Upstream

NewUpstream creates a new instance of WebrtcUpstream.

Parameters:

• poolManager (*pool.Manager): The parameter.

Returns:

• upstream.Upstream: The result.

Side Effects:

• None.

Summary: Initializes NewUpstream operation.

Parameters:

• TODO: Document parameters.

Returns:

• TODO: Document returns.

Errors:

• TODO: Document errors.

Side Effects:

• None.

Types

type Upstream

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

Upstream implements the upstream.Upstream interface for services that communicate over WebRTC data channels.

Summary: Represents a Upstream.

func (*Upstream) CheckHealth

func (u *Upstream) CheckHealth(ctx context.Context) error

CheckHealth performs a health check on the upstream service.

Parameters:

• ctx (context.Context): The context for the request.

Returns:

• error: An error if the operation fails.

Errors:

• Returns an error if ...

Side Effects:

• None.

Summary: Executes CheckHealth operation.

Parameters:

• TODO: Document parameters.

Returns:

• TODO: Document returns.

Errors:

• TODO: Document errors.

Side Effects:

• None.

func (*Upstream) Register

func (u *Upstream) Register(
	ctx context.Context,
	serviceConfig *configv1.UpstreamServiceConfig,
	toolManager tool.ManagerInterface,
	promptManager prompt.ManagerInterface,
	resourceManager resource.ManagerInterface,
	isReload bool,
) (string, []*configv1.ToolDefinition, []*configv1.ResourceDefinition, error)

Register processes the configuration for a WebRTC service, creating and registering tools for each call definition specified in the configuration.

Parameters:

• ctx (context.Context): The context for the request.
• serviceConfig (*configv1.UpstreamServiceConfig): The serviceConfig parameter.
• toolManager (tool.ManagerInterface): The toolManager parameter.
• promptManager (prompt.ManagerInterface): The promptManager parameter.
• resourceManager (resource.ManagerInterface): The resourceManager parameter.
• isReload (bool): The isReload parameter.

Returns:

• string: The resulting string.
• []*configv1.ToolDefinition: The resulting []*configv1.ToolDefinition.
• []*configv1.ResourceDefinition: The resulting []*configv1.ResourceDefinition.
• error: An error if the operation fails.

Errors:

• Returns an error if the operation fails or is invalid.

Side Effects:

• None

Summary: Executes Register operation.

Parameters:

• TODO: Document parameters.

Returns:

• TODO: Document returns.

Errors:

• TODO: Document errors.

Side Effects:

• None.

func (*Upstream) Shutdown

func (u *Upstream) Shutdown(_ context.Context) error

Shutdown is a no-op for the WebRTC upstream, as connections are transient and not managed by a persistent pool.

Parameters:

• _ (context.Context): The parameter.

Returns:

• error: An error if the operation fails.

Errors:

• Returns an error if ...

Side Effects:

• None.

Summary: Executes Shutdown operation.

Parameters:

• TODO: Document parameters.

Returns:

• TODO: Document returns.

Errors:

• TODO: Document errors.

Side Effects:

• None.