cli

Documentation

Overview

Package cli implements the socat command-line interface.

Index

• func Run(args []string, signalExit func(int)) int
• type Config
  • func ParseArgs(args []string) (*Config, error)
• type LogDest

Functions

func Run

func Run(args []string, signalExit func(int)) int

Run runs socat with the given args (excluding program name). signalExit is owned by cmd/socat so tests can exercise signal handling without terminating the test process.

Types

type Config

type Config struct {
	Help         int // 0 none, 1 -h, 2 -hh, 3 -hhh
	Version      bool
	LogLevel     logx.Level
	LogDest      LogDest
	LogFile      string
	LogFacility  string
	DumpFDs      bool
	Progname     string
	Micros       bool
	Hostname     bool
	Verbose      bool
	Hex          bool
	BlockSize    int
	Linger       time.Duration
	Idle         time.Duration // <0 infinite, 0 zero, >0 timeout
	IdleSet      bool
	LeftToRight  bool // -u
	RightToLeft  bool // -U
	IP4          bool
	IP6          bool
	IPAny        bool
	Statistics   bool
	Experimental bool
	LockFile     string
	LockWait     string

	RawLeft       string // -r
	RawRight      string // -R
	SignalLogMask uint64 // -S: signals whose termination is logged
	Addresses     []string
	// contains filtered or unexported fields
}

Config holds parsed CLI flags. Per-session peer, child wait status, and dump files live on xio.Global after buildGlobal; this struct is not mutated once parsing finishes.

func ParseArgs

func ParseArgs(args []string) (*Config, error)

ParseArgs parses os.Args-style arguments (without program name).

type LogDest

type LogDest int

LogDest is the active diagnostic destination. The last -ls/-lf/-ly/-lm option on the command line wins.

const (
	LogDestStderr LogDest = iota
	LogDestFile
	LogDestSyslog
	LogDestMixed
)