Mirror.NetworkAuthenticator Class Reference

Base class for implementing component-based authentication during the Connect phase More...

Inheritance diagram for Mirror.NetworkAuthenticator:

Public Member Functions
virtual void	OnStartServer ()
	Called when server starts, used to register message handlers if needed. More...
virtual void	OnStopServer ()
	Called when server stops, used to unregister message handlers if needed. More...
virtual void	OnServerAuthenticate (NetworkConnectionToClient conn)
	Called on server from OnServerConnectInternal when a client needs to authenticate More...
virtual void	OnStartClient ()
	Called when client starts, used to register message handlers if needed. More...
virtual void	OnStopClient ()
	Called when client stops, used to unregister message handlers if needed. More...
virtual void	OnClientAuthenticate ()
	Called on client from OnClientConnectInternal when a client needs to authenticate More...

Public Attributes
UnityEventNetworkConnection	OnServerAuthenticated = new UnityEventNetworkConnection()
	Notify subscribers on the server when a client is authenticated More...
UnityEvent	OnClientAuthenticated = new UnityEvent()
	Notify subscribers on the client when the client is authenticated More...

Protected Member Functions
void	ServerAccept (NetworkConnectionToClient conn)
void	ServerReject (NetworkConnectionToClient conn)
void	ClientAccept ()
void	ClientReject ()

Detailed Description

Base class for implementing component-based authentication during the Connect phase

Definition at line 11 of file NetworkAuthenticator.cs.

Member Function Documentation

ClientAccept()

void Mirror.NetworkAuthenticator.ClientAccept ( )

protected

Definition at line 50 of file NetworkAuthenticator.cs.

        {
            OnClientAuthenticated.Invoke();
        }

ClientReject()

void Mirror.NetworkAuthenticator.ClientReject ( )

protected

Definition at line 55 of file NetworkAuthenticator.cs.

        {
            // Set this on the client for local reference
            NetworkClient.connection.isAuthenticated = false;
 
            // disconnect the client
            NetworkClient.connection.Disconnect();
        }

OnClientAuthenticate()

virtual void Mirror.NetworkAuthenticator.OnClientAuthenticate ( )

virtual

Called on client from OnClientConnectInternal when a client needs to authenticate

Definition at line 48 of file NetworkAuthenticator.cs.

{}

OnServerAuthenticate()

virtual void Mirror.NetworkAuthenticator.OnServerAuthenticate ( NetworkConnectionToClient  conn )

virtual

Called on server from OnServerConnectInternal when a client needs to authenticate

Definition at line 29 of file NetworkAuthenticator.cs.

{}

OnStartClient()

virtual void Mirror.NetworkAuthenticator.OnStartClient ( )

virtual

Called when client starts, used to register message handlers if needed.

Definition at line 42 of file NetworkAuthenticator.cs.

{}

OnStartServer()

virtual void Mirror.NetworkAuthenticator.OnStartServer ( )

virtual

Called when server starts, used to register message handlers if needed.

Definition at line 23 of file NetworkAuthenticator.cs.

{}

OnStopClient()

virtual void Mirror.NetworkAuthenticator.OnStopClient ( )

virtual

Called when client stops, used to unregister message handlers if needed.

Definition at line 45 of file NetworkAuthenticator.cs.

{}

OnStopServer()

virtual void Mirror.NetworkAuthenticator.OnStopServer ( )

virtual

Called when server stops, used to unregister message handlers if needed.

Definition at line 26 of file NetworkAuthenticator.cs.

{}

ServerAccept()

void Mirror.NetworkAuthenticator.ServerAccept ( NetworkConnectionToClient  conn )

protected

Definition at line 31 of file NetworkAuthenticator.cs.

        {
            OnServerAuthenticated.Invoke(conn);
        }

ServerReject()

void Mirror.NetworkAuthenticator.ServerReject ( NetworkConnectionToClient  conn )

protected

Definition at line 36 of file NetworkAuthenticator.cs.

        {
            conn.Disconnect();
        }

Member Data Documentation

OnClientAuthenticated

UnityEvent Mirror.NetworkAuthenticator.OnClientAuthenticated = new UnityEvent()

Notify subscribers on the client when the client is authenticated

Definition at line 20 of file NetworkAuthenticator.cs.

OnServerAuthenticated

UnityEventNetworkConnection Mirror.NetworkAuthenticator.OnServerAuthenticated = new UnityEventNetworkConnection()

Notify subscribers on the server when a client is authenticated

Definition at line 16 of file NetworkAuthenticator.cs.