dolor.servers.server

connection_task(func)

Decorator for connection tasks within a class.

class ServerConnection(server, reader, writer)

Bases: dolor.connection.Connection

property is_player

async disconnect(reason)

async set_compression(threshold)

async login_success()

async message(message, *, position=ChatPosition.Chat, sender=None)

close()

Closes the connection.

Should be used alongside the wait_closed() method.

async wait_closed()

Waits until the connection is closed.

create_task(coro)

Internal function used to ensure that all listeners complete.

async write_packet(*args, **kwargs)

Writes a packet.

Parameters

• packet (subclass of Packet or Packet) –

  If a subclass of Packet, then the packet to write will be created by forwarding packet and **kwargs to the create_packet() method. Otherwise, packet is the packet to write.

  packet being a subclass of Packet is preferred so that the packet is created with the correct context for the connection.

• **kwargs – The packet attributes to set and their corresponding values. Only able to be passed if packet is a subclass of Packet.

Returns

The written packet.

Return type

Packet

Raises

TypeError – If **kwargs is passed but packet isn’t a subclass of Packet.

class Server(version, address, port=25565, *, lang_file=None, max_players=20, description=None, favicon=None, offline=False, comp_enabled=True, comp_threshold=256)

Bases: dolor.packet_handler.PacketHandler

session_server = 'https://sessionserver.mojang.com/session/minecraft'

Connection

alias of dolor.servers.server.ServerConnection

register_connection_task(func)

Registers a packet listener.

func is a coroutine function.

unregister_connection_task(func)

Unregisters a connection task.

external_connection_task(func)

Decorator for external connection tasks.

register_intrinsic_connection_tasks()

safe_connection_func(task)

register_packet_listener(*args, outgoing=False)

Registers a packet listener.

Parameters

• func (coroutine function) – The packet listener.

• *checkers (subclass of Packet or int or function) –

  If a subclass of Packet, then the listener will be called if the packet is an instance of that class.

  If an int, then the listener will be called if the id of the packet is equal to the passed int.

  If a function, then the function can either return a bool and take one argument, which represents the packet to check, or it can return a bool and take two arguments, the first being the relevant Connection, and the second being the packet to check.

• **kwargs – Keyword arguments that must match the keyword arguments passed to listeners_for_packet() for the packet listener to be included in its return.

Raises

• TypeError – If func isn’t a coroutine function.

• ValueError – If no checkers are specified.

async listen_to_packet(c, p, *, outgoing)

async listen(c)

async new_connection(reader, writer)

async central_connection_task(c)

async main_task()

is_serving()

close()

async wait_closed()

append(conn)

remove(conn)

async startup()

async on_start()

async start()

run()

property players

async send_server_hash(c, server_hash)