110 lines
3.6 KiB
Go
110 lines
3.6 KiB
Go
package api
|
|
|
|
import (
|
|
"context"
|
|
|
|
"github.com/matrix-org/dendrite/federationsender/types"
|
|
"github.com/matrix-org/gomatrixserverlib"
|
|
)
|
|
|
|
// FederationSenderInternalAPI is used to query information from the federation sender.
|
|
type FederationSenderInternalAPI interface {
|
|
// PerformDirectoryLookup looks up a remote room ID from a room alias.
|
|
PerformDirectoryLookup(
|
|
ctx context.Context,
|
|
request *PerformDirectoryLookupRequest,
|
|
response *PerformDirectoryLookupResponse,
|
|
) error
|
|
// Query the joined hosts and the membership events accounting for their participation in a room.
|
|
// Note that if a server has multiple users in the room, it will have multiple entries in the returned slice.
|
|
// See `QueryJoinedHostServerNamesInRoom` for a de-duplicated version.
|
|
QueryJoinedHostsInRoom(
|
|
ctx context.Context,
|
|
request *QueryJoinedHostsInRoomRequest,
|
|
response *QueryJoinedHostsInRoomResponse,
|
|
) 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).
|
|
QueryJoinedHostServerNamesInRoom(
|
|
ctx context.Context,
|
|
request *QueryJoinedHostServerNamesInRoomRequest,
|
|
response *QueryJoinedHostServerNamesInRoomResponse,
|
|
) error
|
|
// Handle an instruction to make_join & send_join with a remote server.
|
|
PerformJoin(
|
|
ctx context.Context,
|
|
request *PerformJoinRequest,
|
|
response *PerformJoinResponse,
|
|
) error
|
|
// Handle an instruction to make_leave & send_leave with a remote server.
|
|
PerformLeave(
|
|
ctx context.Context,
|
|
request *PerformLeaveRequest,
|
|
response *PerformLeaveResponse,
|
|
) error
|
|
// Notifies the federation sender that these servers may be online and to retry sending messages.
|
|
PerformServersAlive(
|
|
ctx context.Context,
|
|
request *PerformServersAliveRequest,
|
|
response *PerformServersAliveResponse,
|
|
) error
|
|
}
|
|
|
|
type PerformDirectoryLookupRequest struct {
|
|
RoomAlias string `json:"room_alias"`
|
|
ServerName gomatrixserverlib.ServerName `json:"server_name"`
|
|
}
|
|
|
|
type PerformDirectoryLookupResponse struct {
|
|
RoomID string `json:"room_id"`
|
|
ServerNames []gomatrixserverlib.ServerName `json:"server_names"`
|
|
}
|
|
|
|
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 struct {
|
|
}
|
|
|
|
type PerformLeaveRequest struct {
|
|
RoomID string `json:"room_id"`
|
|
UserID string `json:"user_id"`
|
|
ServerNames types.ServerNames `json:"server_names"`
|
|
}
|
|
|
|
type PerformLeaveResponse struct {
|
|
}
|
|
|
|
type PerformServersAliveRequest struct {
|
|
Servers []gomatrixserverlib.ServerName
|
|
}
|
|
|
|
type PerformServersAliveResponse struct {
|
|
}
|
|
|
|
// QueryJoinedHostsInRoomRequest is a request to QueryJoinedHostsInRoom
|
|
type QueryJoinedHostsInRoomRequest struct {
|
|
RoomID string `json:"room_id"`
|
|
}
|
|
|
|
// QueryJoinedHostsInRoomResponse is a response to QueryJoinedHostsInRoom
|
|
type QueryJoinedHostsInRoomResponse struct {
|
|
JoinedHosts []types.JoinedHost `json:"joined_hosts"`
|
|
}
|
|
|
|
// QueryJoinedHostServerNamesRequest is a request to QueryJoinedHostServerNames
|
|
type QueryJoinedHostServerNamesInRoomRequest struct {
|
|
RoomID string `json:"room_id"`
|
|
}
|
|
|
|
// QueryJoinedHostServerNamesResponse is a response to QueryJoinedHostServerNames
|
|
type QueryJoinedHostServerNamesInRoomResponse struct {
|
|
ServerNames []gomatrixserverlib.ServerName `json:"server_names"`
|
|
}
|