| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839 |
- <Type Name="Connection" FullName="Urho.Network.Connection">
- <TypeSignature Language="C#" Value="public class Connection : Urho.UrhoObject" />
- <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit Connection extends Urho.UrhoObject" />
- <AssemblyInfo>
- <AssemblyName>Urho</AssemblyName>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <Base>
- <BaseTypeName>Urho.UrhoObject</BaseTypeName>
- </Base>
- <Interfaces />
- <Docs>
- <summary>Connection to a remote network host.
- </summary>
- <remarks>On the client, this object is retrieved after a successful connection from the <see cref="P:Urho.Network.Network.ServerConnection" /> property. On the server, a new instance of this object is created for every connected client.</remarks>
- </Docs>
- <Members>
- <Member MemberName=".ctor">
- <MemberSignature Language="C#" Value="public Connection (IntPtr handle);" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(native int handle) cil managed" />
- <MemberType>Constructor</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <Attributes>
- <Attribute>
- <AttributeName>Preserve</AttributeName>
- </Attribute>
- </Attributes>
- <Parameters>
- <Parameter Name="handle" Type="System.IntPtr" />
- </Parameters>
- <Docs>
- <param name="handle">Pointer to the raw unmanaged Urho object.</param>
- <summary>Constructs a new instance of Urho.Network.Connection, given a raw pointer to an unmanaged object</summary>
- <remarks>
- <para>This creates a new managed wrapper for the type using the raw pointer to an unmanaged object.</para>
- <para>Objects that are created in this fashion get registered with the UrhoSharp runtime.</para>
- <para>This is intended to be used by the UrhoSharp runtime, and is not intended to be used by users.</para>
- </remarks>
- </Docs>
- </Member>
- <Member MemberName=".ctor">
- <MemberSignature Language="C#" Value="protected Connection (Urho.UrhoObjectFlag emptyFlag);" />
- <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(valuetype Urho.UrhoObjectFlag emptyFlag) cil managed" />
- <MemberType>Constructor</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <Attributes>
- <Attribute>
- <AttributeName>Preserve</AttributeName>
- </Attribute>
- </Attributes>
- <Parameters>
- <Parameter Name="emptyFlag" Type="Urho.UrhoObjectFlag" />
- </Parameters>
- <Docs>
- <param name="emptyFlag">Pass UrhoObjectFlag.Empty.</param>
- <summary>Empty constructor, chain to this constructor when you provide your own constructor that sets the handle field.</summary>
- <remarks>
- <para>This constructor should be invoked by your code if you provide your own constructor that sets the handle field.</para>
- <para>This essentially circumvents the default path that creates a new object and sets the handle and does not call RegisterObject on the target, you must do this on your own constructor.</para>
- <para>You would typically chain to this constructor from your own, and then set the handle to the unmanaged object from your code, and then register your object.</para>
- </remarks>
- </Docs>
- </Member>
- <Member MemberName="Address">
- <MemberSignature Language="C#" Value="public string Address { get; }" />
- <MemberSignature Language="ILAsm" Value=".property instance string Address" />
- <MemberType>Property</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>System.String</ReturnType>
- </ReturnValue>
- <Docs>
- <summary>
- Return remote address.
- </summary>
- <value>To be added.</value>
- <remarks>To be added.</remarks>
- </Docs>
- </Member>
- <Member MemberName="BytesInPerSec">
- <MemberSignature Language="C#" Value="public float BytesInPerSec { get; }" />
- <MemberSignature Language="ILAsm" Value=".property instance float32 BytesInPerSec" />
- <MemberType>Property</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>System.Single</ReturnType>
- </ReturnValue>
- <Docs>
- <summary>
- Return bytes received per second.
- </summary>
- <value>To be added.</value>
- <remarks>To be added.</remarks>
- </Docs>
- </Member>
- <Member MemberName="BytesOutPerSec">
- <MemberSignature Language="C#" Value="public float BytesOutPerSec { get; }" />
- <MemberSignature Language="ILAsm" Value=".property instance float32 BytesOutPerSec" />
- <MemberType>Property</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>System.Single</ReturnType>
- </ReturnValue>
- <Docs>
- <summary>
- Return bytes sent per second.
- </summary>
- <value>To be added.</value>
- <remarks>To be added.</remarks>
- </Docs>
- </Member>
- <Member MemberName="Client">
- <MemberSignature Language="C#" Value="public bool Client { get; }" />
- <MemberSignature Language="ILAsm" Value=".property instance bool Client" />
- <MemberType>Property</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>System.Boolean</ReturnType>
- </ReturnValue>
- <Docs>
- <summary>Return whether is a client connection.</summary>
- <value>To be added.</value>
- <remarks>To be added.</remarks>
- </Docs>
- </Member>
- <Member MemberName="ClientIdentity">
- <MemberSignature Language="C#" Value="public event Action<Urho.Network.ClientIdentityEventArgs> ClientIdentity;" />
- <MemberSignature Language="ILAsm" Value=".event class System.Action`1<valuetype Urho.Network.ClientIdentityEventArgs> ClientIdentity" />
- <MemberType>Event</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>System.Action<Urho.Network.ClientIdentityEventArgs></ReturnType>
- </ReturnValue>
- <Docs>
- <summary>Event raised on the server after the connection and contains the client identity information. The default is to accept all connections.</summary>
- <remarks>
- <para>The event can register multiple callbacks and invoke all of them. If this is not desired, and you only need a single shot callback, you can use the <see cref="M:Urho.SubscribeToClientIdentity" /> method. That one will force that callback and will ignore any previously set events here.</para>
- </remarks>
- </Docs>
- </Member>
- <Member MemberName="ClientSceneLoaded">
- <MemberSignature Language="C#" Value="public event Action<Urho.Network.ClientSceneLoadedEventArgs> ClientSceneLoaded;" />
- <MemberSignature Language="ILAsm" Value=".event class System.Action`1<valuetype Urho.Network.ClientSceneLoadedEventArgs> ClientSceneLoaded" />
- <MemberType>Event</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>System.Action<Urho.Network.ClientSceneLoadedEventArgs></ReturnType>
- </ReturnValue>
- <Docs>
- <summary>To be added.</summary>
- <remarks>
- <para>The event can register multiple callbacks and invoke all of them. If this is not desired, and you only need a single shot callback, you can use the <see cref="M:Urho.SubscribeToClientSceneLoaded" /> method. That one will force that callback and will ignore any previously set events here.</para>
- </remarks>
- </Docs>
- </Member>
- <Member MemberName="ConfigureNetworkSimulator">
- <MemberSignature Language="C#" Value="public void ConfigureNetworkSimulator (int latencyMs, float packetLoss);" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void ConfigureNetworkSimulator(int32 latencyMs, float32 packetLoss) cil managed" />
- <MemberType>Method</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>System.Void</ReturnType>
- </ReturnValue>
- <Parameters>
- <Parameter Name="latencyMs" Type="System.Int32" />
- <Parameter Name="packetLoss" Type="System.Single" />
- </Parameters>
- <Docs>
- <param name="latencyMs">To be added.</param>
- <param name="packetLoss">To be added.</param>
- <summary>
- Set network simulation parameters. Called by Network.
- </summary>
- <remarks>To be added.</remarks>
- </Docs>
- </Member>
- <Member MemberName="Connected">
- <MemberSignature Language="C#" Value="public bool Connected { get; }" />
- <MemberSignature Language="ILAsm" Value=".property instance bool Connected" />
- <MemberType>Property</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>System.Boolean</ReturnType>
- </ReturnValue>
- <Docs>
- <summary>Return whether is fully connected.</summary>
- <value>To be added.</value>
- <remarks>To be added.</remarks>
- </Docs>
- </Member>
- <Member MemberName="ConnectPending">
- <MemberSignature Language="C#" Value="public bool ConnectPending { get; set; }" />
- <MemberSignature Language="ILAsm" Value=".property instance bool ConnectPending" />
- <MemberType>Property</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>System.Boolean</ReturnType>
- </ReturnValue>
- <Docs>
- <summary>Return whether connection is pending.</summary>
- <value>To be added.</value>
- <remarks>To be added.</remarks>
- </Docs>
- </Member>
- <Member MemberName="Controls">
- <MemberSignature Language="C#" Value="public Urho.Controls Controls { get; set; }" />
- <MemberSignature Language="ILAsm" Value=".property instance class Urho.Controls Controls" />
- <MemberType>Property</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>Urho.Controls</ReturnType>
- </ReturnValue>
- <Docs>
- <summary>To be added.</summary>
- <value>To be added.</value>
- <remarks>To be added.</remarks>
- </Docs>
- </Member>
- <Member MemberName="Disconnect">
- <MemberSignature Language="C#" Value="public void Disconnect (int waitMSec = 0);" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Disconnect(int32 waitMSec) cil managed" />
- <MemberType>Method</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>System.Void</ReturnType>
- </ReturnValue>
- <Parameters>
- <Parameter Name="waitMSec" Type="System.Int32" />
- </Parameters>
- <Docs>
- <param name="waitMSec">To be added.</param>
- <summary>
- Disconnect. If wait time is non-zero, will block while waiting for disconnect to finish.
- </summary>
- <remarks>To be added.</remarks>
- </Docs>
- </Member>
- <Member MemberName="DownloadName">
- <MemberSignature Language="C#" Value="public string DownloadName { get; }" />
- <MemberSignature Language="ILAsm" Value=".property instance string DownloadName" />
- <MemberType>Property</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>System.String</ReturnType>
- </ReturnValue>
- <Docs>
- <summary>
- Return name of current package download, or empty if no downloads.
- </summary>
- <value>To be added.</value>
- <remarks>To be added.</remarks>
- </Docs>
- </Member>
- <Member MemberName="DownloadProgress">
- <MemberSignature Language="C#" Value="public float DownloadProgress { get; }" />
- <MemberSignature Language="ILAsm" Value=".property instance float32 DownloadProgress" />
- <MemberType>Property</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>System.Single</ReturnType>
- </ReturnValue>
- <Docs>
- <summary>
- Return progress of current package download, or 1.0 if no downloads.
- </summary>
- <value>To be added.</value>
- <remarks>To be added.</remarks>
- </Docs>
- </Member>
- <Member MemberName="LastHeardTime">
- <MemberSignature Language="C#" Value="public float LastHeardTime { get; }" />
- <MemberSignature Language="ILAsm" Value=".property instance float32 LastHeardTime" />
- <MemberType>Property</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>System.Single</ReturnType>
- </ReturnValue>
- <Docs>
- <summary>
- Return the time since last received data from the remote host in milliseconds.
- </summary>
- <value>To be added.</value>
- <remarks>To be added.</remarks>
- </Docs>
- </Member>
- <Member MemberName="LogStatistics">
- <MemberSignature Language="C#" Value="public bool LogStatistics { get; set; }" />
- <MemberSignature Language="ILAsm" Value=".property instance bool LogStatistics" />
- <MemberType>Property</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>System.Boolean</ReturnType>
- </ReturnValue>
- <Docs>
- <summary>
- Return whether to log data in/out statistics.
- Or
- Set whether to log data in/out statistics.
- </summary>
- <value>To be added.</value>
- <remarks>To be added.</remarks>
- </Docs>
- </Member>
- <Member MemberName="NumDownloads">
- <MemberSignature Language="C#" Value="public uint NumDownloads { get; }" />
- <MemberSignature Language="ILAsm" Value=".property instance unsigned int32 NumDownloads" />
- <MemberType>Property</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>System.UInt32</ReturnType>
- </ReturnValue>
- <Docs>
- <summary>
- Return number of package downloads remaining.
- </summary>
- <value>To be added.</value>
- <remarks>To be added.</remarks>
- </Docs>
- </Member>
- <Member MemberName="PacketsInPerSec">
- <MemberSignature Language="C#" Value="public float PacketsInPerSec { get; }" />
- <MemberSignature Language="ILAsm" Value=".property instance float32 PacketsInPerSec" />
- <MemberType>Property</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>System.Single</ReturnType>
- </ReturnValue>
- <Docs>
- <summary>
- Return packets received per second.
- </summary>
- <value>To be added.</value>
- <remarks>To be added.</remarks>
- </Docs>
- </Member>
- <Member MemberName="PacketsOutPerSec">
- <MemberSignature Language="C#" Value="public float PacketsOutPerSec { get; }" />
- <MemberSignature Language="ILAsm" Value=".property instance float32 PacketsOutPerSec" />
- <MemberType>Property</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>System.Single</ReturnType>
- </ReturnValue>
- <Docs>
- <summary>
- Return packets sent per second.
- </summary>
- <value>To be added.</value>
- <remarks>To be added.</remarks>
- </Docs>
- </Member>
- <Member MemberName="Port">
- <MemberSignature Language="C#" Value="public ushort Port { get; }" />
- <MemberSignature Language="ILAsm" Value=".property instance unsigned int16 Port" />
- <MemberType>Property</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>System.UInt16</ReturnType>
- </ReturnValue>
- <Docs>
- <summary>
- Return remote port.
- </summary>
- <value>To be added.</value>
- <remarks>To be added.</remarks>
- </Docs>
- </Member>
- <Member MemberName="Position">
- <MemberSignature Language="C#" Value="public Urho.Vector3 Position { get; set; }" />
- <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.Vector3 Position" />
- <MemberType>Property</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>Urho.Vector3</ReturnType>
- </ReturnValue>
- <Docs>
- <summary>
- Return the observer position sent by the client for interest management.
- Or
- Set the observer position for interest management, to be sent to the server.
- </summary>
- <value>To be added.</value>
- <remarks>To be added.</remarks>
- </Docs>
- </Member>
- <Member MemberName="ProcessPendingLatestData">
- <MemberSignature Language="C#" Value="public void ProcessPendingLatestData ();" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void ProcessPendingLatestData() cil managed" />
- <MemberType>Method</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>System.Void</ReturnType>
- </ReturnValue>
- <Parameters />
- <Docs>
- <summary>
- Process pending latest data for nodes and components.
- </summary>
- <remarks>To be added.</remarks>
- </Docs>
- </Member>
- <Member MemberName="Rotation">
- <MemberSignature Language="C#" Value="public Urho.Quaternion Rotation { get; set; }" />
- <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.Quaternion Rotation" />
- <MemberType>Property</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>Urho.Quaternion</ReturnType>
- </ReturnValue>
- <Docs>
- <summary>
- Return the observer rotation sent by the client for interest management.
- Or
- Set the observer rotation for interest management, to be sent to the server. Note: not used by the NetworkPriority component.
- </summary>
- <value>To be added.</value>
- <remarks>To be added.</remarks>
- </Docs>
- </Member>
- <Member MemberName="RoundTripTime">
- <MemberSignature Language="C#" Value="public float RoundTripTime { get; }" />
- <MemberSignature Language="ILAsm" Value=".property instance float32 RoundTripTime" />
- <MemberType>Property</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>System.Single</ReturnType>
- </ReturnValue>
- <Docs>
- <summary>
- Return the connection's round trip time in milliseconds.
- </summary>
- <value>To be added.</value>
- <remarks>To be added.</remarks>
- </Docs>
- </Member>
- <Member MemberName="Scene">
- <MemberSignature Language="C#" Value="public Urho.Scene Scene { get; set; }" />
- <MemberSignature Language="ILAsm" Value=".property instance class Urho.Scene Scene" />
- <MemberType>Property</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>Urho.Scene</ReturnType>
- </ReturnValue>
- <Docs>
- <summary>
- Return the scene used by this connection.
- Or
- Assign scene. On the server, this will cause the client to load it.
- </summary>
- <value>To be added.</value>
- <remarks>To be added.</remarks>
- </Docs>
- </Member>
- <Member MemberName="SceneLoaded">
- <MemberSignature Language="C#" Value="public bool SceneLoaded { get; }" />
- <MemberSignature Language="ILAsm" Value=".property instance bool SceneLoaded" />
- <MemberType>Property</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>System.Boolean</ReturnType>
- </ReturnValue>
- <Docs>
- <summary>Return whether the scene is loaded and ready to receive server updates.</summary>
- <value>To be added.</value>
- <remarks>To be added.</remarks>
- </Docs>
- </Member>
- <Member MemberName="SendClientUpdate">
- <MemberSignature Language="C#" Value="public void SendClientUpdate ();" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SendClientUpdate() cil managed" />
- <MemberType>Method</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>System.Void</ReturnType>
- </ReturnValue>
- <Parameters />
- <Docs>
- <summary>
- Send latest controls from the client. Called by Network.
- </summary>
- <remarks>To be added.</remarks>
- </Docs>
- </Member>
- <Member MemberName="SendMessage">
- <MemberSignature Language="C#" Value="public void SendMessage (int msgId, bool reliable, bool inOrder, byte[] buffer, uint contentId = 0);" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SendMessage(int32 msgId, bool reliable, bool inOrder, unsigned int8[] buffer, unsigned int32 contentId) cil managed" />
- <MemberType>Method</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>System.Void</ReturnType>
- </ReturnValue>
- <Parameters>
- <Parameter Name="msgId" Type="System.Int32" />
- <Parameter Name="reliable" Type="System.Boolean" />
- <Parameter Name="inOrder" Type="System.Boolean" />
- <Parameter Name="buffer" Type="System.Byte[]" />
- <Parameter Name="contentId" Type="System.UInt32" />
- </Parameters>
- <Docs>
- <param name="msgId">To be added.</param>
- <param name="reliable">To be added.</param>
- <param name="inOrder">To be added.</param>
- <param name="buffer">To be added.</param>
- <param name="contentId">To be added.</param>
- <summary>Sends a message over the connection.</summary>
- <remarks>To be added.</remarks>
- </Docs>
- </Member>
- <Member MemberName="SendMessage">
- <MemberSignature Language="C#" Value="public void SendMessage (int msgID, bool reliable, bool inOrder, byte* data, uint numBytes, uint contentID = 0);" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SendMessage(int32 msgID, bool reliable, bool inOrder, unsigned int8* data, unsigned int32 numBytes, unsigned int32 contentID) cil managed" />
- <MemberType>Method</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>System.Void</ReturnType>
- </ReturnValue>
- <Parameters>
- <Parameter Name="msgID" Type="System.Int32" />
- <Parameter Name="reliable" Type="System.Boolean" />
- <Parameter Name="inOrder" Type="System.Boolean" />
- <Parameter Name="data" Type="System.Byte*" />
- <Parameter Name="numBytes" Type="System.UInt32" />
- <Parameter Name="contentID" Type="System.UInt32" />
- </Parameters>
- <Docs>
- <param name="msgID">To be added.</param>
- <param name="reliable">To be added.</param>
- <param name="inOrder">To be added.</param>
- <param name="data">To be added.</param>
- <param name="numBytes">To be added.</param>
- <param name="contentID">To be added.</param>
- <summary>Sends a message over the connection.</summary>
- <remarks>To be added.</remarks>
- </Docs>
- </Member>
- <Member MemberName="SendPackages">
- <MemberSignature Language="C#" Value="public void SendPackages ();" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SendPackages() cil managed" />
- <MemberType>Method</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>System.Void</ReturnType>
- </ReturnValue>
- <Parameters />
- <Docs>
- <summary>
- Send package files to client. Called by network.
- </summary>
- <remarks>To be added.</remarks>
- </Docs>
- </Member>
- <Member MemberName="SendPackageToClient">
- <MemberSignature Language="C#" Value="public void SendPackageToClient (Urho.IO.PackageFile package);" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SendPackageToClient(class Urho.IO.PackageFile package) cil managed" />
- <MemberType>Method</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>System.Void</ReturnType>
- </ReturnValue>
- <Parameters>
- <Parameter Name="package" Type="Urho.IO.PackageFile" />
- </Parameters>
- <Docs>
- <param name="package">To be added.</param>
- <summary>
- Trigger client connection to download a package file from the server. Can be used to download additional resource packages when client is already joined in a scene. The package must have been added as a requirement to the scene the client is joined in, or else the eventual download will fail.
- </summary>
- <remarks>To be added.</remarks>
- </Docs>
- </Member>
- <Member MemberName="SendRemoteEvents">
- <MemberSignature Language="C#" Value="public void SendRemoteEvents ();" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SendRemoteEvents() cil managed" />
- <MemberType>Method</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>System.Void</ReturnType>
- </ReturnValue>
- <Parameters />
- <Docs>
- <summary>
- Send queued remote events. Called by Network.
- </summary>
- <remarks>To be added.</remarks>
- </Docs>
- </Member>
- <Member MemberName="SendServerUpdate">
- <MemberSignature Language="C#" Value="public void SendServerUpdate ();" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SendServerUpdate() cil managed" />
- <MemberType>Method</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>System.Void</ReturnType>
- </ReturnValue>
- <Parameters />
- <Docs>
- <summary>
- Send scene update messages. Called by Network.
- </summary>
- <remarks>To be added.</remarks>
- </Docs>
- </Member>
- <Member MemberName="SubscribeToClientIdentity">
- <MemberSignature Language="C#" Value="public Urho.Subscription SubscribeToClientIdentity (Action<Urho.Network.ClientIdentityEventArgs> handler);" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.Subscription SubscribeToClientIdentity(class System.Action`1<valuetype Urho.Network.ClientIdentityEventArgs> handler) cil managed" />
- <MemberType>Method</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <Attributes>
- <Attribute>
- <AttributeName>System.Obsolete("SubscribeTo API may lead to unxpected behaviour and will be removed in a future version. Use C# event '.ClientIdentity += ...' instead.")</AttributeName>
- </Attribute>
- </Attributes>
- <ReturnValue>
- <ReturnType>Urho.Subscription</ReturnType>
- </ReturnValue>
- <Parameters>
- <Parameter Name="handler" Type="System.Action<Urho.Network.ClientIdentityEventArgs>" />
- </Parameters>
- <Docs>
- <param name="handler">The handler to invoke when this event is raised.</param>
- <summary>Subscribes to the ClientIdentity event raised by the Connection.</summary>
- <returns>Returns an Urho.Subscription that can be used to cancel the subscription.</returns>
- <remarks>
- <para>This method will override any prior subscription, including those assigned to on event handlers.</para>
- <para>This has the advantage that it does a straight connection and returns a handle that is easy to unsubscribe from.</para>
- <para>For a more event-like approach, use the <see cref="E:Urho.Network.Connection.ClientIdentity" /> event.</para>
- </remarks>
- </Docs>
- </Member>
- <Member MemberName="SubscribeToClientSceneLoaded">
- <MemberSignature Language="C#" Value="public Urho.Subscription SubscribeToClientSceneLoaded (Action<Urho.Network.ClientSceneLoadedEventArgs> handler);" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.Subscription SubscribeToClientSceneLoaded(class System.Action`1<valuetype Urho.Network.ClientSceneLoadedEventArgs> handler) cil managed" />
- <MemberType>Method</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <Attributes>
- <Attribute>
- <AttributeName>System.Obsolete("SubscribeTo API may lead to unxpected behaviour and will be removed in a future version. Use C# event '.ClientSceneLoaded += ...' instead.")</AttributeName>
- </Attribute>
- </Attributes>
- <ReturnValue>
- <ReturnType>Urho.Subscription</ReturnType>
- </ReturnValue>
- <Parameters>
- <Parameter Name="handler" Type="System.Action<Urho.Network.ClientSceneLoadedEventArgs>" />
- </Parameters>
- <Docs>
- <param name="handler">The handler to invoke when this event is raised.</param>
- <summary>Subscribes to the ClientSceneLoaded event raised by the Connection.</summary>
- <returns>Returns an Urho.Subscription that can be used to cancel the subscription.</returns>
- <remarks>
- <para>This method will override any prior subscription, including those assigned to on event handlers.</para>
- <para>This has the advantage that it does a straight connection and returns a handle that is easy to unsubscribe from.</para>
- <para>For a more event-like approach, use the <see cref="E:Urho.Network.Connection.ClientSceneLoaded" /> event.</para>
- </remarks>
- </Docs>
- </Member>
- <Member MemberName="TimeStamp">
- <MemberSignature Language="C#" Value="public byte TimeStamp { get; }" />
- <MemberSignature Language="ILAsm" Value=".property instance unsigned int8 TimeStamp" />
- <MemberType>Property</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>System.Byte</ReturnType>
- </ReturnValue>
- <Docs>
- <summary>
- Return the controls timestamp, sent from client to server along each control update.
- </summary>
- <value>To be added.</value>
- <remarks>To be added.</remarks>
- </Docs>
- </Member>
- <Member MemberName="ToDebugString">
- <MemberSignature Language="C#" Value="public string ToDebugString ();" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance string ToDebugString() cil managed" />
- <MemberType>Method</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>System.String</ReturnType>
- </ReturnValue>
- <Parameters />
- <Docs>
- <summary>
- Return an address:port string.
- </summary>
- <returns>To be added.</returns>
- <remarks>To be added.</remarks>
- </Docs>
- </Member>
- <Member MemberName="Type">
- <MemberSignature Language="C#" Value="public override Urho.StringHash Type { get; }" />
- <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.StringHash Type" />
- <MemberType>Property</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>Urho.StringHash</ReturnType>
- </ReturnValue>
- <Docs>
- <summary>Urho's type system type.</summary>
- <value>StringHash representing the type for this C# type.</value>
- <remarks>This returns the Urho's type and is surfaced for low-level Urho code.</remarks>
- </Docs>
- </Member>
- <Member MemberName="TypeName">
- <MemberSignature Language="C#" Value="public override string TypeName { get; }" />
- <MemberSignature Language="ILAsm" Value=".property instance string TypeName" />
- <MemberType>Property</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>System.String</ReturnType>
- </ReturnValue>
- <Docs>
- <summary>Urho's low-level type name.</summary>
- <value>Stringified low-level type name.</value>
- <remarks>
- </remarks>
- </Docs>
- </Member>
- <Member MemberName="TypeNameStatic">
- <MemberSignature Language="C#" Value="public static string TypeNameStatic { get; }" />
- <MemberSignature Language="ILAsm" Value=".property string TypeNameStatic" />
- <MemberType>Property</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>System.String</ReturnType>
- </ReturnValue>
- <Docs>
- <summary>Urho's low-level type name, accessible as a static method.</summary>
- <value>Stringified low-level type name.</value>
- <remarks>
- </remarks>
- </Docs>
- </Member>
- <Member MemberName="TypeStatic">
- <MemberSignature Language="C#" Value="public static Urho.StringHash TypeStatic { get; }" />
- <MemberSignature Language="ILAsm" Value=".property valuetype Urho.StringHash TypeStatic" />
- <MemberType>Property</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <Attributes>
- <Attribute>
- <AttributeName>Preserve</AttributeName>
- </Attribute>
- </Attributes>
- <ReturnValue>
- <ReturnType>Urho.StringHash</ReturnType>
- </ReturnValue>
- <Docs>
- <summary>Urho's low-level type, accessible as a static method.</summary>
- <value>This returns the Urho's type and is surface for the low-level Urho code.</value>
- <remarks>
- </remarks>
- </Docs>
- </Member>
- </Members>
- </Type>
|