nntpserver

Documentation

Overview

Package nntpserver provides everything you need for your own NNTP server.

Index

• Variables
• type Backend
• type ContextKey
• type Handler
• type MiddlewareFunc
  • func (mw MiddlewareFunc) Middleware(handler Handler) Handler
• type NNTPError
  • func (e *NNTPError) Error() string
• type NumberedArticle
• type Server
  • func NewServer(backend Backend) *Server
  • func (s *Server) Process(nc net.Conn)
  • func (s *Server) Use(mwf ...MiddlewareFunc)
• type Session

Variables

var ErrAuthRejected = &NNTPError{452, "authorization rejected"}

ErrAuthRejected is returned for invalid authentication.

var ErrAuthRequired = &NNTPError{450, "authorization required"}

ErrAuthRequired is returned to indicate authentication is required to proceed.

var ErrInvalidArticleNumber = &NNTPError{423, "No article with that number"}

ErrInvalidArticleNumber is returned when an article is requested that can't be found.

var ErrInvalidMessageID = &NNTPError{430, "No article with that message-id"}

ErrInvalidMessageID is returned when a message is requested that can't be found.

var ErrNoCurrentArticle = &NNTPError{420, "Current article number is invalid"}

ErrNoCurrentArticle is returned when a command is executed that requires a current article when one has not been selected.

var ErrNoGroupSelected = &NNTPError{412, "No newsgroup selected"}

ErrNoSuchGroup is returned for a request that requires a current group when none has been selected.

var ErrNoSuchGroup = &NNTPError{411, "No such newsgroup"}

ErrNoSuchGroup is returned for a request for a group that can't be found.

var ErrNotAuthenticated = &NNTPError{480, "authentication required"}

ErrNotAuthenticated is returned when a command is issued that requires authentication, but authentication was not provided.

var ErrNotWanted = &NNTPError{435, "Article not wanted"}

ErrNotWanted is returned when an attempt to post an article is rejected due the server not wanting the article.

var ErrPostingFailed = &NNTPError{441, "posting failed"}

ErrPostingFailed is returned when an attempt to post an article fails.

var ErrPostingNotPermitted = &NNTPError{440, "Posting not permitted"}

ErrPostingNotPermitted is returned as the response to an attempt to post an article where posting is not permitted.

var ErrSyntax = &NNTPError{501, "not supported, or syntax error"}

ErrSyntax is returned when a command can't be parsed.

var ErrUnknownCommand = &NNTPError{500, "Unknown command"}

ErrUnknownCommand is returned for unknown comands.

Types

type Backend

type Backend interface {
	ListGroups(ctx context.Context, max int) ([]*nntp.Group, error)
	GetGroup(ctx context.Context, name string) (*nntp.Group, error)
	GetArticle(ctx context.Context, group *nntp.Group, id string) (*nntp.Article, error)
	GetArticles(ctx context.Context, group *nntp.Group, from, to int64) ([]NumberedArticle, error)
	Authorized(ctx context.Context) bool
	// Authenticate and optionally swap out the backend for this Session.
	// You may return nil to continue using the same backend.
	Authenticate(ctx context.Context, user, pass string) (Backend, error)
	AllowPost(ctx context.Context) bool
	Post(ctx context.Context, article *nntp.Article) error
}

The Backend that provides the things and does the stuff.

type ContextKey

type ContextKey int

const (
	ContextKeyCommand ContextKey = iota
)

type Handler

type Handler func(ctx context.Context, args []string, s *Session, c *textproto.Conn) error

Handler is a low-level protocol handler

type MiddlewareFunc

type MiddlewareFunc func(Handler) Handler

func (MiddlewareFunc) Middleware

func (mw MiddlewareFunc) Middleware(handler Handler) Handler

type NNTPError

type NNTPError struct {
	Code int
	Msg  string
}

An NNTPError is a coded NNTP error message.

func (*NNTPError) Error

func (e *NNTPError) Error() string

type NumberedArticle

type NumberedArticle struct {
	Num     int64
	Article *nntp.Article
}

A NumberedArticle provides local sequence nubers to articles When listing articles in a group.

type Server

type Server struct {
	// Handlers are dispatched by command name.
	Handlers map[string]Handler
	// The backend (your code) that provides data
	Backend Backend
	// contains filtered or unexported fields
}

The Server handle.

func NewServer

func NewServer(backend Backend) *Server

NewServer builds a new server handle request to a backend.

func (*Server) Process

func (s *Server) Process(nc net.Conn)

Process an NNTP Session.

func (*Server) Use

func (s *Server) Use(mwf ...MiddlewareFunc)

type Session

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