Documentation ¶
Index ¶
- Constants
- Variables
- func EnsureSpoolDirPresent(spoolDir string, subdir string) (err error)
- func GetTextAndAttachments(m Msg) string
- func LogChannelEventReceived(r *http.Request, event ChannelEvent)
- func LogMsgReceived(r *http.Request, msg Msg)
- func LogMsgStatusReceived(r *http.Request, status MsgStatus)
- func LogRequestIgnored(r *http.Request, details string)
- func RegisterBackend(backendType string, constructorFunc BackendConstructorFunc)
- func RegisterFlusher(directory string, flusherFunc FlusherFunc)
- func RegisterHandler(handler ChannelHandler)
- func SplitAttachment(attachment string) (string, string)
- func WriteChannelEventSuccess(w http.ResponseWriter, r *http.Request, event ChannelEvent) error
- func WriteError(w http.ResponseWriter, r *http.Request, err error) error
- func WriteIgnored(w http.ResponseWriter, r *http.Request, details string) error
- func WriteMsgSuccess(w http.ResponseWriter, r *http.Request, msg Msg) error
- func WriteStatusSuccess(w http.ResponseWriter, r *http.Request, status MsgStatus) error
- func WriteToSpool(spoolDir string, subdir string, contents interface{}) error
- type Backend
- type BackendConstructorFunc
- type Channel
- type ChannelActionHandlerFunc
- type ChannelEvent
- type ChannelEventType
- type ChannelHandler
- type ChannelID
- type ChannelLog
- type ChannelReceiveMsgFunc
- type ChannelType
- type ChannelUUID
- type ChannelUpdateStatusFunc
- type FlusherFunc
- type Foreman
- type MockBackend
- func (mb *MockBackend) AddChannel(channel Channel)
- func (mb *MockBackend) Cleanup() error
- func (mb *MockBackend) ClearChannels()
- func (mb *MockBackend) ClearQueueMsgs()
- func (mb *MockBackend) GetChannel(cType ChannelType, uuid ChannelUUID) (Channel, error)
- func (mb *MockBackend) GetLastChannelEvent() (ChannelEvent, error)
- func (mb *MockBackend) GetLastContactName() string
- func (mb *MockBackend) GetLastMsgStatus() (MsgStatus, error)
- func (mb *MockBackend) GetLastQueueMsg() (Msg, error)
- func (mb *MockBackend) GetLastStoppedMsgContact() Msg
- func (mb *MockBackend) Health() string
- func (mb *MockBackend) MarkOutgoingMsgComplete(msg Msg, s MsgStatus)
- func (mb *MockBackend) NewChannelEvent(channel Channel, eventType ChannelEventType, urn urns.URN) ChannelEvent
- func (mb *MockBackend) NewIncomingMsg(channel Channel, urn urns.URN, text string) Msg
- func (mb *MockBackend) NewMsgStatusForExternalID(channel Channel, externalID string, status MsgStatusValue) MsgStatus
- func (mb *MockBackend) NewMsgStatusForID(channel Channel, id MsgID, status MsgStatusValue) MsgStatus
- func (mb *MockBackend) NewOutgoingMsg(channel Channel, id MsgID, urn urns.URN, text string, highPriority bool) Msg
- func (mb *MockBackend) PopNextOutgoingMsg() (Msg, error)
- func (mb *MockBackend) PushOutgoingMsg(msg Msg)
- func (mb *MockBackend) SetErrorOnQueue(shouldError bool)
- func (mb *MockBackend) Start() error
- func (mb *MockBackend) Status() string
- func (mb *MockBackend) Stop() error
- func (mb *MockBackend) StopMsgContact(msg Msg)
- func (mb *MockBackend) WasMsgSent(msg Msg) (bool, error)
- func (mb *MockBackend) WriteChannelEvent(event ChannelEvent) error
- func (mb *MockBackend) WriteChannelLogs(logs []*ChannelLog) error
- func (mb *MockBackend) WriteMsg(m Msg) error
- func (mb *MockBackend) WriteMsgStatus(status MsgStatus) error
- type MockChannel
- func (c *MockChannel) Address() string
- func (c *MockChannel) ChannelType() ChannelType
- func (c *MockChannel) ConfigForKey(key string, defaultValue interface{}) interface{}
- func (c *MockChannel) Country() string
- func (c *MockChannel) Schemes() []string
- func (c *MockChannel) SetConfig(key string, value interface{})
- func (c *MockChannel) StringConfigForKey(key string, defaultValue string) string
- func (c *MockChannel) UUID() ChannelUUID
- type Msg
- type MsgID
- type MsgStatus
- type MsgStatusValue
- type MsgUUID
- type ReceiveEvent
- type Sender
- type Server
Constants ¶
const ( // ConfigAuthToken is a constant key for channel configs ConfigAuthToken = "auth_token" // ConfigUsername is a constant key for channel configs ConfigUsername = "username" // ConfigPassword is a constant key for channel configs ConfigPassword = "password" // ConfigAPIKey is a constant key for channel configs ConfigAPIKey = "api_key" // ConfigSendURL is a constant key for channel configs ConfigSendURL = "send_url" // ConfigSendBody is a constant key for channel configs ConfigSendBody = "send_body" // ConfigSendMethod is a constant key for channel configs ConfigSendMethod = "send_method" // ConfigContentType is a constant key for channel configs ConfigContentType = "content_type" )
const NilStatusCode int = 417
NilStatusCode is used when we have an error before even sending anything
Variables ¶
var AnyChannelType = ChannelType("")
AnyChannelType is our empty channel type used when doing lookups without channel type assertions
var ErrChannelExpired = errors.New("channel expired")
ErrChannelExpired is returned when our cached channel has outlived it's TTL
var ErrChannelNotFound = errors.New("channel not found")
ErrChannelNotFound is returned when we fail to find a channel in the db
var ErrChannelWrongType = errors.New("channel type wrong")
ErrChannelWrongType is returned when we find a channel with the set UUID but with a different type
var ErrMsgNotFound = errors.New("message not found")
ErrMsgNotFound is returned when trying to queue the status for a Msg that doesn't exit
var NilChannelID = ChannelID{null.NewInt(0, false)}
NilChannelID is our nil value for ChannelIDs
var NilChannelUUID = ChannelUUID{uuid.Nil}
NilChannelUUID is our nil value for channel UUIDs
var NilMsgID = MsgID{null.NewInt(0, false)}
NilMsgID is our nil value for MsgID
var NilMsgUUID = MsgUUID{uuid.Nil}
NilMsgUUID is a "zero value" message UUID
Functions ¶
func EnsureSpoolDirPresent ¶
EnsureSpoolDirPresent checks that the passed in spool directory is present and writable
func GetTextAndAttachments ¶ added in v0.2.0
GetTextAndAttachments returns both the text of our message as well as any attachments, newline delimited
func LogChannelEventReceived ¶ added in v0.9.2
func LogChannelEventReceived(r *http.Request, event ChannelEvent)
LogChannelEventReceived logs that we received the passed in channel event
func LogMsgReceived ¶ added in v0.9.2
LogMsgReceived logs that we received the passed in message
func LogMsgStatusReceived ¶ added in v0.9.2
LogMsgStatusReceived logs our that we received a new MsgStatus
func LogRequestIgnored ¶ added in v0.9.2
LogRequestIgnored logs that we ignored the passed in request
func RegisterBackend ¶
func RegisterBackend(backendType string, constructorFunc BackendConstructorFunc)
RegisterBackend adds a new backend, called by individual backends in their init() func
func RegisterFlusher ¶
func RegisterFlusher(directory string, flusherFunc FlusherFunc)
RegisterFlusher creates a new walker which we will use to flush files from the passed in directory
func RegisterHandler ¶
func RegisterHandler(handler ChannelHandler)
RegisterHandler adds a new handler for a channel type, this is called by individual handlers when they are initialized
func SplitAttachment ¶ added in v0.2.0
SplitAttachment takes an attachment string and returns the media type and URL for the attachment
func WriteChannelEventSuccess ¶ added in v0.8.0
func WriteChannelEventSuccess(w http.ResponseWriter, r *http.Request, event ChannelEvent) error
WriteChannelEventSuccess writes a JSON response for the passed in event indicating we handled it
func WriteError ¶
WriteError writes a JSON response for the passed in error
func WriteIgnored ¶
WriteIgnored writes a JSON response for the passed in message
func WriteMsgSuccess ¶ added in v0.8.0
WriteMsgSuccess writes a JSON response for the passed in msg indicating we handled it
func WriteStatusSuccess ¶
WriteStatusSuccess writes a JSON response for the passed in status update indicating we handled it
func WriteToSpool ¶
WriteToSpool writes the passed in object to the passed in subdir
Types ¶
type Backend ¶
type Backend interface { // Start starts the backend and opens any db connections it needs Start() error // Stop stops any backend processes Stop() error // Cleanup closes any active connections to databases Cleanup() error // GetChannel returns the channel with the passed in type and UUID GetChannel(ChannelType, ChannelUUID) (Channel, error) // NewIncomingMsg creates a new message from the given params NewIncomingMsg(channel Channel, urn urns.URN, text string) Msg // WriteMsg writes the passed in message to our backend WriteMsg(Msg) error // NewMsgStatusForID creates a new Status object for the given message id NewMsgStatusForID(Channel, MsgID, MsgStatusValue) MsgStatus // NewMsgStatusForExternalID creates a new Status object for the given external id NewMsgStatusForExternalID(Channel, string, MsgStatusValue) MsgStatus // WriteMsgStatus writes the passed in status update to our backend WriteMsgStatus(MsgStatus) error // NewChannelEvent creates a new channel event for the given channel and event type NewChannelEvent(Channel, ChannelEventType, urns.URN) ChannelEvent // WriteChannelEvent writes the passed in channel even returning any error WriteChannelEvent(ChannelEvent) error // WriteChannelLogs writes the passed in channel logs to our backend WriteChannelLogs([]*ChannelLog) error // PopNextOutgoingMsg returns the next message that needs to be sent, callers should call MarkOutgoingMsgComplete with the // returned message when they have dealt with the message (regardless of whether it was sent or not) PopNextOutgoingMsg() (Msg, error) // WasMsgSent returns whether the backend thinks the passed in message was already sent. This can be used in cases where // a backend wants to implement a failsafe against double sending messages (say if they were double queued) WasMsgSent(msg Msg) (bool, error) // MarkOutgoingMsgComplete marks the passed in message as having been processed. Note this should be called even in the case // of errors during sending as it will manage the number of active workers per channel. The optional status parameter can be // used to determine any sort of deduping of msg sends MarkOutgoingMsgComplete(Msg, MsgStatus) // StopMsgContact marks the contact for the passed in msg as stopped StopMsgContact(Msg) // Health returns a string describing any health problems the backend has, or empty string if all is well Health() string // Status returns a string describing the current status, this can detail queue sizes or other attributes Status() string }
Backend represents the part of Courier that deals with looking up and writing channels and results
type BackendConstructorFunc ¶
BackendConstructorFunc defines a function to create a particular backend type
type Channel ¶
type Channel interface { UUID() ChannelUUID ChannelType() ChannelType Schemes() []string Country() string Address() string ConfigForKey(key string, defaultValue interface{}) interface{} StringConfigForKey(key string, defaultValue string) string }
Channel defines the general interface backend Channel implementations must adhere to
type ChannelActionHandlerFunc ¶
ChannelActionHandlerFunc is the interface ChannelHandler functions must satisfy to handle other types of requests. These generic handlers should only be used if they are not dealing with receiving messages or status updates.
The Server will take care of looking up the channel by UUID before passing it to this function.
type ChannelEvent ¶ added in v0.8.0
type ChannelEvent interface { ChannelUUID() ChannelUUID URN() urns.URN EventType() ChannelEventType CreatedOn() time.Time OccurredOn() time.Time Logs() []*ChannelLog AddLog(log *ChannelLog) WithContactName(name string) ChannelEvent WithExtra(extra map[string]interface{}) ChannelEvent WithOccurredOn(time.Time) ChannelEvent ReceiveID() int64 }
ChannelEvent represents an event on a channel, such as a follow, new conversation or referral
type ChannelEventType ¶ added in v0.8.0
type ChannelEventType string
ChannelEventType is the type of channel event this is
const ( NewConversation ChannelEventType = "new_conversation" Referral ChannelEventType = "referral" )
Possible values for ChannelEventTypes
type ChannelHandler ¶
type ChannelHandler interface { Initialize(Server) error ChannelType() ChannelType ChannelName() string SendMsg(Msg) (MsgStatus, error) }
ChannelHandler is the interface all handlers must satisfy
type ChannelID ¶ added in v0.2.0
ChannelID is our SQL type for a channel's id
func NewChannelID ¶ added in v0.2.0
NewChannelID creates a new ChannelID for the passed in int64
type ChannelLog ¶ added in v0.2.0
type ChannelLog struct { Description string Channel Channel MsgID MsgID Method string URL string StatusCode int Error string Request string Response string Elapsed time.Duration CreatedOn time.Time }
ChannelLog represents the log for a msg being received, sent or having its status updated. It includes the HTTP request and response for the action as well as the channel it was performed on and an option ID of the msg (for some error cases we may log without a msg id)
func NewChannelLog ¶ added in v0.2.0
func NewChannelLog(description string, channel Channel, msgID MsgID, method string, url string, statusCode int, request string, response string, elapsed time.Duration, err error) *ChannelLog
NewChannelLog creates a new channel log for the passed in channel, id, and request and response info
func NewChannelLogFromRR ¶ added in v0.2.0
func NewChannelLogFromRR(description string, channel Channel, msgID MsgID, rr *utils.RequestResponse) *ChannelLog
NewChannelLogFromRR creates a new channel log for the passed in channel, id, and request/response log
func (*ChannelLog) String ¶ added in v0.2.0
func (l *ChannelLog) String() string
func (*ChannelLog) WithError ¶ added in v0.6.3
func (l *ChannelLog) WithError(description string, err error) *ChannelLog
WithError augments the passed in ChannelLog with the passed in description and error if error is not nil
type ChannelReceiveMsgFunc ¶ added in v0.2.0
type ChannelReceiveMsgFunc func(Channel, http.ResponseWriter, *http.Request) ([]ReceiveEvent, error)
ChannelReceiveMsgFunc is the interface ChannelHandler functions must satisfy to handle incoming msgs The Server will take care of looking up the channel by UUID before passing it to this function.
type ChannelType ¶
type ChannelType string
ChannelType is our typing of the two char channel types
func (ChannelType) String ¶ added in v0.4.2
func (ct ChannelType) String() string
type ChannelUUID ¶
ChannelUUID is our typing of a channel's UUID
func NewChannelUUID ¶
func NewChannelUUID(u string) (ChannelUUID, error)
NewChannelUUID creates a new ChannelUUID for the passed in string
type ChannelUpdateStatusFunc ¶ added in v0.2.0
ChannelUpdateStatusFunc is the interface ChannelHandler functions must satisfy to handle incoming status requests. The Server will take care of looking up the channel by UUID before passing it to this function.
type FlusherFunc ¶
FlusherFunc defines our interface for flushers, they are handed a filename and byte blob and are expected to try to flush that to the db, returning an error if the db is still down
type Foreman ¶ added in v0.2.0
type Foreman struct {
// contains filtered or unexported fields
}
Foreman takes care of managing our set of sending workers and assigns msgs for each to send
func NewForeman ¶ added in v0.2.0
NewForeman creates a new Foreman for the passed in server with the number of max senders
func (*Foreman) Assign ¶ added in v0.2.0
func (f *Foreman) Assign()
Assign is our main loop for the Foreman, it takes care of popping the next outgoing messages from our backend and assigning them to workers
type MockBackend ¶
type MockBackend struct {
// contains filtered or unexported fields
}
MockBackend is a mocked version of a backend which doesn't require a real database or cache
func NewMockBackend ¶
func NewMockBackend() *MockBackend
NewMockBackend returns a new mock backend suitable for testing
func (*MockBackend) AddChannel ¶
func (mb *MockBackend) AddChannel(channel Channel)
AddChannel adds a test channel to the test server
func (*MockBackend) Cleanup ¶ added in v0.5.3
func (mb *MockBackend) Cleanup() error
Cleanup cleans up any connections that are open
func (*MockBackend) ClearChannels ¶
func (mb *MockBackend) ClearChannels()
ClearChannels is a utility function on our mock server to clear all added channels
func (*MockBackend) ClearQueueMsgs ¶
func (mb *MockBackend) ClearQueueMsgs()
ClearQueueMsgs clears our mock msg queue
func (*MockBackend) GetChannel ¶
func (mb *MockBackend) GetChannel(cType ChannelType, uuid ChannelUUID) (Channel, error)
GetChannel returns the channel with the passed in type and channel uuid
func (*MockBackend) GetLastChannelEvent ¶ added in v0.8.0
func (mb *MockBackend) GetLastChannelEvent() (ChannelEvent, error)
GetLastChannelEvent returns the last event written to the server
func (*MockBackend) GetLastContactName ¶ added in v0.8.0
func (mb *MockBackend) GetLastContactName() string
GetLastContactName returns the contact name set on the last msg or channel event written
func (*MockBackend) GetLastMsgStatus ¶ added in v0.9.0
func (mb *MockBackend) GetLastMsgStatus() (MsgStatus, error)
GetLastMsgStatus returns the last status written to the server
func (*MockBackend) GetLastQueueMsg ¶
func (mb *MockBackend) GetLastQueueMsg() (Msg, error)
GetLastQueueMsg returns the last message queued to the server
func (*MockBackend) GetLastStoppedMsgContact ¶ added in v0.2.0
func (mb *MockBackend) GetLastStoppedMsgContact() Msg
GetLastStoppedMsgContact returns the last msg contact
func (*MockBackend) Health ¶
func (mb *MockBackend) Health() string
Health gives a string representing our health, empty for our mock
func (*MockBackend) MarkOutgoingMsgComplete ¶ added in v0.2.0
func (mb *MockBackend) MarkOutgoingMsgComplete(msg Msg, s MsgStatus)
MarkOutgoingMsgComplete marks the passed msg as having been dealt with
func (*MockBackend) NewChannelEvent ¶ added in v0.8.0
func (mb *MockBackend) NewChannelEvent(channel Channel, eventType ChannelEventType, urn urns.URN) ChannelEvent
NewChannelEvent creates a new channel event with the passed in parameters
func (*MockBackend) NewIncomingMsg ¶ added in v0.2.0
NewIncomingMsg creates a new message from the given params
func (*MockBackend) NewMsgStatusForExternalID ¶ added in v0.2.0
func (mb *MockBackend) NewMsgStatusForExternalID(channel Channel, externalID string, status MsgStatusValue) MsgStatus
NewMsgStatusForExternalID creates a new Status object for the given external id
func (*MockBackend) NewMsgStatusForID ¶ added in v0.2.0
func (mb *MockBackend) NewMsgStatusForID(channel Channel, id MsgID, status MsgStatusValue) MsgStatus
NewMsgStatusForID creates a new Status object for the given message id
func (*MockBackend) NewOutgoingMsg ¶ added in v0.2.0
func (mb *MockBackend) NewOutgoingMsg(channel Channel, id MsgID, urn urns.URN, text string, highPriority bool) Msg
NewOutgoingMsg creates a new outgoing message from the given params
func (*MockBackend) PopNextOutgoingMsg ¶ added in v0.2.0
func (mb *MockBackend) PopNextOutgoingMsg() (Msg, error)
PopNextOutgoingMsg returns the next message that should be sent, or nil if there are none to send
func (*MockBackend) PushOutgoingMsg ¶ added in v0.2.0
func (mb *MockBackend) PushOutgoingMsg(msg Msg)
PushOutgoingMsg is a test method to add a message to our queue of messages to send
func (*MockBackend) SetErrorOnQueue ¶
func (mb *MockBackend) SetErrorOnQueue(shouldError bool)
SetErrorOnQueue is a mock method which makes the QueueMsg call throw the passed in error on next call
func (*MockBackend) Status ¶ added in v0.4.6
func (mb *MockBackend) Status() string
Status returns a string describing the status of the service, queue size etc..
func (*MockBackend) StopMsgContact ¶ added in v0.2.0
func (mb *MockBackend) StopMsgContact(msg Msg)
StopMsgContact stops the contact for the passed in msg
func (*MockBackend) WasMsgSent ¶ added in v0.2.0
func (mb *MockBackend) WasMsgSent(msg Msg) (bool, error)
WasMsgSent returns whether the passed in msg was already sent
func (*MockBackend) WriteChannelEvent ¶ added in v0.8.0
func (mb *MockBackend) WriteChannelEvent(event ChannelEvent) error
WriteChannelEvent writes the channel event passed in
func (*MockBackend) WriteChannelLogs ¶ added in v0.2.0
func (mb *MockBackend) WriteChannelLogs(logs []*ChannelLog) error
WriteChannelLogs writes the passed in channel logs to the DB
func (*MockBackend) WriteMsg ¶
func (mb *MockBackend) WriteMsg(m Msg) error
WriteMsg queues the passed in message internally
func (*MockBackend) WriteMsgStatus ¶
func (mb *MockBackend) WriteMsgStatus(status MsgStatus) error
WriteMsgStatus writes the status update to our queue
type MockChannel ¶ added in v0.2.0
type MockChannel struct {
// contains filtered or unexported fields
}
MockChannel implements the Channel interface and is used in our tests
func (*MockChannel) Address ¶ added in v0.2.0
func (c *MockChannel) Address() string
Address returns the address of this channel
func (*MockChannel) ChannelType ¶ added in v0.2.0
func (c *MockChannel) ChannelType() ChannelType
ChannelType returns the type of this channel
func (*MockChannel) ConfigForKey ¶ added in v0.2.0
func (c *MockChannel) ConfigForKey(key string, defaultValue interface{}) interface{}
ConfigForKey returns the config value for the passed in key
func (*MockChannel) Country ¶ added in v0.2.0
func (c *MockChannel) Country() string
Country returns the country this channel is for (if any)
func (*MockChannel) Schemes ¶ added in v0.3.0
func (c *MockChannel) Schemes() []string
Schemes returns the schemes for this channel
func (*MockChannel) SetConfig ¶ added in v0.2.0
func (c *MockChannel) SetConfig(key string, value interface{})
SetConfig sets the passed in config parameter
func (*MockChannel) StringConfigForKey ¶ added in v0.2.0
func (c *MockChannel) StringConfigForKey(key string, defaultValue string) string
StringConfigForKey returns the config value for the passed in key
func (*MockChannel) UUID ¶ added in v0.2.0
func (c *MockChannel) UUID() ChannelUUID
UUID returns the uuid for this channel
type Msg ¶
type Msg interface { Channel() Channel ID() MsgID UUID() MsgUUID Text() string Attachments() []string ExternalID() string URN() urns.URN ContactName() string ReceivedOn() *time.Time SentOn() *time.Time HighPriority() bool WithContactName(name string) Msg WithReceivedOn(date time.Time) Msg WithExternalID(id string) Msg WithID(id MsgID) Msg WithUUID(uuid MsgUUID) Msg WithAttachment(url string) Msg ReceiveID() int64 }
Msg is our interface to represent an incoming or outgoing message
type MsgStatus ¶
type MsgStatus interface { ChannelUUID() ChannelUUID ID() MsgID ExternalID() string SetExternalID(string) Status() MsgStatusValue SetStatus(MsgStatusValue) Logs() []*ChannelLog AddLog(log *ChannelLog) }
MsgStatus represents a status update on a message
type MsgStatusValue ¶ added in v0.2.0
type MsgStatusValue string
MsgStatusValue is the status of a message
const ( MsgPending MsgStatusValue = "P" MsgQueued MsgStatusValue = "Q" MsgSent MsgStatusValue = "S" MsgWired MsgStatusValue = "W" MsgErrored MsgStatusValue = "E" MsgDelivered MsgStatusValue = "D" MsgFailed MsgStatusValue = "F" NilMsgStatus MsgStatusValue = "" )
Possible values for MsgStatus
type MsgUUID ¶
MsgUUID is the UUID of a message which has been received
func NewMsgUUIDFromString ¶ added in v0.2.0
NewMsgUUIDFromString creates a new message UUID for the passed in string
type ReceiveEvent ¶ added in v0.8.0
type ReceiveEvent interface {
ReceiveID() int64
}
ReceiveEvent is our interface for the types of things a ChannelReceiveMsgFunc can return. Currently Msgs and ChannelEvent both satisfy this
type Sender ¶ added in v0.2.0
type Sender struct {
// contains filtered or unexported fields
}
Sender is our type for a single goroutine that is sending messages
func (*Sender) Send ¶ added in v0.2.0
func (w *Sender) Send()
Send is our main work loop for our worker. The Worker marks itself as available for work to the foreman, then waits for the next job
type Server ¶
type Server interface { Config() *config.Courier AddChannelRoute(handler ChannelHandler, method string, action string, handlerFunc ChannelActionHandlerFunc) error AddReceiveMsgRoute(handler ChannelHandler, method string, action string, handlerFunc ChannelReceiveMsgFunc) error AddUpdateStatusRoute(handler ChannelHandler, method string, action string, handlerFunc ChannelUpdateStatusFunc) error SendMsg(Msg) (MsgStatus, error) Backend() Backend WaitGroup() *sync.WaitGroup StopChan() chan bool Stopped() bool Router() chi.Router Start() error Stop() error }
Server is the main interface ChannelHandlers use to interact with backends. It provides an abstraction that makes mocking easier for isolated unit tests
func NewServer ¶
NewServer creates a new Server for the passed in configuration. The server will have to be started afterwards, which is when configuration options are checked.
func NewServerWithLogger ¶ added in v0.2.0
NewServerWithLogger creates a new Server for the passed in configuration. The server will have to be started afterwards, which is when configuration options are checked.