route

Documentation

Index

• Variables
• type RunOption
  • func WithGracefullContext(ctx context.Context) RunOption
• type RunOptions
• type Server
  • func New(containerCli container.Cli, options config.ServerConfig) (*Server, error)
  • func (server *Server) ClientAdd(addr string)
  • func (server *Server) Run00(ctx context.Context, options ...RunOption) error
  • func (server *Server) Run01(ctx context.Context, options ...RunOption) error
  • func (server *Server) RunGinRoute(ctx context.Context, r *gin.Engine, prefix string, options ...RunOption) error

Variables

var WebCtx = ""

Types

type RunOption

type RunOption func(*RunOptions)

RunOption is an option of Server.Run().

func WithGracefullContext

func WithGracefullContext(ctx context.Context) RunOption

WithGracefullContext accepts a context to shutdown a Server with care for existing client connections.

type RunOptions

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

RunOptions holds a set of configurations for Server.Run().

type Server

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

Server provides a webtty HTTP endpoint.

func New

func New(containerCli container.Cli, options config.ServerConfig) (*Server, error)

New creates a new instance of Server. Server will use the New() of the factory provided to handle each request.

func (*Server) ClientAdd

func (server *Server) ClientAdd(addr string)

func (*Server) Run00

func (server *Server) Run00(ctx context.Context, options ...RunOption) error

Run starts the main process of the Server. The cancelation of ctx will shutdown the server immediately with aborting existing connections. Use WithGracefulContext() to support graceful shutdown.

func (*Server) Run01

func (server *Server) Run01(ctx context.Context, options ...RunOption) error

func (*Server) RunGinRoute

func (server *Server) RunGinRoute(ctx context.Context, r *gin.Engine, prefix string, options ...RunOption) error