comms

package
v0.1.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 20, 2022 License: Apache-2.0, MIT Imports: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Request

type Request struct {

	// Request fields
	CurrencyID byte
	FromAddr   string
	ToAddr     string
	// contains filtered or unexported fields
}

Request represents a standard request in the payment network.

func NewRequestIn

func NewRequestIn(ctx context.Context, opTimeout time.Duration, ioTimeout time.Duration, conn network.Stream, signer crypto.Signer) (Request, error)

NewRequestIn creates a request for receiving.

@input - context, operation timeout, io timeout, network stream, signer.

@output - request.

func NewRequestOut

func NewRequestOut(ctx context.Context, opTimeout time.Duration, ioTimeout time.Duration, conn network.Stream, signer crypto.Signer, currencyID byte, toAddr string) (Request, error)

NewRequestOut creates a request for sending out.

@input - context, operation timeout, io timeout, network stream, signer, currency id, recipient address, data.

@output - request, error.

func (*Request) GetResponse

func (r *Request) GetResponse(ctx context.Context, ioTimeout time.Duration) (bool, []byte, error)

GetResponse gets a response from a request.

@input - context, io timeout.

@output - response status, response data, error.

func (*Request) Receive

func (r *Request) Receive(ctx context.Context, ioTimeout time.Duration) ([]byte, error)

Receive receives a request in.

@input - context, io timeout.

@output - data, error.

func (*Request) Respond

func (r *Request) Respond(ctx context.Context, opTimeout time.Duration, ioTimeout time.Duration, succeed bool, data []byte) error

Respond sends a response back to a request.

@input - context, operation timeout, io timeout, response status, response data.

@output - error.

func (*Request) Send

func (r *Request) Send(ctx context.Context, opTimeout time.Duration, ioTimeout time.Duration, data []byte) error

Send sends a request out.

@input - context, operation timeout, io timeout, data.

@output - error.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL