docs.unity3d.com
    Show / Hide Table of Contents

    Class UnityCloudClientTransport

    This class is a NGO transport using the Unity Cloud IWebsocketClient as a transport. Contains only client implementation

    Inheritance
    Object
    NetworkTransport
    UnityCloudClientTransport
    Inherited Members
    NetworkTransport.InvokeOnTransportEvent(NetworkEvent, UInt64, ArraySegment<Byte>, Single)
    NetworkTransport.IsSupported
    NetworkTransport.OnTransportEvent
    Namespace: Unity.Cloud.Presence.Runtime
    Syntax
    public class UnityCloudClientTransport : NetworkTransport

    Fields

    k_DefaultConnectionString

    Declaration
    public const string k_DefaultConnectionString = "127.0.0.1"
    Field Value
    Type Description
    String

    Properties

    ConnectionString

    Declaration
    public string ConnectionString { get; set; }
    Property Value
    Type Description
    String

    Headers

    Declaration
    public WebSocketHeaders Headers { get; set; }
    Property Value
    Type Description
    WebSocketHeaders

    ServerClientId

    Declaration
    public override ulong ServerClientId { get; }
    Property Value
    Type Description
    UInt64
    Overrides
    NetworkTransport.ServerClientId

    ServiceHostConfiguration

    Declaration
    public ServiceHostConfiguration ServiceHostConfiguration { get; set; }
    Property Value
    Type Description
    ServiceHostConfiguration

    Methods

    DisconnectLocalClient()

    Declaration
    public override void DisconnectLocalClient()
    Overrides
    NetworkTransport.DisconnectLocalClient()

    DisconnectRemoteClient(UInt64)

    Declaration
    public override void DisconnectRemoteClient(ulong clientId)
    Parameters
    Type Name Description
    UInt64 clientId
    Overrides
    NetworkTransport.DisconnectRemoteClient(UInt64)

    GetCurrentRtt(UInt64)

    Declaration
    public override ulong GetCurrentRtt(ulong clientId)
    Parameters
    Type Name Description
    UInt64 clientId
    Returns
    Type Description
    UInt64
    Overrides
    NetworkTransport.GetCurrentRtt(UInt64)

    Initialize(NetworkManager)

    Declaration
    public override void Initialize(NetworkManager networkManager = null)
    Parameters
    Type Name Description
    NetworkManager networkManager
    Overrides
    NetworkTransport.Initialize(NetworkManager)

    PollEvent(out UInt64, out ArraySegment<Byte>, out Single)

    Declaration
    public override NetworkEvent PollEvent(out ulong clientId, out ArraySegment<byte> payload, out float receiveTime)
    Parameters
    Type Name Description
    UInt64 clientId
    ArraySegment<Byte> payload
    Single receiveTime
    Returns
    Type Description
    NetworkEvent
    Overrides
    NetworkTransport.PollEvent(out UInt64, out ArraySegment<Byte>, out Single)

    Send(UInt64, ArraySegment<Byte>, NetworkDelivery)

    Declaration
    public override void Send(ulong clientId, ArraySegment<byte> payload, NetworkDelivery networkDelivery)
    Parameters
    Type Name Description
    UInt64 clientId
    ArraySegment<Byte> payload
    NetworkDelivery networkDelivery
    Overrides
    NetworkTransport.Send(UInt64, ArraySegment<Byte>, NetworkDelivery)

    Shutdown()

    Declaration
    public override void Shutdown()
    Overrides
    NetworkTransport.Shutdown()

    StartClient()

    Declaration
    public override bool StartClient()
    Returns
    Type Description
    Boolean
    Overrides
    NetworkTransport.StartClient()

    StartServer()

    Declaration
    public override bool StartServer()
    Returns
    Type Description
    Boolean
    Overrides
    NetworkTransport.StartServer()

    Extension Methods

    GenericDataExtensions.SerializeToByteArray(Object)
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023