Class NetworkAuthenticator

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

Inheritance
Object
NetworkAuthenticator
Namespace: Mirror
Assembly: doc.dll
Syntax
public abstract class NetworkAuthenticator : MonoBehaviour

Fields

| Improve this Doc View Source

OnClientAuthenticated

Notify subscribers on the client when the client is authenticated

Declaration
public UnityEvent OnClientAuthenticated
Field Value
Type Description
UnityEvent
| Improve this Doc View Source

OnServerAuthenticated

Notify subscribers on the server when a client is authenticated

Declaration
public UnityEventNetworkConnection OnServerAuthenticated
Field Value
Type Description
UnityEventNetworkConnection

Methods

| Improve this Doc View Source

ClientAccept()

Declaration
protected void ClientAccept()
| Improve this Doc View Source

ClientReject()

Declaration
protected void ClientReject()
| Improve this Doc View Source

OnClientAuthenticate()

Called on client from OnClientConnectInternal when a client needs to authenticate

Declaration
public virtual void OnClientAuthenticate()
| Improve this Doc View Source

OnServerAuthenticate(NetworkConnectionToClient)

Called on server from OnServerConnectInternal when a client needs to authenticate

Declaration
public virtual void OnServerAuthenticate(NetworkConnectionToClient conn)
Parameters
Type Name Description
NetworkConnectionToClient conn
| Improve this Doc View Source

OnStartClient()

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

Declaration
public virtual void OnStartClient()
| Improve this Doc View Source

OnStartServer()

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

Declaration
public virtual void OnStartServer()
| Improve this Doc View Source

OnStopClient()

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

Declaration
public virtual void OnStopClient()
| Improve this Doc View Source

OnStopServer()

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

Declaration
public virtual void OnStopServer()
| Improve this Doc View Source

ServerAccept(NetworkConnectionToClient)

Declaration
protected void ServerAccept(NetworkConnectionToClient conn)
Parameters
Type Name Description
NetworkConnectionToClient conn
| Improve this Doc View Source

ServerReject(NetworkConnectionToClient)

Declaration
protected void ServerReject(NetworkConnectionToClient conn)
Parameters
Type Name Description
NetworkConnectionToClient conn