94 lines
3.0 KiB
Markdown
94 lines
3.0 KiB
Markdown
<!-- Code generated by gomarkdoc. DO NOT EDIT -->
|
|
|
|
# abstractions
|
|
|
|
```go
|
|
import "github.com/Akilan1999/p2p-rendering-computation/abstractions"
|
|
```
|
|
|
|
## Index
|
|
|
|
- [func GetSpecs\(IP string\) \(specs \*server.SysInfo, err error\)](<#GetSpecs>)
|
|
- [func Init\(customConfig interface\{\}\) \(config \*Config.Config, err error\)](<#Init>)
|
|
- [func MapPort\(port string, domainName string, serverAddress string\) \(entireAddress string, mapPort string, err error\)](<#MapPort>)
|
|
- [func RemoveContainer\(IP string, ID string\) error](<#RemoveContainer>)
|
|
- [func Start\(\) \(\*gin.Engine, error\)](<#Start>)
|
|
- [func StartContainer\(IP string\) \(container \*docker.DockerVM, err error\)](<#StartContainer>)
|
|
- [func UpdateIPTable\(\) \(err error\)](<#UpdateIPTable>)
|
|
- [func ViewIPTable\(\) \(table \*p2p.IpAddresses, err error\)](<#ViewIPTable>)
|
|
|
|
|
|
<a name="GetSpecs"></a>
|
|
## func [GetSpecs](<https://github.com/Akilan1999/p2p-rendering-computation/blob/master/abstractions/base.go#L73>)
|
|
|
|
```go
|
|
func GetSpecs(IP string) (specs *server.SysInfo, err error)
|
|
```
|
|
|
|
GetSpecs Get spec information about the remote server
|
|
|
|
<a name="Init"></a>
|
|
## func [Init](<https://github.com/Akilan1999/p2p-rendering-computation/blob/master/abstractions/base.go#L17>)
|
|
|
|
```go
|
|
func Init(customConfig interface{}) (config *Config.Config, err error)
|
|
```
|
|
|
|
Init Initialises p2prc
|
|
|
|
<a name="MapPort"></a>
|
|
## func [MapPort](<https://github.com/Akilan1999/p2p-rendering-computation/blob/master/abstractions/base.go#L55>)
|
|
|
|
```go
|
|
func MapPort(port string, domainName string, serverAddress string) (entireAddress string, mapPort string, err error)
|
|
```
|
|
|
|
MapPort Creates a reverse proxy connection and maps the appropriate port
|
|
|
|
<a name="RemoveContainer"></a>
|
|
## func [RemoveContainer](<https://github.com/Akilan1999/p2p-rendering-computation/blob/master/abstractions/base.go#L68>)
|
|
|
|
```go
|
|
func RemoveContainer(IP string, ID string) error
|
|
```
|
|
|
|
RemoveContainer Removes docker container based on the IP address and ID provided
|
|
|
|
<a name="Start"></a>
|
|
## func [Start](<https://github.com/Akilan1999/p2p-rendering-computation/blob/master/abstractions/base.go#L46>)
|
|
|
|
```go
|
|
func Start() (*gin.Engine, error)
|
|
```
|
|
|
|
Start p2prc in a server mode
|
|
|
|
<a name="StartContainer"></a>
|
|
## func [StartContainer](<https://github.com/Akilan1999/p2p-rendering-computation/blob/master/abstractions/base.go#L61>)
|
|
|
|
```go
|
|
func StartContainer(IP string) (container *docker.DockerVM, err error)
|
|
```
|
|
|
|
StartContainer Starts docker container on the remote machine
|
|
|
|
<a name="UpdateIPTable"></a>
|
|
## func [UpdateIPTable](<https://github.com/Akilan1999/p2p-rendering-computation/blob/master/abstractions/base.go#L86>)
|
|
|
|
```go
|
|
func UpdateIPTable() (err error)
|
|
```
|
|
|
|
UpdateIPTable Force updates IP tables based on new new nodes discovered in the network
|
|
|
|
<a name="ViewIPTable"></a>
|
|
## func [ViewIPTable](<https://github.com/Akilan1999/p2p-rendering-computation/blob/master/abstractions/base.go#L79>)
|
|
|
|
```go
|
|
func ViewIPTable() (table *p2p.IpAddresses, err error)
|
|
```
|
|
|
|
ViewIPTable View information of nodes in the network
|
|
|
|
Generated by [gomarkdoc](<https://github.com/princjef/gomarkdoc>)
|