README
¶
ramp
builds upon: eyedeekay/sam3, eyedeekay/gosam
Convenient structures for managing sam sessions in Go. Some of them might be reimplemented in sam3, it's initially intended to make it more intuitive to port cretz/bine based applications to I2P streaming.
Besides that, it in general exists to explore a few ease-of-use issues in sam3 and goSam, like how for now they use different, non-compatible formats for saving keys, which are in turn not compatible with i2ptunnel, the more-tedious-than-it-needs-to-be keeping track of configuration options, full support for Contexts, etc.
Directory Structure
./ : Base Ramp classes, the things most will need to use
./config : Configuration structures to deal with compatibility issues
./consume : Handle replies from the SAM bridge
./emit : Takes a stored configuration and uses it to send SAM commands
./examples : Usage examples
./sam3 : Functional sam3 constructors
Goals
- Make gosam and sam3 share a common(optional) configuration class
- Make gosam and sam3 share a common(mandatory) key storage format inherited from sam3
- Make sam3 configuration much more intuitive, require less user input to create a session
- Make gosam and sam3 configurable from files without adding clutter to their code
- Be a useful underlying primitive for custom/application specific SAM interactions and a toolkit for developing new libraries
- Have lots of examples and documentation
Documentation
¶
Index ¶
- func SetAccessList(s []string) func(*Ramp) error
- func SetAccessListType(s string) func(*Ramp) error
- func SetAllowZeroIn(b bool) func(*Ramp) error
- func SetAllowZeroOut(b bool) func(*Ramp) error
- func SetCloseIdle(b bool) func(*Ramp) error
- func SetCloseIdleTime(u int) func(*Ramp) error
- func SetCloseIdleTimeMs(u int) func(*Ramp) error
- func SetCompress(b bool) func(*Ramp) error
- func SetEncrypt(b bool) func(*Ramp) error
- func SetFastRecieve(b bool) func(*Ramp) error
- func SetFromPort(s string) func(*Ramp) error
- func SetInBackups(u int) func(*Ramp) error
- func SetInLength(u int) func(*Ramp) error
- func SetInQuantity(u int) func(*Ramp) error
- func SetInVariance(i int) func(*Ramp) error
- func SetLeaseSetKey(s string) func(*Ramp) error
- func SetLeaseSetPrivateKey(s string) func(*Ramp) error
- func SetLeaseSetPrivateSigningKey(s string) func(*Ramp) error
- func SetMessageReliability(s string) func(*Ramp) error
- func SetName(s string) func(*Ramp) error
- func SetOutBackups(u int) func(*Ramp) error
- func SetOutLength(u int) func(*Ramp) error
- func SetOutQuantity(u int) func(*Ramp) error
- func SetOutVariance(i int) func(*Ramp) error
- func SetReduceIdle(b bool) func(*Ramp) error
- func SetReduceIdleQuantity(u int) func(*Ramp) error
- func SetReduceIdleTime(u int) func(*Ramp) error
- func SetReduceIdleTimeMs(u int) func(*Ramp) error
- func SetSAMAddress(s string) func(*Ramp) error
- func SetSAMHost(s string) func(*Ramp) error
- func SetSAMPort(s string) func(*Ramp) error
- func SetToPort(s string) func(*Ramp) error
- func SetType(s string) func(*Ramp) error
- type Option
- type Ramp
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func SetAccessList ¶
SetAccessList tells the system to treat the AccessList as a whitelist
func SetAccessListType ¶
SetAccessListType tells the system to treat the AccessList as a whitelist
func SetAllowZeroIn ¶
SetAllowZeroIn tells the tunnel to accept zero-hop peers
func SetAllowZeroOut ¶
SetAllowZeroOut tells the tunnel to accept zero-hop peers
func SetCloseIdle ¶
SetCloseIdle tells the connection to close it's tunnels during extended idle time.
func SetCloseIdleTime ¶
SetCloseIdleTime sets the time to wait before closing tunnels to idle levels
func SetCloseIdleTimeMs ¶
SetCloseIdleTimeMs sets the time to wait before closing tunnels to idle levels in milliseconds
func SetCompress ¶
SetCompress tells clients to use compression
func SetEncrypt ¶
SetEncrypt tells the router to use an encrypted leaseset
func SetFastRecieve ¶
SetFastRecieve tells clients to use compression
func SetFromPort ¶
SetFromPort sets the FROM_PORT propert to pass to SAM
func SetInBackups ¶
SetInBackups sets the inbound tunnel backups
func SetInLength ¶
SetInLength sets the number of hops inbound
func SetInQuantity ¶
SetInQuantity sets the inbound tunnel quantity
func SetInVariance ¶
SetInVariance sets the variance of a number of hops inbound
func SetLeaseSetKey ¶
SetLeaseSetKey sets the host of the Ramp's SAM bridge
func SetLeaseSetPrivateKey ¶
SetLeaseSetPrivateKey sets the host of the Ramp's SAM bridge
func SetLeaseSetPrivateSigningKey ¶
SetLeaseSetPrivateSigningKey sets the host of the Ramp's SAM bridge
func SetMessageReliability ¶
SetMessageReliability sets the host of the Ramp's SAM bridge
func SetOutBackups ¶
SetOutBackups sets the inbound tunnel backups
func SetOutLength ¶
SetOutLength sets the number of hops outbound
func SetOutQuantity ¶
SetOutQuantity sets the outbound tunnel quantity
func SetOutVariance ¶
SetOutVariance sets the variance of a number of hops outbound
func SetReduceIdle ¶
SetReduceIdle tells the connection to reduce it's tunnels during extended idle time.
func SetReduceIdleQuantity ¶
SetReduceIdleQuantity sets minimum number of tunnels to reduce to during idle time
func SetReduceIdleTime ¶
SetReduceIdleTime sets the time to wait before reducing tunnels to idle levels
func SetReduceIdleTimeMs ¶
SetReduceIdleTimeMs sets the time to wait before reducing tunnels to idle levels in milliseconds
func SetSAMAddress ¶
func SetSAMHost ¶
SetSAMHost sets the host of the Ramp's SAM bridge
func SetSAMPort ¶
SetSAMPort sets the port of the Ramp's SAM bridge using a string
Source Files
Directories