StarBridge

README

Overview of Replicant for Go

(This is still in an unstable state! It is not suitable for production deployment.)

Replicant is still in progress. more information will appear as development furthers.

Documentation

Index

• func NewClientConnection(conn net.Conn) (*replicant.Connection, error)
• func NewReplicantClientConnectionState() (*replicant.ConnectionState, error)
• func NewReplicantServerConnectionState(polishServer polish.Server, conn net.Conn) (*replicant.ConnectionState, error)
• func NewServerConnection(conn net.Conn) (*replicant.Connection, error)
• type ClientConfig
  • func (config ClientConfig) Dial(address string) (net.Conn, error)
• type ServerConfig
  • func (config ServerConfig) Listen(address string) net.Listener
• type Transport
  • func (transport *Transport) Dial() (net.Conn, error)

Functions

func NewClientConnection

func NewClientConnection(conn net.Conn) (*replicant.Connection, error)

func NewReplicantClientConnectionState

func NewReplicantClientConnectionState() (*replicant.ConnectionState, error)

func NewReplicantServerConnectionState

func NewReplicantServerConnectionState(polishServer polish.Server, conn net.Conn) (*replicant.ConnectionState, error)

func NewServerConnection

func NewServerConnection(conn net.Conn) (*replicant.Connection, error)

Types

type ClientConfig

type ClientConfig struct {
	Address string `json:"serverAddress"`
}

func (ClientConfig) Dial

func (config ClientConfig) Dial(address string) (net.Conn, error)

Dial connects to the address on the named network

type ServerConfig

type ServerConfig struct {
}

func (ServerConfig) Listen

func (config ServerConfig) Listen(address string) net.Listener

Listen checks for a working connection

type Transport

type Transport struct {
	Config  ClientConfig
	Address string
	Dialer  proxy.Dialer
}

func (*Transport) Dial

func (transport *Transport) Dial() (net.Conn, error)

Dial creates outgoing transport connection