api

package

v1.1.1 Latest Latest Go to latest Published: Feb 18, 2026 License: MIT Imports: 17 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/xmtp/xmtpd

Links

Open Source Insights

Documentation ¶

Overview ¶

Package api implements the API server.

Index ¶

type APIServer
- func NewAPIServer(opts ...APIServerOption) (*APIServer, error)
type APIServerConfig
type APIServerOption
type RegistrationFunc

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type APIServer ¶ added in v0.5.1

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

func NewAPIServer ¶

func NewAPIServer(opts ...APIServerOption) (*APIServer, error)

func (*APIServer) Addr ¶ added in v0.5.1

func (svc *APIServer) Addr() string

func (*APIServer) Close ¶ added in v0.5.1

func (svc *APIServer) Close(timeout time.Duration)

func (*APIServer) Start ¶ added in v1.0.0

func (svc *APIServer) Start()

type APIServerConfig ¶ added in v0.5.1

type APIServerConfig struct {
	Ctx              context.Context
	Logger           *zap.Logger
	PromRegistry     *prometheus.Registry
	RegistrationFunc RegistrationFunc
	Listener         net.Listener
	EnableReflection bool
}

type APIServerOption ¶ added in v0.5.1

type APIServerOption func(*APIServerConfig)

func WithContext ¶ added in v0.4.0

func WithContext(ctx context.Context) APIServerOption

func WithListener ¶ added in v1.0.0

func WithListener(listener net.Listener) APIServerOption

func WithLogger ¶ added in v0.4.0

func WithLogger(logger *zap.Logger) APIServerOption

func WithPrometheusRegistry ¶ added in v0.4.0

func WithPrometheusRegistry(reg *prometheus.Registry) APIServerOption

func WithReflection ¶ added in v0.4.0

func WithReflection(enabled bool) APIServerOption

func WithRegistrationFunc ¶ added in v0.4.0

func WithRegistrationFunc(registrationFunc RegistrationFunc) APIServerOption

type RegistrationFunc ¶ added in v0.1.1

type RegistrationFunc func(mux *http.ServeMux, interceptors ...connect.Interceptor) (servicePaths []string, err error)

Source Files ¶

View all Source files

server.go

Directories ¶

Path	Synopsis
message Package message implements the replication API service.	Package message implements the replication API service.
metadata Package metadata implements the metadata API service.	Package metadata implements the metadata API service.
payer Package payer implements the Payer API service.	Package payer implements the Payer API service.
selectors

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL