stream_srpc_client

package

v0.31.1 Latest Latest Go to latest Published: May 1, 2024 License: Apache-2.0 Imports: 16 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/aperturerobotics/bifrost

Links

Open Source Insights

Documentation ¶

Index ¶

type Client
- func NewClient(le *logrus.Entry, b bus.Bus, c *Config, protocolID protocol.ID) (Client, error)
type Config

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Client ¶

type Client = srpc.Client

Client is a common srpc client implementation.

func NewClient ¶

func NewClient(le *logrus.Entry, b bus.Bus, c *Config, protocolID protocol.ID) (Client, error)

NewClient constructs a new client.

type Config ¶

type Config struct {

	// ServerPeerIds are the static list of peer IDs to contact.
	ServerPeerIds []string `protobuf:"bytes,1,rep,name=server_peer_ids,json=serverPeerIds,proto3" json:"serverPeerIds,omitempty"`
	// PerServerBackoff is the server peer error backoff configuration.
	// Can be empty.
	PerServerBackoff *backoff.Backoff `protobuf:"bytes,2,opt,name=per_server_backoff,json=perServerBackoff,proto3" json:"perServerBackoff,omitempty"`
	// SrcPeerId is the source peer id to contact from.
	// Can be empty.
	SrcPeerId string `protobuf:"bytes,3,opt,name=src_peer_id,json=srcPeerId,proto3" json:"srcPeerId,omitempty"`
	// TransportId restricts which transport we can dial out from.
	TransportId uint64 `protobuf:"varint,4,opt,name=transport_id,json=transportId,proto3" json:"transportId,omitempty"`
	// TimeoutDur sets the per-server establish timeout.
	// If unset, no timeout.
	// Example: 15s
	TimeoutDur string `protobuf:"bytes,5,opt,name=timeout_dur,json=timeoutDur,proto3" json:"timeoutDur,omitempty"`
	// contains filtered or unexported fields
}

Config configures a client for a srpc service.

func (*Config) CloneMessageVT ¶ added in v0.15.6

func (m *Config) CloneMessageVT() protobuf_go_lite.CloneMessage

func (*Config) CloneVT ¶ added in v0.8.3

func (m *Config) CloneVT() *Config

func (*Config) EqualMessageVT ¶ added in v0.15.6

func (this *Config) EqualMessageVT(thatMsg any) bool

func (*Config) EqualVT ¶

func (this *Config) EqualVT(that *Config) bool

func (*Config) GetPerServerBackoff ¶

func (x *Config) GetPerServerBackoff() *backoff.Backoff

func (*Config) GetServerPeerIds ¶

func (x *Config) GetServerPeerIds() []string

func (*Config) GetSrcPeerId ¶

func (x *Config) GetSrcPeerId() string

func (*Config) GetTimeoutDur ¶

func (x *Config) GetTimeoutDur() string

func (*Config) GetTransportId ¶

func (x *Config) GetTransportId() uint64

func (*Config) MarshalJSON ¶ added in v0.29.0

func (x *Config) MarshalJSON() ([]byte, error)

MarshalJSON marshals the Config to JSON.

func (*Config) MarshalProtoJSON ¶ added in v0.29.0

func (x *Config) MarshalProtoJSON(s *json.MarshalState)

MarshalProtoJSON marshals the Config message to JSON.

func (*Config) MarshalProtoText ¶ added in v0.29.2

func (x *Config) MarshalProtoText() string

func (*Config) MarshalToSizedBufferVT ¶

func (m *Config) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*Config) MarshalToVT ¶

func (m *Config) MarshalToVT(dAtA []byte) (int, error)

func (*Config) MarshalVT ¶

func (m *Config) MarshalVT() (dAtA []byte, err error)

func (*Config) ParseServerPeerIds ¶

func (c *Config) ParseServerPeerIds() ([]peer.ID, error)

ParseServerPeerIds parses the destination peer ids

func (*Config) ParseSrcPeerId ¶

func (c *Config) ParseSrcPeerId() (peer.ID, error)

ParseSrcPeerId parses the source peer id, if set.

func (*Config) ParseTimeoutDur ¶

func (c *Config) ParseTimeoutDur() (time.Duration, error)

ParseTimeoutDur parses the timeout duration. returns zero if empty

func (*Config) ProtoMessage ¶

func (*Config) ProtoMessage()

func (*Config) Reset ¶

func (x *Config) Reset()

func (*Config) SizeVT ¶

func (m *Config) SizeVT() (n int)

func (*Config) String ¶

func (x *Config) String() string

func (*Config) UnmarshalJSON ¶ added in v0.29.0

func (x *Config) UnmarshalJSON(b []byte) error

UnmarshalJSON unmarshals the Config from JSON.

func (*Config) UnmarshalProtoJSON ¶ added in v0.29.0

func (x *Config) UnmarshalProtoJSON(s *json.UnmarshalState)

UnmarshalProtoJSON unmarshals the Config message from JSON.

func (*Config) UnmarshalVT ¶

func (m *Config) UnmarshalVT(dAtA []byte) error

func (*Config) Validate ¶

func (c *Config) Validate() error

Validate validates the config.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
controller

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