1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89

//! Client-received general messages.
use endio::{Deserialize, Serialize};
use lu_packets_derive::VariantTests;

use crate::common::ServiceId;

/// Client-received general messages.
#[derive(Debug, Deserialize, PartialEq, Serialize, VariantTests)]
#[post_disc_padding = 1]
#[repr(u32)]
pub enum GeneralMessage {
	Handshake(Handshake),
	DisconnectNotify(DisconnectNotify),
}

/**
	Completes a version handshake initiated by the client.

	### Trigger
	Receipt of a client-sent [`Handshake`](super::server::Handshake) packet that was acceptable to the server.

	### Handling
	Optionally check if the server's [`network_version`](Self::network_version) matches your own. You can usually assume that the server will check this itself and disconnect if it doesn't match, but you can check again to be sure.

	### Response
	If the server's [`service_id`](Self::service_id) is [`ServiceId::Auth`], respond with a [`LoginRequest`](crate::auth::server::LoginRequest) with your username and password. If it is [`ServiceId::World`], send a [`ClientValidation`](crate::world::server::ClientValidation) with your username and the session key provided by auth.

	### Notes
	As the version confirm process was designed with more than just client-server in mind, it sends the server's network version and service id as well, even though this isn't really needed by the client (even the service id isn't needed, since you usually only connect to auth once, and it's the very first connection). This could be simplified if the protocol is ever revised.
*/
#[derive(Debug, Deserialize, PartialEq, Serialize)]
#[trailing_padding = 41]
pub struct Handshake {
	/// The network protocol version of the server. For servers compatible with live, this is `171022`. This was relevant mainly back when LU was actively updated. Server projects making modifications to the network protocol should set this to a different value.
	pub network_version: u32,
	/// Service ID of the server, [`ServiceId::Auth`] for auth servers, [`ServiceId::World`] for world servers.
	#[padding = 4]
	pub service_id: ServiceId,
}

/**
	Notifies the client when it was actively disconnected by the server.

	### Trigger
	Being disconnected by the server, the exact trigger depends on the variant.

	### Handling
	Display a message to the user.

	### Response
	None. Expect the connection to be closed shortly after, so a response won't even be possible.

	### Notes
	You can be disconnected without receiving this packet, for example when your connection is lost. The server is also not obligated to send this packet and may disconnect you without doing so.
*/
#[derive(Debug, Deserialize, PartialEq, Serialize)]
#[repr(u32)]
pub enum DisconnectNotify {
	/// Unspecified disconnect reason.
	UnknownServerError,
	/// The client's [`network_version`](super::server::Handshake::network_version) did not match the server's [`network_version`](Handshake::network_version). The message contains the server network version number.
	WrongGameVersion(u32),
	/// Unused for client-server.
	WrongServerVersion(u32),
	/// Connection attempt on invalid port, server emulators probably won't send this as they usually won't have server-server communication using LU's protocol.
	ConnectionOnInvalidPort,
	/// There was another login with your account and your session has been closed in favor of the new login.
	DuplicateLogin,
	/// The server is shutting down.
	ServerShutdown,
	/// No server hosting this map is available.
	UnableToLoadMap,
	/// The provided [`ClientValidation::session_key`](crate::world::server::ClientValidation::session_key) is incorrect.
	InvalidSessionKey,
	/// Server did not expect a [`ClientValidation`](crate::world::server::ClientValidation) at this time.
	AccountNotInPendingList,
	/// The provided [`CharacterLoginRequest::char_id`](crate::world::server::CharacterLoginRequest::char_id) was not a valid character ID of this account.
	CharacterNotFound,
	/// The character seems to be corrupted in the database.
	CharacterCorruption,
	/// You were kicked from the server.
	Kick,
	/// Error saving or loading progress.
	SaveFailure,
	/// The account's time-limited free trial expired, unused.
	FreeTrialExpired,
	/// The parental controls for this account prevent it from further play.
	PlayScheduleTimeUp,
}