comm

Documentation

Index

• Variables
• func SendPL(sendPipe sec.Pipe, task Task, opl didcomm.Payload) (err error)
• type Continuator
• type Creator
• type FillStatus
• type Handler
• type HandlerFunc
• type Packet
• type ProtHandler
• type ProtProc
  • func (p ProtProc) Process(packet Packet) (err error)
• type Receiver
• type Receivers
  • func (rs *Receivers) Add(DID string, r Receiver)
  • func (rs *Receivers) Get(DID string) Receiver
• type SeedHandler
• type Starter
• type Task
• type TaskBase
  • func (t *TaskBase) ConnectionID() string
  • func (t *TaskBase) DIDMethod() method.Type
  • func (t *TaskBase) ID() string
  • func (t *TaskBase) ProtocolType() pb.Protocol_Type
  • func (t *TaskBase) ReceiverEndp() service.Addr
  • func (t *TaskBase) Role() pb.Protocol_Role
  • func (t *TaskBase) SetReceiverEndp(r service.Addr)
  • func (t *TaskBase) Type() string
  • func (t *TaskBase) UserActionType() string
• type TaskHeader
  • func (t *TaskHeader) SwitchDirection()

Variables

var (
	// SendAndWaitReq is proxy function to route actual call to http or pseudo http in tests.
	SendAndWaitReq = sendAndWaitHTTPRequest

	// FileDownload is proxy function to route actual call to http or pseudo http in tests.
	FileDownload = downloadFile
)

var ActiveRcvrs = Receivers{
	Rcvrs: make(map[string]Receiver),
}

var Proc = &processor{}

Functions

func SendPL

func SendPL(sendPipe sec.Pipe, task Task, opl didcomm.Payload) (err error)

SendPL is helper function to send a protocol messages to receiver which is defined in the Task.ReceiverEndp. Function will encrypt messages before sending. It doesn't resend PL in case of failure. The recovering in done at PSM level.

Types

type Continuator

type Continuator func(ca Receiver, im didcomm.Msg)

type Creator

type Creator func(header *TaskHeader, protocol *pb.Protocol) (Task, error)

type FillStatus

type FillStatus func(workerDID string, taskID string, ps *pb.ProtocolStatus) *pb.ProtocolStatus

type Handler

type Handler interface {
}

Handler can be Agency or Agent. They can input Payloads.

type HandlerFunc

type HandlerFunc func(packet Packet) (err error)

HandlerFunc is func type for protocol message handlers. We add them to protocol processors with the associated message type. See Payload.Type

type Packet

type Packet struct {
	Payload  didcomm.Payload
	Address  *endp.Addr
	Receiver Receiver
}

type ProtHandler

type ProtHandler interface {
	Process(packet Packet) (err error)
}

ProtHandler is an interface for whole protocol. Where HandlerFunc is handler for protocol message, the protocol handler is whole protocol group, all of the same message family.

type ProtProc

type ProtProc struct {
	Creator
	Starter
	Handlers map[string]HandlerFunc
	Continuator
	FillStatus
}

ProtProc is a protocol processor. It is struct for protocol handlers. Instances of it are the actual protocol handlers. Just declare var and the needed msg handlers (HandlerFunc) and register it to the processor.

func (ProtProc) Process

func (p ProtProc) Process(packet Packet) (err error)

Process delivers the protocol message inside the packet to correct protocol function.

type Receiver

type Receiver interface {
	MyDID() core.DID
	MyCA() Receiver
	WorkerEA() Receiver
	ExportWallet(key string, exportPath string) (url string)
	RootDid() core.DID
	SendNYM(targetDid *ssi.DID, submitterDid, alias, role string) (err error)
	LoadDID(did string) core.DID
	LoadTheirDID(connection storage.Connection) core.DID
	WDID() string
	PwPipe(pw string) (cp sec.Pipe, err error)
	NewOutDID(didInfo ...string) (id core.DID, err error)
	Wallet() int
	ManagedWallet() (managed.Wallet, managed.Wallet)
	Pool() int
	FindPWByID(id string) (pw *storage.Connection, err error)
	AttachSAImpl(implID string)
	AddToPWMap(me, you core.DID, name string) sec.Pipe
	SaveTheirDID(did, vk string) (err error)
	CAEndp(connID string) (endP *endp.Addr)
	AddPipeToPWMap(p sec.Pipe, name string)
	MasterSecret() (string, error)
	AutoPermission() bool
	ID() string
}

type Receivers

type Receivers struct {
	Rcvrs map[string]Receiver
	Lk    sync.Mutex
}

func (*Receivers) Add

func (rs *Receivers) Add(DID string, r Receiver)

func (*Receivers) Get

func (rs *Receivers) Get(DID string) Receiver

type SeedHandler

type SeedHandler interface {
	Prepare() (Handler, error)
}

SeedHandler is preloaded cloud agent which is not initialized yet.

type Starter

type Starter func(ca Receiver, t Task)

type Task

type Task interface {
	ID() string                     // Unique uid: API Protocol ID/Protocol thread ID
	Type() string                   // Our internal payload type
	ProtocolType() pb.Protocol_Type // Aries protocol
	UserActionType() string         // Internal payload type when waiting for user action
	Role() pb.Protocol_Role         // Agent role in Aries protocol
	ConnectionID() string           // Pairwise id
	ReceiverEndp() service.Addr     // Pairwise receiver endpoint
	SetReceiverEndp(r service.Addr)
	DIDMethod() method.Type
}

type TaskBase

type TaskBase struct {
	Task
	TaskHeader
}

func (*TaskBase) ConnectionID

func (t *TaskBase) ConnectionID() string

func (*TaskBase) DIDMethod

func (t *TaskBase) DIDMethod() method.Type

func (*TaskBase) ID

func (t *TaskBase) ID() string

func (*TaskBase) ProtocolType

func (t *TaskBase) ProtocolType() pb.Protocol_Type

func (*TaskBase) ReceiverEndp

func (t *TaskBase) ReceiverEndp() service.Addr

func (*TaskBase) Role

func (t *TaskBase) Role() pb.Protocol_Role

func (*TaskBase) SetReceiverEndp

func (t *TaskBase) SetReceiverEndp(r service.Addr)

func (*TaskBase) Type

func (t *TaskBase) Type() string

func (*TaskBase) UserActionType

func (t *TaskBase) UserActionType() string

type TaskHeader

type TaskHeader struct {
	TaskID           string
	TypeID           string
	ProtocolRole     pb.Protocol_Role
	ConnID           string
	UserActionPLType string

	Sender   service.Addr
	Receiver service.Addr

	Method method.Type
}

func (*TaskHeader) SwitchDirection

func (t *TaskHeader) SwitchDirection()

SwitchDirection changes SenderEndp and ReceiverEndp data