protocol

Documentation

Index

• func MustMarshalAny(msg proto.Message) *types.Any
• func NameFromMessage(msg *protocolpb.Message) (string, error)
• type Instance
• type Registry
  • func NewRegistry() *Registry
  • func (r *Registry) ClearCompleted()
  • func (r *Registry) FindOrAdd(instID string, ctor func() Instance) Instance

Functions

func MustMarshalAny

func MustMarshalAny(msg proto.Message) *types.Any

MustMarshalAny serializes a protobuf message into an Any or panics.

func NameFromMessage

func NameFromMessage(msg *protocolpb.Message) (string, error)

NameFromMessage extracts the name of the protocol to which the supplied message belongs.

Types

type Instance

type Instance interface {
	HandleMessage(*protocolpb.Message) error
	HasCompleted() bool
}

Instance is the required interface for protocol objects.

type Registry

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

Registry stores running protocols.

func NewRegistry

func NewRegistry() *Registry

func (*Registry) ClearCompleted

func (r *Registry) ClearCompleted()

ClearCopmleted walks the registered protocols and removes those that have completed.

func (*Registry) FindOrAdd

func (r *Registry) FindOrAdd(instID string, ctor func() Instance) Instance

FindOrAdd looks up an existing protocol by instance ID or constructs a new one and registers it under the instance ID indicated.