README ¶
GoCryptoTrader package Base
This base package is part of the GoCryptoTrader codebase.
This is still in active development
You can track ideas, planned features and what's in progress on this Trello board: https://trello.com/b/ZAhMhpOy/gocryptotrader.
Join our slack to discuss all things related to GoCryptoTrader! GoCryptoTrader Slack
Base Communications package
Current Features
- Used to enforce standard variables and methods across the communication packages
Please click GoDocs chevron above to view current GoDoc information for this package
Contribution
Please feel free to submit any pull requests or suggest any desired features to be added.
When submitting a PR, please abide by our coding guidelines:
- Code must adhere to the official Go formatting guidelines (i.e. uses gofmt).
- Code must be documented adhering to the official Go commentary guidelines.
- Code must adhere to our coding style.
- Pull requests need to be based on and opened against the
master
branch.
Donations
If this framework helped you in any way, or you would like to support the developers working on it, please donate Bitcoin to:
bc1qk0jareu4jytc0cfrhr5wgshsq8282awpavfahc
Documentation ¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var (
ServiceStarted time.Time
)
global vars contain staged update data that will be sent to the communication mediums
Functions ¶
This section is empty.
Types ¶
type Base ¶
Base enforces standard variables across communication packages
func (*Base) IsConnected ¶
IsConnected returns if the package is connected to a server and/or ready to send
type CommsStatus ¶
CommsStatus stores the status of a comms relayer
type IComm ¶
type IComm []ICommunicate
IComm is the main interface array across the communication packages
func (IComm) GetEnabledCommunicationMediums ¶
GetEnabledCommunicationMediums prints out enabled and connected communication packages (#debug output only)
func (IComm) GetStatus ¶
func (c IComm) GetStatus() map[string]CommsStatus
GetStatus returns the status of the comms relayers
type ICommunicate ¶
type ICommunicate interface { Setup(config *config.CommunicationsConfig) Connect() error PushEvent(Event) error IsEnabled() bool IsConnected() bool GetName() string }
ICommunicate enforces standard functions across communication packages