net2

Documentation

Overview

net2 is a collection of functions meant to supplement the capabilities provided by the standard "net" package.

Index

• func GetLocalIPs() ([]*net.IP, error)
• func IsLocalhost(host string) bool
• func MyHostname() string
• func MyIp4() *net.IPAddr
• func MyIp6() *net.IPAddr
• type BaseConnectionPool
  • func (p *BaseConnectionPool) ActiveHighWaterMark() int32
  • func (p *BaseConnectionPool) Discard(conn ManagedConn) error
  • func (p *BaseConnectionPool) EnterLameDuckMode()
  • func (p *BaseConnectionPool) Get(network string, address string) (ManagedConn, error)
  • func (p *BaseConnectionPool) ListRegistered() []NetworkAddress
  • func (p *BaseConnectionPool) NumActive() int32
  • func (p *BaseConnectionPool) NumIdle() int
  • func (p *BaseConnectionPool) Register(network string, address string) error
  • func (p *BaseConnectionPool) Release(conn ManagedConn) error
  • func (p *BaseConnectionPool) Unregister(network string, address string) error
• type ConnectionOptions
• type ConnectionPool
  • func NewMultiConnectionPool(options ConnectionOptions) ConnectionPool
  • func NewSimpleConnectionPool(options ConnectionOptions) ConnectionPool
• type ManagedConn
  • func NewManagedConn(network string, address string, handle resource_pool.ManagedHandle, ...) ManagedConn
• type ManagedConnImpl
  • func (c *ManagedConnImpl) Close() error
  • func (c *ManagedConnImpl) DiscardConnection() error
  • func (c *ManagedConnImpl) Key() NetworkAddress
  • func (c *ManagedConnImpl) LocalAddr() net.Addr
  • func (c *ManagedConnImpl) Owner() ConnectionPool
  • func (c *ManagedConnImpl) RawConn() net.Conn
  • func (c *ManagedConnImpl) Read(b []byte) (n int, err error)
  • func (c *ManagedConnImpl) ReleaseConnection() error
  • func (c *ManagedConnImpl) RemoteAddr() net.Addr
  • func (c *ManagedConnImpl) SetDeadline(t time.Time) error
  • func (c *ManagedConnImpl) SetReadDeadline(t time.Time) error
  • func (c *ManagedConnImpl) SetWriteDeadline(t time.Time) error
  • func (c *ManagedConnImpl) Write(b []byte) (n int, err error)
• type NetworkAddress

Functions

func GetLocalIPs

func GetLocalIPs() ([]*net.IP, error)

This returns the list of local ip addresses which other hosts can connect to (NOTE: Loopback ip is ignored). Also resolves Hostname to an address and adds it to the list too, so IPs from /etc/hosts can work too.

func IsLocalhost

func IsLocalhost(host string) bool

Given a host string, return true if the host is an ip (v4/v6) localhost.

func MyHostname

func MyHostname() string

Like os.Hostname but caches first successful result, making it cheap to call it over and over. It will also crash whole process if fetching Hostname fails!

func MyIp4

func MyIp4() *net.IPAddr

Resolves `MyHostname()` to an Ip4 address. Caches first successful result, making it cheap to call it over and over. It will also crash whole process if resolving the IP fails!

func MyIp6

func MyIp6() *net.IPAddr

Resolves `MyHostname()` to an Ip6 address. Caches first successful result, making it cheap to call it over and over. It will also crash whole process if resolving the IP fails!

Types

type BaseConnectionPool

type BaseConnectionPool struct {
	// contains filtered or unexported fields
}

A thin wrapper around the underlying resource pool.

func (*BaseConnectionPool) ActiveHighWaterMark

func (p *BaseConnectionPool) ActiveHighWaterMark() int32

See ConnectionPool for documentation.

func (*BaseConnectionPool) Discard

func (p *BaseConnectionPool) Discard(conn ManagedConn) error

See ConnectionPool for documentation.

