Add more code explanations.

Author: Illicitus

backtest/backtest.go

@@ -59,7 +59,11 @@ type Backtest struct {
 	zmqConn        *ZmqConn
 }
 
+// NewBacktest create new Backtest object with selected start,
+// end dates and create new ZMQ connection using chosen socket URL
 func NewBacktest(start, end, socketUrl string) (*Backtest, error) {
+
+	// Create new ZMQ connection
 	zmqConn, err := NewZmq(socketUrl)
 	if err != nil {
 		return nil, err
@@ -73,7 +77,11 @@ func NewBacktest(start, end, socketUrl string) (*Backtest, error) {
 	}, nil
 }
 
+// CallErocMethod parse client request data and use it to create new EROC request and send data using ZMQ;
+// Returns EROC response as HTTP response.
 func (b *Backtest) CallErocMethod(req *http.Request) *http.Response {
+
+	// Parse request data as JSON to erocRequestData structure
 	erocRequestData := ErocRequestData{}
 
 	if req.Body != nil {
@@ -111,6 +119,7 @@ func (b *Backtest) CallErocMethod(req *http.Request) *http.Response {
 		return b.errorHandler(req, err, DefaultErrorMessage)
 	}
 
+	// Set runtime events
 	b.runtimeEvents = erocResponse.Events
 
 	erocJSONResponse, err := json.Marshal(BacktestResponse{
@@ -139,7 +148,9 @@ func (b *Backtest) CallErocMethod(req *http.Request) *http.Response {
 
 }
 
+// errorHandler returns HTTP Bad Gateway error if something unexpected happened inside CallErocMethod function
 func (b *Backtest) errorHandler(req *http.Request, err error, message string) *http.Response {
+
 	// Log source error
 	if err != nil {
 		log.Println(err)
@@ -171,14 +182,17 @@ func (b *Backtest) errorHandler(req *http.Request, err error, message string) *h
 	return res
 }
 
+// SetCurrentBarInfo set currentBarInfo datetime and resolution
 func (b *Backtest) SetCurrentBarInfo(info *BarInfo) {
 	b.currentBarInfo = info
 }
 
+// GetRuntimeEvents returns current Backtest events data
 func (b *Backtest) GetRuntimeEvents() map[string]interface{} {
 	return b.runtimeEvents
 }
 
+// Close ZMQ connection
 func (b *Backtest) Close() {
 	b.zmqConn.Close()
 }

backtest/zmq.go

@@ -9,9 +9,8 @@ type ZmqConn struct {
 	req *goczmq.Sock
 }
 
+// NewZmq create new Req socket and connect it to the router
 func NewZmq(socketUrl string) (*ZmqConn, error) {
-
-	// Create a new Req socket and connect it to the router.
 	req, err := goczmq.NewReq(socketUrl)
 	if err != nil {
 		return nil, err
@@ -20,12 +19,14 @@ func NewZmq(socketUrl string) (*ZmqConn, error) {
 	return &ZmqConn{req}, nil
 }
 
+// SendMsg sends a byte array via the socket
 func (z *ZmqConn) SendMsg(msg []byte) error {
 	err := z.req.SendFrame(msg, goczmq.FlagNone)
 
 	return err
 }
 
+// SendJSON convert data to json and sends a byte array via the socket
 func (z *ZmqConn) SendJSON(src interface{}) error {
 	srcJSON, err := json.Marshal(src)
 	if err != nil {
@@ -39,11 +40,13 @@ func (z *ZmqConn) SendJSON(src interface{}) error {
 	return nil
 }
 
+// ReceiveMsg receives a full message from the socket and returns it as an array of byte arrays
 func (z *ZmqConn) ReceiveMsg() ([][]byte, error) {
 	msg, err := z.req.RecvMessage()
 	return msg, err
 }
 
+// ReceiveJSON receives a full message from the socket and parse JSON-encoded data into selected struct
 func (z *ZmqConn) ReceiveJSON(dst interface{}) error {
 	msg, err := z.req.RecvMessage()
 	if err != nil {

net/http/http.go

@@ -30,13 +30,15 @@ type Response _http.Response
 type Header _http.Header
 type Client _http.Client
 
+// NewDefaultClient returns new HTTP client pointer with default timeout
 func NewDefaultClient() *Client {
 	return &Client{Timeout: defaultTimeout}
 }
 
 var DefaultClient = NewDefaultClient()
 var httpDefaultClient = _http.DefaultClient
 
+// newRequestWithContentType wraps NewRequestWithContext using context.Background and set content type to headers
 func newRequestWithContentType(method, url string, contentType string, body io.Reader) (*_http.Request, error) {
 	req, err := NewRequest(method, url, body)
 	if err != nil {
@@ -49,6 +51,8 @@ func newRequestWithContentType(method, url string, contentType string, body io.R
 	return req, err
 }
 
+// Do send an HTTP request and returns an HTTP response, following policy (such as redirects, cookies, auth)
+// as configured on the client.
 func (c *Client) Do(req *_http.Request) (*_http.Response, error) {
 
 	// If url include protocol, then use default http client
@@ -59,6 +63,9 @@ func (c *Client) Do(req *_http.Request) (*_http.Response, error) {
 
 }
 
+// processRequest proxy request to external endpoints
+// or proxy to Tradologics API if URL doesn't include protocol,
+// or proxy to Backtest/ZMQ client if backtest mode is turned on
 func (c *Client) processRequest(method, url, contentType string, body io.Reader, header _http.Header) (*_http.Response, error) {
 
 	if includeProtocol(url) {
@@ -72,7 +79,6 @@ func (c *Client) processRequest(method, url, contentType string, body io.Reader,
 	}
 
 	if IsBacktest {
-		// TODO error handler
 		req, err := newRequestWithContentType(method, url, contentType, body)
 		if err != nil {
 			return nil, err
@@ -107,42 +113,52 @@ func (c *Client) processRequest(method, url, contentType string, body io.Reader,
 	return r, nil
 }
 
+// Head issues a HEAD to the specified URL using default client
 func Head(url string) (resp *_http.Response, err error) {
 	return DefaultClient.Head(url)
 }
 
+// Head issues a HEAD to the specified URL
 func (c *Client) Head(url string) (resp *_http.Response, err error) {
 	return c.processRequest("HEAD", url, "", nil, nil)
 }
 
+// Get issues a GET to the specified URL using default client
 func Get(url string) (resp *_http.Response, err error) {
 	return DefaultClient.Get(url)
 }
 
+// Get issues a GET to the specified URL
 func (c *Client) Get(url string) (resp *_http.Response, err error) {
 	return c.processRequest("GET", url, "", nil, nil)
 }
 
+// Post issues a POST to the specified URL using default client
 func Post(url, contentType string, body io.Reader) (resp *_http.Response, err error) {
 	return DefaultClient.Post(url, contentType, body)
 }
 
+// Post issues a POST to the specified URL
 func (c *Client) Post(url, contentType string, body io.Reader) (resp *_http.Response, err error) {
 	return c.processRequest("POST", url, contentType, body, nil)
 }
 
+// PostForm issues a POST to the specified URL using default client
 func PostForm(url string, data url.Values) (resp *_http.Response, err error) {
 	return DefaultClient.PostForm(url, data)
 }
 
+// PostForm issues a POST to the specified URL using default client
 func (c *Client) PostForm(url string, data url.Values) (resp *_http.Response, err error) {
 	return c.Post(url, "application/x-www-form-urlencoded", strings.NewReader(data.Encode()))
 }
 
+// SetToken set Authorization token
 func SetToken(token string) {
 	Token = token
 }
 
+// SetBacktestMode turn on backtest mode
 func SetBacktestMode(start, end string) (err error) {
 	Backtest, err = backtest.NewBacktest(start, end, socketUrl)
 	if err != nil {
@@ -154,6 +170,7 @@ func SetBacktestMode(start, end string) (err error) {
 	return nil
 }
 
+// SetCurrentBarInfo set current Backtest currentBarInfo datetime and resolution
 func SetCurrentBarInfo(info *backtest.BarInfo) error {
 	if Backtest != nil {
 		Backtest.SetCurrentBarInfo(info)
@@ -163,6 +180,7 @@ func SetCurrentBarInfo(info *backtest.BarInfo) error {
 	return errors.New("please set backtest mode first")
 }
 
+// GetRuntimeEvents returns current Backtest runtime events
 func GetRuntimeEvents() (map[string]interface{}, error) {
 	if Backtest != nil {
 		return Backtest.GetRuntimeEvents(), nil

net/http/utils.go

@@ -2,6 +2,7 @@ package http
 
 import "strings"
 
+// includeProtocol returns trues if string include protocol
 func includeProtocol(url string) bool {
 	if strings.Contains(url, "://") {
 		return true

server/server.go

@@ -8,6 +8,7 @@ import (
 
 var strategyHandler func(w http.ResponseWriter, r *http.Request)
 
+// postMethodOnlyHandler validate request method and execute only 'POST'
 func postMethodOnlyHandler(w http.ResponseWriter, r *http.Request) {
 	if r.Method == http.MethodPost {
 		strategyHandler(w, r)
@@ -20,6 +21,7 @@ func postMethodOnlyHandler(w http.ResponseWriter, r *http.Request) {
 	}
 }
 
+// router returns http server mux with selected handler and URL path
 func router(strategy func(w http.ResponseWriter, r *http.Request), endpoint string) http.Handler {
 	strategyHandler = strategy
 
@@ -29,6 +31,7 @@ func router(strategy func(w http.ResponseWriter, r *http.Request), endpoint stri
 	return router
 }
 
+// Start create new server with selected host and port, and use strategy as request handler
 func Start(strategy func(w http.ResponseWriter, r *http.Request), endpoint, host string, port int) {
 	err := http.ListenAndServe(fmt.Sprintf("%s:%d", host, port), router(strategy, endpoint))
 	if err != nil {