PluginInterface2

Collaboration diagram for PluginInterface2:

Classes
class	RakNet::PluginInterface2
Modules
	Plugins
Enumerations
enum	RakNet::PI2_FailedConnectionAttemptReason {   RakNet::FCAR_CONNECTION_ATTEMPT_FAILED, RakNet::FCAR_ALREADY_CONNECTED, RakNet::FCAR_NO_FREE_INCOMING_CONNECTIONS, RakNet::FCAR_SECURITY_PUBLIC_KEY_MISMATCH,   RakNet::FCAR_CONNECTION_BANNED, RakNet::FCAR_INVALID_PASSWORD, RakNet::FCAR_INCOMPATIBLE_PROTOCOL, RakNet::FCAR_IP_RECENTLY_CONNECTED,   RakNet::FCAR_REMOTE_SYSTEM_REQUIRES_PUBLIC_KEY, RakNet::FCAR_OUR_SYSTEM_REQUIRES_SECURITY, RakNet::FCAR_PUBLIC_KEY_MISMATCH }
enum	RakNet::PI2_LostConnectionReason { RakNet::LCR_CLOSED_BY_USER, RakNet::LCR_DISCONNECTION_NOTIFICATION, RakNet::LCR_CONNECTION_LOST }
enum	RakNet::PluginReceiveResult { RakNet::RR_STOP_PROCESSING_AND_DEALLOCATE = 0, RakNet::RR_CONTINUE_PROCESSING, RakNet::RR_STOP_PROCESSING }

---

Enumeration Type Documentation

enum RakNet::PI2_FailedConnectionAttemptReason

Returns why a connection attempt failed

Enumerator:

FCAR_CONNECTION_ATTEMPT_FAILED
FCAR_ALREADY_CONNECTED
FCAR_NO_FREE_INCOMING_CONNECTIONS
FCAR_SECURITY_PUBLIC_KEY_MISMATCH
FCAR_CONNECTION_BANNED
FCAR_INVALID_PASSWORD
FCAR_INCOMPATIBLE_PROTOCOL
FCAR_IP_RECENTLY_CONNECTED
FCAR_REMOTE_SYSTEM_REQUIRES_PUBLIC_KEY
FCAR_OUR_SYSTEM_REQUIRES_SECURITY
FCAR_PUBLIC_KEY_MISMATCH

Definition at line 60 of file PluginInterface2.h.

{
    FCAR_CONNECTION_ATTEMPT_FAILED,
    FCAR_ALREADY_CONNECTED,
    FCAR_NO_FREE_INCOMING_CONNECTIONS,
    FCAR_SECURITY_PUBLIC_KEY_MISMATCH,
    FCAR_CONNECTION_BANNED,
    FCAR_INVALID_PASSWORD,
    FCAR_INCOMPATIBLE_PROTOCOL,
    FCAR_IP_RECENTLY_CONNECTED,
    FCAR_REMOTE_SYSTEM_REQUIRES_PUBLIC_KEY,
    FCAR_OUR_SYSTEM_REQUIRES_SECURITY,
    FCAR_PUBLIC_KEY_MISMATCH,
};

enum RakNet::PI2_LostConnectionReason

Reasons why a connection was lost

Enumerator:

LCR_CLOSED_BY_USER	Called RakPeer::CloseConnection()
LCR_DISCONNECTION_NOTIFICATION	Got ID_DISCONNECTION_NOTIFICATION.
LCR_CONNECTION_LOST	GOT ID_CONNECTION_LOST.

Definition at line 46 of file PluginInterface2.h.

{
    LCR_CLOSED_BY_USER,

    LCR_DISCONNECTION_NOTIFICATION,

    LCR_CONNECTION_LOST
};

enum RakNet::PluginReceiveResult

For each message that arrives on an instance of RakPeer, the plugins get an opportunity to process them first. This enumeration represents what to do with the message

Enumerator:

RR_STOP_PROCESSING_AND_DEALLOCATE	The plugin used this message and it shouldn't be given to the user.
RR_CONTINUE_PROCESSING	This message will be processed by other plugins, and at last by the user.
RR_STOP_PROCESSING	The plugin is going to hold on to this message. Do not deallocate it but do not pass it to other plugins either.

Definition at line 32 of file PluginInterface2.h.

{
    RR_STOP_PROCESSING_AND_DEALLOCATE=0,

    RR_CONTINUE_PROCESSING,

    RR_STOP_PROCESSING,
};