api

Documentation

Index

• type ClientFederationAPI
• type FederationClient
• type FederationClientError
  • func (e *FederationClientError) Error() string
• type FederationInternalAPI
• type InputPublicKeysRequest
• type InputPublicKeysResponse
• type PerformBroadcastEDURequest
• type PerformBroadcastEDUResponse
• type PerformDirectoryLookupRequest
• type PerformDirectoryLookupResponse
• type PerformInviteRequest
• type PerformInviteResponse
• type PerformJoinRequest
• type PerformJoinResponse
• type PerformLeaveRequest
• type PerformLeaveResponse
• type PerformOutboundPeekRequest
• type PerformOutboundPeekResponse
• type QueryJoinedHostServerNamesInRoomRequest
• type QueryJoinedHostServerNamesInRoomResponse
• type QueryPublicKeysRequest
• type QueryPublicKeysResponse
• type QueryServerKeysRequest
  • func (q *QueryServerKeysRequest) KeyIDs() []gomatrixserverlib.KeyID
• type QueryServerKeysResponse
• type RoomserverFederationAPI
• type ServersInRoomProvider

Types

type ClientFederationAPI

type ClientFederationAPI interface {
	// Query the server names of the joined hosts in a room.
	// Unlike QueryJoinedHostsInRoom, this function returns a de-duplicated slice
	// containing only the server names (without information for membership events).
	// The response will include this server if they are joined to the room.
	QueryJoinedHostServerNamesInRoom(ctx context.Context, request *QueryJoinedHostServerNamesInRoomRequest, response *QueryJoinedHostServerNamesInRoomResponse) error
}

type FederationClient

type FederationClient interface {
	gomatrixserverlib.FederatedStateClient
	GetUserDevices(ctx context.Context, s gomatrixserverlib.ServerName, userID string) (res gomatrixserverlib.RespUserDevices, err error)
	ClaimKeys(ctx context.Context, s gomatrixserverlib.ServerName, oneTimeKeys map[string]map[string]string) (res gomatrixserverlib.RespClaimKeys, err error)
	QueryKeys(ctx context.Context, s gomatrixserverlib.ServerName, keys map[string][]string) (res gomatrixserverlib.RespQueryKeys, err error)
	MSC2836EventRelationships(ctx context.Context, dst gomatrixserverlib.ServerName, r gomatrixserverlib.MSC2836EventRelationshipsRequest, roomVersion gomatrixserverlib.RoomVersion) (res gomatrixserverlib.MSC2836EventRelationshipsResponse, err error)
	MSC2946Spaces(ctx context.Context, dst gomatrixserverlib.ServerName, roomID string, suggestedOnly bool) (res gomatrixserverlib.MSC2946SpacesResponse, err error)
	LookupServerKeys(ctx context.Context, s gomatrixserverlib.ServerName, keyRequests map[gomatrixserverlib.PublicKeyLookupRequest]gomatrixserverlib.Timestamp) ([]gomatrixserverlib.ServerKeys, error)
}

FederationClient is a subset of gomatrixserverlib.FederationClient functions which the fedsender implements as proxy calls, with built-in backoff/retries/etc. Errors returned from functions in this interface are of type FederationClientError

type FederationClientError

type FederationClientError struct {
	Err         string
	RetryAfter  time.Duration
	Blacklisted bool
}

FederationClientError is returned from FederationClient methods in the event of a problem.

func (*FederationClientError) Error

func (e *FederationClientError) Error() string

type FederationInternalAPI

type FederationInternalAPI interface {
	FederationClient
	gomatrixserverlib.KeyDatabase
	ClientFederationAPI
	RoomserverFederationAPI

	QueryServerKeys(ctx context.Context, request *QueryServerKeysRequest, response *QueryServerKeysResponse) error

	// Broadcasts an EDU to all servers in rooms we are joined to. Used in the yggdrasil demos.
	PerformBroadcastEDU(
		ctx context.Context,
		request *PerformBroadcastEDURequest,
		response *PerformBroadcastEDUResponse,
	) error
}

FederationInternalAPI is used to query information from the federation sender.

type InputPublicKeysRequest

type InputPublicKeysRequest struct {
	Keys map[gomatrixserverlib.PublicKeyLookupRequest]gomatrixserverlib.PublicKeyLookupResult `json:"keys"`
}

type InputPublicKeysResponse

type InputPublicKeysResponse struct {
}

type PerformBroadcastEDURequest

type PerformBroadcastEDURequest struct {
}

type PerformBroadcastEDUResponse

type PerformBroadcastEDUResponse struct {
}

type PerformDirectoryLookupRequest

type PerformDirectoryLookupRequest struct {
	RoomAlias  string                       `json:"room_alias"`
	ServerName gomatrixserverlib.ServerName `json:"server_name"`
}

type PerformDirectoryLookupResponse

type PerformDirectoryLookupResponse struct {
	RoomID      string                         `json:"room_id"`
	ServerNames []gomatrixserverlib.ServerName `json:"server_names"`
}

type PerformInviteRequest

type PerformInviteRequest struct {
	RoomVersion     gomatrixserverlib.RoomVersion             `json:"room_version"`
	Event           *gomatrixserverlib.HeaderedEvent          `json:"event"`
	InviteRoomState []gomatrixserverlib.InviteV2StrippedState `json:"invite_room_state"`
}

