Fix documentation
This commit is contained in:
parent
282205f743
commit
5e61a08fb6
@ -4,7 +4,7 @@
|
|||||||
- Respond to all NDP solicitations on an interface
|
- Respond to all NDP solicitations on an interface
|
||||||
- Respond to NDP solicitations for whitelisted addresses on an interface
|
- Respond to NDP solicitations for whitelisted addresses on an interface
|
||||||
- Proxy NDP between interfaces with an optional whitelist for neighbor solicitations
|
- Proxy NDP between interfaces with an optional whitelist for neighbor solicitations
|
||||||
- Optionally automatically determine whitelist based on the IPs assigned to the interfaces
|
- Optionally determine whitelist automatically based on the IPs assigned to the interfaces
|
||||||
- Permissions required: root or CAP_NET_RAW
|
- Permissions required: root or CAP_NET_RAW
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
@ -31,4 +31,4 @@ proxyInstance := pndp.NewProxy(iface1 string, iface2 string, filter []*net.IPNet
|
|||||||
proxyInstance.Start()
|
proxyInstance.Start()
|
||||||
proxyInstance.Stop()
|
proxyInstance.Stop()
|
||||||
````
|
````
|
||||||
Pull request are welcome for any functionality you add.
|
Pull requests are welcome for any functionality you add.
|
@ -126,7 +126,7 @@ func (obj *ProxyObj) start() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
//Stop a running Proxy instance
|
//Stop a running Proxy instance
|
||||||
// Returns false on success
|
// Returns false on error
|
||||||
func (obj *ProxyObj) Stop() bool {
|
func (obj *ProxyObj) Stop() bool {
|
||||||
close(obj.stopChan)
|
close(obj.stopChan)
|
||||||
fmt.Println("Shutting down proxy instance..")
|
fmt.Println("Shutting down proxy instance..")
|
||||||
|
@ -30,6 +30,7 @@ responder {
|
|||||||
|
|
||||||
// Proxy example with autoconfigured whitelist
|
// Proxy example with autoconfigured whitelist
|
||||||
// The whitelist is configured based on the addresses assigned to the interface specified. This works even if the IP addresses change frequently.
|
// The whitelist is configured based on the addresses assigned to the interface specified. This works even if the IP addresses change frequently.
|
||||||
|
// The whitelist is applied to iface2
|
||||||
proxy {
|
proxy {
|
||||||
iface1 eth0
|
iface1 eth0
|
||||||
iface2 eth1
|
iface2 eth1
|
||||||
|
Loading…
x
Reference in New Issue
Block a user