api

Documentation

Index

• Variables
• type MessageServiceProvider
• type ProtocolSvcCreator
• type Provider

Variables

var ErrSvcNotFound = errors.New("service not found")

ErrSvcNotFound is returned when service not found.

Types

type MessageServiceProvider

type MessageServiceProvider interface {
	// Services returns list of available message services in this message handler
	Services() []dispatcher.MessageService
}

MessageServiceProvider is provider of message services.

type ProtocolSvcCreator

type ProtocolSvcCreator struct {
	// Create creates new protocol service.
	Create func(prv Provider) (dispatcher.ProtocolService, error)
	// Init initializes given instance of a protocol service.
	Init           func(svc dispatcher.ProtocolService, prv Provider) error
	ServicePointer dispatcher.ProtocolService
}

ProtocolSvcCreator struct sets initialization functions for a protocol service.

type Provider

type Provider interface {
	OutboundDispatcher() dispatcher.Outbound
	InboundDIDCommMessageHandler() func() service.InboundHandler
	Messenger() service.Messenger
	Service(id string) (interface{}, error)
	StorageProvider() storage.Provider
	KMS() kms.KeyManager
	SecretLock() secretlock.Service
	Crypto() crypto.Crypto
	Packager() transport.Packager
	ServiceEndpoint() string
	RouterEndpoint() string
	VDRegistry() vdrapi.Registry
	ProtocolStateStorageProvider() storage.Provider
	InboundMessageHandler() transport.InboundMessageHandler
	VerifiableStore() verifiable.Store
	DIDConnectionStore() did.ConnectionStore
	JSONLDDocumentLoader() ld.DocumentLoader
	KeyType() kms.KeyType
	KeyAgreementType() kms.KeyType
	MediaTypeProfiles() []string
	AriesFrameworkID() string
	ServiceMsgTypeTargets() []dispatcher.MessageTypeTarget
}

Provider interface for protocol ctx.