perform

Documentation

Index

• type Admin
  • func (r *Admin) PerformAdminEvacuateRoom(ctx context.Context, req *api.PerformAdminEvacuateRoomRequest, ...)
  • func (r *Admin) PerformAdminEvacuateUser(ctx context.Context, req *api.PerformAdminEvacuateUserRequest, ...)
• type Backfiller
  • func (r *Backfiller) PerformBackfill(ctx context.Context, request *api.PerformBackfillRequest, ...) error
• type Forgetter
  • func (f *Forgetter) PerformForget(ctx context.Context, request *api.PerformForgetRequest, ...) error
• type InboundPeeker
  • func (r *InboundPeeker) PerformInboundPeek(ctx context.Context, request *api.PerformInboundPeekRequest, ...) error
• type Inviter
  • func (r *Inviter) PerformInvite(ctx context.Context, req *api.PerformInviteRequest, ...) ([]api.OutputEvent, error)
• type Joiner
  • func (r *Joiner) PerformJoin(ctx context.Context, req *rsAPI.PerformJoinRequest, ...)
• type Leaver
  • func (r *Leaver) PerformLeave(ctx context.Context, req *api.PerformLeaveRequest, ...) ([]api.OutputEvent, error)
• type Peeker
  • func (r *Peeker) PerformPeek(ctx context.Context, req *api.PerformPeekRequest, res *api.PerformPeekResponse)
• type Publisher
  • func (r *Publisher) PerformPublish(ctx context.Context, req *api.PerformPublishRequest, ...)
• type Unpeeker
  • func (r *Unpeeker) PerformUnpeek(ctx context.Context, req *api.PerformUnpeekRequest, ...)
• type Upgrader
  • func (r *Upgrader) PerformRoomUpgrade(ctx context.Context, req *api.PerformRoomUpgradeRequest, ...)

Types

type Admin

type Admin struct {
	DB      storage.Database
	Cfg     *config.RoomServer
	Queryer *query.Queryer
	Inputer *input.Inputer
	Leaver  *Leaver
}

func (*Admin) PerformAdminEvacuateRoom

func (r *Admin) PerformAdminEvacuateRoom(
	ctx context.Context,
	req *api.PerformAdminEvacuateRoomRequest,
	res *api.PerformAdminEvacuateRoomResponse,
)

PerformEvacuateRoom will remove all local users from the given room.

func (*Admin) PerformAdminEvacuateUser

func (r *Admin) PerformAdminEvacuateUser(
	ctx context.Context,
	req *api.PerformAdminEvacuateUserRequest,
	res *api.PerformAdminEvacuateUserResponse,
)

type Backfiller

type Backfiller struct {
	ServerName gomatrixserverlib.ServerName
	DB         storage.Database
	FSAPI      federationAPI.RoomserverFederationAPI
	KeyRing    gomatrixserverlib.JSONVerifier

	// The servers which should be preferred above other servers when backfilling
	PreferServers []gomatrixserverlib.ServerName
}

func (*Backfiller) PerformBackfill

func (r *Backfiller) PerformBackfill(
	ctx context.Context,
	request *api.PerformBackfillRequest,
	response *api.PerformBackfillResponse,
) error

PerformBackfill implements api.RoomServerQueryAPI

type Forgetter

type Forgetter struct {
	DB storage.Database
}

func (*Forgetter) PerformForget

func (f *Forgetter) PerformForget(
	ctx context.Context,
	request *api.PerformForgetRequest,
	response *api.PerformForgetResponse,
) error

PerformForget implements api.RoomServerQueryAPI

type InboundPeeker

type InboundPeeker struct {
	DB      storage.Database
	Inputer *input.Inputer
}

func (*InboundPeeker) PerformInboundPeek

func (r *InboundPeeker) PerformInboundPeek(
	ctx context.Context,
	request *api.PerformInboundPeekRequest,
	response *api.PerformInboundPeekResponse,
) error

PerformInboundPeek handles peeking into matrix rooms, including over federation by talking to the federationapi. called when a remote server initiates a /peek over federation.

It should atomically figure out the current state of the room (for the response to /peek) while adding the new inbound peek to the kafka stream so the fed sender can start sending peeked events without a race between the state snapshot and the stream of peeked events.

type Inviter

type Inviter struct {
	DB      storage.Database
	Cfg     *config.RoomServer
	FSAPI   federationAPI.RoomserverFederationAPI
	Inputer *input.Inputer
}

func (*Inviter) PerformInvite

func (r *Inviter) PerformInvite(
	ctx context.Context,
	req *api.PerformInviteRequest,
	res *api.PerformInviteResponse,
) ([]api.OutputEvent, error)

nolint:gocyclo

type Joiner

type Joiner struct {
	ServerName gomatrixserverlib.ServerName
	Cfg        *config.RoomServer
	FSAPI      fsAPI.RoomserverFederationAPI
	RSAPI      rsAPI.RoomserverInternalAPI
	DB         storage.Database

	Inputer *input.Inputer
	Queryer *query.Queryer
}

func (*Joiner) PerformJoin

func (r *Joiner) PerformJoin(
	ctx context.Context,
	req *rsAPI.PerformJoinRequest,
	res *rsAPI.PerformJoinResponse,
)

PerformJoin handles joining matrix rooms, including over federation by talking to the federationapi.

type Leaver

type Leaver struct {
	Cfg     *config.RoomServer
	DB      storage.Database
	FSAPI   fsAPI.RoomserverFederationAPI
	UserAPI userapi.RoomserverUserAPI
	Inputer *input.Inputer
}

func (*Leaver) PerformLeave

func (r *Leaver) PerformLeave(
	ctx context.Context,
	req *api.PerformLeaveRequest,
	res *api.PerformLeaveResponse,
) ([]api.OutputEvent, error)

WriteOutputEvents implements OutputRoomEventWriter

type Peeker

type Peeker struct {
	ServerName gomatrixserverlib.ServerName
	Cfg        *config.RoomServer
	FSAPI      fsAPI.RoomserverFederationAPI
	DB         storage.Database

	Inputer *input.Inputer
}

func (*Peeker) PerformPeek

func (r *Peeker) PerformPeek(
	ctx context.Context,
	req *api.PerformPeekRequest,
	res *api.PerformPeekResponse,
)

PerformPeek handles peeking into matrix rooms, including over federation by talking to the federationapi.

type Publisher

type Publisher struct {
	DB storage.Database
}

func (*Publisher) PerformPublish

func (r *Publisher) PerformPublish(
	ctx context.Context,
	req *api.PerformPublishRequest,
	res *api.PerformPublishResponse,
)

type Unpeeker

type Unpeeker struct {
	ServerName gomatrixserverlib.ServerName
	Cfg        *config.RoomServer
	FSAPI      fsAPI.RoomserverFederationAPI
	DB         storage.Database

	Inputer *input.Inputer
}

func (*Unpeeker) PerformUnpeek

func (r *Unpeeker) PerformUnpeek(
	ctx context.Context,
	req *api.PerformUnpeekRequest,
	res *api.PerformUnpeekResponse,
)

PerformPeek handles peeking into matrix rooms, including over federation by talking to the federationapi.

type Upgrader

type Upgrader struct {
	Cfg    *config.RoomServer
	URSAPI api.RoomserverInternalAPI
}

func (*Upgrader) PerformRoomUpgrade

func (r *Upgrader) PerformRoomUpgrade(
	ctx context.Context,
	req *api.PerformRoomUpgradeRequest,
	res *api.PerformRoomUpgradeResponse,
)

PerformRoomUpgrade upgrades a room from one version to another