client

README

Client library for Agent Communication API.

Documentation

Overview

Package client is an AgentCommunication client library.

Index

• Variables
• type Connection
  • func CreateConnection(ctx context.Context, channelID string, regional bool, ...) (*Connection, error)
  • func (c *Connection) Close()
  • func (c *Connection) Receive() (*acpb.MessageBody, error)
  • func (c *Connection) SendMessage(msg *acpb.MessageBody) error

Variables

var (
	// DebugLogging enables debug logging.
	DebugLogging = false
	// ErrConnectionClosed is an error indicating that the connection was closed by the caller.
	ErrConnectionClosed = errors.New("connection closed")
	// ErrMessageTimeout is an error indicating message send timed out.
	ErrMessageTimeout = errors.New("timed out waiting for response")
	// ErrResourceExhausted is an error indicating that the server responded to the send with
	// ResourceExhausted.
	ErrResourceExhausted = errors.New("resource exhausted")
)

Types

type Connection

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

Connection is an AgentCommunication connection.

func CreateConnection

func CreateConnection(ctx context.Context, channelID string, regional bool, opts ...option.ClientOption) (*Connection, error)

CreateConnection creates a new connection.

func (*Connection) Close

func (c *Connection) Close()

Close the connection.

func (*Connection) Receive

func (c *Connection) Receive() (*acpb.MessageBody, error)

Receive messages.

func (*Connection) SendMessage

func (c *Connection) SendMessage(msg *acpb.MessageBody) error

SendMessage sends a message to the client. Will automatically retry on message timeout (temporary disconnects) and in the case of ResourceExhausted with a backoff. Because retries are limited the returned error can in some cases be one of ErrMessageTimeout or ErrResourceExhausted, in which case send should be retried by the caller.