added improved docs for P2PRC abstractions

This commit is contained in:
2023-06-07 23:42:56 +01:00
parent 732b31fafa
commit 05c9f52e6d
2 changed files with 16 additions and 19 deletions

View File

@@ -35,6 +35,3 @@ func main() {
}
```
// todo diagram representation of the interaction with
nodes spawned in the p2p network.

View File

@@ -1,27 +1,27 @@
package abstractions
import (
"github.com/Akilan1999/p2p-rendering-computation/config"
"github.com/Akilan1999/p2p-rendering-computation/config/generate"
"github.com/Akilan1999/p2p-rendering-computation/server"
"github.com/gin-gonic/gin"
"github.com/Akilan1999/p2p-rendering-computation/config"
"github.com/Akilan1999/p2p-rendering-computation/config/generate"
"github.com/Akilan1999/p2p-rendering-computation/server"
"github.com/gin-gonic/gin"
)
// Init Initialises p2prc
func Init(name string) (config *config.Config, err error) {
// set the config file with default paths
config, err = generate.SetDefaults(name, false)
if err != nil {
return
}
return
func Init(name string, customConfig interface{}) (config *config.Config, err error) {
// set the config file with default paths
config, err = generate.SetDefaults(name, false, customConfig, false)
if err != nil {
return
}
return
}
// Start p2prc in a server mode
func Start() (*gin.Engine, error) {
engine, err := server.Server()
if err != nil {
return nil, err
}
return engine, nil
engine, err := server.Server()
if err != nil {
return nil, err
}
return engine, nil
}