ffdx

Documentation

Index

• Constants
• type FFDX
  • func (h *FFDX) AddNode(ctx context.Context, networkNamespace, nodeName string, ...) (err error)
  • func (h *FFDX) Capabilities() *dataexchange.Capabilities
  • func (h *FFDX) DeleteBlob(ctx context.Context, payloadRef string) (err error)
  • func (h *FFDX) DownloadBlob(ctx context.Context, payloadRef string) (content io.ReadCloser, err error)
  • func (h *FFDX) GetEndpointInfo(ctx context.Context, nodeName string) (peer fftypes.JSONObject, err error)
  • func (h *FFDX) GetPeerID(peer fftypes.JSONObject) string
  • func (h *FFDX) Init(ctx context.Context, cancelCtx context.CancelFunc, config config.Section) (err error)
  • func (h *FFDX) InitConfig(config config.Section)
  • func (h *FFDX) Name() string
  • func (h *FFDX) SendMessage(ctx context.Context, nsOpID string, peer, sender fftypes.JSONObject, ...) (err error)
  • func (h *FFDX) SetHandler(networkNamespace, nodeName string, handler dataexchange.Callbacks)
  • func (h *FFDX) SetOperationHandler(namespace string, handler core.OperationCallbacks)
  • func (h *FFDX) Start() error
  • func (h *FFDX) TransferBlob(ctx context.Context, nsOpID string, peer, sender fftypes.JSONObject, ...) (err error)
  • func (h *FFDX) UploadBlob(ctx context.Context, ns string, id fftypes.UUID, content io.Reader) (payloadRef string, hash *fftypes.Bytes32, size int64, err error)

Constants

const (
	// DataExchangeManifestEnabled determines whether to require+validate a manifest from other DX instances in the network. Must be supported by the connector
	DataExchangeManifestEnabled = "manifestEnabled"
	// DataExchangeInitEnabled instructs FireFly to always post all current nodes to the /init API before connecting or reconnecting to the connector
	DataExchangeInitEnabled = "initEnabled"

	DataExchangeEventRetryInitialDelay = "eventRetry.initialDelay"
	DataExchangeEventRetryMaxDelay     = "eventRetry.maxDelay"
	DataExchangeEventRetryFactor       = "eventRetry.factor"

	DataExchangeBackgroundStart             = "backgroundStart.enabled"
	DataExchangeBackgroundStartInitialDelay = "backgroundStart.initialDelay"
	DataExchangeBackgroundStartMaxDelay     = "backgroundStart.maxDelay"
	DataExchangeBackgroundStartFactor       = "backgroundStart.factor"
)

const DXIDSeparator = "/"

Types

type FFDX

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

func (*FFDX) AddNode

func (h *FFDX) AddNode(ctx context.Context, networkNamespace, nodeName string, peer fftypes.JSONObject) (err error)

func (*FFDX) Capabilities

func (h *FFDX) Capabilities() *dataexchange.Capabilities

func (*FFDX) DeleteBlob

func (h *FFDX) DeleteBlob(ctx context.Context, payloadRef string) (err error)

func (*FFDX) DownloadBlob

func (h *FFDX) DownloadBlob(ctx context.Context, payloadRef string) (content io.ReadCloser, err error)

func (*FFDX) GetEndpointInfo

func (h *FFDX) GetEndpointInfo(ctx context.Context, nodeName string) (peer fftypes.JSONObject, err error)

func (*FFDX) GetPeerID

func (h *FFDX) GetPeerID(peer fftypes.JSONObject) string

func (*FFDX) Init

func (h *FFDX) Init(ctx context.Context, cancelCtx context.CancelFunc, config config.Section) (err error)

func (*FFDX) InitConfig

func (h *FFDX) InitConfig(config config.Section)

func (*FFDX) Name

func (h *FFDX) Name() string

func (*FFDX) SendMessage

func (h *FFDX) SendMessage(ctx context.Context, nsOpID string, peer, sender fftypes.JSONObject, data []byte) (err error)

func (*FFDX) SetHandler

func (h *FFDX) SetHandler(networkNamespace, nodeName string, handler dataexchange.Callbacks)

func (*FFDX) SetOperationHandler

func (h *FFDX) SetOperationHandler(namespace string, handler core.OperationCallbacks)

func (*FFDX) Start

func (h *FFDX) Start() error

func (*FFDX) TransferBlob

func (h *FFDX) TransferBlob(ctx context.Context, nsOpID string, peer, sender fftypes.JSONObject, payloadRef string) (err error)

func (*FFDX) UploadBlob

func (h *FFDX) UploadBlob(ctx context.Context, ns string, id fftypes.UUID, content io.Reader) (payloadRef string, hash *fftypes.Bytes32, size int64, err error)