Documentation
¶
Overview ¶
Package service defines types for the chat service.
Index ¶
- Variables
- type Config
- type Host
- type Manager
- type PeerHistory
- type Service
- func (s *Service) AddToGRPCServer(gs *grpc.Server)
- func (s *Service) Config() interface{}
- func (s *Service) Desc() string
- func (s *Service) Expose() interface{}
- func (s *Service) ID() string
- func (s *Service) Name() string
- func (s *Service) Needs() map[string]struct{}
- func (s *Service) Plug(services map[string]interface{}) error
- func (s *Service) Run(ctx context.Context, running, stopping func()) error
- func (s *Service) SetConfig(config interface{}) error
Constants ¶
This section is empty.
Variables ¶
View Source
var ( // ErrNotHost is returned when the connected service is not a host. ErrNotHost = errors.New("connected service is not a host") // ErrNotEvent is returned when the connected service is not an event emitter. ErrNotEvent = errors.New("connected service is not an event emitter") // available. ErrUnavailable = errors.New("the service is not available") )
Functions ¶
This section is empty.
Types ¶
type Config ¶
type Config struct {
// Host is the name of the host service.
Host string `toml:"host" comment:"The name of the host service."`
// Event is the name of the event service.
Event string `toml:"event" comment:"The name of the event service."`
// HistoryDBPath is the path of the chat history db file.
HistoryDBPath string `toml:"history_db_path" comment:"The path of the chat history db file."`
}
Config contains configuration options for the Chat service.
type Manager ¶
type Manager struct {
// contains filtered or unexported fields
}
Manager manages a chat history.
func NewManager ¶
NewManager creates a new chat manager.
type Service ¶
type Service struct {
// contains filtered or unexported fields
}
Service is the Chat service.
func (*Service) AddToGRPCServer ¶
AddToGRPCServer adds the service to a gRPC server.
func (*Service) Config ¶
func (s *Service) Config() interface{}
Config returns the current service configuration or creates one with good default values.
func (*Service) Expose ¶
func (s *Service) Expose() interface{}
Expose exposes the chat service to other services. It is currently not exposed.
Source Files
Click to show internal directories.
Click to hide internal directories.