func (*BaseConnectionPool) EnterLameDuckMode

func (p *BaseConnectionPool) EnterLameDuckMode()

See ConnectionPool for documentation.

func (*BaseConnectionPool) Get

func (p *BaseConnectionPool) Get(
	network string,
	address string) (ManagedConn, error)

This gets an active connection from the connection pool. Note that network and address arguments are ignored (The connections with point to the network/address provided by the first Register call).

func (*BaseConnectionPool) ListRegistered

func (p *BaseConnectionPool) ListRegistered() []NetworkAddress

func (*BaseConnectionPool) NumActive

func (p *BaseConnectionPool) NumActive() int32

See ConnectionPool for documentation.

func (*BaseConnectionPool) NumIdle

func (p *BaseConnectionPool) NumIdle() int

This returns the number of alive idle connections. This method is not part of ConnectionPool's API. It is used only for testing.

func (*BaseConnectionPool) Register

func (p *BaseConnectionPool) Register(network string, address string) error

BaseConnectionPool can only register a single (network, address) entry. Register should be call before any Get calls.

func (*BaseConnectionPool) Release

func (p *BaseConnectionPool) Release(conn ManagedConn) error

See ConnectionPool for documentation.

func (*BaseConnectionPool) Unregister

func (p *BaseConnectionPool) Unregister(network string, address string) error

BaseConnectionPool has nothing to do on Unregister.

type ConnectionOptions

type ConnectionOptions struct {
	// The maximum number of connections that can be active per host at any
	// given time (A non-positive value indicates the number of connections
	// is unbounded).
	MaxActiveConnections int32

	// The maximum number of idle connections per host that are kept alive by
	// the connection pool.
	MaxIdleConnections uint32

	// The maximum amount of time an idle connection can alive (if specified).
	MaxIdleTime *time.Duration

	// This limits the number of concurrent Dial calls (there's no limit when
	// DialMaxConcurrency is non-positive).
	DialMaxConcurrency int

	// Dial specifies the dial function for creating network connections.
	// If Dial is nil, net.DialTimeout is used, with timeout set to 1 second.
	Dial func(network string, address string) (net.Conn, error)

	// This specifies the now time function.  When the function is non-nil, the
	// connection pool will use the specified function instead of time.Now to
	// generate the current time.
	NowFunc func() time.Time

	// This specifies the timeout for any Read() operation.
	ReadTimeout time.Duration

	// This specifies the timeout for any Write() operation.
	WriteTimeout time.Duration
}

type ConnectionPool

type ConnectionPool interface {
	// This returns the number of active connections that are on loan.
	NumActive() int32

	// This returns the highest number of active connections for the entire
	// lifetime of the pool.
	ActiveHighWaterMark() int32

	// This returns the number of idle connections that are in the pool.
	NumIdle() int

	// This associates (network, address) to the connection pool; afterwhich,
	// the user can get connections to (network, address).
	Register(network string, address string) error

	// This dissociate (network, address) from the connection pool;
	// afterwhich, the user can no longer get connections to
	// (network, address).
	Unregister(network string, address string) error

	// This returns the list of registered (network, address) entries.
	ListRegistered() []NetworkAddress

	// This gets an active connection from the connection pool.  The connection
	// will remain active until one of the following is called:
	//  1. conn.ReleaseConnection()
	//  2. conn.DiscardConnection()
	//  3. pool.Release(conn)
	//  4. pool.Discard(conn)
	Get(network string, address string) (ManagedConn, error)

	// This releases an active connection back to the connection pool.
	Release(conn ManagedConn) error

	// This discards an active connection from the connection pool.
	Discard(conn ManagedConn) error

	// Enter the connection pool into lame duck mode.  The connection pool
	// will no longer return connections, and all idle connections are closed
	// immediately (including active connections that are released back to the
	// pool afterward).
	EnterLameDuckMode()
}

A generic interface for managed connection pool. All connection pool implementations must be threadsafe.

