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
- type Receiver
- type Receivers
- 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
Constants ¶
This section is empty.
Variables ¶
View Source
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 )
View Source
var ActiveRcvrs = Receivers{ Rcvrs: make(map[string]Receiver), }
View Source
var Proc = &processor{}
Functions ¶
Types ¶
type Continuator ¶
type Creator ¶ added in v0.24.29
type Creator func(header *TaskHeader, protocol *pb.Protocol) (Task, error)
type FillStatus ¶ added in v0.25.13
type FillStatus func(workerDID string, taskID string, ps *pb.ProtocolStatus) *pb.ProtocolStatus
type HandlerFunc ¶
HandlerFunc is func type for protocol message handlers. We add them to protocol processors with the associated message type. See Payload.Type
type ProtHandler ¶
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.
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 SeedHandler ¶
SeedHandler is preloaded cloud agent which is not initialized yet.
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 ¶ added in v0.24.29
type TaskBase struct {
Task
TaskHeader
}
func (*TaskBase) ConnectionID ¶ added in v0.24.29
func (*TaskBase) ProtocolType ¶ added in v0.25.4
func (t *TaskBase) ProtocolType() pb.Protocol_Type
func (*TaskBase) ReceiverEndp ¶ added in v0.24.29
func (*TaskBase) Role ¶ added in v0.24.29
func (t *TaskBase) Role() pb.Protocol_Role
func (*TaskBase) SetReceiverEndp ¶ added in v0.24.29
func (*TaskBase) UserActionType ¶ added in v0.25.4
type TaskHeader ¶ added in v0.24.29
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 ¶ added in v0.24.29
func (t *TaskHeader) SwitchDirection()
SwitchDirection changes SenderEndp and ReceiverEndp data
Click to show internal directories.
Click to hide internal directories.