listener

Documentation

Overview

Package listener allows Caddy to listen on arbitrary networks.

Index

• type Listener
  • func (p *Listener) Accept() (net.Conn, error)
  • func (p *Listener) Addr() net.Addr
  • func (*Listener) CaddyModule() caddy.ModuleInfo
  • func (p *Listener) Close() error
  • func (p *Listener) Provision(ctx caddy.Context) error
  • func (p *Listener) Start(fn func(net.Listener)) error
  • func (p *Listener) UnmarshalCaddyfile(d *caddyfile.Dispenser) error

Types

type Listener

type Listener struct {
	Name configvalues.Hostname `json:"name"`
	Port configvalues.Port     `json:"port"`
	// contains filtered or unexported fields
}

Listener allows a caddy server to listen on a point-c network.

func (*Listener) Accept

func (p *Listener) Accept() (net.Conn, error)

Accept implements net.Listener.

func (*Listener) Addr

func (p *Listener) Addr() net.Addr

Addr implements net.Listener.

func (*Listener) CaddyModule

func (*Listener) CaddyModule() caddy.ModuleInfo

CaddyModule implements caddy.Module.

func (*Listener) Close

func (p *Listener) Close() error

Close implements net.Listener.

func (*Listener) Provision

func (p *Listener) Provision(ctx caddy.Context) error

Provision implements caddy.Provisioner.

func (*Listener) Start

func (p *Listener) Start(fn func(net.Listener)) error

Start implement [ListenerProvider].

func (*Listener) UnmarshalCaddyfile

func (p *Listener) UnmarshalCaddyfile(d *caddyfile.Dispenser) error

UnmarshalCaddyfile unmarshals the caddyfile. ```

	{
	  servers :443 {
	    listener_wrappers {
	      merge {
            # this is the actual listener definition
	        point-c <network name> <port to expose>
	      }
          # make sure tls goes after otherwise encryption will be dropped
	      tls
	    }
	  }
	}

```