tcp

Documentation

Index

• Constants
• func ConnectToTCPServer(address, password, room string, timelimit ...time.Duration) (c *comm.Comm, banner string, ipaddr string, err error)
• func PingServer(address string) (err error)
• func Run(debugLevel, host, port, password string, banner ...string) (err error)
• func RunWithOptionsAsync(host, port, password string, opts ...serverOptsFunc) error
• func WithBanner(banner ...string) serverOptsFunc
• func WithLogLevel(level string) serverOptsFunc
• func WithRoomCleanupInterval(interval time.Duration) serverOptsFunc
• func WithRoomTTL(ttl time.Duration) serverOptsFunc

Constants

const (
	DEFAULT_LOG_LEVEL             = "debug"
	DEFAULT_ROOM_CLEANUP_INTERVAL = 10 * time.Minute
	DEFAULT_ROOM_TTL              = 3 * time.Hour
)

Functions

func ConnectToTCPServer

func ConnectToTCPServer(address, password, room string, timelimit ...time.Duration) (c *comm.Comm, banner string, ipaddr string, err error)

ConnectToTCPServer will initiate a new connection to the specified address, room with optional time limit

func PingServer

func PingServer(address string) (err error)

func Run

func Run(debugLevel, host, port, password string, banner ...string) (err error)

Run starts a tcp listener, run async

func RunWithOptionsAsync

func RunWithOptionsAsync(host, port, password string, opts ...serverOptsFunc) error

RunWithOptionsAsync asynchronously starts a TCP listener.

func WithBanner

func WithBanner(banner ...string) serverOptsFunc

func WithLogLevel

func WithLogLevel(level string) serverOptsFunc

func WithRoomCleanupInterval

func WithRoomCleanupInterval(interval time.Duration) serverOptsFunc

func WithRoomTTL

func WithRoomTTL(ttl time.Duration) serverOptsFunc