pushed final docs for initial merge
This commit is contained in:
63
client/clientIPTable/docs.md
Normal file
63
client/clientIPTable/docs.md
Normal file
@@ -0,0 +1,63 @@
|
||||
<!-- Code generated by gomarkdoc. DO NOT EDIT -->
|
||||
|
||||
# clientIPTable
|
||||
|
||||
```go
|
||||
import "github.com/Akilan1999/p2p-rendering-computation/client/clientIPTable"
|
||||
```
|
||||
|
||||
## Index
|
||||
|
||||
- [func AddCustomInformationToIPTable\(text string\) error](<#AddCustomInformationToIPTable>)
|
||||
- [func RemoveOfflineNodes\(\) error](<#RemoveOfflineNodes>)
|
||||
- [func UpdateIpTable\(IpAddress string, serverPort string, wg \*sync.WaitGroup\) error](<#UpdateIpTable>)
|
||||
- [func UpdateIpTableListClient\(\) error](<#UpdateIpTableListClient>)
|
||||
- [func UploadMultipartFile\(client http.Client, uri, key, path string\) \(\[\]byte, error\)](<#UploadMultipartFile>)
|
||||
|
||||
|
||||
<a name="AddCustomInformationToIPTable"></a>
|
||||
## func [AddCustomInformationToIPTable](<https://github.com/Akilan1999/p2p-rendering-computation/blob/master/client/clientIPTable/AddCustomInformationToIPTable.go#L9>)
|
||||
|
||||
```go
|
||||
func AddCustomInformationToIPTable(text string) error
|
||||
```
|
||||
|
||||
|
||||
|
||||
<a name="RemoveOfflineNodes"></a>
|
||||
## func [RemoveOfflineNodes](<https://github.com/Akilan1999/p2p-rendering-computation/blob/master/client/clientIPTable/Iptable.go#L154>)
|
||||
|
||||
```go
|
||||
func RemoveOfflineNodes() error
|
||||
```
|
||||
|
||||
|
||||
|
||||
<a name="UpdateIpTable"></a>
|
||||
## func [UpdateIpTable](<https://github.com/Akilan1999/p2p-rendering-computation/blob/master/client/clientIPTable/Iptable.go#L19>)
|
||||
|
||||
```go
|
||||
func UpdateIpTable(IpAddress string, serverPort string, wg *sync.WaitGroup) error
|
||||
```
|
||||
|
||||
UpdateIpTable Does the following to update it's IP table
|
||||
|
||||
<a name="UpdateIpTableListClient"></a>
|
||||
## func [UpdateIpTableListClient](<https://github.com/Akilan1999/p2p-rendering-computation/blob/master/client/clientIPTable/Iptable.go#L80>)
|
||||
|
||||
```go
|
||||
func UpdateIpTableListClient() error
|
||||
```
|
||||
|
||||
UpdateIpTableListClient updates IP tables \(Default 3 hops\) based on server information available on the ip tables
|
||||
|
||||
<a name="UploadMultipartFile"></a>
|
||||
## func [UploadMultipartFile](<https://github.com/Akilan1999/p2p-rendering-computation/blob/master/client/clientIPTable/Iptable.go#L209>)
|
||||
|
||||
```go
|
||||
func UploadMultipartFile(client http.Client, uri, key, path string) ([]byte, error)
|
||||
```
|
||||
|
||||
|
||||
|
||||
Generated by [gomarkdoc](<https://github.com/princjef/gomarkdoc>)
|
||||
Reference in New Issue
Block a user