type PerformInviteResponse

type PerformInviteResponse struct {
	Event *gomatrixserverlib.HeaderedEvent `json:"event"`
}

type PerformJoinRequest

type PerformJoinRequest struct {
	RoomID string `json:"room_id"`
	UserID string `json:"user_id"`
	// The sorted list of servers to try. Servers will be tried sequentially, after de-duplication.
	ServerNames types.ServerNames      `json:"server_names"`
	Content     map[string]interface{} `json:"content"`
}

type PerformJoinResponse

type PerformJoinResponse struct {
	JoinedVia gomatrixserverlib.ServerName
	LastError *gomatrix.HTTPError
}

type PerformLeaveRequest

type PerformLeaveRequest struct {
	RoomID      string            `json:"room_id"`
	UserID      string            `json:"user_id"`
	ServerNames types.ServerNames `json:"server_names"`
}

type PerformLeaveResponse

type PerformLeaveResponse struct {
}

type PerformOutboundPeekRequest

type PerformOutboundPeekRequest struct {
	RoomID string `json:"room_id"`
	// The sorted list of servers to try. Servers will be tried sequentially, after de-duplication.
	ServerNames types.ServerNames `json:"server_names"`
}

type PerformOutboundPeekResponse

type PerformOutboundPeekResponse struct {
	LastError *gomatrix.HTTPError
}

type QueryJoinedHostServerNamesInRoomRequest

type QueryJoinedHostServerNamesInRoomRequest struct {
	RoomID      string `json:"room_id"`
	ExcludeSelf bool   `json:"exclude_self"`
}

QueryJoinedHostServerNamesInRoomRequest is a request to QueryJoinedHostServerNames

type QueryJoinedHostServerNamesInRoomResponse

type QueryJoinedHostServerNamesInRoomResponse struct {
	ServerNames []gomatrixserverlib.ServerName `json:"server_names"`
}

QueryJoinedHostServerNamesInRoomResponse is a response to QueryJoinedHostServerNames

type QueryPublicKeysRequest

type QueryPublicKeysRequest struct {
	Requests map[gomatrixserverlib.PublicKeyLookupRequest]gomatrixserverlib.Timestamp `json:"requests"`
}

type QueryPublicKeysResponse

type QueryPublicKeysResponse struct {
	Results map[gomatrixserverlib.PublicKeyLookupRequest]gomatrixserverlib.PublicKeyLookupResult `json:"results"`
}

type QueryServerKeysRequest

type QueryServerKeysRequest struct {
	ServerName      gomatrixserverlib.ServerName
	KeyIDToCriteria map[gomatrixserverlib.KeyID]gomatrixserverlib.PublicKeyNotaryQueryCriteria
}

func (*QueryServerKeysRequest) KeyIDs

func (q *QueryServerKeysRequest) KeyIDs() []gomatrixserverlib.KeyID

type QueryServerKeysResponse

type QueryServerKeysResponse struct {
	ServerKeys []gomatrixserverlib.ServerKeys
}

type RoomserverFederationAPI

type RoomserverFederationAPI interface {
	gomatrixserverlib.BackfillClient
	gomatrixserverlib.FederatedStateClient
	KeyRing() *gomatrixserverlib.KeyRing

	// PerformDirectoryLookup looks up a remote room ID from a room alias.
	PerformDirectoryLookup(ctx context.Context, request *PerformDirectoryLookupRequest, response *PerformDirectoryLookupResponse) error
	// Handle an instruction to make_join & send_join with a remote server.
	PerformJoin(ctx context.Context, request *PerformJoinRequest, response *PerformJoinResponse)
	// Handle an instruction to make_leave & send_leave with a remote server.
	PerformLeave(ctx context.Context, request *PerformLeaveRequest, response *PerformLeaveResponse) error
	// Handle sending an invite to a remote server.
	PerformInvite(ctx context.Context, request *PerformInviteRequest, response *PerformInviteResponse) error
	// Handle an instruction to peek a room on a remote server.
	PerformOutboundPeek(ctx context.Context, request *PerformOutboundPeekRequest, response *PerformOutboundPeekResponse) error
	// Query the server names of the joined hosts in a room.
	// Unlike QueryJoinedHostsInRoom, this function returns a de-duplicated slice
	// containing only the server names (without information for membership events).
	// The response will include this server if they are joined to the room.
	QueryJoinedHostServerNamesInRoom(ctx context.Context, request *QueryJoinedHostServerNamesInRoomRequest, response *QueryJoinedHostServerNamesInRoomResponse) error
	GetEventAuth(ctx context.Context, s gomatrixserverlib.ServerName, roomVersion gomatrixserverlib.RoomVersion, roomID, eventID string) (res gomatrixserverlib.RespEventAuth, err error)
	GetEvent(ctx context.Context, s gomatrixserverlib.ServerName, eventID string) (res gomatrixserverlib.Transaction, err error)
	LookupMissingEvents(ctx context.Context, s gomatrixserverlib.ServerName, roomID string, missing gomatrixserverlib.MissingEvents, roomVersion gomatrixserverlib.RoomVersion) (res gomatrixserverlib.RespMissingEvents, err error)
}

type ServersInRoomProvider

type ServersInRoomProvider interface {
	GetServersForRoom(ctx context.Context, roomID string, event *gomatrixserverlib.Event) []gomatrixserverlib.ServerName
}