server

package

v0.13.0 Latest Latest Go to latest Published: Jan 11, 2023 License: MIT Imports: 13 Imported by: 21

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package server contains the core FTP server code

This section is empty.

View Source

var ErrNotEnabled = errors.New("not enabled")

ErrNotEnabled is returned when a feature hasn't been enabled

View Source

var ErrTimeout = errors.New("timeout")

ErrTimeout is returned when an operation timeouts

This section is empty.

type ClientDriver struct {
	afero.Fs
}

The ClientDriver is the internal structure used for handling the client. At this stage it's limited to the afero.Fs

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

Server structure

func NewServer(config *config.Config, logger log.Logger) (*Server, error)

NewServer creates a server instance

func (s *Server) AuthUser(cc serverlib.ClientContext, user, pass string) (serverlib.ClientDriver, error)

AuthUser authenticates the user and selects an handling driver

func (s *Server) ClientConnected(cc serverlib.ClientContext) (string, error)

ClientConnected is called to send the very first welcome message

func (s *Server) ClientDisconnected(cc serverlib.ClientContext)

ClientDisconnected is called when the user disconnects, even if he never authenticated

func (s *Server) GetSettings() (*serverlib.Settings, error)

GetSettings returns some general settings around the server setup

func (s *Server) GetTLSConfig() (*tls.Config, error)

GetTLSConfig returns a TLS Certificate to use The certificate could frequently change if we use something like "let's encrypt"

func (s *Server) Stop()

Stop will trigger a graceful stop of the server. All currently connected clients won't be disconnected instantly.

func (s *Server) WaitGracefully(timeout time.Duration) error

WaitGracefully allows to gracefully wait for all currently connected clients before disconnecting