bifrost_api

Documentation

Index

• func RegisterAsDRPCServer(s BifrostAPIServer, mux drpc.Mux)
• type API
  • func NewAPI(bus bus.Bus, conf *Config) (*API, error)
  • func (a *API) AcceptStream(serv stream_api.DRPCStreamService_AcceptStreamStream) error
  • func (a *API) DialStream(serv stream_api.DRPCStreamService_DialStreamStream) error
  • func (a *API) ForwardStreams(req *stream_api.ForwardStreamsRequest, ...) error
  • func (a *API) GetPeerInfo(ctx context.Context, req *peer_api.GetPeerInfoRequest) (*peer_api.GetPeerInfoResponse, error)
  • func (a *API) Identify(req *peer_api.IdentifyRequest, serv peer_api.DRPCPeerService_IdentifyStream) error
  • func (a *API) ListenStreams(req *stream_api.ListenStreamsRequest, ...) error
  • func (a *API) RegisterAsDRPCServer(mux drpc.Mux)
  • func (a *API) Subscribe(serv pubsub_api.DRPCPubSubService_SubscribeStream) error
• type BifrostAPIClient
  • func NewBifrostAPIClient(cc drpc.Conn) BifrostAPIClient
• type BifrostAPIServer
• type BusAPI
• type Config
  • func (*Config) Descriptor() ([]byte, []int)
  • func (m *Config) GetBusConfig() *api.Config
  • func (*Config) ProtoMessage()
  • func (m *Config) Reset()
  • func (m *Config) String() string
  • func (m *Config) XXX_DiscardUnknown()
  • func (m *Config) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
  • func (m *Config) XXX_Merge(src proto.Message)
  • func (m *Config) XXX_Size() int
  • func (m *Config) XXX_Unmarshal(b []byte) error
• type DRPCBifrostAPIClient
• type DRPCBifrostAPIServer

Functions

func RegisterAsDRPCServer

func RegisterAsDRPCServer(s BifrostAPIServer, mux drpc.Mux)

RegisterAsDRPCServer registers a server with a DRPC mux.

Types

type API

type API struct {
	*BusAPI
	// contains filtered or unexported fields
}

API implements the daemon API.

func NewAPI

func NewAPI(bus bus.Bus, conf *Config) (*API, error)

NewAPI constructs a new instance of the API.

func (*API) AcceptStream

func (a *API) AcceptStream(serv stream_api.DRPCStreamService_AcceptStreamStream) error

AcceptStream accepts an incoming stream. Stream data is sent over the request / response streams.

func (*API) DialStream

func (a *API) DialStream(serv stream_api.DRPCStreamService_DialStreamStream) error

DialStream dials a outgoing stream. Stream data is sent over the request / response streams.

func (*API) ForwardStreams

func (a *API) ForwardStreams(
	req *stream_api.ForwardStreamsRequest,
	serv stream_api.DRPCStreamService_ForwardStreamsStream,
) error

ForwardStreams forwards streams to the target multiaddress. Handles HandleMountedStream directives by contacting the target.

func (*API) GetPeerInfo

func (a *API) GetPeerInfo(
	ctx context.Context,
	req *peer_api.GetPeerInfoRequest,
) (*peer_api.GetPeerInfoResponse, error)

GetPeerInfo returns the peer information

func (*API) Identify

func (a *API) Identify(
	req *peer_api.IdentifyRequest,
	serv peer_api.DRPCPeerService_IdentifyStream,
) error

Identify loads and manages a private key identity.

func (*API) ListenStreams

func (a *API) ListenStreams(
	req *stream_api.ListenStreamsRequest,
	serv stream_api.DRPCStreamService_ListenStreamsStream,
) error

ListenStreams listens for streams on the multiaddress.

func (*API) RegisterAsDRPCServer

func (a *API) RegisterAsDRPCServer(mux drpc.Mux)

RegisterAsDRPCServer registers the API to the DRPC mux.

func (*API) Subscribe

func (a *API) Subscribe(serv pubsub_api.DRPCPubSubService_SubscribeStream) error

Subscribe subscribes to a pubsub channel.

TODO: move this code to pubsub/api

type BifrostAPIClient

type BifrostAPIClient interface {
	bus_api.DRPCControllerBusServiceClient
	stream_api.DRPCStreamServiceClient
	peer_api.DRPCPeerServiceClient
	pubsub_api.DRPCPubSubServiceClient
}

BifrostAPIClient is the bifrost daemon client interface.

func NewBifrostAPIClient

func NewBifrostAPIClient(cc drpc.Conn) BifrostAPIClient

NewBifrostAPIClient constructs a new bifrost api client.

type BifrostAPIServer

type BifrostAPIServer interface {
	bus_api.DRPCControllerBusServiceServer
	stream_api.DRPCStreamServiceServer
	peer_api.DRPCPeerServiceServer
	pubsub_api.DRPCPubSubServiceServer
}

BifrostAPIServer is the bifrost daemon server interface.

type BusAPI

type BusAPI = bus_api.API

BusAPI implements the controller bus api.

type Config

type Config struct {
	// BusConfig configures the bus api.
	BusConfig            *api.Config `protobuf:"bytes,1,opt,name=bus_config,json=busConfig,proto3" json:"bus_config,omitempty"`
	XXX_NoUnkeyedLiteral struct{}    `json:"-"`
	XXX_unrecognized     []byte      `json:"-"`
	XXX_sizecache        int32       `json:"-"`
}

Config configures the API.

func (*Config) Descriptor

func (*Config) Descriptor() ([]byte, []int)

func (*Config) GetBusConfig

func (m *Config) GetBusConfig() *api.Config

func (*Config) ProtoMessage

func (*Config) ProtoMessage()

func (*Config) Reset

func (m *Config) Reset()

func (*Config) String

func (m *Config) String() string

func (*Config) XXX_DiscardUnknown

func (m *Config) XXX_DiscardUnknown()

func (*Config) XXX_Marshal

func (m *Config) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Config) XXX_Merge

func (m *Config) XXX_Merge(src proto.Message)

func (*Config) XXX_Size

func (m *Config) XXX_Size() int

func (*Config) XXX_Unmarshal

func (m *Config) XXX_Unmarshal(b []byte) error

type DRPCBifrostAPIClient

type DRPCBifrostAPIClient = BifrostAPIClient

DRPCBifrostAPIClient is the bifrost daemon client interface.

type DRPCBifrostAPIServer

type DRPCBifrostAPIServer = BifrostAPIServer

DRPCBifrostAPIServer is the bifrost daemon server interface.