ipc

Documentation

Index

• type Client
• type PipeClient
  • func NewPipeClient(name string, payload func() []string) *PipeClient
  • func (p *PipeClient) Probe(ctx context.Context)
  • func (p *PipeClient) Run(ctx context.Context)
  • func (p *PipeClient) SetCallback(cb func([]ProxyMessage))
• type ProxyMessage
• type Server
  • func NewServer(name string, exporter client.StatusExporter) (*Server, error)
  • func (s *Server) Close() error
  • func (s *Server) Run()

Types

type Client

type Client interface {
	// SetCallback changes the callback function for the response message.
	SetCallback(cb func([]ProxyMessage))
	// Run the client in blocking mode.
	Run(ctx context.Context)
	// Probe triggers a query request immediately.
	Probe(ctx context.Context)
}

Client is used to query proxy state from the frp client. It may be a pipe client or HTTP client.

type PipeClient

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

func NewPipeClient

func NewPipeClient(name string, payload func() []string) *PipeClient

func (*PipeClient) Probe

func (p *PipeClient) Probe(ctx context.Context)

func (*PipeClient) Run

func (p *PipeClient) Run(ctx context.Context)

func (*PipeClient) SetCallback

func (p *PipeClient) SetCallback(cb func([]ProxyMessage))

type ProxyMessage

type ProxyMessage struct {
	Name       string
	Type       string
	Status     string
	Err        string
	RemoteAddr string
}

ProxyMessage is the status information of a proxy.

type Server

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

func NewServer

func NewServer(name string, exporter client.StatusExporter) (*Server, error)

func (*Server) Close

func (s *Server) Close() error

func (*Server) Run

func (s *Server) Run()