commons

Documentation

Index

• Constants
• func ChildProcessReadConfigViaSTDIN() (*commons.Config, io.WriteCloser, error)
• func ParentProcessSendConfigViaSTDIN(config *commons.Config, stdin io.WriteCloser, stdout io.ReadCloser) error
• func PrintHelp(command *cobra.Command) error
• func PrintVersion(command *cobra.Command) error
• func ProcessCommonFlags(command *cobra.Command) (*commons.Config, io.WriteCloser, bool, error)
• func ReportChildProcessError()
• func ReportChildProcessStartSuccessfully()
• func RunChildProcess(serverExec string) (io.WriteCloser, io.ReadCloser, error)
• func SetCommonFlags(command *cobra.Command)
• func SetNilLogWriter()
• type NilWriter
  • func (w *NilWriter) Close() (err error)
  • func (w *NilWriter) Write(p []byte) (n int, err error)

Constants

const (
	// InterProcessCommunicationFinishSuccess is the message that parent process receives when child process is executed successfully
	InterProcessCommunicationFinishSuccess string = "<<COMMUNICATION_CLOSE_SUCCESS>>"
	// InterProcessCommunicationFinishError is the message that parent process receives when child process fails to run
	InterProcessCommunicationFinishError string = "<<COMMUNICATION_CLOSE_ERROR>>"
)

const (
	ChildProcessArgument = "child_process"
)

Functions

func ChildProcessReadConfigViaSTDIN

func ChildProcessReadConfigViaSTDIN() (*commons.Config, io.WriteCloser, error)

func ParentProcessSendConfigViaSTDIN

func ParentProcessSendConfigViaSTDIN(config *commons.Config, stdin io.WriteCloser, stdout io.ReadCloser) error

func PrintHelp

func PrintHelp(command *cobra.Command) error

func PrintVersion

func PrintVersion(command *cobra.Command) error

func ProcessCommonFlags

func ProcessCommonFlags(command *cobra.Command) (*commons.Config, io.WriteCloser, bool, error)

func ReportChildProcessError

func ReportChildProcessError()

func ReportChildProcessStartSuccessfully

func ReportChildProcessStartSuccessfully()

func RunChildProcess

func RunChildProcess(serverExec string) (io.WriteCloser, io.ReadCloser, error)

func SetCommonFlags

func SetCommonFlags(command *cobra.Command)

func SetNilLogWriter

func SetNilLogWriter()

Types

type NilWriter

type NilWriter struct{}

NilWriter drains output

func (*NilWriter) Close

func (w *NilWriter) Close() (err error)

func (*NilWriter) Write

func (w *NilWriter) Write(p []byte) (n int, err error)

Write does nothing