func NewMultiConnectionPool

func NewMultiConnectionPool(options ConnectionOptions) ConnectionPool

This returns a connection pool that manages multiple (network, address) entries. The connections to each (network, address) entry acts independently. For example ("tcp", "localhost:11211") could act as memcache shard 0 and ("tcp", "localhost:11212") could act as memcache shard 1.

func NewSimpleConnectionPool

func NewSimpleConnectionPool(options ConnectionOptions) ConnectionPool

This returns a connection pool where all connections are connected to the same (network, address)

type ManagedConn

type ManagedConn interface {
	net.Conn

	// This returns the original (network, address) entry used for creating
	// the connection.
	Key() NetworkAddress

	// This returns the underlying net.Conn implementation.
	RawConn() net.Conn

	// This returns the connection pool which owns this connection.
	Owner() ConnectionPool

	// This indictes a user is done with the connection and releases the
	// connection back to the connection pool.
	ReleaseConnection() error

	// This indicates the connection is an invalid state, and that the
	// connection should be discarded from the connection pool.
	DiscardConnection() error
}

A connection managed by a connection pool. NOTE: SetDeadline, SetReadDeadline and SetWriteDeadline are disabled for managed connections. (The deadlines are set by the connection pool).

func NewManagedConn

func NewManagedConn(
	network string,
	address string,
	handle resource_pool.ManagedHandle,
	pool ConnectionPool,
	options ConnectionOptions) ManagedConn

This creates a managed connection wrapper.

type ManagedConnImpl

type ManagedConnImpl struct {
	// contains filtered or unexported fields
}

A physical implementation of ManagedConn

func (*ManagedConnImpl) Close

func (c *ManagedConnImpl) Close() error

See net.Conn for documentation

func (*ManagedConnImpl) DiscardConnection

func (c *ManagedConnImpl) DiscardConnection() error

See ManagedConn for documentation.

func (*ManagedConnImpl) Key

func (c *ManagedConnImpl) Key() NetworkAddress

See ManagedConn for documentation.

func (*ManagedConnImpl) LocalAddr

func (c *ManagedConnImpl) LocalAddr() net.Addr

See net.Conn for documentation

func (*ManagedConnImpl) Owner

func (c *ManagedConnImpl) Owner() ConnectionPool

See ManagedConn for documentation.

func (*ManagedConnImpl) RawConn

func (c *ManagedConnImpl) RawConn() net.Conn

See ManagedConn for documentation.

func (*ManagedConnImpl) Read

func (c *ManagedConnImpl) Read(b []byte) (n int, err error)

See net.Conn for documentation

func (*ManagedConnImpl) ReleaseConnection

func (c *ManagedConnImpl) ReleaseConnection() error

See ManagedConn for documentation.

func (*ManagedConnImpl) RemoteAddr

func (c *ManagedConnImpl) RemoteAddr() net.Addr

See net.Conn for documentation

func (*ManagedConnImpl) SetDeadline

func (c *ManagedConnImpl) SetDeadline(t time.Time) error

SetDeadline is disabled for managed connection (The deadline is set by us, with respect to the read/write timeouts specified in ConnectionOptions).

func (*ManagedConnImpl) SetReadDeadline

func (c *ManagedConnImpl) SetReadDeadline(t time.Time) error

SetReadDeadline is disabled for managed connection (The deadline is set by us with respect to the read timeout specified in ConnectionOptions).

func (*ManagedConnImpl) SetWriteDeadline

func (c *ManagedConnImpl) SetWriteDeadline(t time.Time) error

SetWriteDeadline is disabled for managed connection (The deadline is set by us with respect to the write timeout specified in ConnectionOptions).

func (*ManagedConnImpl) Write

func (c *ManagedConnImpl) Write(b []byte) (n int, err error)

See net.Conn for documentation

type NetworkAddress

type NetworkAddress struct {
	Network string
	Address string
}

Dial's arguments.