docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class NetworkConnectionManager

    The NGO connection manager handles:

    • Client Connections
    • Client Approval
    • Processing NetworkEvents.
    • Client Disconnection
    Inheritance
    object
    NetworkConnectionManager
    Inherited Members
    object.ToString()
    object.Equals(object)
    object.Equals(object, object)
    object.ReferenceEquals(object, object)
    object.GetHashCode()
    object.GetType()
    Namespace: Unity.Netcode
    Assembly: solution.dll
    Syntax
    public sealed class NetworkConnectionManager

    Properties

    DisconnectReason

    When disconnected from the server, the server may send a reason. If a reason was sent, this property will tell client code what the reason was. It should be queried after the OnClientDisconnectCallback is called

    Declaration
    public string DisconnectReason { get; }
    Property Value
    Type Description
    string

    IsListening

    Is true when a server or host is listening for connections. Is true when a client is connecting or connected to a network session. Is false when not listening, connecting, or connected.

    Declaration
    public bool IsListening { get; }
    Property Value
    Type Description
    bool

    Events

    OnClientConnectedCallback

    The callback to invoke once a client connects. This callback is only ran on the server and on the local client that connects.

    Declaration
    public event Action<ulong> OnClientConnectedCallback
    Event Type
    Type Description
    Action<ulong>

    OnClientDisconnectCallback

    The callback to invoke when a client disconnects. This callback is only ran on the server and on the local client that disconnects.

    Declaration
    public event Action<ulong> OnClientDisconnectCallback
    Event Type
    Type Description
    Action<ulong>

    OnConnectionEvent

    The callback to invoke once a peer connects. This callback is only ran on the server and on the local client that connects.

    Declaration
    public event Action<NetworkManager, ConnectionEventData> OnConnectionEvent
    Event Type
    Type Description
    Action<NetworkManager, ConnectionEventData>

    OnTransportFailure

    The callback to invoke if the NetworkTransport fails.

    Declaration
    public event Action OnTransportFailure
    Event Type
    Type Description
    Action
    Remarks

    A failure of the transport is always followed by the NetworkManager shutting down. Recovering from a transport failure would normally entail reconfiguring the transport (e.g. re-authenticating, or recreating a new service allocation depending on the transport) and restarting the client/server/host.


    Did you find this page useful? Please give it a rating:

    Thanks for rating this page!

    Report a problem on this page

    What kind of problem would you like to report?

    • This page needs code samples
    • Code samples do not work
    • Information is missing
    • Information is incorrect
    • Information is unclear or confusing
    • There is a spelling/grammar error on this page
    • Something else

    Thanks for letting us know! This page has been marked for review based on your feedback.

    If you have time, you can provide more information to help us fix the problem faster.

    Provide more information

    You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:

    You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:

    You've told us there is information missing from this page. Please tell us more about what's missing:

    You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:

    You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:

    You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:

    You've told us this page has a problem. Please tell us more about what's wrong:

    Thank you for helping to make the Unity documentation better!

    Your feedback has been submitted as a ticket for our documentation team to review.

    We are not able to reply to every ticket submitted.

    In This Article
    • Properties
      • DisconnectReason
      • IsListening
    • Events
      • OnClientConnectedCallback
      • OnClientDisconnectCallback
      • OnConnectionEvent
      • OnTransportFailure
    Back to top
    Copyright © 2024 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)