rpcchainvm

type Message ¶ added in v1.16.56

type Message uint32

Message represents a notification message type

const (

	// PendingTxs indicates pending transactions notification
	PendingTxs Message
)

func (m Message) String() string

type NotificationForwarder ¶ added in v1.16.56

type NotificationForwarder struct {
	Engine    Notifier
	Subscribe Subscription
	Log       log.Logger
	// contains filtered or unexported fields
}

NotificationForwarder is a component that listens for notifications from a Subscription, and forwards them to a Notifier. When CheckForEvent is called mid-subscription, it retries the subscription. After Notify is called, it waits for CheckForEvent to be called before subscribing again.

func NewNotificationForwarder(
	engine Notifier,
	subscribe Subscription,
	log log.Logger,
) *NotificationForwarder

func (nf *NotificationForwarder) CheckForEvent()

func (nf *NotificationForwarder) Close()

type Notifier ¶ added in v1.16.56

type Notifier interface {
	Notify(context.Context, Message) error
}

type Subscription ¶ added in v1.16.56

type Subscription func(ctx context.Context) (Message, error)

Subscription is a function that blocks until either the given context is cancelled, or a message is returned. It is used to receive messages from a VM such as Pending transactions, state sync completion, etc. The function returns the message received, or an error if the context is cancelled.

type Transport ¶ added in v1.23.2

type Transport string

Transport specifies the RPC transport protocol for VM communication

const (
	// TransportGRPC uses gRPC with protobuf serialization (default)
	TransportGRPC Transport = "grpc"
	// TransportZAP uses ZAP zero-copy serialization over TCP
	TransportZAP Transport = "zap"
	// TransportBoth enables both gRPC and ZAP transports
	TransportBoth Transport = "both"
)

func ValidTransports() []Transport

func (t Transport) IsValid() bool

func (t Transport) UsesGRPC() bool

func (t Transport) UsesZAP() bool

type TransportConfig ¶ added in v1.23.2

type TransportConfig struct {
	// Transport specifies which transport(s) to use
	Transport Transport
	// Timeout for transport operations
	Timeout time.Duration
}

TransportConfig contains transport configuration

func DefaultTransportConfig() TransportConfig