docs/vendor/github.com/cloudevents/sdk-go/v2/protocol/inbound.go

42 lines
1.1 KiB
Go

package protocol
import (
"context"
"github.com/cloudevents/sdk-go/v2/binding"
)
// Receiver receives messages.
type Receiver interface {
// Receive blocks till a message is received or ctx expires.
//
// A non-nil error means the receiver is closed.
// io.EOF means it closed cleanly, any other value indicates an error.
Receive(ctx context.Context) (binding.Message, error)
}
// ReceiveCloser is a Receiver that can be closed.
type ReceiveCloser interface {
Receiver
Closer
}
// ResponseFn is the function callback provided from Responder.Respond to allow
// for a receiver to "reply" to a message it receives.
type ResponseFn func(ctx context.Context, m binding.Message, r Result) error
// Responder receives messages and is given a callback to respond.
type Responder interface {
// Receive blocks till a message is received or ctx expires.
//
// A non-nil error means the receiver is closed.
// io.EOF means it closed cleanly, any other value indicates an error.
Respond(ctx context.Context) (binding.Message, ResponseFn, error)
}
// ResponderCloser is a Responder that can be closed.
type ResponderCloser interface {
Responder
Closer
}