Unity-Technologies
/
com.unity.multiplayer.docs
зеркало из https://github.com/Unity-Technologies/com.unity.multiplayer.docs.git
1
0
Форкнуть 0
Код Задачи Пакеты Проекты Релизы Вики Активность

Tranport 2.x updates (#1036)

This commit is contained in:
Sara [Unity] 2023-04-28 14:39:29 -04:00 коммит произвёл GitHub
Родитель cd5ff1fa70
Коммит 5730466aa6
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
336 изменённых файлов: 26255 добавлений и 25558 удалений
Показать статистику Скачать Patch файл Скачать Diff файл Показать все файлы Свернуть все файлы

8
docusaurus.config.js
Просмотреть файл

@ -196,7 +196,7 @@ module.exports = {
items: [
{
type: "doc",
docId: "transport/transport-1-0-0",
docId: "transport/transport-2-0-0",
label: "Release Notes",
docsPluginId: "releases",
},
@ -435,9 +435,13 @@ module.exports = {
lastVersion: "current",
versions: {
current: {
label: "1.0.0",
label: "2.0.0",
path: "current",
},
"1.0.0": {
label: "1.0.0",
path: "1.0.0",
},
"0.8.0": {
label: "0.8.0",
path: "0.8.0",

93
releases/transport/transport-2-0-0.md
Просмотреть файл

@ -5,6 +5,99 @@ id: transport-2-0-0
The [Unity Transport](../../transport/current/about) `com.unity.transport` package repository adds multiplayer and network features to your project. See the following changelog for new features, updates, fixes, and upgrade information.
## [2.0.2] - 2023-04-26
## Changes
- When using Unity Relay, NetworkDriver.GetRemoteEndpoint will now always return the address of the Relay server, instead of returning the address until a connection is established, and then returning the allocation ID encoded as an endpoint (appearing as an invalid endpoint). This makes the behavior the same as it was in version 1.X of the package.
## Fixes
- Fixed an issue where the reliable pipeline stage could end up writing past the end of its internal buffer and thrashing the buffers of other connections. This could result in packet corruption, but would most likely result in erroneous -7 (NetworkDriverParallelForErr) errors being reported when calling EndSend.
- Fixed an issue where upon returning -7 (NetworkDriverParallelForErr), EndSend would leak the send handle. Over time, this would result in less send handles being available, resulting in more -5 (NetworkSendQueueFull) errors.
- Fixed an issue where WebSocket connections would always take at least connectTimeoutMS milliseconds to be reported as established, even if the connection was actually established faster than that.
- Fixed an issue where ArgumentOutOfRangeException could be thrown in situations where a new WebSocket connection is established while a previous connection is in the process of being closed.
- If nothing is received from a Unity Relay server for a while, the transport will now attempt to rebind to it. This should improve the accuracy of GetRelayConnectionStatus in scenarios where the Relay allocation times out while communications with the server are out.
- Fixed an issue where UDPNetworkInterface (the default one) would not bind to the correct address if the local IP address change and the socket needs to be recreated (e.g. because the app was backgrounded on a mobile device).
## [2.0.1] - 2023-04-17
### Changes
- Updated Collections dependency to 2.1.1.
## [2.0.0] - 2023-04-14
### Changes
- NetworkEndpoint.ToString and its fixed string variant now return "invalid" for invalid endpoints instead of an empty string.
- Updated Burst dependency to 1.8.4.
- Updated Collections dependency to 2.1.0.
### Fixes
- Fixed an issue where the TLS handshake of a new secure WebSocket connection could possibly fail if there were already other active connections on the same server.
## [2.0.0-pre.8] - 2023-03-30
### New features
- MultiNetworkDriver can then be used for client drivers too. The restriction on it accepting only listening drivers has been lifted, and it now offers a new Connect method to connect client drivers. This makes it easier to write networking code that can be shared between server and client.
- Added a new ReliableUtility.SetMaximumResendTime static method, allowing to modify the maximum resend time of the reliable pipeline at runtime (there's already a similar method for the minimum resend time). Increasing this value can improve bandwidth usage for poor connections (RTT greater than 200ms).
- Added the possibility of setting the minimum and maximum resend times of the reliable pipeline through NetworkSettings (with WithReliableStageParameters).
### Changes
- NetworkEndpoint.TryParse will now return false and log an error when attempting to parse an IPv6 address on platforms where IPv6 is not supported. The previous behavior was to throw an exception, but only in the editor. On the devices themselves, the address would be successfully parsed silently, which would lead to confusing socket errors down the line.
- The SimulatorUtility.Context structure has been made internal. It contained only implementation details, or values that appeared useful but were actually either misleading or broken.
- The RelayMessageType enum has been made internal. The only purpose of this type was to list the different messages of the Relay protocol, which is an implementation detail that should not be relevant to users.
### Fixes
- Fixed an issue where calling ScheduleFlushSend before the socket was bound would still result in socket system calls being made, resulting in errors being logged.
- No warning will be printed when attempting to send on a WebSocket connection that has been closed by the remote peer (would only happen if calling ScheduleFlushSend).
## [2.0.0-pre.7] - 2023-03-15
### New features
- Added a new MultiNetworkDriver API to make it easier to handle multiple NetworkDriver instances at the same time for cross-play scenarios. Refer to the "cross-play support" section of the documentation for more details on this feature. This new API is also showcased in a new "CrossPlay" package sample.
### Changes
- Update Burst dependency to 1.8.3.
- The QueuedSendMessage structure was removed as it didn't serve any purpose anymore.
- The dependency argument of NetworkDriver.ScheduleFlushSend is now optional.
- SequenceHelpers, RandomHelpers, and the extensions in NativeListExt and FixedStringExt have all been made internal. These are all internal helper classes that shouldn't have been part of the public API in the first place.
- Many APIs and types inside ReliableUtility have been made internal (among them all APIs and types dealing with send/receive contexts and packet information and timers). The information they contain was meant purely for internal consumption in the first place. The statistics and RTT information inside the shared context remains public.
- Removed errorCode from ReliableUtility.SharedContext. Any useful information it can provide is already returned by higher-level APIs like NetworkDriver.EndSend.
- Default send and receive queue sizes are now set to 512 packets (previous value was 64). The queue sizes are modifiable with NetworkSettings.WithNetworkConfigParameters.
### Fixes
- Fixed a possible exception in IPCNetworkInterface if it was fed an unknown endpoint.
- Fixed NetworkDriver.GetLocalEndpoint when using WebSocketNetworkInterface (note that on web browsers this will now print a warning since local endpoints are not available on WebGL).
## [2.0.0-pre.6] - 2023-01-13
### New features
- Added a NetworkConnection.ToFixedString method to allow logging network connections from Burst.
## [2.0.0-pre.5] - 2023-01-12
### Changes
- Revert to Collections 2.1.0-pre.6 as pre.7 is not promoted yet.
## [2.0.0-pre.4] - 2023-01-12
### Changes
- Update Burst dependency to 1.8.2.
- Update Collections dependency to 2.1.0-pre.7.
- The InternalId and Version properties of NetworkConnection are now internal. These referred to internal values and using them directly was error-prone since values could be reused across connections. To compare connections reliably, compare the NetworkConnection objects directly (they implement all the relevant operators and interfaces).
- Replace NetworkDriverIdentifierParameter (and WithNetworkDriverIdentifierParameters) with a more general LoggingParameter (and WithLoggingParameters). Note that currently these parameters don't affect anything, and are there for future use only.
## [2.0.0-pre.3] - 2022-11-29
### Changes

121
sidebarsTransport.js
Просмотреть файл

@ -9,97 +9,68 @@ module.exports = {
"id": "install"
},
{
"collapsed": true,
"type": "category",
"label": "Minimal Client and Server",
"items": [
{
"type": "doc",
"id": "minimal-workflow"
},
{
"type": "doc",
"id": "samples/clientbehaviour"
},
{
"type": "doc",
"id": "samples/serverbehaviour"
},
]
},
{
"collapsed": true,
"type": "category",
"label": "Jobified Client and Server",
"items": [
{
"type": "doc",
"id": "jobs",
},
{
"type": "doc",
"id": "samples/jobifiedclientbehaviour"
},
{
"type": "doc",
"id": "samples/jobifiedserverbehaviour"
},
]
},
{
"collapsed": true,
"type": "category",
"label": "Secure Client and Server",
"items": [
{
"type": "doc",
"id": "secure-connection",
},
{
"type": "doc",
"id": "samples/secureparameters"
},
{
"type": "doc",
"id": "samples/secureserverbehaviour"
},
{
"type": "doc",
"id": "samples/secureclientbehaviour"
},
]
"type": "doc",
"id": "migration",
},
{
"type": "doc",
"id": "pipelines"
"id": "using-sample",
},
{
"collapsed": true,
"type": "category",
"label": "Additional information",
"label": "Minimum client and server",
"items": [
{
"type": "doc",
"id": "connection-state"
"id": "minimal-workflow-udp",
},
{
"type": "doc",
"id": "events"
},
{
"type": "doc",
"id": "network-settings"
},
{
"type": "doc",
"id": "utp-2-faq"
"id": "minimal-workflow-ws",
}
]
],
},
{
"type": "doc",
"id": "mtt-terms"
"collapsed": true,
"type": "category",
"label": "Best practices",
"items": [
{
"type": "doc",
"id": "pipelines",
},
{
"collapsed": true,
"type": "category",
"label": "Improved client and server",
"items": [
{
"type": "doc",
"id": "jobs",
},
{
"type": "doc",
"id": "secure-connection",
},
{
"type": "doc",
"id": "integrate-logging",
},
],
},
],
},
{
"collapsed": true,
"type": "category",
"label": "Extending functionalities",
"items": [
{
"type": "doc",
"id": "network-settings",
},
],
},
],
"api": [

78
transport/about.md
Просмотреть файл

@ -3,31 +3,61 @@ id: about
title: About Unity Transport
---
Unity Transport provides the `com.unity.transport` package, used to add multiplayer and network features to your project.
The Unity Transport package (`com.unity.transport`) is a low-level networking library for multiplayer game development.
It’s the underlying protocol of both [Netcode for GameObjects](../../docs/about.md) and [Netcode for Entities](https://docs.unity3d.com/Packages/com.unity.netcode@latest), but you can also use it with a custom solution.
Unity Transport seamlessly supports all platforms the Unity Engine supports thanks to a connection-based abstraction layer (built-in network driver) provided over UDP and WebSockets.
You can set up both UDP and WebSockets with or without encryption. The following illustration shows encrypted connections with a closed padlock and unencrypted connections with an open padlock.
![Block diagram](../static/img/transport/layercake-2.png)
You can also use [pipelines](pipelines-usage.md) to leverage additional functionality, such as reliability, packet ordering, and packet fragmentation.
## Get started with Unity Transport
See the [Installation](install.md) guide if you’re new to Unity Transport. If you’re upgrading from a earlier version of Unity Transport, see [Migrating from 1.X](migration.md). Check the [Compatibility with Unity Editor versions](#compatibility-with-unity-editor-versions) table to ensure your Editor version is compatible with Transport 2.X or 1.X.
## Main Features of Transport 2.0
* Addition of WebGL: Transport package can now be used for all Unity Engine supported platforms.
* Transport users now have access to our Websocket transport implementation, with or without TLS. It is supported on every platform as Client or Server and for WebGL as Client only.
* Players on the go can now benefit from a transparent network migration, typically across cell towers. The feature is currently limited to client side and for UDP transport.
* The integration with Relay more is straightforward thanks to a new set of API that are now abstracting some boiler plate code.
* Added support for com.unity.logging package. If the package is installed, logs will go through its default logger instead of the classic UnityEngine.Debug mechanism.
### Compatibility with Unity Editor versions
Based on your Unity Editor Version
| Unity Editor Version | Transport 1.X | Transport 2.X |
|---|---|---|
| 2020 LTS | Yes | No |
| 2021 LTS | Yes | No |
| 2022.2 and LTS | Yes | Yes |
| Next | No | Yes |
Based on your Netcode Solution working with Transport
| Unity Editor Version | Netcode for GameObjects 1.2.0 + | Netcode for Entities 1.0.0 + | Custom Solutions |
|---|---|---|---|
| 2020 LTS | Transport 1.X | N/A | Transport 1.X | Transport 2.X |
| 2021 LTS | Transport 1.X | N/A | Transport 1.X | Transport 2.X |
| 2022.2 and LTS | Transport 1.X | Transport 2.X | Transport 2.X |
| Next | Transport 2.X | Transport 2.X | Transport 2.X |
Next, check out [Create a simple client and server](workflow-client-server-udp.md) and the Unity Transport [sample projects](using-sample.md).
### Requirements for Unity Transport 2.X
- Install Unity Editor version 2022.2 or later.
- Install the `com.unity.transport` package.
:::note
This package should not be confused with Unity Netcode's `NetworkTransport` abstraction. Please see Netcode's [Transports](/netcode/current/advanced-topics/transports) section for more information.
WebGL only supports Unity Transport WebSocket connections in client mode.
:::
:::unity Content Licenses
All Transport code and documentation is covered by Unity Companion License. See [Licenses](/reference/license) for more information.
:::
## Overview
![Transport Overview](/img/transport/layercake.png)
## Installing Transport
See the [installation guide](install.md) to install the `com.unity.transport` package.
## Using Transport
To learn how to use the `com.unity.transport` package in your own project, review the client and server workflows, additional information, and sample code available in this guide.
## Requirements
This version of `com.unity.transport` is compatible with the following Unity versions and platforms:
* 2020.1.2 and later.
* All platforms supported by Unity are supported, except WebGL.
:::warning
Unity Transport (the `com.unity.transport` package) is separate from the NetworkTransport abstraction in Netcode for GameObjects.
:::

388
transport/api/Unity.Networking.Transport.BaselibNetworkInterface.md
Просмотреть файл

@ -1,447 +1,407 @@
---
id: Unity.Networking.Transport.BaselibNetworkInterface
title: Unity.Networking.Transport.BaselibNetworkInterface
---
id: Unity.Networking.Transport.BaselibNetworkInterface
title: Unity.Networking.Transport.BaselibNetworkInterface
---
# Struct BaselibNetworkInterface
Default NetworkInterface implementation based on Unity's internal
Baselib UDP sockets this is ensure to work on all platforms except for
Unity's WebGL.
<div class="markdown level0 summary">
</div>
<div class="markdown level0 conceptual">
</div>
<div classs="implements">
##### Implements
<div>
INetworkInterface
</div>
<div>
System.IDisposable
</div>
</div>
<div class="inheritedMembers">
##### Inherited Members
<div>
ValueType.Equals(Object)
System.ValueType.Equals(System.Object)
</div>
<div>
ValueType.GetHashCode()
</div>
<div>
System.ValueType.GetHashCode()
ValueType.ToString()
</div>
<div>
Object.Equals(Object, Object)
</div>
System.ValueType.ToString()
<div>
Object.GetType()
</div>
<div>
Object.ReferenceEquals(Object, Object)
System.Object.Equals(System.Object, System.Object)
</div>
</div>
##### **Namespace**: System.Dynamic.ExpandoObject
System.Object.GetType()
System.Object.ReferenceEquals(System.Object, System.Object)
###### **Namespace**: Unity.Networking.Transport
###### **Assembly**: Transport.dll
##### **Assembly**: transport.dll
##### Syntax
``` lang-csharp
public struct BaselibNetworkInterface : INetworkInterface, IDisposable
```
##
### DefaultParameters
### Fields
<div class="markdown level1 summary">
#### DefaultParameters
</div>
<div class="markdown level1 conceptual">
Default Parameters for BaselibNetworkInterface
##### Declaration
</div>
#### Declaration
``` lang-csharp
public static BaselibNetworkParameter DefaultParameters
```
##### Field Value
#### Field Value
| Type | Description |
|-------------------------|-------------|
| BaselibNetworkParameter | |
### Properties
##
#### IsCreated
### IsCreated
<div class="markdown level1 summary">
Gets if the interface has been created.
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public readonly bool IsCreated { get; }
```
##### Property Value
#### Property Value
| Type | Description |
|----------------|-------------|
| System.Boolean | |
#### LocalEndPoint
### LocalEndPoint
<div class="markdown level1 summary">
Returns the local endpoint the BaselibNetworkInterface is bound to.
Returns the local endpoint.
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public readonly NetworkInterfaceEndPoint LocalEndPoint { get; }
```
##### Property Value
#### Property Value
| Type | Description |
|--------------------------|--------------------------|
| NetworkInterfaceEndPoint | NetworkInterfaceEndPoint |
### Methods
##
#### Bind(NetworkInterfaceEndPoint)
### Bind(NetworkInterfaceEndPoint)
<div class="markdown level1 summary">
Binds the medium to a specific endpoint.
Binds the BaselibNetworkInterface to the endpoint passed.
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public int Bind(NetworkInterfaceEndPoint endpoint)
```
#### Parameters
| Type | Name | Description |
|--------------------------|----------|------------------------------|
| NetworkInterfaceEndPoint | endpoint | A valid ipv4 or ipv6 address |
##### Parameters
#### Returns
| Type | Name | Description |
|--------------------------|----------|-----------------------------------|
| NetworkInterfaceEndPoint | endpoint | A valid NetworkInterfaceEndPoint. |
| Type | Description |
|--------------|-------------|
| System.Int32 | int |
##### Returns
### CreateInterfaceEndPoint(NetworkEndPoint, out NetworkInterfaceEndPoint)
| Type | Description |
|--------------|-----------------------|
| System.Int32 | Returns 0 on success. |
<div class="markdown level1 summary">
#### CreateInterfaceEndPoint(NetworkEndPoint, out NetworkInterfaceEndPoint)
Creates a interface endpoint.
</div>
Converts a generic NetworkEndPoint to its NetworkInterfaceEndPoint
version for the BaselibNetworkInterface.
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public int CreateInterfaceEndPoint(NetworkEndPoint address, out NetworkInterfaceEndPoint endpoint)
```
#### Parameters
| Type | Name | Description |
|--------------------------|----------|-------------|
| NetworkEndPoint | address | |
| NetworkInterfaceEndPoint | endpoint | |
##### Parameters
#### Returns
| Type | Name | Description |
|--------------------------|----------|------------------------------------------|
| NetworkEndPoint | address | The NetworkEndPoint endpoint to convert. |
| NetworkInterfaceEndPoint | endpoint | |
| Type | Description |
|--------------|--------------------------|
| System.Int32 | NetworkInterfaceEndPoint |
##### Returns
### CreateSendInterface()
| Type | Description |
|--------------|------------------------------------------------------------|
| System.Int32 | returns 0 on success and sets the converted endpoint value |
<div class="markdown level1 summary">
#### CreateSendInterface()
</div>
<div class="markdown level1 conceptual">
Creates the send interface
##### Declaration
</div>
#### Declaration
``` lang-csharp
public NetworkSendInterface CreateSendInterface()
```
#### Returns
| Type | Description |
|----------------------|-------------|
| NetworkSendInterface | |
##### Returns
### Dispose()
| Type | Description |
|----------------------|----------------------------|
| NetworkSendInterface | The network send interface |
<div class="markdown level1 summary">
#### Dispose()
</div>
<div class="markdown level1 conceptual">
Disposes this instance
##### Declaration
</div>
#### Declaration
``` lang-csharp
public void Dispose()
```
### GetGenericEndPoint(NetworkInterfaceEndPoint)
<div class="markdown level1 summary">
#### GetGenericEndPoint(NetworkInterfaceEndPoint)
</div>
<div class="markdown level1 conceptual">
Converts a NetworkInterfaceEndPoint to its generic NetworkEndPoint
version.
##### Declaration
</div>
#### Declaration
``` lang-csharp
public NetworkEndPoint GetGenericEndPoint(NetworkInterfaceEndPoint endpoint)
```
#### Parameters
| Type | Name | Description |
|--------------------------|----------|-------------|
| NetworkInterfaceEndPoint | endpoint | |
##### Parameters
#### Returns
| Type | Name | Description |
|--------------------------|----------|---------------------------------------------------|
| NetworkInterfaceEndPoint | endpoint | The NetworkInterfaceEndPoint endpoint to convert. |
| Type | Description |
|-----------------|-------------|
| NetworkEndPoint | |
##### Returns
| Type | Description |
|-----------------|---------------------------------------|
| NetworkEndPoint | Returns the converted endpoint value. |
#### Initialize(NetworkSettings)
### Initialize(NetworkSettings)
<div class="markdown level1 summary">
Initializes a instance of the BaselibNetworkInterface struct.
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public int Initialize(NetworkSettings settings)
```
##### Parameters
#### Parameters
| Type | Name | Description |
|-----------------|----------|-------------|
| NetworkSettings | settings | |
##### Returns
#### Returns
| Type | Description |
|--------------|-----------------------|
| System.Int32 | Returns 0 on succees. |
| Type | Description |
|--------------|-------------|
| System.Int32 | |
#### Listen()
### Listen()
<div class="markdown level1 summary">
Listens on the socket, currently this Interface doesn't support
listening as its UDP based.
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public int Listen()
```
##### Returns
#### Returns
| Type | Description |
|--------------|-------------|
| System.Int32 | Returns 0 |
| System.Int32 | |
#### ScheduleReceive(NetworkPacketReceiver, JobHandle)
### ScheduleReceive(NetworkPacketReceiver, JobHandle)
<div class="markdown level1 summary">
Schedule a ReceiveJob. This is used to read data from your supported
medium and pass it to the AppendData function supplied by NetworkDriver
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public JobHandle ScheduleReceive(NetworkPacketReceiver receiver, JobHandle dep)
```
#### Parameters
| Type | Name | Description |
|-----------------------|----------|-------------|
| NetworkPacketReceiver | receiver | |
| JobHandle | dep | |
##### Parameters
#### Returns
| Type | Name | Description |
|-----------------------|----------|--------------------------------------------------|
| NetworkPacketReceiver | receiver | A NetworkDriver used to parse the data received. |
| JobHandle | dep | A to any dependency we might have. |
| Type | Description |
|-----------|-------------|
| JobHandle | |
##### Returns
### ScheduleSend(NativeQueue&lt;QueuedSendMessage&gt;, JobHandle)
| Type | Description |
|-----------|---------------------------------------------|
| JobHandle | A to our newly created ScheduleReceive Job. |
<div class="markdown level1 summary">
#### ScheduleSend(NativeQueue\<QueuedSendMessage\>, JobHandle)
</div>
<div class="markdown level1 conceptual">
Schedule a SendJob. This is used to flush send queues to your supported
medium
##### Declaration
</div>
#### Declaration
``` lang-csharp
public JobHandle ScheduleSend(NativeQueue<QueuedSendMessage> sendQueue, JobHandle dep)
```
#### Parameters
| Type | Name | Description |
|----------------------------------|-----------|-------------|
| NativeQueue&lt;QueuedSendMessage&gt;| sendQueue | |
| JobHandle | dep | |
##### Parameters
#### Returns
| Type | Name | Description |
|----------------------------------|-----------|------------------------------------------------------------|
| NativeQueue\<QueuedSendMessage\> | sendQueue | The send queue which can be used to emulate parallel send. |
| JobHandle | dep | A to any dependency we might have. |
##### Returns
| Type | Description |
|-----------|------------------------------------------|
| JobHandle | A to our newly created ScheduleSend Job. |
| Type | Description |
|-----------|-------------|
| JobHandle | |
### Implements
<div>
INetworkInterface
</div>
<div>
System.IDisposable
</div>

153
transport/api/Unity.Networking.Transport.BaselibNetworkParameter.md
Просмотреть файл

@ -1,183 +1,173 @@
---
id: Unity.Networking.Transport.BaselibNetworkParameter
title: Unity.Networking.Transport.BaselibNetworkParameter
---
id: Unity.Networking.Transport.BaselibNetworkParameter
title: Unity.Networking.Transport.BaselibNetworkParameter
---
<div class="markdown level0 summary">
# Struct BaselibNetworkParameter
Network Parameters used to set queue and payload sizes for
BaselibNetworkInterface
</div>
<div class="markdown level0 conceptual">
</div>
<div classs="implements">
##### Implements
<div>
INetworkParameter
</div>
<div>
IValidatableNetworkParameter
</div>
</div>
<div class="inheritedMembers">
##### Inherited Members
<div>
ValueType.Equals(Object)
System.ValueType.Equals(System.Object)
</div>
<div>
ValueType.GetHashCode()
</div>
<div>
System.ValueType.GetHashCode()
ValueType.ToString()
</div>
<div>
Object.Equals(Object, Object)
</div>
System.ValueType.ToString()
<div>
Object.GetType()
</div>
<div>
Object.ReferenceEquals(Object, Object)
System.Object.Equals(System.Object, System.Object)
</div>
</div>
##### **Namespace**: System.Dynamic.ExpandoObject
System.Object.GetType()
System.Object.ReferenceEquals(System.Object, System.Object)
###### **Namespace**: Unity.Networking.Transport
###### **Assembly**: Transport.dll
##### **Assembly**: transport.dll
##### Syntax
``` lang-csharp
public struct BaselibNetworkParameter : INetworkParameter
public struct BaselibNetworkParameter : INetworkParameter, IValidatableNetworkParameter
```
##
### maximumPayloadSize
### Fields
<div class="markdown level1 summary">
#### maximumPayloadSize
</div>
<div class="markdown level1 conceptual">
The maximum payload size.
##### Declaration
</div>
#### Declaration
``` lang-csharp
public uint maximumPayloadSize
```
##### Field Value
#### Field Value
| Type | Description |
|---------------|-------------|
| System.UInt32 | |
#### receiveQueueCapacity
### receiveQueueCapacity
<div class="markdown level1 summary">
The maximum number of receiving packets that the BaselibNetworkInterface
can process in a single update iteration.
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public int receiveQueueCapacity
```
##### Field Value
#### Field Value
| Type | Description |
|--------------|-------------|
| System.Int32 | |
#### sendQueueCapacity
### sendQueueCapacity
<div class="markdown level1 summary">
The maximum number of sending packets that the BaselibNetworkInterface
can process in a single update iteration.
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public int sendQueueCapacity
```
##### Field Value
#### Field Value
| Type | Description |
|--------------|-------------|
| System.Int32 | |
### Methods
##
#### Validate()
### Validate()
<div class="markdown level1 summary">
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public bool Validate()
```
##### Returns
#### Returns
| Type | Description |
|----------------|-------------|
@ -185,11 +175,14 @@ public bool Validate()
### Implements
<div>
INetworkParameter
</div>
<div>
IValidatableNetworkParameter
</div>

140
transport/api/Unity.Networking.Transport.BaselibNetworkParameterExtensions.md
Просмотреть файл

@ -1,157 +1,149 @@
---
id: Unity.Networking.Transport.BaselibNetworkParameterExtensions
title: Unity.Networking.Transport.BaselibNetworkParameterExtensions
---
id: Unity.Networking.Transport.BaselibNetworkParameterExtensions
title: Unity.Networking.Transport.BaselibNetworkParameterExtensions
---
<div class="markdown level0 summary">
# Class BaselibNetworkParameterExtensions
</div>
<div class="markdown level0 conceptual">
</div>
<div class="inheritance">
##### Inheritance
<div class="level0">
System.Object
System.Dynamic.ExpandoObject
</div>
<div class="level1">
System.Dynamic.ExpandoObject
BaselibNetworkParameterExtensions
</div>
</div>
<div class="inheritedMembers">
##### Inherited Members
<div>
Object.Equals(Object)
System.Object.Equals(System.Object)
</div>
<div>
Object.Equals(Object, Object)
</div>
<div>
System.Object.Equals(System.Object, System.Object)
Object.GetHashCode()
</div>
<div>
Object.GetType()
</div>
System.Object.GetHashCode()
<div>
Object.MemberwiseClone()
</div>
<div>
Object.ReferenceEquals(Object, Object)
System.Object.GetType()
</div>
<div>
Object.ToString()
</div>
</div>
System.Object.MemberwiseClone()
##### **Namespace**: System.Dynamic.ExpandoObject
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
###### **Namespace**: Unity.Networking.Transport
###### **Assembly**: Transport.dll
##### **Assembly**: transport.dll
##### Syntax
``` lang-csharp
public static class BaselibNetworkParameterExtensions
```
##
### GetBaselibNetworkInterfaceParameters(ref NetworkSettings)
### Methods
<div class="markdown level1 summary">
#### GetBaselibNetworkInterfaceParameters(ref NetworkSettings)
</div>
<div class="markdown level1 conceptual">
Gets the BaselibNetworkParameter
##### Declaration
</div>
#### Declaration
``` lang-csharp
public static BaselibNetworkParameter GetBaselibNetworkInterfaceParameters(this ref NetworkSettings settings)
```
##### Parameters
#### Parameters
| Type | Name | Description |
|-----------------|----------|-------------|
| NetworkSettings | settings | |
##### Returns
#### Returns
| Type | Description |
|-------------------------|--------------------------------------------------------------------|
| BaselibNetworkParameter | Returns the BaselibNetworkParameter values for the NetworkSettings |
| Type | Description |
|-------------------------|-------------|
| BaselibNetworkParameter | |
#### WithBaselibNetworkInterfaceParameters(ref NetworkSettings, Int32, Int32, UInt32)
### WithBaselibNetworkInterfaceParameters(ref NetworkSettings, Int32, Int32, UInt32)
<div class="markdown level1 summary">
Sets the BaselibNetworkParameter values for the NetworkSettings
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public static ref NetworkSettings WithBaselibNetworkInterfaceParameters(this ref NetworkSettings settings, int receiveQueueCapacity = 64, int sendQueueCapacity = 64, uint maximumPayloadSize = 2000U)
```
#### Parameters
| Type | Name | Description |
|-----------------|----------------------|-------------|
| NetworkSettings | settings | |
| System.Int32 | receiveQueueCapacity | |
| System.Int32 | sendQueueCapacity | |
| System.UInt32 | maximumPayloadSize | |
##### Parameters
| Type | Name | Description |
|-----------------|----------------------|----------------------|
| NetworkSettings | settings | |
| System.Int32 | receiveQueueCapacity | receiveQueueCapacity |
| System.Int32 | sendQueueCapacity | sendQueueCapacity |
| System.UInt32 | maximumPayloadSize | maximumPayloadSize |
##### Returns
#### Returns
| Type | Description |
|-----------------|-------------|
| NetworkSettings | |

195
transport/api/Unity.Networking.Transport.CommonNetworkParametersExtensions.md
Просмотреть файл

@ -1,223 +1,210 @@
---
id: Unity.Networking.Transport.CommonNetworkParametersExtensions
title: Unity.Networking.Transport.CommonNetworkParametersExtensions
---
id: Unity.Networking.Transport.CommonNetworkParametersExtensions
title: Unity.Networking.Transport.CommonNetworkParametersExtensions
---
<div class="markdown level0 summary">
# Class CommonNetworkParametersExtensions
</div>
<div class="markdown level0 conceptual">
</div>
<div class="inheritance">
##### Inheritance
<div class="level0">
System.Object
System.Dynamic.ExpandoObject
</div>
<div class="level1">
System.Dynamic.ExpandoObject
CommonNetworkParametersExtensions
</div>
</div>
<div class="inheritedMembers">
##### Inherited Members
<div>
Object.Equals(Object)
System.Object.Equals(System.Object)
</div>
<div>
Object.Equals(Object, Object)
</div>
<div>
System.Object.Equals(System.Object, System.Object)
Object.GetHashCode()
</div>
<div>
Object.GetType()
</div>
System.Object.GetHashCode()
<div>
Object.MemberwiseClone()
</div>
<div>
Object.ReferenceEquals(Object, Object)
System.Object.GetType()
</div>
<div>
Object.ToString()
</div>
</div>
System.Object.MemberwiseClone()
##### **Namespace**: System.Dynamic.ExpandoObject
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
###### **Namespace**: Unity.Networking.Transport
###### **Assembly**: Transport.dll
##### **Assembly**: transport.dll
##### Syntax
``` lang-csharp
public static class CommonNetworkParametersExtensions
```
##
### GetDataStreamParameters(ref NetworkSettings)
### Methods
<div class="markdown level1 summary">
#### GetDataStreamParameters(ref NetworkSettings)
</div>
<div class="markdown level1 conceptual">
Gets the NetworkDataStreamParameter
##### Declaration
</div>
#### Declaration
``` lang-csharp
public static NetworkDataStreamParameter GetDataStreamParameters(this ref NetworkSettings settings)
```
##### Parameters
#### Parameters
| Type | Name | Description |
|-----------------|----------|-------------|
| NetworkSettings | settings | |
##### Returns
#### Returns
| Type | Description |
|----------------------------|-----------------------------------------------------------------------|
| NetworkDataStreamParameter | Returns the NetworkDataStreamParameter values for the NetworkSettings |
| Type | Description |
|----------------------------|-------------|
| NetworkDataStreamParameter | |
#### GetNetworkConfigParameters(ref NetworkSettings)
### GetNetworkConfigParameters(ref NetworkSettings)
<div class="markdown level1 summary">
Gets the NetworkConfigParameter
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public static NetworkConfigParameter GetNetworkConfigParameters(this ref NetworkSettings settings)
```
##### Parameters
#### Parameters
| Type | Name | Description |
|-----------------|----------|-------------|
| NetworkSettings | settings | |
##### Returns
#### Returns
| Type | Description |
|------------------------|-------------------------------------------------------------------|
| NetworkConfigParameter | Returns the NetworkConfigParameter values for the NetworkSettings |
| Type | Description |
|------------------------|-------------|
| NetworkConfigParameter | |
#### WithDataStreamParameters(ref NetworkSettings, Int32)
### WithDataStreamParameters(ref NetworkSettings, Int32)
<div class="markdown level1 summary">
Sets the NetworkDataStreamParameter values for the NetworkSettings
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public static ref NetworkSettings WithDataStreamParameters(this ref NetworkSettings settings, int size = 0)
```
##### Parameters
#### Parameters
| Type | Name | Description |
|-----------------|----------|-------------|
| NetworkSettings | settings | |
| System.Int32 | size | size |
| System.Int32 | size | |
##### Returns
#### Returns
| Type | Description |
|-----------------|-------------|
| NetworkSettings | |
#### WithNetworkConfigParameters(ref NetworkSettings, Int32, Int32, Int32, Int32, Int32, Int32)
### WithNetworkConfigParameters(ref NetworkSettings, Int32, Int32, Int32, Int32, Int32, Int32, Int32)
<div class="markdown level1 summary">
Sets the NetworkConfigParameter values for the NetworkSettings
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public static ref NetworkSettings WithNetworkConfigParameters(this ref NetworkSettings settings, int connectTimeoutMS = 1000, int maxConnectAttempts = 60, int disconnectTimeoutMS = 30000, int heartbeatTimeoutMS = 500, int maxFrameTimeMS = 0, int fixedFrameTimeMS = 0)
public static ref NetworkSettings WithNetworkConfigParameters(this ref NetworkSettings settings, int connectTimeoutMS = 1000, int maxConnectAttempts = 60, int disconnectTimeoutMS = 30000, int heartbeatTimeoutMS = 500, int reconnectionTimeoutMS = 2000, int maxFrameTimeMS = 0, int fixedFrameTimeMS = 0)
```
#### Parameters
| Type | Name | Description |
|-----------------|-----------------------|-------------|
| NetworkSettings | settings | |
| System.Int32 | connectTimeoutMS | |
| System.Int32 | maxConnectAttempts | |
| System.Int32 | disconnectTimeoutMS | |
| System.Int32 | heartbeatTimeoutMS | |
| System.Int32 | reconnectionTimeoutMS | |
| System.Int32 | maxFrameTimeMS | |
| System.Int32 | fixedFrameTimeMS | |
##### Parameters
| Type | Name | Description |
|-----------------|---------------------|---------------------|
| NetworkSettings | settings | |
| System.Int32 | connectTimeoutMS | connectTimeoutMS |
| System.Int32 | maxConnectAttempts | maxConnectAttempts |
| System.Int32 | disconnectTimeoutMS | disconnectTimeoutMS |
| System.Int32 | heartbeatTimeoutMS | heartbeatTimeoutMS |
| System.Int32 | maxFrameTimeMS | maxFrameTimeMS |
| System.Int32 | fixedFrameTimeMS | fixedFrameTimeMS |
##### Returns
#### Returns
| Type | Description |
|-----------------|-------------|
| NetworkSettings | |

804
transport/api/Unity.Networking.Transport.DataStreamReader.md
Просмотреть файл

Разница между файлами не показана из-за своего большого размера Загрузить разницу

846
transport/api/Unity.Networking.Transport.DataStreamWriter.md
Просмотреть файл

Разница между файлами не показана из-за своего большого размера Загрузить разницу

59
transport/api/Unity.Networking.Transport.Error.DisconnectReason.md
Просмотреть файл

@ -1,57 +1,34 @@
---
id: Unity.Networking.Transport.Error.DisconnectReason
title: Unity.Networking.Transport.Error.DisconnectReason
---
id: Unity.Networking.Transport.Error.DisconnectReason
title: Unity.Networking.Transport.Error.DisconnectReason
---
<div class="markdown level0 summary">
# Enum DisconnectReason
DisconnectReason enumerates all disconnect reasons.
</div>
<div class="markdown level0 conceptual">
</div>
##### **Namespace**: System.Dynamic.ExpandoObject
###### **Namespace**: Unity.Networking.Transport.Error
###### **Assembly**: Transport.dll
##### **Assembly**: transport.dll
##### Syntax
``` lang-csharp
public enum DisconnectReason : byte
```
##
### Fields
Name
Description
ClosedByRemote
Count
Used internally to track the number of reasons. Keep last.
Default
MaxConnectionAttempts
Indicates the connection failed to establish after too many failed
attempts (see maxConnectAttempts).
Timeout
| Name | Description |
|-----------------------|---------------------------------------------------------------------------------------|
| ClosedByRemote | Indicates the connection was closed remotely. |
| Count | Used only for count. Keep last and don't assign explicit values |
| Default | Indicates a normal disconnection as a result of calling Disconnect on the connection. |
| MaxConnectionAttempts | Indicates the connection failed to establish a connection after maxConnectAttempts. |
| Timeout | Indicates the connection timed out. |

96
transport/api/Unity.Networking.Transport.Error.StatusCode.md
Просмотреть файл

@ -1,89 +1,37 @@
---
id: Unity.Networking.Transport.Error.StatusCode
title: Unity.Networking.Transport.Error.StatusCode
---
id: Unity.Networking.Transport.Error.StatusCode
title: Unity.Networking.Transport.Error.StatusCode
---
<div class="markdown level0 summary">
# Enum StatusCode
</div>
<div class="markdown level0 conceptual">
Status code returned by many functions in the API.
</div>
##### **Namespace**: System.Dynamic.ExpandoObject
###### **Namespace**: Unity.Networking.Transport.Error
###### **Assembly**: Transport.dll
##### **Assembly**: transport.dll
##### Syntax
``` lang-csharp
public enum StatusCode
```
##
##### **Remarks**
Any value less than 0 denotes a failure.
### Fields
Name
Description
NetworkArgumentMismatch
NetworkDriverParallelForErr
Tried to process the same connection multiple times in a parallel job.
NetworkHeaderInvalid
A packet's header is invalid.
NetworkIdMismatch
Unknown connection (internal ID doesn't exist).
NetworkPacketOverflow
Packet data is too large to handle.
NetworkSendHandleInvalid
Internal send handle is invalid.
NetworkSendQueueFull
Network send queue is full.
NetworkStateMismatch
Invalid operation given connection's state.
NetworkVersionMismatch
Unknown connection (internal ID in use by newer connection).
Success
Success; no error encountered.
| Name | Description |
|-----------------------------|-------------|
| NetworkArgumentMismatch | |
| NetworkDriverParallelForErr | |
| NetworkHeaderInvalid | |
| NetworkIdMismatch | |
| NetworkPacketOverflow | |
| NetworkSendHandleInvalid | |
| NetworkSendQueueFull | |
| NetworkStateMismatch | |
| NetworkVersionMismatch | |
| Success | |

34
transport/api/Unity.Networking.Transport.Error.md
Просмотреть файл

@ -1,32 +1,34 @@
---
id: Unity.Networking.Transport.Error
title: Unity.Networking.Transport.Error
---
id: Unity.Networking.Transport.Error
title: Unity.Networking.Transport.Error
---
##
# Namespace Unity.Networking.Transport.Error
<div class="markdown level0 summary">
</div>
<div class="markdown level0 conceptual">
</div>
<div class="markdown level0 remarks">
</div>
##
### Unity.Networking.Transport.Error.DisconnectReason
<div class="section">
### Enums
#### DisconnectReason
#### StatusCode
Status code returned by many functions in the API.
DisconnectReason enumerates all disconnect reasons.
</div>
### Unity.Networking.Transport.Error.StatusCode
<div class="section">
</div>

135
transport/api/Unity.Networking.Transport.FragmentationPipelineStage.FragContext.md
Просмотреть файл

@ -1,173 +1,154 @@
---
id: Unity.Networking.Transport.FragmentationPipelineStage.FragContext
title: Unity.Networking.Transport.FragmentationPipelineStage.FragContext
---
id: Unity.Networking.Transport.FragmentationPipelineStage.FragContext
title: Unity.Networking.Transport.FragmentationPipelineStage.FragContext
---
<div class="markdown level0 summary">
# Struct FragmentationPipelineStage.FragContext
The fragmentation stage's internal context.
</div>
<div class="markdown level0 conceptual">
</div>
<div class="inheritedMembers">
##### Inherited Members
<div>
ValueType.Equals(Object)
System.ValueType.Equals(System.Object)
</div>
<div>
ValueType.GetHashCode()
</div>
<div>
System.ValueType.GetHashCode()
ValueType.ToString()
</div>
<div>
Object.Equals(Object, Object)
</div>
System.ValueType.ToString()
<div>
Object.GetType()
</div>
<div>
Object.ReferenceEquals(Object, Object)
System.Object.Equals(System.Object, System.Object)
</div>
</div>
##### **Namespace**: System.Dynamic.ExpandoObject
System.Object.GetType()
System.Object.ReferenceEquals(System.Object, System.Object)
###### **Namespace**: Unity.Networking.Transport
###### **Assembly**: Transport.dll
##### **Assembly**: transport.dll
##### Syntax
``` lang-csharp
public struct FragContext
```
##
### endIndex
### Fields
<div class="markdown level1 summary">
#### endIndex
</div>
<div class="markdown level1 conceptual">
Ending index.
##### Declaration
</div>
#### Declaration
``` lang-csharp
public int endIndex
```
##### Field Value
#### Field Value
| Type | Description |
|--------------|-------------|
| System.Int32 | |
#### packetError
### packetError
<div class="markdown level1 summary">
Whether there's an error with a packet.
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public bool packetError
```
##### Field Value
#### Field Value
| Type | Description |
|----------------|-------------|
| System.Boolean | |
#### sequence
### sequence
<div class="markdown level1 summary">
Sequence number.
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public int sequence
```
##### Field Value
#### Field Value
| Type | Description |
|--------------|-------------|
| System.Int32 | |
#### startIndex
### startIndex
<div class="markdown level1 summary">
Starting index.
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public int startIndex
```
##### Field Value
#### Field Value
| Type | Description |
|--------------|-------------|
| System.Int32 | |

136
transport/api/Unity.Networking.Transport.FragmentationPipelineStage.md
Просмотреть файл

@ -1,156 +1,140 @@
---
id: Unity.Networking.Transport.FragmentationPipelineStage
title: Unity.Networking.Transport.FragmentationPipelineStage
---
id: Unity.Networking.Transport.FragmentationPipelineStage
title: Unity.Networking.Transport.FragmentationPipelineStage
---
<div class="markdown level0 summary">
# Struct FragmentationPipelineStage
</div>
<div class="markdown level0 conceptual">
</div>
<div classs="implements">
##### Implements
<div>
INetworkPipelineStage
</div>
</div>
<div class="inheritedMembers">
##### Inherited Members
<div>
ValueType.Equals(Object)
System.ValueType.Equals(System.Object)
</div>
<div>
ValueType.GetHashCode()
</div>
<div>
System.ValueType.GetHashCode()
ValueType.ToString()
</div>
<div>
Object.Equals(Object, Object)
</div>
System.ValueType.ToString()
<div>
Object.GetType()
</div>
<div>
Object.ReferenceEquals(Object, Object)
System.Object.Equals(System.Object, System.Object)
</div>
</div>
##### **Namespace**: System.Dynamic.ExpandoObject
System.Object.GetType()
System.Object.ReferenceEquals(System.Object, System.Object)
###### **Namespace**: Unity.Networking.Transport
###### **Assembly**: Transport.dll
##### **Assembly**: transport.dll
##### Syntax
``` lang-csharp
public struct FragmentationPipelineStage : INetworkPipelineStage
```
##
### StaticSize
### Properties
<div class="markdown level1 summary">
#### StaticSize
</div>
<div class="markdown level1 conceptual">
Gets the value of the static size
##### Declaration
</div>
#### Declaration
``` lang-csharp
public readonly int StaticSize { get; }
```
##### Property Value
#### Property Value
| Type | Description |
|--------------|-------------|
| System.Int32 | |
### Methods
##
#### StaticInitialize(Byte\*, Int32, NetworkSettings)
### StaticInitialize(Byte\*, Int32, NetworkSettings)
<div class="markdown level1 summary">
Statics the initialize using the specified static instance buffer
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public NetworkPipelineStage StaticInitialize(byte *staticInstanceBuffer, int staticInstanceBufferLength, NetworkSettings settings)
```
#### Parameters
| Type | Name | Description |
|-----------------|----------------------------|-------------|
| System.Byte\* | staticInstanceBuffer | |
| System.Int32 | staticInstanceBufferLength | |
| NetworkSettings | settings | |
##### Parameters
#### Returns
| Type | Name | Description |
|-----------------|----------------------------|-----------------------------------|
| System.Byte\* | staticInstanceBuffer | The static instance buffer |
| System.Int32 | staticInstanceBufferLength | The static instance buffer length |
| NetworkSettings | settings | The NetworkSettings |
##### Returns
| Type | Description |
|----------------------|----------------------------|
| NetworkPipelineStage | The network pipeline stage |
##### Exceptions
| Type | Condition |
|----------------------------------|------------------------------------------------------------------------------------------------------------------------------------|
| System.InvalidOperationException | Please specify a FragmentationUtility.Parameters with a PayloadCapacity greater than MTU, which is {NetworkParameterConstants.MTU} |
| Type | Description |
|----------------------|-------------|
| NetworkPipelineStage | |
### Implements
<div>
INetworkPipelineStage
</div>

239
transport/api/Unity.Networking.Transport.INetworkInterface.md
Просмотреть файл

@ -1,323 +1,286 @@
---
id: Unity.Networking.Transport.INetworkInterface
title: Unity.Networking.Transport.INetworkInterface
---
id: Unity.Networking.Transport.INetworkInterface
title: Unity.Networking.Transport.INetworkInterface
---
<div class="markdown level0 summary">
# Interface INetworkInterface
Interface for implementing a low-level networking interface see
BaselibNetworkInterface as an example
</div>
<div class="markdown level0 conceptual">
</div>
<div class="inheritedMembers">
##### Inherited Members
<div>
IDisposable.Dispose()
System.IDisposable.Dispose()
</div>
</div>
##### **Namespace**: System.Dynamic.ExpandoObject
###### **Namespace**: Unity.Networking.Transport
###### **Assembly**: Transport.dll
##### **Assembly**: transport.dll
##### Syntax
``` lang-csharp
public interface INetworkInterface : IDisposable
```
##
### LocalEndPoint
### Properties
<div class="markdown level1 summary">
#### LocalEndPoint
</div>
<div class="markdown level1 conceptual">
Gets the value of the local end point
##### Declaration
</div>
#### Declaration
``` lang-csharp
NetworkInterfaceEndPoint LocalEndPoint { get; }
```
##### Property Value
#### Property Value
| Type | Description |
|--------------------------|-------------|
| NetworkInterfaceEndPoint | |
### Methods
##
#### Bind(NetworkInterfaceEndPoint)
### Bind(NetworkInterfaceEndPoint)
<div class="markdown level1 summary">
Binds the medium to a specific endpoint.
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
int Bind(NetworkInterfaceEndPoint endpoint)
```
##### Parameters
#### Parameters
| Type | Name | Description |
|--------------------------|----------|-----------------------------------|
| NetworkInterfaceEndPoint | endpoint | A valid NetworkInterfaceEndPoint. |
##### Returns
#### Returns
| Type | Description |
|--------------|--------------|
| System.Int32 | 0 on Success |
#### CreateInterfaceEndPoint(NetworkEndPoint, out NetworkInterfaceEndPoint)
### CreateInterfaceEndPoint(NetworkEndPoint, out NetworkInterfaceEndPoint)
<div class="markdown level1 summary">
Creates the interface end point using the specified address
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
int CreateInterfaceEndPoint(NetworkEndPoint address, out NetworkInterfaceEndPoint endpoint)
```
#### Parameters
| Type | Name | Description |
|--------------------------|----------|-------------|
| NetworkEndPoint | address | |
| NetworkInterfaceEndPoint | endpoint | |
##### Parameters
| Type | Name | Description |
|--------------------------|----------|--------------|
| NetworkEndPoint | address | The address |
| NetworkInterfaceEndPoint | endpoint | The endpoint |
##### Returns
#### Returns
| Type | Description |
|--------------|-------------|
| System.Int32 | The int |
| System.Int32 | |
#### CreateSendInterface()
### CreateSendInterface()
<div class="markdown level1 summary">
Creates the send interface
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
NetworkSendInterface CreateSendInterface()
```
#### Returns
| Type | Description |
|----------------------|-------------|
| NetworkSendInterface | |
##### Returns
### GetGenericEndPoint(NetworkInterfaceEndPoint)
| Type | Description |
|----------------------|----------------------------|
| NetworkSendInterface | The network send interface |
<div class="markdown level1 summary">
#### GetGenericEndPoint(NetworkInterfaceEndPoint)
</div>
<div class="markdown level1 conceptual">
Gets the generic end point using the specified endpoint
##### Declaration
</div>
#### Declaration
``` lang-csharp
NetworkEndPoint GetGenericEndPoint(NetworkInterfaceEndPoint endpoint)
```
#### Parameters
| Type | Name | Description |
|--------------------------|----------|-------------|
| NetworkInterfaceEndPoint | endpoint | |
##### Parameters
#### Returns
| Type | Name | Description |
|--------------------------|----------|--------------|
| NetworkInterfaceEndPoint | endpoint | The endpoint |
| Type | Description |
|-----------------|-------------|
| NetworkEndPoint | |
##### Returns
### Initialize(NetworkSettings)
| Type | Description |
|-----------------|-----------------------|
| NetworkEndPoint | The network end point |
<div class="markdown level1 summary">
#### Initialize(NetworkSettings)
</div>
<div class="markdown level1 conceptual">
Initializes the interfacing passing in optional INetworkParameter
##### Declaration
</div>
#### Declaration
``` lang-csharp
int Initialize(NetworkSettings settings)
```
##### Parameters
#### Parameters
| Type | Name | Description |
|-----------------|----------|-------------|
| NetworkSettings | settings | |
##### Returns
#### Returns
| Type | Description |
|--------------|-------------|
| System.Int32 | The int |
| System.Int32 | |
#### Listen()
### Listen()
<div class="markdown level1 summary">
Start listening for incoming connections. This is normally a no-op for
real UDP sockets.
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
int Listen()
```
##### Returns
#### Returns
| Type | Description |
|--------------|--------------|
| System.Int32 | 0 on Success |
#### ScheduleReceive(NetworkPacketReceiver, JobHandle)
### ScheduleReceive(NetworkPacketReceiver, JobHandle)
<div class="markdown level1 summary">
Schedule a ReceiveJob. This is used to read data from your supported
medium and pass it to the AppendData function supplied by NetworkDriver
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
JobHandle ScheduleReceive(NetworkPacketReceiver receiver, JobHandle dep)
```
##### Parameters
#### Parameters
| Type | Name | Description |
|-----------------------|----------|--------------------------------------------------|
| NetworkPacketReceiver | receiver | A NetworkDriver used to parse the data received. |
| JobHandle | dep | A to any dependency we might have. |
##### Returns
#### Returns
| Type | Description |
|-----------|---------------------------------------------|
| JobHandle | A to our newly created ScheduleReceive Job. |
#### ScheduleSend(NativeQueue\<QueuedSendMessage\>, JobHandle)
### ScheduleSend(NativeQueue\&lt;QueuedSendMessage&gt;, JobHandle)
<div class="markdown level1 summary">
Schedule a SendJob. This is used to flush send queues to your supported
medium
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
JobHandle ScheduleSend(NativeQueue<QueuedSendMessage> sendQueue, JobHandle dep)
```
##### Parameters
#### Parameters
| Type | Name | Description |
|----------------------------------|-----------|------------------------------------------------------------|
| NativeQueue\<QueuedSendMessage\> | sendQueue | The send queue which can be used to emulate parallel send. |
| NativeQueue\&lt;QueuedSendMessage&gt; | sendQueue | The send queue which can be used to emulate parallel send. |
| JobHandle | dep | A to any dependency we might have. |
##### Returns
#### Returns
| Type | Description |
|-----------|------------------------------------------|
| JobHandle | A to our newly created ScheduleSend Job. |
System.IDisposable

52
transport/api/Unity.Networking.Transport.INetworkParameter.md
Просмотреть файл

@ -1,58 +1,24 @@
---
id: Unity.Networking.Transport.INetworkParameter
title: Unity.Networking.Transport.INetworkParameter
---
id: Unity.Networking.Transport.INetworkParameter
title: Unity.Networking.Transport.INetworkParameter
---
# Interface INetworkParameter
<div class="markdown level0 summary">
The interface for NetworkParameters
</div>
<div class="markdown level0 conceptual">
</div>
##### **Namespace**: System.Dynamic.ExpandoObject
###### **Namespace**: Unity.Networking.Transport
###### **Assembly**: Transport.dll
##### **Assembly**: transport.dll
##### Syntax
``` lang-csharp
public interface INetworkParameter
```
### Methods
#### Validate()
Checks if the values for all fields are valid. This method will be
automatically called when adding a paramter to the NetworkSettings.
##### Declaration
``` lang-csharp
bool Validate()
```
##### Returns
| Type | Description |
|----------------|-----------------------------------------|
| System.Boolean | Returns true if the parameter is valid. |

82
transport/api/Unity.Networking.Transport.INetworkPipelineStage.md
Просмотреть файл

@ -1,92 +1,78 @@
---
id: Unity.Networking.Transport.INetworkPipelineStage
title: Unity.Networking.Transport.INetworkPipelineStage
---
id: Unity.Networking.Transport.INetworkPipelineStage
title: Unity.Networking.Transport.INetworkPipelineStage
---
<div class="markdown level0 summary">
# Interface INetworkPipelineStage
</div>
<div class="markdown level0 conceptual">
The network pipeline stage interface
</div>
##### **Namespace**: System.Dynamic.ExpandoObject
###### **Namespace**: Unity.Networking.Transport
###### **Assembly**: Transport.dll
##### **Assembly**: transport.dll
##### Syntax
``` lang-csharp
public interface INetworkPipelineStage
```
##
### StaticSize
### Properties
<div class="markdown level1 summary">
#### StaticSize
</div>
<div class="markdown level1 conceptual">
Gets the value of the static size
##### Declaration
</div>
#### Declaration
``` lang-csharp
int StaticSize { get; }
```
##### Property Value
#### Property Value
| Type | Description |
|--------------|-------------|
| System.Int32 | |
### Methods
##
#### StaticInitialize(Byte\*, Int32, NetworkSettings)
### StaticInitialize(Byte\*, Int32, NetworkSettings)
<div class="markdown level1 summary">
Statics the initialize using the specified static instance buffer
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
NetworkPipelineStage StaticInitialize(byte *staticInstanceBuffer, int staticInstanceBufferLength, NetworkSettings settings)
```
#### Parameters
| Type | Name | Description |
|-----------------|----------------------------|-------------|
| System.Byte\* | staticInstanceBuffer | |
| System.Int32 | staticInstanceBufferLength | |
| NetworkSettings | settings | |
##### Parameters
| Type | Name | Description |
|-----------------|----------------------------|-----------------------------------|
| System.Byte\* | staticInstanceBuffer | The static instance buffer |
| System.Int32 | staticInstanceBufferLength | The static instance buffer length |
| NetworkSettings | settings | |
##### Returns
| Type | Description |
|----------------------|----------------------------|
| NetworkPipelineStage | The network pipeline stage |
#### Returns
| Type | Description |
|----------------------|-------------|
| NetworkPipelineStage | |

355
transport/api/Unity.Networking.Transport.IPCNetworkInterface.md
Просмотреть файл

@ -1,392 +1,353 @@
---
id: Unity.Networking.Transport.IPCNetworkInterface
title: Unity.Networking.Transport.IPCNetworkInterface
---
id: Unity.Networking.Transport.IPCNetworkInterface
title: Unity.Networking.Transport.IPCNetworkInterface
---
<div class="markdown level0 summary">
# Struct IPCNetworkInterface
The ipc network interface
</div>
<div class="markdown level0 conceptual">
</div>
<div classs="implements">
##### Implements
<div>
INetworkInterface
</div>
<div>
System.IDisposable
</div>
</div>
<div class="inheritedMembers">
##### Inherited Members
<div>
ValueType.Equals(Object)
System.ValueType.Equals(System.Object)
</div>
<div>
ValueType.GetHashCode()
</div>
<div>
System.ValueType.GetHashCode()
ValueType.ToString()
</div>
<div>
Object.Equals(Object, Object)
</div>
System.ValueType.ToString()
<div>
Object.GetType()
</div>
<div>
Object.ReferenceEquals(Object, Object)
System.Object.Equals(System.Object, System.Object)
</div>
</div>
##### **Namespace**: System.Dynamic.ExpandoObject
System.Object.GetType()
System.Object.ReferenceEquals(System.Object, System.Object)
###### **Namespace**: Unity.Networking.Transport
###### **Assembly**: Transport.dll
##### **Assembly**: transport.dll
##### Syntax
``` lang-csharp
public struct IPCNetworkInterface : INetworkInterface, IDisposable
```
##
### LocalEndPoint
### Properties
<div class="markdown level1 summary">
#### LocalEndPoint
</div>
<div class="markdown level1 conceptual">
Gets the value of the local end point
##### Declaration
</div>
#### Declaration
``` lang-csharp
public readonly NetworkInterfaceEndPoint LocalEndPoint { get; }
```
##### Property Value
#### Property Value
| Type | Description |
|--------------------------|-------------|
| NetworkInterfaceEndPoint | |
### Methods
##
#### Bind(NetworkInterfaceEndPoint)
### Bind(NetworkInterfaceEndPoint)
<div class="markdown level1 summary">
Binds the medium to a specific endpoint.
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public int Bind(NetworkInterfaceEndPoint endpoint)
```
#### Parameters
| Type | Name | Description |
|--------------------------|----------|-------------|
| NetworkInterfaceEndPoint | endpoint | |
##### Parameters
#### Returns
| Type | Name | Description |
|--------------------------|----------|-----------------------------------|
| NetworkInterfaceEndPoint | endpoint | A valid NetworkInterfaceEndPoint. |
| Type | Description |
|--------------|-------------|
| System.Int32 | |
##### Returns
### CreateInterfaceEndPoint(NetworkEndPoint, out NetworkInterfaceEndPoint)
| Type | Description |
|--------------|--------------|
| System.Int32 | 0 on Success |
<div class="markdown level1 summary">
#### CreateInterfaceEndPoint(NetworkEndPoint, out NetworkInterfaceEndPoint)
</div>
<div class="markdown level1 conceptual">
Creates an interface end point. Only available for loopback addresses.
##### Declaration
</div>
#### Declaration
``` lang-csharp
public int CreateInterfaceEndPoint(NetworkEndPoint address, out NetworkInterfaceEndPoint endpoint)
```
#### Parameters
| Type | Name | Description |
|--------------------------|----------|-------------|
| NetworkEndPoint | address | |
| NetworkInterfaceEndPoint | endpoint | |
##### Parameters
#### Returns
| Type | Name | Description |
|--------------------------|----------|------------------|
| NetworkEndPoint | address | Loopback address |
| NetworkInterfaceEndPoint | endpoint | The endpoint |
| Type | Description |
|--------------|-------------|
| System.Int32 | |
##### Returns
### CreateSendInterface()
| Type | Description |
|--------------|---------------------------------------------------|
| System.Int32 | The status code of the result, 0 being a success. |
<div class="markdown level1 summary">
#### CreateSendInterface()
</div>
<div class="markdown level1 conceptual">
Creates the send interface
##### Declaration
</div>
#### Declaration
``` lang-csharp
public NetworkSendInterface CreateSendInterface()
```
#### Returns
| Type | Description |
|----------------------|-------------|
| NetworkSendInterface | |
##### Returns
### Dispose()
| Type | Description |
|----------------------|----------------------------|
| NetworkSendInterface | The network send interface |
<div class="markdown level1 summary">
#### Dispose()
</div>
<div class="markdown level1 conceptual">
Cleans up both the local end point and the IPCManager instance.
##### Declaration
</div>
#### Declaration
``` lang-csharp
public void Dispose()
```
### GetGenericEndPoint(NetworkInterfaceEndPoint)
<div class="markdown level1 summary">
#### GetGenericEndPoint(NetworkInterfaceEndPoint)
</div>
<div class="markdown level1 conceptual">
Retrieves an already created endpoint with port or creates one.
##### Declaration
</div>
#### Declaration
``` lang-csharp
public NetworkEndPoint GetGenericEndPoint(NetworkInterfaceEndPoint endpoint)
```
#### Parameters
| Type | Name | Description |
|--------------------------|----------|-------------|
| NetworkInterfaceEndPoint | endpoint | |
##### Parameters
#### Returns
| Type | Name | Description |
|--------------------------|----------|-----------------------|
| NetworkInterfaceEndPoint | endpoint | The loopback endpoint |
| Type | Description |
|-----------------|-------------|
| NetworkEndPoint | |
##### Returns
### Initialize(NetworkSettings)
| Type | Description |
|-----------------|-----------------|
| NetworkEndPoint | NetworkEndPoint |
<div class="markdown level1 summary">
#### Initialize(NetworkSettings)
</div>
<div class="markdown level1 conceptual">
Initializes the interface passing in optional INetworkParameter
##### Declaration
</div>
#### Declaration
``` lang-csharp
public int Initialize(NetworkSettings settings)
```
##### Parameters
#### Parameters
| Type | Name | Description |
|-----------------|----------|-------------|
| NetworkSettings | settings | |
##### Returns
#### Returns
| Type | Description |
|--------------|---------------------------------------------------|
| System.Int32 | The status code of the result, 0 being a success. |
| Type | Description |
|--------------|-------------|
| System.Int32 | |
#### Listen()
### Listen()
<div class="markdown level1 summary">
Start listening for incoming connections. This is normally a no-op for
real UDP sockets.
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public int Listen()
```
#### Returns
| Type | Description |
|--------------|-------------|
| System.Int32 | |
##### Returns
### ScheduleReceive(NetworkPacketReceiver, JobHandle)
| Type | Description |
|--------------|--------------|
| System.Int32 | 0 on Success |
<div class="markdown level1 summary">
#### ScheduleReceive(NetworkPacketReceiver, JobHandle)
</div>
<div class="markdown level1 conceptual">
Schedule a ReceiveJob. This is used to read data from your supported
medium and pass it to the AppendData function supplied by NetworkDriver
##### Declaration
</div>
#### Declaration
``` lang-csharp
public JobHandle ScheduleReceive(NetworkPacketReceiver receiver, JobHandle dep)
```
#### Parameters
| Type | Name | Description |
|-----------------------|----------|-------------|
| NetworkPacketReceiver | receiver | |
| JobHandle | dep | |
##### Parameters
#### Returns
| Type | Name | Description |
|-----------------------|----------|--------------------------------------------------|
| NetworkPacketReceiver | receiver | A NetworkDriver used to parse the data received. |
| JobHandle | dep | A to any dependency we might have. |
| Type | Description |
|-----------|-------------|
| JobHandle | |
##### Returns
### ScheduleSend(NativeQueue\&lt;QueuedSendMessage&gt;, JobHandle)
| Type | Description |
|-----------|---------------------------------------------|
| JobHandle | A to our newly created ScheduleReceive Job. |
<div class="markdown level1 summary">
#### ScheduleSend(NativeQueue\<QueuedSendMessage\>, JobHandle)
</div>
<div class="markdown level1 conceptual">
Schedule a SendJob. This is used to flush send queues to your supported
medium
##### Declaration
</div>
#### Declaration
``` lang-csharp
public JobHandle ScheduleSend(NativeQueue<QueuedSendMessage> sendQueue, JobHandle dep)
```
#### Parameters
| Type | Name | Description |
|----------------------------------|-----------|-------------|
| NativeQueue\&lt;QueuedSendMessage&gt; | sendQueue | |
| JobHandle | dep | |
##### Parameters
#### Returns
| Type | Name | Description |
|----------------------------------|-----------|------------------------------------------------------------|
| NativeQueue\<QueuedSendMessage\> | sendQueue | The send queue which can be used to emulate parallel send. |
| JobHandle | dep | A to any dependency we might have. |
##### Returns
| Type | Description |
|-----------|------------------------------------------|
| JobHandle | A to our newly created ScheduleSend Job. |
| Type | Description |
|-----------|-------------|
| JobHandle | |
### Implements
<div>
INetworkInterface
</div>
<div>
System.IDisposable
</div>

0
transport_versioned_docs/version-2.0.0/api/Unity.Networking.Transport.IValidatableNetworkParameter.md → transport/api/Unity.Networking.Transport.IValidatableNetworkParameter.md
Просмотреть файл

126
transport/api/Unity.Networking.Transport.InboundRecvBuffer.md
Просмотреть файл

@ -1,156 +1,140 @@
---
id: Unity.Networking.Transport.InboundRecvBuffer
title: Unity.Networking.Transport.InboundRecvBuffer
---
id: Unity.Networking.Transport.InboundRecvBuffer
title: Unity.Networking.Transport.InboundRecvBuffer
---
<div class="markdown level0 summary">
# Struct InboundRecvBuffer
The inbound recv buffer
</div>
<div class="markdown level0 conceptual">
</div>
<div class="inheritedMembers">
##### Inherited Members
<div>
ValueType.Equals(Object)
System.ValueType.Equals(System.Object)
</div>
<div>
ValueType.GetHashCode()
</div>
<div>
System.ValueType.GetHashCode()
ValueType.ToString()
</div>
<div>
Object.Equals(Object, Object)
</div>
System.ValueType.ToString()
<div>
Object.GetType()
</div>
<div>
Object.ReferenceEquals(Object, Object)
System.Object.Equals(System.Object, System.Object)
</div>
</div>
##### **Namespace**: System.Dynamic.ExpandoObject
System.Object.GetType()
System.Object.ReferenceEquals(System.Object, System.Object)
###### **Namespace**: Unity.Networking.Transport
###### **Assembly**: Transport.dll
##### **Assembly**: transport.dll
##### Syntax
``` lang-csharp
public struct InboundRecvBuffer
```
##
### buffer
### Fields
<div class="markdown level1 summary">
#### buffer
</div>
<div class="markdown level1 conceptual">
The buffer
##### Declaration
</div>
#### Declaration
``` lang-csharp
public byte *buffer
```
##### Field Value
#### Field Value
| Type | Description |
|---------------|-------------|
| System.Byte\* | |
#### bufferLength
### bufferLength
<div class="markdown level1 summary">
The buffer length
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public int bufferLength
```
##### Field Value
#### Field Value
| Type | Description |
|--------------|-------------|
| System.Int32 | |
### Methods
##
#### Slice(Int32)
### Slice(Int32)
<div class="markdown level1 summary">
Slices the offset
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public InboundRecvBuffer Slice(int offset)
```
##### Parameters
#### Parameters
| Type | Name | Description |
|--------------|--------|-------------|
| System.Int32 | offset | The offset |
| System.Int32 | offset | |
##### Returns
#### Returns
| Type | Description |
|-------------------|-------------|
| InboundRecvBuffer | The slice |
| InboundRecvBuffer | |

171
transport/api/Unity.Networking.Transport.InboundSendBuffer.md
Просмотреть файл

@ -1,219 +1,194 @@
---
id: Unity.Networking.Transport.InboundSendBuffer
title: Unity.Networking.Transport.InboundSendBuffer
---
id: Unity.Networking.Transport.InboundSendBuffer
title: Unity.Networking.Transport.InboundSendBuffer
---
<div class="markdown level0 summary">
# Struct InboundSendBuffer
The inbound send buffer
</div>
<div class="markdown level0 conceptual">
</div>
<div class="inheritedMembers">
##### Inherited Members
<div>
ValueType.Equals(Object)
System.ValueType.Equals(System.Object)
</div>
<div>
ValueType.GetHashCode()
</div>
<div>
System.ValueType.GetHashCode()
ValueType.ToString()
</div>
<div>
Object.Equals(Object, Object)
</div>
System.ValueType.ToString()
<div>
Object.GetType()
</div>
<div>
Object.ReferenceEquals(Object, Object)
System.Object.Equals(System.Object, System.Object)
</div>
</div>
##### **Namespace**: System.Dynamic.ExpandoObject
System.Object.GetType()
System.Object.ReferenceEquals(System.Object, System.Object)
###### **Namespace**: Unity.Networking.Transport
###### **Assembly**: Transport.dll
##### **Assembly**: transport.dll
##### Syntax
``` lang-csharp
public struct InboundSendBuffer
```
##
### buffer
### Fields
<div class="markdown level1 summary">
#### buffer
</div>
<div class="markdown level1 conceptual">
The buffer
##### Declaration
</div>
#### Declaration
``` lang-csharp
public byte *buffer
```
##### Field Value
#### Field Value
| Type | Description |
|---------------|-------------|
| System.Byte\* | |
#### bufferLength
### bufferLength
<div class="markdown level1 summary">
The buffer length
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public int bufferLength
```
##### Field Value
#### Field Value
| Type | Description |
|--------------|-------------|
| System.Int32 | |
#### bufferWithHeaders
### bufferWithHeaders
<div class="markdown level1 summary">
The buffer with headers
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public byte *bufferWithHeaders
```
##### Field Value
#### Field Value
| Type | Description |
|---------------|-------------|
| System.Byte\* | |
#### bufferWithHeadersLength
### bufferWithHeadersLength
<div class="markdown level1 summary">
The buffer with headers length
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public int bufferWithHeadersLength
```
##### Field Value
#### Field Value
| Type | Description |
|--------------|-------------|
| System.Int32 | |
#### headerPadding
### headerPadding
<div class="markdown level1 summary">
The header padding
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public int headerPadding
```
##### Field Value
#### Field Value
| Type | Description |
|--------------|-------------|
| System.Int32 | |
### Methods
##
#### SetBufferFrombufferWithHeaders()
### SetBufferFromBufferWithHeaders()
<div class="markdown level1 summary">
Sets the buffer frombuffer with headers
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public void SetBufferFrombufferWithHeaders()
public void SetBufferFromBufferWithHeaders()
```

224
transport/api/Unity.Networking.Transport.NetworkCompressionModel.md
Просмотреть файл

@ -1,170 +1,244 @@
---
id: Unity.Networking.Transport.NetworkCompressionModel
title: Unity.Networking.Transport.NetworkCompressionModel
---
id: Unity.Networking.Transport.NetworkCompressionModel
title: Unity.Networking.Transport.NetworkCompressionModel
---
<div class="markdown level0 summary">
# Struct NetworkCompressionModel
Used to provide Huffman compression when using packed DataStream
functions
</div>
<div class="markdown level0 conceptual">
</div>
<div classs="implements">
##### Implements
<div>
System.IDisposable
</div>
</div>
<div class="inheritedMembers">
##### Inherited Members
<div>
ValueType.Equals(Object)
System.ValueType.Equals(System.Object)
</div>
<div>
ValueType.GetHashCode()
</div>
<div>
System.ValueType.GetHashCode()
ValueType.ToString()
</div>
<div>
Object.Equals(Object, Object)
</div>
System.ValueType.ToString()
<div>
Object.GetType()
</div>
<div>
Object.ReferenceEquals(Object, Object)
System.Object.Equals(System.Object, System.Object)
</div>
</div>
##### **Namespace**: System.Dynamic.ExpandoObject
System.Object.GetType()
System.Object.ReferenceEquals(System.Object, System.Object)
###### **Namespace**: Unity.Networking.Transport
###### **Assembly**: Transport.dll
##### **Assembly**: transport.dll
##### Syntax
``` lang-csharp
public struct NetworkCompressionModel : IDisposable
```
##
### NetworkCompressionModel(Allocator)
### Constructors
<div class="markdown level1 summary">
#### NetworkCompressionModel(Allocator)
</div>
<div class="markdown level1 conceptual">
Initializes a new instance of the NetworkCompressionModel class
##### Declaration
</div>
#### Declaration
``` lang-csharp
public NetworkCompressionModel(Allocator allocator)
```
#### Parameters
| Type | Name | Description |
|-----------|-----------|-------------|
| Allocator | allocator | |
##### Parameters
##
| Type | Name | Description |
|-----------|-----------|---------------|
| Allocator | allocator | The allocator |
### bucketOffsets
### Methods
<div class="markdown level1 summary">
#### CalculateBucket(UInt32)
</div>
<div class="markdown level1 conceptual">
Calculates the bucket using the specified value
</div>
#### Declaration
``` lang-csharp
public uint *bucketOffsets
```
#### Field Value
| Type | Description |
|-----------------|-------------|
| System.UInt32\* | |
### bucketSizes
##### Declaration
<div class="markdown level1 summary">
</div>
<div class="markdown level1 conceptual">
</div>
#### Declaration
``` lang-csharp
public byte *bucketSizes
```
#### Field Value
| Type | Description |
|---------------|-------------|
| System.Byte\* | |
### decodeTable
<div class="markdown level1 summary">
</div>
<div class="markdown level1 conceptual">
</div>
#### Declaration
``` lang-csharp
public ushort *decodeTable
```
#### Field Value
| Type | Description |
|-----------------|-------------|
| System.UInt16\* | |
### encodeTable
<div class="markdown level1 summary">
</div>
<div class="markdown level1 conceptual">
</div>
#### Declaration
``` lang-csharp
public ushort *encodeTable
```
#### Field Value
| Type | Description |
|-----------------|-------------|
| System.UInt16\* | |
##
### CalculateBucket(UInt32)
<div class="markdown level1 summary">
</div>
<div class="markdown level1 conceptual">
</div>
#### Declaration
``` lang-csharp
public int CalculateBucket(uint value)
```
##### Parameters
#### Parameters
| Type | Name | Description |
|---------------|-------|-------------|
| System.UInt32 | value | The value |
| System.UInt32 | value | |
##### Returns
#### Returns
| Type | Description |
|--------------|------------------|
| System.Int32 | The bucket index |
| Type | Description |
|--------------|-------------|
| System.Int32 | |
#### Dispose()
### Dispose()
<div class="markdown level1 summary">
Disposes this instance
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public void Dispose()
```
### Implements
<div>
System.IDisposable
</div>

219
transport/api/Unity.Networking.Transport.NetworkConfigParameter.md
Просмотреть файл

@ -1,287 +1,313 @@
---
id: Unity.Networking.Transport.NetworkConfigParameter
title: Unity.Networking.Transport.NetworkConfigParameter
---
id: Unity.Networking.Transport.NetworkConfigParameter
title: Unity.Networking.Transport.NetworkConfigParameter
---
# Struct NetworkConfigParameter
<div class="markdown level0 summary">
The NetworkConfigParameter is used to set specific parameters that the
driver uses.
</div>
<div class="markdown level0 conceptual">
</div>
<div classs="implements">
##### Implements
<div>
INetworkParameter
</div>
<div>
IValidatableNetworkParameter
</div>
</div>
<div class="inheritedMembers">
##### Inherited Members
<div>
ValueType.Equals(Object)
System.ValueType.Equals(System.Object)
</div>
<div>
ValueType.GetHashCode()
</div>
<div>
System.ValueType.GetHashCode()
ValueType.ToString()
</div>
<div>
Object.Equals(Object, Object)
</div>
System.ValueType.ToString()
<div>
Object.GetType()
</div>
<div>
Object.ReferenceEquals(Object, Object)
System.Object.Equals(System.Object, System.Object)
</div>
</div>
##### **Namespace**: System.Dynamic.ExpandoObject
System.Object.GetType()
System.Object.ReferenceEquals(System.Object, System.Object)
###### **Namespace**: Unity.Networking.Transport
###### **Assembly**: Transport.dll
##### **Assembly**: transport.dll
##### Syntax
``` lang-csharp
public struct NetworkConfigParameter : INetworkParameter
public struct NetworkConfigParameter : INetworkParameter, IValidatableNetworkParameter
```
##
### connectTimeoutMS
### Fields
#### connectTimeoutMS
<div class="markdown level1 summary">
A timeout in milliseconds indicating how long we will wait until we send
a new connection attempt.
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public int connectTimeoutMS
```
##### Field Value
#### Field Value
| Type | Description |
|--------------|-------------|
| System.Int32 | |
#### disconnectTimeoutMS
### disconnectTimeoutMS
<div class="markdown level1 summary">
A timeout in milliseconds indicating how long we will wait for a
connection event, before we disconnect it.
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public int disconnectTimeoutMS
```
##### Field Value
#### Field Value
| Type | Description |
|--------------|-------------|
| System.Int32 | |
##### Remarks
#### Remarks
<div class="markdown level1 remarks">
The connection needs to receive data from the connected endpoint within
this timeout. Note that with heartbeats enabled (heartbeatTimeoutMS \>
0), simply not sending any data will not be enough to trigger this
timeout (since heartbeats count as connection events).
</div>
### fixedFrameTimeMS
#### fixedFrameTimeMS
<div class="markdown level1 summary">
A fixed amount of time to use for an interval between ScheduleUpdate.
This is used instead of a clock.
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public int fixedFrameTimeMS
```
##### Field Value
#### Field Value
| Type | Description |
|--------------|-------------|
| System.Int32 | |
##### Remarks
#### Remarks
<div class="markdown level1 remarks">
The main use for this parameter is tests where determinism is more
important than correctness.
</div>
### heartbeatTimeoutMS
#### heartbeatTimeoutMS
<div class="markdown level1 summary">
A timeout in milliseconds after which a heartbeat is sent if there is no
activity.
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public int heartbeatTimeoutMS
```
##### Field Value
#### Field Value
| Type | Description |
|--------------|-------------|
| System.Int32 | |
#### maxConnectAttempts
### maxConnectAttempts
<div class="markdown level1 summary">
The maximum amount of connection attempts we will try before
disconnecting.
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public int maxConnectAttempts
```
##### Field Value
#### Field Value
| Type | Description |
|--------------|-------------|
| System.Int32 | |
#### maxFrameTimeMS
### maxFrameTimeMS
<div class="markdown level1 summary">
The maximum amount of time a single frame can advance timeout values.
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public int maxFrameTimeMS
```
##### Field Value
#### Field Value
| Type | Description |
|--------------|-------------|
| System.Int32 | |
##### Remarks
#### Remarks
<div class="markdown level1 remarks">
The main use for this parameter is to not get disconnects at frame
spikes when both endpoints lives in the same process.
</div>
### reconnectionTimeoutMS
### Methods
<div class="markdown level1 summary">
#### Validate()
A timeout in milliseconds after which reconnection is attempted if there
is no activity.
</div>
<div class="markdown level1 conceptual">
</div>
#### Declaration
``` lang-csharp
public int reconnectionTimeoutMS
```
#### Field Value
##### Declaration
| Type | Description |
|--------------|-------------|
| System.Int32 | |
##
### Validate()
<div class="markdown level1 summary">
</div>
<div class="markdown level1 conceptual">
</div>
#### Declaration
``` lang-csharp
public bool Validate()
```
##### Returns
#### Returns
| Type | Description |
|----------------|-------------|
@ -289,11 +315,14 @@ public bool Validate()
### Implements
<div>
INetworkParameter
</div>
<div>
IValidatableNetworkParameter
</div>

57
transport/api/Unity.Networking.Transport.NetworkConnection.State.md
Просмотреть файл

@ -1,56 +1,33 @@
---
id: Unity.Networking.Transport.NetworkConnection.State
title: Unity.Networking.Transport.NetworkConnection.State
---
id: Unity.Networking.Transport.NetworkConnection.State
title: Unity.Networking.Transport.NetworkConnection.State
---
<div class="markdown level0 summary">
# Enum NetworkConnection.State
ConnectionState enumerates available connection states a connection can
have.
</div>
Connection States
<div class="markdown level0 conceptual">
</div>
##### **Namespace**: System.Dynamic.ExpandoObject
###### **Namespace**: Unity.Networking.Transport
###### **Assembly**: Transport.dll
##### **Assembly**: transport.dll
##### Syntax
``` lang-csharp
public enum State
```
##
### Fields
Name
Description
Connected
Indicates the connection is connected.
Connecting
Indicates the connection is being established.
Disconnected
Indicates the connection is disconnected.
| Name | Description |
|--------------|------------------------------------------------|
| Connected | Indicates the connection is connected.. |
| Connecting | Indicates the connection is trying to connect. |
| Disconnected | Indicates the connection is disconnected |

358
transport/api/Unity.Networking.Transport.NetworkConnection.md
Просмотреть файл

@ -1,353 +1,358 @@
---
id: Unity.Networking.Transport.NetworkConnection
title: Unity.Networking.Transport.NetworkConnection
---
id: Unity.Networking.Transport.NetworkConnection
title: Unity.Networking.Transport.NetworkConnection
---
<div class="markdown level0 summary">
# Struct NetworkConnection
##### Implements
System.IEquatable\<NetworkConnection\>
The NetworkConnection is a struct that hold all information needed by
the driver to link it with a virtual connection. The NetworkConnection
is a public representation of a connection.
</div>
<div class="markdown level0 conceptual">
</div>
<div class="inheritedMembers">
##### Inherited Members
<div>
Object.Equals(Object, Object)
System.ValueType.ToString()
</div>
<div>
Object.GetType()
</div>
<div>
System.Object.Equals(System.Object, System.Object)
Object.ReferenceEquals(Object, Object)
</div>
</div>
##### **Namespace**: System.Dynamic.ExpandoObject
System.Object.GetType()
System.Object.ReferenceEquals(System.Object, System.Object)
###### **Namespace**: Unity.Networking.Transport
###### **Assembly**: Transport.dll
##### **Assembly**: transport.dll
##### Syntax
``` lang-csharp
public struct NetworkConnection : IEquatable<NetworkConnection>
public struct NetworkConnection
```
##
### InternalId
### Properties
<div class="markdown level1 summary">
#### InternalId
</div>
<div class="markdown level1 conceptual">
Gets the value of the connection's internal ID.
##### Declaration
</div>
#### Declaration
``` lang-csharp
public readonly int InternalId { get; }
```
##### Property Value
#### Property Value
| Type | Description |
|--------------|-------------|
| System.Int32 | |
#### IsCreated
### IsCreated
<div class="markdown level1 summary">
Check to see if a NetworkConnection is Created.
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public readonly bool IsCreated { get; }
```
#### Property Value
| Type | Description |
|----------------|--------------------------------------------------------------------------------------------------------------|
| System.Boolean | `true` if the NetworkConnection has been correctly created by a call to Accept() or Connect(NetworkEndPoint) |
##### Property Value
### Version
| Type | Description |
|----------------|-------------|
| System.Boolean | |
<div class="markdown level1 summary">
### Methods
</div>
#### Close(NetworkDriver)
<div class="markdown level1 conceptual">
</div>
#### Declaration
``` lang-csharp
public readonly int Version { get; }
```
#### Property Value
| Type | Description |
|--------------|-------------|
| System.Int32 | |
##
##### Declaration
### Close(NetworkDriver)
<div class="markdown level1 summary">
Close an active NetworkConnection, similar to .
</div>
<div class="markdown level1 conceptual">
</div>
#### Declaration
``` lang-csharp
public int Close(NetworkDriver driver)
```
#### Parameters
| Type | Name | Description |
|---------------|--------|----------------------------------------------|
| NetworkDriver | driver | The driver that owns the virtual connection. |
##### Parameters
| Type | Name | Description |
|---------------|--------|-------------|
| NetworkDriver | driver | |
##### Returns
#### Returns
| Type | Description |
|--------------|-------------|
| System.Int32 | |
#### Disconnect(NetworkDriver)
### Disconnect(NetworkDriver)
<div class="markdown level1 summary">
Disconnects a virtual connection and marks it for deletion. This
connection will be removed on next the next frame.
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public int Disconnect(NetworkDriver driver)
```
#### Parameters
| Type | Name | Description |
|---------------|--------|----------------------------------------------|
| NetworkDriver | driver | The driver that owns the virtual connection. |
##### Parameters
| Type | Name | Description |
|---------------|--------|-------------|
| NetworkDriver | driver | |
##### Returns
#### Returns
| Type | Description |
|--------------|-------------|
| System.Int32 | |
#### Equals(Object)
### Equals(Object)
<div class="markdown level1 summary">
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public override bool Equals(object o)
```
##### Parameters
#### Parameters
| Type | Name | Description |
|---------------|------|-------------|
| System.Object | o | |
##### Returns
#### Returns
| Type | Description |
|----------------|-------------|
| System.Boolean | |
##### Overrides
#### Overrides
<div>
System.ValueType.Equals(System.Object)
</div>
### Equals(NetworkConnection)
#### Equals(NetworkConnection)
<div class="markdown level1 summary">
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public bool Equals(NetworkConnection o)
```
##### Parameters
#### Parameters
| Type | Name | Description |
|-------------------|------|-------------|
| NetworkConnection | o | |
##### Returns
#### Returns
| Type | Description |
|----------------|-------------|
| System.Boolean | |
#### GetHashCode()
### GetHashCode()
<div class="markdown level1 summary">
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public override int GetHashCode()
```
##### Returns
#### Returns
| Type | Description |
|--------------|-------------|
| System.Int32 | |
##### Overrides
#### Overrides
<div>
System.ValueType.GetHashCode()
</div>
### GetState(NetworkDriver)
#### GetState(NetworkDriver)
<div class="markdown level1 summary">
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public NetworkConnection.State GetState(NetworkDriver driver)
```
##### Parameters
#### Parameters
| Type | Name | Description |
|---------------|--------|-------------|
| NetworkDriver | driver | |
##### Returns
#### Returns
| Type | Description |
|-------------------------|-------------|
| NetworkConnection.State | |
#### PopEvent(NetworkDriver, out DataStreamReader)
### PopEvent(NetworkDriver, out DataStreamReader)
<div class="markdown level1 summary">
Receive an event for this specific connection. Should be called until it
returns Empty, even if the socket is disconnected.
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public NetworkEvent.Type PopEvent(NetworkDriver driver, out DataStreamReader stream)
```
#### Parameters
| Type | Name | Description |
|------------------|--------|----------------------------------------------|
| NetworkDriver | driver | The driver that owns the virtual connection. |
| DataStreamReader | stream | |
##### Parameters
| Type | Name | Description |
|------------------|--------|-------------|
| NetworkDriver | driver | |
| DataStreamReader | stream | |
##### Returns
#### Returns
| Type | Description |
|-------------------|-------------|
| NetworkEvent.Type | |
#### PopEvent(NetworkDriver, out DataStreamReader, out NetworkPipeline)
### PopEvent(NetworkDriver, out DataStreamReader, out NetworkPipeline)
<div class="markdown level1 summary">
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public NetworkEvent.Type PopEvent(NetworkDriver driver, out DataStreamReader stream, out NetworkPipeline pipeline)
```
##### Parameters
#### Parameters
| Type | Name | Description |
|------------------|----------|-------------|
@ -355,81 +360,98 @@ public NetworkEvent.Type PopEvent(NetworkDriver driver, out DataStreamReader str
| DataStreamReader | stream | |
| NetworkPipeline | pipeline | |
##### Returns
#### Returns
| Type | Description |
|-------------------|-------------|
| NetworkEvent.Type | |
### Operators
### ToString()
#### Equality(NetworkConnection, NetworkConnection)
<div class="markdown level1 summary">
</div>
<div class="markdown level1 conceptual">
</div>
#### Declaration
``` lang-csharp
public override string ToString()
```
#### Returns
##### Declaration
| Type | Description |
|---------------|-------------|
| System.String | |
#### Overrides
<div>
System.ValueType.ToString()
</div>
##
### Equality(NetworkConnection, NetworkConnection)
<div class="markdown level1 summary">
</div>
<div class="markdown level1 conceptual">
</div>
#### Declaration
``` lang-csharp
public static bool operator ==(NetworkConnection lhs, NetworkConnection rhs)
```
##### Parameters
#### Parameters
| Type | Name | Description |
|-------------------|------|-------------|
| NetworkConnection | lhs | |
| NetworkConnection | rhs | |
##### Returns
#### Returns
| Type | Description |
|----------------|-------------|
| System.Boolean | |
#### Inequality(NetworkConnection, NetworkConnection)
### Inequality(NetworkConnection, NetworkConnection)
<div class="markdown level1 summary">
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public static bool operator !=(NetworkConnection lhs, NetworkConnection rhs)
```
##### Parameters
#### Parameters
| Type | Name | Description |
|-------------------|------|-------------|
| NetworkConnection | lhs | |
| NetworkConnection | rhs | |
##### Returns
#### Returns
| Type | Description |
|----------------|-------------|
| System.Boolean | |
### Implements
System.IEquatable\<T\>

115
transport/api/Unity.Networking.Transport.NetworkDataStreamParameter.md
Просмотреть файл

@ -1,137 +1,141 @@
---
id: Unity.Networking.Transport.NetworkDataStreamParameter
title: Unity.Networking.Transport.NetworkDataStreamParameter
---
id: Unity.Networking.Transport.NetworkDataStreamParameter
title: Unity.Networking.Transport.NetworkDataStreamParameter
---
# Struct NetworkDataStreamParameter
<div class="markdown level0 summary">
The NetworkDataStreamParameter is used to set a fixed data stream size.
</div>
<div class="markdown level0 conceptual">
</div>
<div classs="implements">
##### Implements
<div>
INetworkParameter
</div>
<div>
IValidatableNetworkParameter
</div>
</div>
<div class="inheritedMembers">
##### Inherited Members
<div>
ValueType.Equals(Object)
System.ValueType.Equals(System.Object)
</div>
<div>
ValueType.GetHashCode()
</div>
<div>
System.ValueType.GetHashCode()
ValueType.ToString()
</div>
<div>
Object.Equals(Object, Object)
</div>
System.ValueType.ToString()
<div>
Object.GetType()
</div>
<div>
Object.ReferenceEquals(Object, Object)
System.Object.Equals(System.Object, System.Object)
</div>
</div>
##### **Namespace**: System.Dynamic.ExpandoObject
System.Object.GetType()
System.Object.ReferenceEquals(System.Object, System.Object)
###### **Namespace**: Unity.Networking.Transport
###### **Assembly**: Transport.dll
##### **Assembly**: transport.dll
##### Syntax
``` lang-csharp
public struct NetworkDataStreamParameter : INetworkParameter
public struct NetworkDataStreamParameter : INetworkParameter, IValidatableNetworkParameter
```
##### **Remarks**
<div class="markdown level0 remarks">
The DataStreamWriter will grow on demand if the size is set to zero.
</div>
##
### Fields
#### size
### size
<div class="markdown level1 summary">
Size of the default DataStreamWriter
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public int size
```
##### Field Value
#### Field Value
| Type | Description |
|--------------|-------------|
| System.Int32 | |
### Methods
##
#### Validate()
### Validate()
<div class="markdown level1 summary">
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public bool Validate()
```
##### Returns
#### Returns
| Type | Description |
|----------------|-------------|
@ -139,11 +143,14 @@ public bool Validate()
### Implements
<div>
INetworkParameter
</div>
<div>
IValidatableNetworkParameter
</div>

273
transport/api/Unity.Networking.Transport.NetworkDriver.Concurrent.md
Просмотреть файл

@ -1,127 +1,123 @@
---
id: Unity.Networking.Transport.NetworkDriver.Concurrent
title: Unity.Networking.Transport.NetworkDriver.Concurrent
---
id: Unity.Networking.Transport.NetworkDriver.Concurrent
title: Unity.Networking.Transport.NetworkDriver.Concurrent
---
# Struct NetworkDriver.Concurrent
<div class="markdown level0 summary">
The Concurrent struct is used to create an Concurrent instance of the
NetworkDriver.
GenericNetworkDriver.
</div>
<div class="markdown level0 conceptual">
</div>
<div class="inheritedMembers">
##### Inherited Members
<div>
ValueType.Equals(Object)
System.ValueType.Equals(System.Object)
</div>
<div>
ValueType.GetHashCode()
</div>
<div>
System.ValueType.GetHashCode()
ValueType.ToString()
</div>
<div>
Object.Equals(Object, Object)
</div>
System.ValueType.ToString()
<div>
Object.GetType()
</div>
<div>
Object.ReferenceEquals(Object, Object)
System.Object.Equals(System.Object, System.Object)
</div>
</div>
##### **Namespace**: System.Dynamic.ExpandoObject
System.Object.GetType()
System.Object.ReferenceEquals(System.Object, System.Object)
###### **Namespace**: Unity.Networking.Transport
###### **Assembly**: Transport.dll
##### **Assembly**: transport.dll
##### Syntax
``` lang-csharp
public struct Concurrent
```
##
### AbortSend(DataStreamWriter)
### Methods
#### AbortSend(DataStreamWriter)
<div class="markdown level1 summary">
Aborts a asynchronous send.
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public void AbortSend(DataStreamWriter writer)
```
##### Parameters
#### Parameters
| Type | Name | Description |
|------------------|--------|---------------------------------------------------|
| DataStreamWriter | writer | If you require the payload to be of certain size. |
##### Exceptions
#### Exceptions
| Type | Condition |
|----------------------------------|----------------------------------------------------------------------|
| System.InvalidOperationException | If endsend is called with a matching BeginSend call. |
| System.InvalidOperationException | If the connection got closed between the call of being and end send. |
#### BeginSend(NetworkConnection, out DataStreamWriter, Int32)
### BeginSend(NetworkConnection, out DataStreamWriter, Int32)
<div class="markdown level1 summary">
Acquires a DataStreamWriter for starting a asynchronous send.
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public int BeginSend(NetworkConnection id, out DataStreamWriter writer, int requiredPayloadSize = 0)
```
##### Parameters
#### Parameters
| Type | Name | Description |
|-------------------|---------------------|--------------------------------------------------|
@ -129,40 +125,40 @@ public int BeginSend(NetworkConnection id, out DataStreamWriter writer, int requ
| DataStreamWriter | writer | A DataStreamWriter to write to |
| System.Int32 | requiredPayloadSize | If you require the payload to be of certain size |
##### Returns
#### Returns
| Type | Description |
|--------------|------------------------------------------------------------------------------------------------|
| System.Int32 | Returns Success on a successful acquire. Otherwise returns an StatusCode indicating the error. |
##### Remarks
#### Remarks
<div class="markdown level1 remarks">
Will throw a System.InvalidOperationException if the connection is in a
Connecting state.
</div>
### BeginSend(NetworkPipeline, NetworkConnection, out DataStreamWriter, Int32)
#### BeginSend(NetworkPipeline, NetworkConnection, out DataStreamWriter, Int32)
<div class="markdown level1 summary">
Acquires a DataStreamWriter for starting a asynchronous send.
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public int BeginSend(NetworkPipeline pipe, NetworkConnection id, out DataStreamWriter writer, int requiredPayloadSize = 0)
```
##### Parameters
#### Parameters
| Type | Name | Description |
|-------------------|---------------------|--------------------------------------------------|
@ -171,184 +167,169 @@ public int BeginSend(NetworkPipeline pipe, NetworkConnection id, out DataStreamW
| DataStreamWriter | writer | A DataStreamWriter to write to |
| System.Int32 | requiredPayloadSize | If you require the payload to be of certain size |
##### Returns
#### Returns
| Type | Description |
|--------------|------------------------------------------------------------------------------------------------|
| System.Int32 | Returns Success on a successful acquire. Otherwise returns an StatusCode indicating the error. |
##### Remarks
#### Remarks
<div class="markdown level1 remarks">
Will throw a System.InvalidOperationException if the connection is in a
Connecting state.
</div>
### EndSend(DataStreamWriter)
#### EndSend(DataStreamWriter)
<div class="markdown level1 summary">
Ends a asynchronous send.
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public int EndSend(DataStreamWriter writer)
```
##### Parameters
#### Parameters
| Type | Name | Description |
|------------------|--------|---------------------------------------------------|
| DataStreamWriter | writer | If you require the payload to be of certain size. |
##### Returns
#### Returns
| Type | Description |
|--------------|------------------------------------------------------|
| System.Int32 | The length of the buffer sent if nothing went wrong. |
##### Exceptions
#### Exceptions
| Type | Condition |
|----------------------------------|----------------------------------------------------------------------|
| System.InvalidOperationException | If endsend is called with a matching BeginSend call. |
| System.InvalidOperationException | If the connection got closed between the call of being and end send. |
#### GetConnectionState(NetworkConnection)
### GetConnectionState(NetworkConnection)
<div class="markdown level1 summary">
Gets the connection state using the specified id
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public NetworkConnection.State GetConnectionState(NetworkConnection id)
```
#### Parameters
| Type | Name | Description |
|-------------------|------|-------------|
| NetworkConnection | id | |
##### Parameters
#### Returns
| Type | Name | Description |
|-------------------|------|-------------------|
| NetworkConnection | id | The connection id |
| Type | Description |
|-------------------------|-------------|
| NetworkConnection.State | |
##### Returns
### MaxHeaderSize(NetworkPipeline)
| Type | Description |
|-------------------------|------------------------------|
| NetworkConnection.State | The network connection state |
<div class="markdown level1 summary">
#### MaxHeaderSize(NetworkPipeline)
</div>
<div class="markdown level1 conceptual">
Max headersize including a NetworkPipeline
##### Declaration
</div>
#### Declaration
``` lang-csharp
public int MaxHeaderSize(NetworkPipeline pipe)
```
#### Parameters
| Type | Name | Description |
|-----------------|------|-------------|
| NetworkPipeline | pipe | |
##### Parameters
#### Returns
| Type | Name | Description |
|-----------------|------|---------------------------------------------------------|
| NetworkPipeline | pipe | The pipeline with which to get the maximum header size. |
| Type | Description |
|--------------|-------------|
| System.Int32 | |
##### Returns
### PopEventForConnection(NetworkConnection, out DataStreamReader)
| Type | Description |
|--------------|-----------------|
| System.Int32 | The header size |
<div class="markdown level1 summary">
#### PopEventForConnection(NetworkConnection, out DataStreamReader)
</div>
<div class="markdown level1 conceptual">
Pops events for a connection using the specified connection id
##### Declaration
</div>
#### Declaration
``` lang-csharp
public NetworkEvent.Type PopEventForConnection(NetworkConnection connectionId, out DataStreamReader reader)
```
#### Parameters
| Type | Name | Description |
|-------------------|--------------|-------------|
| NetworkConnection | connectionId | |
| DataStreamReader | reader | |
##### Parameters
#### Returns
| Type | Name | Description |
|-------------------|--------------|-------------------------------------|
| NetworkConnection | connectionId | The connection id |
| DataStreamReader | reader | Stream reader for the event's data. |
| Type | Description |
|-------------------|-------------|
| NetworkEvent.Type | |
##### Returns
### PopEventForConnection(NetworkConnection, out DataStreamReader, out NetworkPipeline)
| Type | Description |
|-------------------|------------------------|
| NetworkEvent.Type | The network event type |
<div class="markdown level1 summary">
#### PopEventForConnection(NetworkConnection, out DataStreamReader, out NetworkPipeline)
</div>
<div class="markdown level1 conceptual">
Pops events for a connection using the specified connection id
##### Declaration
</div>
#### Declaration
``` lang-csharp
public NetworkEvent.Type PopEventForConnection(NetworkConnection connectionId, out DataStreamReader reader, out NetworkPipeline pipeline)
```
#### Parameters
| Type | Name | Description |
|-------------------|--------------|-------------|
| NetworkConnection | connectionId | |
| DataStreamReader | reader | |
| NetworkPipeline | pipeline | |
##### Parameters
| Type | Name | Description |
|-------------------|--------------|------------------------------------------------|
| NetworkConnection | connectionId | The connection id |
| DataStreamReader | reader | Stream reader for the event's data. |
| NetworkPipeline | pipeline | Pipeline on which the data event was received. |
##### Returns
#### Returns
| Type | Description |
|-------------------|-------------|
| NetworkEvent.Type | The type |
| NetworkEvent.Type | |

1012
transport/api/Unity.Networking.Transport.NetworkDriver.md
Просмотреть файл

Разница между файлами не показана из-за своего большого размера Загрузить разницу

476
transport/api/Unity.Networking.Transport.NetworkEndPoint.md
Просмотреть файл

@ -1,469 +1,423 @@
---
id: Unity.Networking.Transport.NetworkEndPoint
title: Unity.Networking.Transport.NetworkEndPoint
---
id: Unity.Networking.Transport.NetworkEndPoint
title: Unity.Networking.Transport.NetworkEndPoint
---
<div class="markdown level0 summary">
# Struct NetworkEndPoint
Describes a raw network endpoint (typically IP and port number).
</div>
<div class="markdown level0 conceptual">
</div>
<div class="inheritedMembers">
##### Inherited Members
<div>
Object.Equals(Object, Object)
System.Object.Equals(System.Object, System.Object)
</div>
<div>
Object.GetType()
</div>
<div>
System.Object.GetType()
Object.ReferenceEquals(Object, Object)
</div>
</div>
##### **Namespace**: System.Dynamic.ExpandoObject
System.Object.ReferenceEquals(System.Object, System.Object)
###### **Namespace**: Unity.Networking.Transport
###### **Assembly**: Transport.dll
##### **Assembly**: transport.dll
##### Syntax
``` lang-csharp
public struct NetworkEndPoint
```
##
### Address
### Properties
<div class="markdown level1 summary">
#### Address
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public readonly string Address { get; }
```
##### Property Value
#### Property Value
| Type | Description |
|---------------|-------------|
| System.String | |
#### AnyIpv4
### AnyIpv4
<div class="markdown level1 summary">
Gets an IPv4 endpoint that can be used to bind to any address available
(0.0.0.0:0).
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public static readonly NetworkEndPoint AnyIpv4 { get; }
```
##### Property Value
#### Property Value
| Type | Description |
|-----------------|-------------|
| NetworkEndPoint | |
#### AnyIpv6
### AnyIpv6
<div class="markdown level1 summary">
Gets an IPv6 endpoint that can be used to bind to any address available
(\[::0\]:0).
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public static readonly NetworkEndPoint AnyIpv6 { get; }
```
##### Property Value
#### Property Value
| Type | Description |
|-----------------|-------------|
| NetworkEndPoint | |
#### Family
### Family
<div class="markdown level1 summary">
Gets or sets NetworkFamily of the endpoint.
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public NetworkFamily Family { get; set; }
```
##### Property Value
#### Property Value
| Type | Description |
|---------------|-------------|
| NetworkFamily | |
#### IsAny
### IsAny
<div class="markdown level1 summary">
Whether the endpoint is using an "any" address.
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public readonly bool IsAny { get; }
```
##### Property Value
#### Property Value
| Type | Description |
|----------------|-------------|
| System.Boolean | |
#### IsLoopback
### IsLoopback
<div class="markdown level1 summary">
Whether the endpoint is using a loopback address.
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public readonly bool IsLoopback { get; }
```
##### Property Value
#### Property Value
| Type | Description |
|----------------|-------------|
| System.Boolean | |
#### IsValid
### IsValid
<div class="markdown level1 summary">
Whether the endpoint is valid or not.
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public readonly bool IsValid { get; }
```
##### Property Value
#### Property Value
| Type | Description |
|----------------|-------------|
| System.Boolean | |
#### Length
### Length
<div class="markdown level1 summary">
Returns the length of the raw network endpoint in bytes.
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public readonly int Length { get; }
```
##### Property Value
#### Property Value
| Type | Description |
|--------------|-------------|
| System.Int32 | |
#### LoopbackIpv4
### LoopbackIpv4
<div class="markdown level1 summary">
Gets an IPv4 loopback endpoint (127.0.0.1:0).
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public static readonly NetworkEndPoint LoopbackIpv4 { get; }
```
##### Property Value
#### Property Value
| Type | Description |
|-----------------|-------------|
| NetworkEndPoint | |
#### LoopbackIpv6
### LoopbackIpv6
<div class="markdown level1 summary">
Gets an IPv6 loopback endpoint (\[::1\]:0).
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public static readonly NetworkEndPoint LoopbackIpv6 { get; }
```
##### Property Value
#### Property Value
| Type | Description |
|-----------------|-------------|
| NetworkEndPoint | |
#### Port
### Port
<div class="markdown level1 summary">
Gets or sets port number of the endpoint.
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public ushort Port { get; set; }
```
##### Property Value
#### Property Value
| Type | Description |
|---------------|-------------|
| System.UInt16 | |
#### RawPort
### RawPort
<div class="markdown level1 summary">
Gets or sets the value of the raw port number.
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public ushort RawPort { get; set; }
```
##### Property Value
#### Property Value
| Type | Description |
|---------------|-------------|
| System.UInt16 | |
### Methods
##
#### Equals(Object)
### Equals(Object)
<div class="markdown level1 summary">
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public override bool Equals(object other)
```
##### Parameters
#### Parameters
| Type | Name | Description |
|---------------|-------|-------------|
| System.Object | other | |
##### Returns
#### Returns
| Type | Description |
|----------------|-------------|
| System.Boolean | |
##### Overrides
#### Overrides
<div>
System.ValueType.Equals(System.Object)
</div>
### GetHashCode()
#### GetHashCode()
<div class="markdown level1 summary">
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public override int GetHashCode()
```
##### Returns
#### Returns
| Type | Description |
|--------------|-------------|
| System.Int32 | |
##### Overrides
#### Overrides
<div>
System.ValueType.GetHashCode()
</div>
### GetRawAddressBytes()
#### GetRawAddressBytes()
<div class="markdown level1 summary">
</div>
Gets the raw bytes for the endpoint.
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public NativeArray<byte> GetRawAddressBytes()
```
#### Returns
| Type | Description |
|----------------------------|-------------|
| NativeArray\&lt;System.Byte&gt; | |
##### Returns
### Parse(String, UInt16, NetworkFamily)
| Type | Description |
|----------------------------|--------------------------------------------------------------------|
| NativeArray\<System.Byte\> | Native array containing the raw bytes (uses temporary allocation). |
<div class="markdown level1 summary">
#### Parse(String, UInt16, NetworkFamily)
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public static NetworkEndPoint Parse(string address, ushort port, NetworkFamily family = NetworkFamily.Ipv4)
```
##### Parameters
#### Parameters
| Type | Name | Description |
|---------------|---------|-------------|
@ -471,94 +425,82 @@ public static NetworkEndPoint Parse(string address, ushort port, NetworkFamily f
| System.UInt16 | port | |
| NetworkFamily | family | |
##### Returns
#### Returns
| Type | Description |
|-----------------|-------------|
| NetworkEndPoint | |
#### SetRawAddressBytes(NativeArray\<Byte\>, NetworkFamily)
### SetRawAddressBytes(NativeArray\&lt;Byte&gt;, NetworkFamily)
<div class="markdown level1 summary">
Directly sets the raw bytes of the endpoint using the specified bytes
and family.
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public void SetRawAddressBytes(NativeArray<byte> bytes, NetworkFamily family = NetworkFamily.Ipv4)
```
#### Parameters
| Type | Name | Description |
|----------------------------|--------|-------------|
| NativeArray\&lt;System.Byte&gt; | bytes | |
| NetworkFamily | family | |
##### Parameters
### ToString()
| Type | Name | Description |
|----------------------------|--------|------------------------------------|
| NativeArray\<System.Byte\> | bytes | Raw bytes to use for the endpoint. |
| NetworkFamily | family | Endpoint's address family. |
<div class="markdown level1 summary">
##### Exceptions
</div>
| Type | Condition |
|----------------------------------|---------------------------------------|
| System.InvalidOperationException | Length of bytes doesn't match family. |
<div class="markdown level1 conceptual">
#### ToString()
##### Declaration
</div>
#### Declaration
``` lang-csharp
public override string ToString()
```
##### Returns
#### Returns
| Type | Description |
|---------------|-------------|
| System.String | |
##### Overrides
#### Overrides
<div>
System.ValueType.ToString()
</div>
### TryParse(String, UInt16, out NetworkEndPoint, NetworkFamily)
#### TryParse(String, UInt16, out NetworkEndPoint, NetworkFamily)
<div class="markdown level1 summary">
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public static bool TryParse(string address, ushort port, out NetworkEndPoint endpoint, NetworkFamily family = NetworkFamily.Ipv4)
```
##### Parameters
#### Parameters
| Type | Name | Description |
|-----------------|----------|-------------|
@ -567,104 +509,96 @@ public static bool TryParse(string address, ushort port, out NetworkEndPoint end
| NetworkEndPoint | endpoint | |
| NetworkFamily | family | |
##### Returns
#### Returns
| Type | Description |
|----------------|-------------|
| System.Boolean | |
#### WithPort(UInt16)
### WithPort(UInt16)
<div class="markdown level1 summary">
Use the given port number for this endpoint.
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public NetworkEndPoint WithPort(ushort port)
```
#### Parameters
| Type | Name | Description |
|---------------|------|-------------|
| System.UInt16 | port | |
##### Parameters
#### Returns
| Type | Name | Description |
|---------------|------|------------------|
| System.UInt16 | port | The port number. |
| Type | Description |
|-----------------|-------------|
| NetworkEndPoint | |
##### Returns
##
| Type | Description |
|-----------------|----------------------|
| NetworkEndPoint | The endpoint (this). |
### Equality(NetworkEndPoint, NetworkEndPoint)
### Operators
<div class="markdown level1 summary">
#### Equality(NetworkEndPoint, NetworkEndPoint)
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public static bool operator ==(NetworkEndPoint lhs, NetworkEndPoint rhs)
```
##### Parameters
#### Parameters
| Type | Name | Description |
|-----------------|------|-------------|
| NetworkEndPoint | lhs | |
| NetworkEndPoint | rhs | |
##### Returns
#### Returns
| Type | Description |
|----------------|-------------|
| System.Boolean | |
#### Inequality(NetworkEndPoint, NetworkEndPoint)
### Inequality(NetworkEndPoint, NetworkEndPoint)
<div class="markdown level1 summary">
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public static bool operator !=(NetworkEndPoint lhs, NetworkEndPoint rhs)
```
##### Parameters
#### Parameters
| Type | Name | Description |
|-----------------|------|-------------|
| NetworkEndPoint | lhs | |
| NetworkEndPoint | rhs | |
##### Returns
#### Returns
| Type | Description |
|----------------|-------------|
| System.Boolean | |

61
transport/api/Unity.Networking.Transport.NetworkEvent.Type.md
Просмотреть файл

@ -1,60 +1,33 @@
---
id: Unity.Networking.Transport.NetworkEvent.Type
title: Unity.Networking.Transport.NetworkEvent.Type
---
id: Unity.Networking.Transport.NetworkEvent.Type
title: Unity.Networking.Transport.NetworkEvent.Type
---
<div class="markdown level0 summary">
# Enum NetworkEvent.Type
NetworkEvent.Type enumerates available network events for this driver.
</div>
The different types of events that can be returned for a connection.
<div class="markdown level0 conceptual">
</div>
##### **Namespace**: System.Dynamic.ExpandoObject
###### **Namespace**: Unity.Networking.Transport
###### **Assembly**: Transport.dll
##### **Assembly**: transport.dll
##### Syntax
``` lang-csharp
public enum Type : short
```
##
### Fields
Name
Description
Connect
The connection is now established.
Data
Data was received on the connection.
Disconnect
The connection is now closed.
Empty
No event actually occured. Should be ignored.
| Name | Description |
|------------|-------------|
| Connect | |
| Data | |
| Disconnect | |
| Empty | |

65
transport/api/Unity.Networking.Transport.NetworkEvent.md
Просмотреть файл

@ -1,71 +1,64 @@
---
id: Unity.Networking.Transport.NetworkEvent
title: Unity.Networking.Transport.NetworkEvent
---
id: Unity.Networking.Transport.NetworkEvent
title: Unity.Networking.Transport.NetworkEvent
---
<div class="markdown level0 summary">
# Struct NetworkEvent
Represents an event on a connection.
</div>
<div class="markdown level0 conceptual">
</div>
<div class="inheritedMembers">
##### Inherited Members
<div>
ValueType.Equals(Object)
System.ValueType.Equals(System.Object)
</div>
<div>
ValueType.GetHashCode()
</div>
<div>
System.ValueType.GetHashCode()
ValueType.ToString()
</div>
<div>
Object.Equals(Object, Object)
</div>
System.ValueType.ToString()
<div>
Object.GetType()
</div>
<div>
Object.ReferenceEquals(Object, Object)
System.Object.Equals(System.Object, System.Object)
</div>
</div>
##### **Namespace**: System.Dynamic.ExpandoObject
System.Object.GetType()
System.Object.ReferenceEquals(System.Object, System.Object)
###### **Namespace**: Unity.Networking.Transport
###### **Assembly**: Transport.dll
##### **Assembly**: transport.dll
##### Syntax
``` lang-csharp
public struct NetworkEvent
```

0
transport_versioned_docs/version-2.0.0/api/Unity.Networking.Transport.NetworkEventQueue.Concurrent.md → transport/api/Unity.Networking.Transport.NetworkEventQueue.Concurrent.md
Просмотреть файл

0
transport_versioned_docs/version-2.0.0/api/Unity.Networking.Transport.NetworkEventQueue.md → transport/api/Unity.Networking.Transport.NetworkEventQueue.md
Просмотреть файл

57
transport/api/Unity.Networking.Transport.NetworkFamily.md
Просмотреть файл

@ -1,57 +1,32 @@
---
id: Unity.Networking.Transport.NetworkFamily
title: Unity.Networking.Transport.NetworkFamily
---
id: Unity.Networking.Transport.NetworkFamily
title: Unity.Networking.Transport.NetworkFamily
---
<div class="markdown level0 summary">
# Enum NetworkFamily
NetworkFamily indicates what type of underlying medium we are using.
</div>
Indicates the protocol family of the address (analogous of AF\_\* in
sockets API).
<div class="markdown level0 conceptual">
</div>
##### **Namespace**: System.Dynamic.ExpandoObject
###### **Namespace**: Unity.Networking.Transport
###### **Assembly**: Transport.dll
##### **Assembly**: transport.dll
##### Syntax
``` lang-csharp
public enum NetworkFamily
```
##
### Fields
Name
Description
Invalid
Invalid network family.
Ipv4
IPv4 (analogous to AF_INET).
Ipv6
IPv6 (analogous to AF_INET6).
| Name | Description |
|---------|-------------|
| Invalid | |
| Ipv4 | |
| Ipv6 | |

267
transport/api/Unity.Networking.Transport.NetworkInterfaceEndPoint.md
Просмотреть файл

@ -1,379 +1,357 @@
---
id: Unity.Networking.Transport.NetworkInterfaceEndPoint
title: Unity.Networking.Transport.NetworkInterfaceEndPoint
---
id: Unity.Networking.Transport.NetworkInterfaceEndPoint
title: Unity.Networking.Transport.NetworkInterfaceEndPoint
---
<div class="markdown level0 summary">
# Struct NetworkInterfaceEndPoint
</div>
<div class="markdown level0 conceptual">
</div>
<div classs="implements">
##### Implements
<div>
System.IEquatable\<NetworkInterfaceEndPoint\>
</div>
</div>
<div class="inheritedMembers">
##### Inherited Members
<div>
Object.Equals(Object, Object)
System.Object.Equals(System.Object, System.Object)
</div>
<div>
Object.GetType()
</div>
<div>
System.Object.GetType()
Object.ReferenceEquals(Object, Object)
</div>
</div>
##### **Namespace**: System.Dynamic.ExpandoObject
System.Object.ReferenceEquals(System.Object, System.Object)
###### **Namespace**: Unity.Networking.Transport
###### **Assembly**: Transport.dll
##### **Assembly**: transport.dll
##### Syntax
``` lang-csharp
public struct NetworkInterfaceEndPoint : IEquatable<NetworkInterfaceEndPoint>
```
##
### data
### Fields
<div class="markdown level1 summary">
#### data
</div>
<div class="markdown level1 conceptual">
Raw representation of the interface endpoint.
##### Declaration
</div>
#### Declaration
``` lang-csharp
public byte *data
```
##### Field Value
#### Field Value
| Type | Description |
|---------------|-------------|
| System.Byte\* | |
#### dataLength
### dataLength
<div class="markdown level1 summary">
Actual length of the interface endpoint's raw representation.
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public int dataLength
```
##### Field Value
#### Field Value
| Type | Description |
|--------------|-------------|
| System.Int32 | |
#### k_MaxLength
### k_MaxLength
<div class="markdown level1 summary">
Maximum length of the interface endpoint's raw representation.
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public const int k_MaxLength = 56
```
##### Field Value
#### Field Value
| Type | Description |
|--------------|-------------|
| System.Int32 | |
### Properties
##
#### IsValid
### IsValid
<div class="markdown level1 summary">
Whether the interface endpoint is valid or not.
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public readonly bool IsValid { get; }
```
##### Property Value
#### Property Value
| Type | Description |
|----------------|-------------|
| System.Boolean | |
### Methods
##
#### Equals(Object)
### Equals(Object)
<div class="markdown level1 summary">
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public override bool Equals(object other)
```
##### Parameters
#### Parameters
| Type | Name | Description |
|---------------|-------|-------------|
| System.Object | other | |
##### Returns
#### Returns
| Type | Description |
|----------------|-------------|
| System.Boolean | |
##### Overrides
#### Overrides
<div>
System.ValueType.Equals(System.Object)
</div>
### Equals(NetworkInterfaceEndPoint)
#### Equals(NetworkInterfaceEndPoint)
<div class="markdown level1 summary">
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public bool Equals(NetworkInterfaceEndPoint other)
```
##### Parameters
#### Parameters
| Type | Name | Description |
|--------------------------|-------|-------------|
| NetworkInterfaceEndPoint | other | |
##### Returns
#### Returns
| Type | Description |
|----------------|-------------|
| System.Boolean | |
#### GetHashCode()
### GetHashCode()
<div class="markdown level1 summary">
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public override int GetHashCode()
```
##### Returns
#### Returns
| Type | Description |
|--------------|-------------|
| System.Int32 | |
##### Overrides
#### Overrides
<div>
System.ValueType.GetHashCode()
</div>
### ToFixedString()
#### ToFixedString()
<div class="markdown level1 summary">
</div>
Returns the NetworkInterfaceEndPoint as a .
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public FixedString64Bytes ToFixedString()
```
##### Returns
#### Returns
| Type | Description |
|--------------------|-------------|
| FixedString64Bytes | |
#### ToString()
### ToString()
<div class="markdown level1 summary">
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public override string ToString()
```
##### Returns
#### Returns
| Type | Description |
|---------------|-------------|
| System.String | |
##### Overrides
#### Overrides
<div>
System.ValueType.ToString()
</div>
##
### Operators
### Equality(NetworkInterfaceEndPoint, NetworkInterfaceEndPoint)
#### Equality(NetworkInterfaceEndPoint, NetworkInterfaceEndPoint)
<div class="markdown level1 summary">
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public static bool operator ==(NetworkInterfaceEndPoint lhs, NetworkInterfaceEndPoint rhs)
```
##### Parameters
#### Parameters
| Type | Name | Description |
|--------------------------|------|-------------|
| NetworkInterfaceEndPoint | lhs | |
| NetworkInterfaceEndPoint | rhs | |
##### Returns
#### Returns
| Type | Description |
|----------------|-------------|
| System.Boolean | |
#### Inequality(NetworkInterfaceEndPoint, NetworkInterfaceEndPoint)
### Inequality(NetworkInterfaceEndPoint, NetworkInterfaceEndPoint)
<div class="markdown level1 summary">
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public static bool operator !=(NetworkInterfaceEndPoint lhs, NetworkInterfaceEndPoint rhs)
```
##### Parameters
#### Parameters
| Type | Name | Description |
|--------------------------|------|-------------|
| NetworkInterfaceEndPoint | lhs | |
| NetworkInterfaceEndPoint | rhs | |
##### Returns
#### Returns
| Type | Description |
|----------------|-------------|
@ -381,11 +359,8 @@ public static bool operator !=(NetworkInterfaceEndPoint lhs, NetworkInterfaceEnd
### Implements
<div>
System.IEquatable\&lt;T&gt;
System.IEquatable\<T\>
</div>

152
transport/api/Unity.Networking.Transport.NetworkInterfaceSendHandle.md
Просмотреть файл

@ -1,198 +1,176 @@
---
id: Unity.Networking.Transport.NetworkInterfaceSendHandle
title: Unity.Networking.Transport.NetworkInterfaceSendHandle
---
id: Unity.Networking.Transport.NetworkInterfaceSendHandle
title: Unity.Networking.Transport.NetworkInterfaceSendHandle
---
<div class="markdown level0 summary">
# Struct NetworkInterfaceSendHandle
A handle to data that's going to be sent on an interface.
</div>
<div class="markdown level0 conceptual">
</div>
<div class="inheritedMembers">
##### Inherited Members
<div>
ValueType.Equals(Object)
System.ValueType.Equals(System.Object)
</div>
<div>
ValueType.GetHashCode()
</div>
<div>
System.ValueType.GetHashCode()
ValueType.ToString()
</div>
<div>
Object.Equals(Object, Object)
</div>
System.ValueType.ToString()
<div>
Object.GetType()
</div>
<div>
Object.ReferenceEquals(Object, Object)
System.Object.Equals(System.Object, System.Object)
</div>
</div>
##### **Namespace**: System.Dynamic.ExpandoObject
System.Object.GetType()
System.Object.ReferenceEquals(System.Object, System.Object)
###### **Namespace**: Unity.Networking.Transport
###### **Assembly**: Transport.dll
##### **Assembly**: transport.dll
##### Syntax
``` lang-csharp
public struct NetworkInterfaceSendHandle
```
##
### capacity
### Fields
<div class="markdown level1 summary">
#### capacity
</div>
<div class="markdown level1 conceptual">
Maximum capacity of the data buffer.
##### Declaration
</div>
#### Declaration
``` lang-csharp
public int capacity
```
##### Field Value
#### Field Value
| Type | Description |
|--------------|-------------|
| System.Int32 | |
#### data
### data
<div class="markdown level1 summary">
Pointer to the data buffer.
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public IntPtr data
```
##### Field Value
#### Field Value
| Type | Description |
|---------------|-------------|
| System.IntPtr | |
#### flags
### flags
<div class="markdown level1 summary">
Internal flags used by the driver (tracks who allocated the memory).
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public SendHandleFlags flags
```
##### Field Value
#### Field Value
| Type | Description |
|-----------------|-------------|
| SendHandleFlags | |
#### id
### id
<div class="markdown level1 summary">
Internal ID for this handle.
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public int id
```
##### Field Value
#### Field Value
| Type | Description |
|--------------|-------------|
| System.Int32 | |
#### size
### size
<div class="markdown level1 summary">
Actual size of the data in the buffer.
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public int size
```
##### Field Value
#### Field Value
| Type | Description |
|--------------|-------------|
| System.Int32 | |

52
transport/api/Unity.Networking.Transport.NetworkPacketReceiver.AppendPacketMode.md
Просмотреть файл

@ -1,54 +1,30 @@
---
id: Unity.Networking.Transport.NetworkPacketReceiver.AppendPacketMode
title: Unity.Networking.Transport.NetworkPacketReceiver.AppendPacketMode
---
id: Unity.Networking.Transport.NetworkPacketReceiver.AppendPacketMode
title: Unity.Networking.Transport.NetworkPacketReceiver.AppendPacketMode
---
<div class="markdown level0 summary">
# Enum NetworkPacketReceiver.AppendPacketMode
</div>
<div class="markdown level0 conceptual">
Permits choosing between two ways of appending packets: via a copy or
not.
</div>
##### **Namespace**: System.Dynamic.ExpandoObject
###### **Namespace**: Unity.Networking.Transport
###### **Assembly**: Transport.dll
##### **Assembly**: transport.dll
##### Syntax
``` lang-csharp
[Flags]
public enum AppendPacketMode
```
##
### Fields
Name
Description
NoCopyNeeded
No Copy required when appending a packet
None
Append Packet via a copy, which is the default mode
| Name | Description |
|--------------|-------------|
| NoCopyNeeded | |
| None | |

155
transport/api/Unity.Networking.Transport.NetworkPacketReceiver.md
Просмотреть файл

@ -1,11 +1,9 @@
---
id: Unity.Networking.Transport.NetworkPacketReceiver
title: Unity.Networking.Transport.NetworkPacketReceiver
---
id: Unity.Networking.Transport.NetworkPacketReceiver
title: Unity.Networking.Transport.NetworkPacketReceiver
---
# Struct NetworkPacketReceiver
<div class="markdown level0 summary">
The NetworkPacketReceiver is an interface for handling received packets,
needed by the INetworkInterface It either can be used in two main
@ -20,171 +18,162 @@ scenarios:
should use AppendPacket(IntPtr, ref NetworkInterfaceEndPoint, Int32,
NetworkPacketReceiver.AppendPacketMode) with None (default)
</div>
<div class="markdown level0 conceptual">
</div>
<div class="inheritedMembers">
##### Inherited Members
<div>
ValueType.Equals(Object)
System.ValueType.Equals(System.Object)
</div>
<div>
ValueType.GetHashCode()
</div>
<div>
System.ValueType.GetHashCode()
ValueType.ToString()
</div>
<div>
Object.Equals(Object, Object)
</div>
System.ValueType.ToString()
<div>
Object.GetType()
</div>
<div>
Object.ReferenceEquals(Object, Object)
System.Object.Equals(System.Object, System.Object)
</div>
</div>
##### **Namespace**: System.Dynamic.ExpandoObject
System.Object.GetType()
System.Object.ReferenceEquals(System.Object, System.Object)
###### **Namespace**: Unity.Networking.Transport
###### **Assembly**: Transport.dll
##### **Assembly**: transport.dll
##### Syntax
``` lang-csharp
public struct NetworkPacketReceiver
```
##
### LastUpdateTime
### Properties
<div class="markdown level1 summary">
#### LastUpdateTime
</div>
<div class="markdown level1 conceptual">
Gets the value of the last update time.
##### Declaration
</div>
#### Declaration
``` lang-csharp
public readonly long LastUpdateTime { get; }
```
##### Property Value
#### Property Value
| Type | Description |
|--------------|-------------|
| System.Int64 | |
#### ReceiveErrorCode
### ReceiveErrorCode
<div class="markdown level1 summary">
Sets the value of the receive error code
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public int ReceiveErrorCode { set; }
```
##### Property Value
#### Property Value
| Type | Description |
|--------------|-------------|
| System.Int32 | |
### Methods
##
#### AllocateMemory(ref Int32)
### AllocateMemory(ref Int32)
<div class="markdown level1 summary">
Calls NetworkDriver's
Unity.Networking.Transport.NetworkDriver.AllocateMemory(System.Int32@)
Calls NetworkDriver's AllocateMemory(ref Int32)
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public IntPtr AllocateMemory(ref int dataLen)
```
##### Parameters
#### Parameters
| Type | Name | Description |
|--------------|---------|---------------------------------------------------|
| System.Int32 | dataLen | Size of memory to allocate in bytes. Must be \> 0 |
##### Returns
#### Returns
| Type | Description |
|---------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| System.IntPtr | Pointer to allocated memory or IntPtr.Zero if there is no space left (this function doesn't set ReceiveErrorCode! caller should decide if this is Out of memory or something else) |
#### AppendPacket(IntPtr, ref NetworkInterfaceEndPoint, Int32, NetworkPacketReceiver.AppendPacketMode)
### AppendPacket(IntPtr, ref NetworkInterfaceEndPoint, Int32, NetworkPacketReceiver.AppendPacketMode)
<div class="markdown level1 summary">
When data is received this function should be called to pass it inside
NetworkDriver
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public bool AppendPacket(IntPtr data, ref NetworkInterfaceEndPoint address, int dataLen, NetworkPacketReceiver.AppendPacketMode mode = NetworkPacketReceiver.AppendPacketMode.None)
```
##### Parameters
#### Parameters
| Type | Name | Description |
|----------------------------------------|---------|---------------------------------------------------------------------------------------------------------------------------------|
@ -193,44 +182,40 @@ public bool AppendPacket(IntPtr data, ref NetworkInterfaceEndPoint address, int
| System.Int32 | dataLen | Length of in bytes |
| NetworkPacketReceiver.AppendPacketMode | mode | Extra flags, like NoCopyNeeded that means - no copy is needed, data is already in NetworkDriver's data stream |
##### Returns
#### Returns
| Type | Description |
|----------------|-------------------|
| System.Boolean | True if no errors |
#### IsAddressUsed(NetworkInterfaceEndPoint)
### IsAddressUsed(NetworkInterfaceEndPoint)
<div class="markdown level1 summary">
Check if an address is currently associated with a valid connection.
This is mostly useful to keep interface internal lists of connections in
sync with the correct state.
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public bool IsAddressUsed(NetworkInterfaceEndPoint address)
```
##### Parameters
#### Parameters
| Type | Name | Description |
|--------------------------|---------|-------------|
| NetworkInterfaceEndPoint | address | |
##### Returns
#### Returns
| Type | Description |
|----------------|-------------|
| System.Boolean | |

211
transport/api/Unity.Networking.Transport.NetworkParameterConstants.md
Просмотреть файл

@ -1,278 +1,287 @@
---
id: Unity.Networking.Transport.NetworkParameterConstants
title: Unity.Networking.Transport.NetworkParameterConstants
---
id: Unity.Networking.Transport.NetworkParameterConstants
title: Unity.Networking.Transport.NetworkParameterConstants
---
# Struct NetworkParameterConstants
<div class="markdown level0 summary">
Default NetworkParameter Constants.
</div>
<div class="markdown level0 conceptual">
</div>
<div class="inheritedMembers">
##### Inherited Members
<div>
ValueType.Equals(Object)
System.ValueType.Equals(System.Object)
</div>
<div>
ValueType.GetHashCode()
</div>
<div>
System.ValueType.GetHashCode()
ValueType.ToString()
</div>
<div>
Object.Equals(Object, Object)
</div>
System.ValueType.ToString()
<div>
Object.GetType()
</div>
<div>
Object.ReferenceEquals(Object, Object)
System.Object.Equals(System.Object, System.Object)
</div>
</div>
##### **Namespace**: System.Dynamic.ExpandoObject
System.Object.GetType()
System.Object.ReferenceEquals(System.Object, System.Object)
###### **Namespace**: Unity.Networking.Transport
###### **Assembly**: Transport.dll
##### **Assembly**: transport.dll
##### Syntax
``` lang-csharp
public struct NetworkParameterConstants
```
##
### ConnectTimeoutMS
### Fields
#### ConnectTimeoutMS
<div class="markdown level1 summary">
The default connection timeout value. This value can be overridden using
the NetworkConfigParameter
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public const int ConnectTimeoutMS = 1000
```
##### Field Value
#### Field Value
| Type | Description |
|--------------|-------------|
| System.Int32 | |
#### DisconnectTimeoutMS
### DisconnectTimeoutMS
<div class="markdown level1 summary">
The default disconnect timeout attempts value. This value can be
overridden using the NetworkConfigParameter
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public const int DisconnectTimeoutMS = 30000
```
##### Field Value
#### Field Value
| Type | Description |
|--------------|-------------|
| System.Int32 | |
#### DriverDataStreamSize
### DriverDataStreamSize
<div class="markdown level1 summary">
The default size of the DataStreamWriter. This value can be overridden
using the NetworkConfigParameter.
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public const int DriverDataStreamSize = 65536
```
##### Field Value
#### Field Value
| Type | Description |
|--------------|-------------|
| System.Int32 | |
#### HeartbeatTimeoutMS
### HeartbeatTimeoutMS
<div class="markdown level1 summary">
The default inactivity timeout after which a heartbeat is sent. This
This value can be overridden using the NetworkConfigParameter
value can be overridden using the NetworkConfigParameter
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public const int HeartbeatTimeoutMS = 500
```
##### Field Value
#### Field Value
| Type | Description |
|--------------|-------------|
| System.Int32 | |
#### InitialEventQueueSize
### InitialEventQueueSize
<div class="markdown level1 summary">
The default size of the event queue.
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public const int InitialEventQueueSize = 100
```
##### Field Value
#### Field Value
| Type | Description |
|--------------|-------------|
| System.Int32 | |
#### InvalidConnectionId
### InvalidConnectionId
<div class="markdown level1 summary">
The invalid connection id
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public const int InvalidConnectionId = -1
```
##### Field Value
#### Field Value
| Type | Description |
|--------------|-------------|
| System.Int32 | |
#### MaxConnectAttempts
### MaxConnectAttempts
<div class="markdown level1 summary">
The default max connection attempts value. This value can be overridden
using the NetworkConfigParameter
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public const int MaxConnectAttempts = 60
```
##### Field Value
#### Field Value
| Type | Description |
|--------------|-------------|
| System.Int32 | |
#### MTU
### MTU
<div class="markdown level1 summary">
The max size of any packet that can be sent
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public const int MTU = 1400
```
##### Field Value
#### Field Value
| Type | Description |
|--------------|-------------|
| System.Int32 | |
### ReconnectionTimeoutMS
<div class="markdown level1 summary">
The default inactivity timeout after which re-establishing the
connection is attempted. This value can be overridden using the
NetworkConfigParameter.
</div>
<div class="markdown level1 conceptual">
</div>
#### Declaration
``` lang-csharp
public const int ReconnectionTimeoutMS = 2000
```
#### Field Value
| Type | Description |
|--------------|-------------|
| System.Int32 | |

171
transport/api/Unity.Networking.Transport.NetworkPipeline.md
Просмотреть файл

@ -1,247 +1,232 @@
---
id: Unity.Networking.Transport.NetworkPipeline
title: Unity.Networking.Transport.NetworkPipeline
---
id: Unity.Networking.Transport.NetworkPipeline
title: Unity.Networking.Transport.NetworkPipeline
---
<div class="markdown level0 summary">
# Struct NetworkPipeline
The network pipeline
</div>
<div class="markdown level0 conceptual">
</div>
<div class="inheritedMembers">
##### Inherited Members
<div>
ValueType.ToString()
System.ValueType.ToString()
</div>
<div>
Object.Equals(Object, Object)
</div>
<div>
System.Object.Equals(System.Object, System.Object)
Object.GetType()
</div>
<div>
Object.ReferenceEquals(Object, Object)
</div>
System.Object.GetType()
</div>
##### **Namespace**: System.Dynamic.ExpandoObject
System.Object.ReferenceEquals(System.Object, System.Object)
###### **Namespace**: Unity.Networking.Transport
###### **Assembly**: Transport.dll
##### **Assembly**: transport.dll
##### Syntax
``` lang-csharp
public struct NetworkPipeline
```
##
### Null
### Properties
<div class="markdown level1 summary">
#### Null
</div>
<div class="markdown level1 conceptual">
Returns default unreliable Null NetworkPipeline
##### Declaration
</div>
#### Declaration
``` lang-csharp
public static readonly NetworkPipeline Null { get; }
```
##### Property Value
#### Property Value
| Type | Description |
|-----------------|-------------|
| NetworkPipeline | |
### Methods
##
#### Equals(Object)
### Equals(Object)
<div class="markdown level1 summary">
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public override bool Equals(object compare)
```
##### Parameters
#### Parameters
| Type | Name | Description |
|---------------|---------|-------------|
| System.Object | compare | |
##### Returns
#### Returns
| Type | Description |
|----------------|-------------|
| System.Boolean | |
##### Overrides
#### Overrides
<div>
System.ValueType.Equals(System.Object)
</div>
### Equals(NetworkPipeline)
#### Equals(NetworkPipeline)
<div class="markdown level1 summary">
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public bool Equals(NetworkPipeline connection)
```
##### Parameters
#### Parameters
| Type | Name | Description |
|-----------------|------------|-------------|
| NetworkPipeline | connection | |
##### Returns
#### Returns
| Type | Description |
|----------------|-------------|
| System.Boolean | |
#### GetHashCode()
### GetHashCode()
<div class="markdown level1 summary">
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public override int GetHashCode()
```
##### Returns
#### Returns
| Type | Description |
|--------------|-------------|
| System.Int32 | |
##### Overrides
#### Overrides
<div>
System.ValueType.GetHashCode()
</div>
##
### Operators
### Equality(NetworkPipeline, NetworkPipeline)
#### Equality(NetworkPipeline, NetworkPipeline)
<div class="markdown level1 summary">
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public static bool operator ==(NetworkPipeline lhs, NetworkPipeline rhs)
```
##### Parameters
#### Parameters
| Type | Name | Description |
|-----------------|------|-------------|
| NetworkPipeline | lhs | |
| NetworkPipeline | rhs | |
##### Returns
#### Returns
| Type | Description |
|----------------|-------------|
| System.Boolean | |
#### Inequality(NetworkPipeline, NetworkPipeline)
### Inequality(NetworkPipeline, NetworkPipeline)
<div class="markdown level1 summary">
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public static bool operator !=(NetworkPipeline lhs, NetworkPipeline rhs)
```
##### Parameters
#### Parameters
| Type | Name | Description |
|-----------------|------|-------------|
| NetworkPipeline | lhs | |
| NetworkPipeline | rhs | |
##### Returns
#### Returns
| Type | Description |
|----------------|-------------|
| System.Boolean | |

220
transport/api/Unity.Networking.Transport.NetworkPipelineContext.md
Просмотреть файл

@ -1,298 +1,264 @@
---
id: Unity.Networking.Transport.NetworkPipelineContext
title: Unity.Networking.Transport.NetworkPipelineContext
---
id: Unity.Networking.Transport.NetworkPipelineContext
title: Unity.Networking.Transport.NetworkPipelineContext
---
<div class="markdown level0 summary">
# Struct NetworkPipelineContext
The network pipeline context
</div>
<div class="markdown level0 conceptual">
</div>
<div class="inheritedMembers">
##### Inherited Members
<div>
ValueType.Equals(Object)
System.ValueType.Equals(System.Object)
</div>
<div>
ValueType.GetHashCode()
</div>
<div>
System.ValueType.GetHashCode()
ValueType.ToString()
</div>
<div>
Object.Equals(Object, Object)
</div>
System.ValueType.ToString()
<div>
Object.GetType()
</div>
<div>
Object.ReferenceEquals(Object, Object)
System.Object.Equals(System.Object, System.Object)
</div>
</div>
##### **Namespace**: System.Dynamic.ExpandoObject
System.Object.GetType()
System.Object.ReferenceEquals(System.Object, System.Object)
###### **Namespace**: Unity.Networking.Transport
###### **Assembly**: Transport.dll
##### **Assembly**: transport.dll
##### Syntax
``` lang-csharp
public struct NetworkPipelineContext
```
##
### accumulatedHeaderCapacity
### Fields
<div class="markdown level1 summary">
#### accumulatedHeaderCapacity
</div>
<div class="markdown level1 conceptual">
The accumulated header capacity
##### Declaration
</div>
#### Declaration
``` lang-csharp
public int accumulatedHeaderCapacity
```
##### Field Value
#### Field Value
| Type | Description |
|--------------|-------------|
| System.Int32 | |
#### header
### header
<div class="markdown level1 summary">
The header
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public DataStreamWriter header
```
##### Field Value
#### Field Value
| Type | Description |
|------------------|-------------|
| DataStreamWriter | |
#### internalProcessBuffer
### internalProcessBuffer
<div class="markdown level1 summary">
The internal process buffer
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public byte *internalProcessBuffer
```
##### Field Value
#### Field Value
| Type | Description |
|---------------|-------------|
| System.Byte\* | |
#### internalProcessBufferLength
### internalProcessBufferLength
<div class="markdown level1 summary">
The internal process buffer length
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public int internalProcessBufferLength
```
##### Field Value
#### Field Value
| Type | Description |
|--------------|-------------|
| System.Int32 | |
#### internalSharedProcessBuffer
### internalSharedProcessBuffer
<div class="markdown level1 summary">
The internal shared process buffer
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public byte *internalSharedProcessBuffer
```
##### Field Value
#### Field Value
| Type | Description |
|---------------|-------------|
| System.Byte\* | |
#### internalSharedProcessBufferLength
### internalSharedProcessBufferLength
<div class="markdown level1 summary">
The internal shared process buffer length
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public int internalSharedProcessBufferLength
```
##### Field Value
#### Field Value
| Type | Description |
|--------------|-------------|
| System.Int32 | |
#### staticInstanceBuffer
### staticInstanceBuffer
<div class="markdown level1 summary">
The static instance buffer
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public byte *staticInstanceBuffer
```
##### Field Value
#### Field Value
| Type | Description |
|---------------|-------------|
| System.Byte\* | |
#### staticInstanceBufferLength
### staticInstanceBufferLength
<div class="markdown level1 summary">
The static instance buffer length
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public int staticInstanceBufferLength
```
##### Field Value
#### Field Value
| Type | Description |
|--------------|-------------|
| System.Int32 | |
#### timestamp
### timestamp
<div class="markdown level1 summary">
The timestamp
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public long timestamp
```
##### Field Value
#### Field Value
| Type | Description |
|--------------|-------------|
| System.Int64 | |

136
transport/api/Unity.Networking.Transport.NetworkPipelineParametersExtensions.md
Просмотреть файл

@ -1,155 +1,147 @@
---
id: Unity.Networking.Transport.NetworkPipelineParametersExtensions
title: Unity.Networking.Transport.NetworkPipelineParametersExtensions
---
id: Unity.Networking.Transport.NetworkPipelineParametersExtensions
title: Unity.Networking.Transport.NetworkPipelineParametersExtensions
---
<div class="markdown level0 summary">
# Class NetworkPipelineParametersExtensions
</div>
<div class="markdown level0 conceptual">
</div>
<div class="inheritance">
##### Inheritance
<div class="level0">
System.Object
System.Dynamic.ExpandoObject
</div>
<div class="level1">
System.Dynamic.ExpandoObject
NetworkPipelineParametersExtensions
</div>
</div>
<div class="inheritedMembers">
##### Inherited Members
<div>
Object.Equals(Object)
System.Object.Equals(System.Object)
</div>
<div>
Object.Equals(Object, Object)
</div>
<div>
System.Object.Equals(System.Object, System.Object)
Object.GetHashCode()
</div>
<div>
Object.GetType()
</div>
System.Object.GetHashCode()
<div>
Object.MemberwiseClone()
</div>
<div>
Object.ReferenceEquals(Object, Object)
System.Object.GetType()
</div>
<div>
Object.ToString()
</div>
</div>
System.Object.MemberwiseClone()
##### **Namespace**: System.Dynamic.ExpandoObject
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
###### **Namespace**: Unity.Networking.Transport
###### **Assembly**: Transport.dll
##### **Assembly**: transport.dll
##### Syntax
``` lang-csharp
public static class NetworkPipelineParametersExtensions
```
##
### GetPipelineParameters(ref NetworkSettings)
### Methods
<div class="markdown level1 summary">
#### GetPipelineParameters(ref NetworkSettings)
</div>
<div class="markdown level1 conceptual">
Gets the NetworkPipelineParams
##### Declaration
</div>
#### Declaration
``` lang-csharp
public static NetworkPipelineParams GetPipelineParameters(this ref NetworkSettings settings)
```
##### Parameters
#### Parameters
| Type | Name | Description |
|-----------------|----------|-------------|
| NetworkSettings | settings | |
##### Returns
#### Returns
| Type | Description |
|-----------------------|------------------------------------------------------------------|
| NetworkPipelineParams | Returns the NetworkPipelineParams values for the NetworkSettings |
| Type | Description |
|-----------------------|-------------|
| NetworkPipelineParams | |
#### WithPipelineParameters(ref NetworkSettings, Int32)
### WithPipelineParameters(ref NetworkSettings, Int32)
<div class="markdown level1 summary">
Sets the NetworkPipelineParams values for the NetworkSettings
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public static ref NetworkSettings WithPipelineParameters(this ref NetworkSettings settings, int initialCapacity = 0)
```
#### Parameters
| Type | Name | Description |
|-----------------|-----------------|-------------|
| NetworkSettings | settings | |
| System.Int32 | initialCapacity | |
##### Parameters
| Type | Name | Description |
|-----------------|-----------------|-----------------|
| NetworkSettings | settings | |
| System.Int32 | initialCapacity | initialCapacity |
##### Returns
#### Returns
| Type | Description |
|-----------------|-------------|
| NetworkSettings | |

116
transport/api/Unity.Networking.Transport.NetworkPipelineParams.md
Просмотреть файл

@ -1,130 +1,129 @@
---
id: Unity.Networking.Transport.NetworkPipelineParams
title: Unity.Networking.Transport.NetworkPipelineParams
---
id: Unity.Networking.Transport.NetworkPipelineParams
title: Unity.Networking.Transport.NetworkPipelineParams
---
<div class="markdown level0 summary">
# Struct NetworkPipelineParams
The network pipeline params
</div>
<div class="markdown level0 conceptual">
</div>
<div classs="implements">
##### Implements
<div>
INetworkParameter
</div>
<div>
IValidatableNetworkParameter
</div>
</div>
<div class="inheritedMembers">
##### Inherited Members
<div>
ValueType.Equals(Object)
System.ValueType.Equals(System.Object)
</div>
<div>
ValueType.GetHashCode()
</div>
<div>
System.ValueType.GetHashCode()
ValueType.ToString()
</div>
<div>
Object.Equals(Object, Object)
</div>
System.ValueType.ToString()
<div>
Object.GetType()
</div>
<div>
Object.ReferenceEquals(Object, Object)
System.Object.Equals(System.Object, System.Object)
</div>
</div>
##### **Namespace**: System.Dynamic.ExpandoObject
System.Object.GetType()
System.Object.ReferenceEquals(System.Object, System.Object)
###### **Namespace**: Unity.Networking.Transport
###### **Assembly**: Transport.dll
##### **Assembly**: transport.dll
##### Syntax
``` lang-csharp
public struct NetworkPipelineParams : INetworkParameter
public struct NetworkPipelineParams : INetworkParameter, IValidatableNetworkParameter
```
##
### initialCapacity
### Fields
<div class="markdown level1 summary">
#### initialCapacity
</div>
<div class="markdown level1 conceptual">
The initial capacity
##### Declaration
</div>
#### Declaration
``` lang-csharp
public int initialCapacity
```
##### Field Value
#### Field Value
| Type | Description |
|--------------|-------------|
| System.Int32 | |
### Methods
##
#### Validate()
### Validate()
<div class="markdown level1 summary">
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public bool Validate()
```
##### Returns
#### Returns
| Type | Description |
|----------------|-------------|
@ -132,11 +131,14 @@ public bool Validate()
### Implements
<div>
INetworkParameter
</div>
<div>
IValidatableNetworkParameter
</div>

46
transport/api/Unity.Networking.Transport.NetworkPipelineStage.InitializeConnectionDelegate.md
Просмотреть файл

@ -1,43 +1,35 @@
---
id: Unity.Networking.Transport.NetworkPipelineStage.InitializeConnectionDelegate
title: Unity.Networking.Transport.NetworkPipelineStage.InitializeConnectionDelegate
---
id: Unity.Networking.Transport.NetworkPipelineStage.InitializeConnectionDelegate
title: Unity.Networking.Transport.NetworkPipelineStage.InitializeConnectionDelegate
---
<div class="markdown level0 summary">
# Delegate NetworkPipelineStage.InitializeConnectionDelegate
</div>
<div class="markdown level0 conceptual">
The initialize connection delegate
</div>
##### **Namespace**: System.Dynamic.ExpandoObject
###### **Namespace**: Unity.Networking.Transport
###### **Assembly**: Transport.dll
##### **Assembly**: transport.dll
##### Syntax
``` lang-csharp
public delegate void InitializeConnectionDelegate(byte *staticInstanceBuffer, int staticInstanceBufferLength, byte *sendProcessBuffer, int sendProcessBufferLength, byte *recvProcessBuffer, int recvProcessBufferLength, byte *sharedProcessBuffer, int sharedProcessBufferLength);
```
##### Parameters
| Type | Name | Description |
|---------------|----------------------------|-------------|
| System.Byte\* | staticInstanceBuffer | |
| System.Int32 | staticInstanceBufferLength | |
| System.Byte\* | sendProcessBuffer | |
| System.Int32 | sendProcessBufferLength | |
| System.Byte\* | recvProcessBuffer | |
| System.Int32 | recvProcessBufferLength | |
| System.Byte\* | sharedProcessBuffer | |
| System.Int32 | sharedProcessBufferLength | |
| Type | Name | Description |
|---------------|------------------------------|-------------|
| System.Byte\* | \*staticInstanceBuffer | |
| System.Int32 | \*staticInstanceBufferLength | |
| System.Byte\* | \*sendProcessBuffer | |
| System.Int32 | \*sendProcessBufferLength | |
| System.Byte\* | \*recvProcessBuffer | |
| System.Int32 | \*recvProcessBufferLength | |
| System.Byte\* | \*sharedProcessBuffer | |
| System.Int32 | \*sharedProcessBufferLength | |

38
transport/api/Unity.Networking.Transport.NetworkPipelineStage.ReceiveDelegate.md
Просмотреть файл

@ -1,39 +1,31 @@
---
id: Unity.Networking.Transport.NetworkPipelineStage.ReceiveDelegate
title: Unity.Networking.Transport.NetworkPipelineStage.ReceiveDelegate
---
id: Unity.Networking.Transport.NetworkPipelineStage.ReceiveDelegate
title: Unity.Networking.Transport.NetworkPipelineStage.ReceiveDelegate
---
<div class="markdown level0 summary">
# Delegate NetworkPipelineStage.ReceiveDelegate
</div>
<div class="markdown level0 conceptual">
The receive delegate
</div>
##### **Namespace**: System.Dynamic.ExpandoObject
###### **Namespace**: Unity.Networking.Transport
###### **Assembly**: Transport.dll
##### **Assembly**: transport.dll
##### Syntax
``` lang-csharp
public delegate void ReceiveDelegate(ref NetworkPipelineContext ctx, ref InboundRecvBuffer inboundBuffer, ref NetworkPipelineStage.Requests requests, int systemHeadersSize);
```
##### Parameters
| Type | Name | Description |
|-------------------------------|-------------------|-------------|
| NetworkPipelineContext | ctx | |
| InboundRecvBuffer | inboundBuffer | |
| NetworkPipelineStage.Requests | requests | |
| System.Int32 | systemHeadersSize | |
| Type | Name | Description |
|-------------------------------|---------------------|-------------|
| NetworkPipelineContext | \*ctx | |
| InboundRecvBuffer | \*inboundBuffer | |
| NetworkPipelineStage.Requests | \*requests | |
| System.Int32 | \*systemHeadersSize | |

66
transport/api/Unity.Networking.Transport.NetworkPipelineStage.Requests.md
Просмотреть файл

@ -1,65 +1,33 @@
---
id: Unity.Networking.Transport.NetworkPipelineStage.Requests
title: Unity.Networking.Transport.NetworkPipelineStage.Requests
---
id: Unity.Networking.Transport.NetworkPipelineStage.Requests
title: Unity.Networking.Transport.NetworkPipelineStage.Requests
---
<div class="markdown level0 summary">
# Enum NetworkPipelineStage.Requests
</div>
<div class="markdown level0 conceptual">
The requests enum
</div>
##### **Namespace**: System.Dynamic.ExpandoObject
###### **Namespace**: Unity.Networking.Transport
###### **Assembly**: Transport.dll
##### **Assembly**: transport.dll
##### Syntax
``` lang-csharp
[Flags]
public enum Requests
```
##
### Fields
Name
Description
Error
The error requests
None
The none requests
Resume
The resume requests
SendUpdate
The send update requests
Update
The update requests
| Name | Description |
|------------|-------------|
| Error | |
| None | |
| Resume | |
| SendUpdate | |
| Update | |

38
transport/api/Unity.Networking.Transport.NetworkPipelineStage.SendDelegate.md
Просмотреть файл

@ -1,45 +1,37 @@
---
id: Unity.Networking.Transport.NetworkPipelineStage.SendDelegate
title: Unity.Networking.Transport.NetworkPipelineStage.SendDelegate
---
id: Unity.Networking.Transport.NetworkPipelineStage.SendDelegate
title: Unity.Networking.Transport.NetworkPipelineStage.SendDelegate
---
<div class="markdown level0 summary">
# Delegate NetworkPipelineStage.SendDelegate
</div>
<div class="markdown level0 conceptual">
The send delegate
</div>
##### **Namespace**: System.Dynamic.ExpandoObject
###### **Namespace**: Unity.Networking.Transport
###### **Assembly**: Transport.dll
##### **Assembly**: transport.dll
##### Syntax
``` lang-csharp
public delegate int SendDelegate(ref NetworkPipelineContext ctx, ref InboundSendBuffer inboundBuffer, ref NetworkPipelineStage.Requests requests, int systemHeadersSize);
```
##### Parameters
| Type | Name | Description |
|-------------------------------|-------------------|-------------|
| NetworkPipelineContext | ctx | |
| InboundSendBuffer | inboundBuffer | |
| NetworkPipelineStage.Requests | requests | |
| System.Int32 | systemHeadersSize | |
| Type | Name | Description |
|-------------------------------|---------------------|-------------|
| NetworkPipelineContext | \*ctx | |
| InboundSendBuffer | \*inboundBuffer | |
| NetworkPipelineStage.Requests | \*requests | |
| System.Int32 | \*systemHeadersSize | |
##### Returns
| Type | Description |
|--------------|-------------|
| System.Int32 | |

248
transport/api/Unity.Networking.Transport.NetworkPipelineStage.md
Просмотреть файл

@ -1,307 +1,273 @@
---
id: Unity.Networking.Transport.NetworkPipelineStage
title: Unity.Networking.Transport.NetworkPipelineStage
---
id: Unity.Networking.Transport.NetworkPipelineStage
title: Unity.Networking.Transport.NetworkPipelineStage
---
<div class="markdown level0 summary">
# Struct NetworkPipelineStage
The network pipeline stage
</div>
<div class="markdown level0 conceptual">
</div>
<div class="inheritedMembers">
##### Inherited Members
<div>
ValueType.Equals(Object)
System.ValueType.Equals(System.Object)
</div>
<div>
ValueType.GetHashCode()
</div>
<div>
System.ValueType.GetHashCode()
ValueType.ToString()
</div>
<div>
Object.Equals(Object, Object)
</div>
System.ValueType.ToString()
<div>
Object.GetType()
</div>
<div>
Object.ReferenceEquals(Object, Object)
System.Object.Equals(System.Object, System.Object)
</div>
</div>
##### **Namespace**: System.Dynamic.ExpandoObject
System.Object.GetType()
System.Object.ReferenceEquals(System.Object, System.Object)
###### **Namespace**: Unity.Networking.Transport
###### **Assembly**: Transport.dll
##### **Assembly**: transport.dll
##### Syntax
``` lang-csharp
public struct NetworkPipelineStage
```
##
### NetworkPipelineStage(TransportFunctionPointer&lt;NetworkPipelineStage.ReceiveDelegate&gt; , TransportFunctionPointer&lt;NetworkPipelineStage.SendDelegate&gt; , TransportFunctionPointerlt;NetworkPipelineStage.InitializeConnectionDelegate&gt;
### Constructors
<div class="markdown level1 summary">
#### NetworkPipelineStage(TransportFunctionPointer\<NetworkPipelineStage.ReceiveDelegate\>, TransportFunctionPointer\<NetworkPipelineStage.SendDelegate\>, TransportFunctionPointer\<NetworkPipelineStage.InitializeConnectionDelegate\>, Int32, Int32, Int32, Int32, Int32)
</div>
<div class="markdown level1 conceptual">
Initializes a new instance of the NetworkPipelineStage class
##### Declaration
</div>
#### Declaration
``` lang-csharp
public NetworkPipelineStage(TransportFunctionPointer<NetworkPipelineStage.ReceiveDelegate> Receive, TransportFunctionPointer<NetworkPipelineStage.SendDelegate> Send, TransportFunctionPointer<NetworkPipelineStage.InitializeConnectionDelegate> InitializeConnection, int ReceiveCapacity, int SendCapacity, int HeaderCapacity, int SharedStateCapacity, int PayloadCapacity = 0)
```
#### Parameters
| Type | Name | Description |
|-------------------------------------------------------------------------------|----------------------|-------------|
| TransportFunctionPointer&lt;NetworkPipelineStage.ReceiveDelegate&gt; | Receive | |
| TransportFunctionPointer&lt;NetworkPipelineStage.SendDelegate&gt; | Send | |
| TransportFunctionPointer&lt;NetworkPipelineStage.InitializeConnectionDelegate&gt; | InitializeConnection | |
| System.Int32 | ReceiveCapacity | |
| System.Int32 | SendCapacity | |
| System.Int32 | HeaderCapacity | |
| System.Int32 | SharedStateCapacity | |
| System.Int32 | PayloadCapacity | |
##### Parameters
##
| Type | Name | Description |
|-------------------------------------------------------------------------------|----------------------|---------------------------|
| TransportFunctionPointer\<NetworkPipelineStage.ReceiveDelegate\> | Receive | The receive |
| TransportFunctionPointer\<NetworkPipelineStage.SendDelegate\> | Send | The send |
| TransportFunctionPointer\<NetworkPipelineStage.InitializeConnectionDelegate\> | InitializeConnection | The initialize connection |
| System.Int32 | ReceiveCapacity | The receive capacity |
| System.Int32 | SendCapacity | The send capacity |
| System.Int32 | HeaderCapacity | The header capacity |
| System.Int32 | SharedStateCapacity | The shared state capacity |
| System.Int32 | PayloadCapacity | The payload capacity |
### HeaderCapacity
### Fields
<div class="markdown level1 summary">
#### HeaderCapacity
</div>
<div class="markdown level1 conceptual">
The header capacity
##### Declaration
</div>
#### Declaration
``` lang-csharp
public readonly int HeaderCapacity
```
##### Field Value
#### Field Value
| Type | Description |
|--------------|-------------|
| System.Int32 | |
#### InitializeConnection
### InitializeConnection
<div class="markdown level1 summary">
InitializeConnection function pointer
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public TransportFunctionPointer<NetworkPipelineStage.InitializeConnectionDelegate> InitializeConnection
```
##### Field Value
#### Field Value
| Type | Description |
|-------------------------------------------------------------------------------|-------------|
| TransportFunctionPointer\<NetworkPipelineStage.InitializeConnectionDelegate\> | |
| TransportFunctionPointer\&lt;NetworkPipelineStage.InitializeConnectionDelegate&gt; | |
#### PayloadCapacity
### PayloadCapacity
<div class="markdown level1 summary">
The payload capacity
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public readonly int PayloadCapacity
```
##### Field Value
#### Field Value
| Type | Description |
|--------------|-------------|
| System.Int32 | |
#### Receive
### Receive
<div class="markdown level1 summary">
Receive function pointer
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public TransportFunctionPointer<NetworkPipelineStage.ReceiveDelegate> Receive
```
##### Field Value
#### Field Value
| Type | Description |
|------------------------------------------------------------------|-------------|
| TransportFunctionPointer\<NetworkPipelineStage.ReceiveDelegate\> | |
| TransportFunctionPointer\&lt;NetworkPipelineStage.ReceiveDelegate&gt;| |
#### ReceiveCapacity
### ReceiveCapacity
<div class="markdown level1 summary">
The receive capacity
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public readonly int ReceiveCapacity
```
##### Field Value
#### Field Value
| Type | Description |
|--------------|-------------|
| System.Int32 | |
#### Send
### Send
<div class="markdown level1 summary">
Send function pointer
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public TransportFunctionPointer<NetworkPipelineStage.SendDelegate> Send
```
##### Field Value
#### Field Value
| Type | Description |
|---------------------------------------------------------------|-------------|
| TransportFunctionPointer\<NetworkPipelineStage.SendDelegate\> | |
| TransportFunctionPointer\&lt;NetworkPipelineStage.SendDelegate&gt; | |
#### SendCapacity
### SendCapacity
<div class="markdown level1 summary">
The send capacity
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public readonly int SendCapacity
```
##### Field Value
#### Field Value
| Type | Description |
|--------------|-------------|
| System.Int32 | |
#### SharedStateCapacity
### SharedStateCapacity
<div class="markdown level1 summary">
The shared state capacity
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public readonly int SharedStateCapacity
```
##### Field Value
#### Field Value
| Type | Description |
|--------------|-------------|
| System.Int32 | |

142
transport/api/Unity.Networking.Transport.NetworkPipelineStageCollection.md
Просмотреть файл

@ -1,156 +1,140 @@
---
id: Unity.Networking.Transport.NetworkPipelineStageCollection
title: Unity.Networking.Transport.NetworkPipelineStageCollection
---
id: Unity.Networking.Transport.NetworkPipelineStageCollection
title: Unity.Networking.Transport.NetworkPipelineStageCollection
---
<div class="markdown level0 summary">
# Class NetworkPipelineStageCollection
The network pipeline stage collection class
</div>
<div class="markdown level0 conceptual">
</div>
<div class="inheritance">
##### Inheritance
<div class="level0">
System.Object
System.Dynamic.ExpandoObject
</div>
<div class="level1">
System.Dynamic.ExpandoObject
NetworkPipelineStageCollection
</div>
</div>
<div class="inheritedMembers">
##### Inherited Members
<div>
Object.Equals(Object)
System.Object.Equals(System.Object)
</div>
<div>
Object.Equals(Object, Object)
</div>
<div>
System.Object.Equals(System.Object, System.Object)
Object.GetHashCode()
</div>
<div>
Object.GetType()
</div>
System.Object.GetHashCode()
<div>
Object.MemberwiseClone()
</div>
<div>
Object.ReferenceEquals(Object, Object)
System.Object.GetType()
</div>
<div>
Object.ToString()
</div>
</div>
System.Object.MemberwiseClone()
##### **Namespace**: System.Dynamic.ExpandoObject
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
###### **Namespace**: Unity.Networking.Transport
###### **Assembly**: Transport.dll
##### **Assembly**: transport.dll
##### Syntax
``` lang-csharp
public static class NetworkPipelineStageCollection
```
##
### GetStageId(Type)
### Methods
<div class="markdown level1 summary">
#### GetStageId(Type)
</div>
<div class="markdown level1 conceptual">
Gets the stage id using the specified stage type
##### Declaration
</div>
#### Declaration
``` lang-csharp
public static NetworkPipelineStageId GetStageId(Type stageType)
```
#### Parameters
| Type | Name | Description |
|-------------|-----------|-------------|
| System.Type | stageType | |
##### Parameters
#### Returns
| Type | Name | Description |
|-------------|-----------|----------------|
| System.Type | stageType | The stage type |
| Type | Description |
|------------------------|-------------|
| NetworkPipelineStageId | |
##### Returns
### RegisterPipelineStage(INetworkPipelineStage)
| Type | Description |
|------------------------|-------------------------------|
| NetworkPipelineStageId | The network pipeline stage id |
<div class="markdown level1 summary">
##### Exceptions
</div>
| Type | Condition |
|----------------------------------|----------------------------------------------|
| System.InvalidOperationException | Pipeline stage {stageType} is not registered |
<div class="markdown level1 conceptual">
#### RegisterPipelineStage(INetworkPipelineStage)
Registers the pipeline stage using the specified stage
##### Declaration
</div>
#### Declaration
``` lang-csharp
public static void RegisterPipelineStage(INetworkPipelineStage stage)
```
##### Parameters
#### Parameters
| Type | Name | Description |
|-----------------------|-------|-------------|
| INetworkPipelineStage | stage | The stage |
| INetworkPipelineStage | stage | |

63
transport/api/Unity.Networking.Transport.NetworkPipelineStageId.md
Просмотреть файл

@ -1,69 +1,64 @@
---
id: Unity.Networking.Transport.NetworkPipelineStageId
title: Unity.Networking.Transport.NetworkPipelineStageId
---
id: Unity.Networking.Transport.NetworkPipelineStageId
title: Unity.Networking.Transport.NetworkPipelineStageId
---
<div class="markdown level0 summary">
# Struct NetworkPipelineStageId
</div>
<div class="markdown level0 conceptual">
</div>
<div class="inheritedMembers">
##### Inherited Members
<div>
ValueType.Equals(Object)
System.ValueType.Equals(System.Object)
</div>
<div>
ValueType.GetHashCode()
</div>
<div>
System.ValueType.GetHashCode()
ValueType.ToString()
</div>
<div>
Object.Equals(Object, Object)
</div>
System.ValueType.ToString()
<div>
Object.GetType()
</div>
<div>
Object.ReferenceEquals(Object, Object)
System.Object.Equals(System.Object, System.Object)
</div>
</div>
##### **Namespace**: System.Dynamic.ExpandoObject
System.Object.GetType()
System.Object.ReferenceEquals(System.Object, System.Object)
###### **Namespace**: Unity.Networking.Transport
###### **Assembly**: Transport.dll
##### **Assembly**: transport.dll
##### Syntax
``` lang-csharp
public struct NetworkPipelineStageId
```

35
transport/api/Unity.Networking.Transport.NetworkSendInterface.AbortSendMessageDelegate.md
Просмотреть файл

@ -1,38 +1,29 @@
---
id: Unity.Networking.Transport.NetworkSendInterface.AbortSendMessageDelegate
title: Unity.Networking.Transport.NetworkSendInterface.AbortSendMessageDelegate
---
id: Unity.Networking.Transport.NetworkSendInterface.AbortSendMessageDelegate
title: Unity.Networking.Transport.NetworkSendInterface.AbortSendMessageDelegate
---
<div class="markdown level0 summary">
# Delegate NetworkSendInterface.AbortSendMessageDelegate
</div>
<div class="markdown level0 conceptual">
Will be invoked from the lower level library if sending a message was
aborted.
</div>
##### **Namespace**: System.Dynamic.ExpandoObject
###### **Namespace**: Unity.Networking.Transport
###### **Assembly**: Transport.dll
##### **Assembly**: transport.dll
##### Syntax
``` lang-csharp
public delegate void AbortSendMessageDelegate(ref NetworkInterfaceSendHandle handle, IntPtr userData);
```
##### Parameters
| Type | Name | Description |
|----------------------------|----------|-------------|
| NetworkInterfaceSendHandle | handle | |
| System.IntPtr | userData | |
| Type | Name | Description |
|----------------------------|------------|-------------|
| NetworkInterfaceSendHandle | \*handle | |
| System.IntPtr | \*userData | |

37
transport/api/Unity.Networking.Transport.NetworkSendInterface.BeginSendMessageDelegate.md
Просмотреть файл

@ -1,45 +1,36 @@
---
id: Unity.Networking.Transport.NetworkSendInterface.BeginSendMessageDelegate
title: Unity.Networking.Transport.NetworkSendInterface.BeginSendMessageDelegate
---
id: Unity.Networking.Transport.NetworkSendInterface.BeginSendMessageDelegate
title: Unity.Networking.Transport.NetworkSendInterface.BeginSendMessageDelegate
---
<div class="markdown level0 summary">
# Delegate NetworkSendInterface.BeginSendMessageDelegate
</div>
<div class="markdown level0 conceptual">
Invoked from the lower level library at the beginning of the message
sending routine.
</div>
##### **Namespace**: System.Dynamic.ExpandoObject
###### **Namespace**: Unity.Networking.Transport
###### **Assembly**: Transport.dll
##### **Assembly**: transport.dll
##### Syntax
``` lang-csharp
public delegate int BeginSendMessageDelegate(out NetworkInterfaceSendHandle handle, IntPtr userData, int requiredPayloadSize);
```
##### Parameters
| Type | Name | Description |
|----------------------------|---------------------|-------------|
| NetworkInterfaceSendHandle | handle | |
| System.IntPtr | userData | |
| System.Int32 | requiredPayloadSize | |
| Type | Name | Description |
|----------------------------|-----------------------|-------------|
| NetworkInterfaceSendHandle | \*handle | |
| System.IntPtr | \*userData | |
| System.Int32 | \*requiredPayloadSize | |
##### Returns
| Type | Description |
|--------------|-------------|
| System.Int32 | |

39
transport/api/Unity.Networking.Transport.NetworkSendInterface.EndSendMessageDelegate.md
Просмотреть файл

@ -1,46 +1,37 @@
---
id: Unity.Networking.Transport.NetworkSendInterface.EndSendMessageDelegate
title: Unity.Networking.Transport.NetworkSendInterface.EndSendMessageDelegate
---
id: Unity.Networking.Transport.NetworkSendInterface.EndSendMessageDelegate
title: Unity.Networking.Transport.NetworkSendInterface.EndSendMessageDelegate
---
<div class="markdown level0 summary">
# Delegate NetworkSendInterface.EndSendMessageDelegate
</div>
<div class="markdown level0 conceptual">
Invoked from the lower level library at the end of the message sending
routine.
</div>
##### **Namespace**: System.Dynamic.ExpandoObject
###### **Namespace**: Unity.Networking.Transport
###### **Assembly**: Transport.dll
##### **Assembly**: transport.dll
##### Syntax
``` lang-csharp
public delegate int EndSendMessageDelegate(ref NetworkInterfaceSendHandle handle, ref NetworkInterfaceEndPoint address, IntPtr userData, ref NetworkSendQueueHandle sendQueue);
```
##### Parameters
| Type | Name | Description |
|----------------------------|-----------|-------------|
| NetworkInterfaceSendHandle | handle | |
| NetworkInterfaceEndPoint | address | |
| System.IntPtr | userData | |
| NetworkSendQueueHandle | sendQueue | |
| Type | Name | Description |
|----------------------------|-------------|-------------|
| NetworkInterfaceSendHandle | \*handle | |
| NetworkInterfaceEndPoint | \*address | |
| System.IntPtr | \*userData | |
| NetworkSendQueueHandle | \*sendQueue | |
##### Returns
| Type | Description |
|--------------|-------------|
| System.Int32 | |

142
transport/api/Unity.Networking.Transport.NetworkSendInterface.md
Просмотреть файл

@ -1,174 +1,154 @@
---
id: Unity.Networking.Transport.NetworkSendInterface
title: Unity.Networking.Transport.NetworkSendInterface
---
id: Unity.Networking.Transport.NetworkSendInterface
title: Unity.Networking.Transport.NetworkSendInterface
---
<div class="markdown level0 summary">
# Struct NetworkSendInterface
The network send interface used to pass around function pointers to the
actual INetworkInterface
</div>
<div class="markdown level0 conceptual">
</div>
<div class="inheritedMembers">
##### Inherited Members
<div>
ValueType.Equals(Object)
System.ValueType.Equals(System.Object)
</div>
<div>
ValueType.GetHashCode()
</div>
<div>
System.ValueType.GetHashCode()
ValueType.ToString()
</div>
<div>
Object.Equals(Object, Object)
</div>
System.ValueType.ToString()
<div>
Object.GetType()
</div>
<div>
Object.ReferenceEquals(Object, Object)
System.Object.Equals(System.Object, System.Object)
</div>
</div>
##### **Namespace**: System.Dynamic.ExpandoObject
System.Object.GetType()
System.Object.ReferenceEquals(System.Object, System.Object)
###### **Namespace**: Unity.Networking.Transport
###### **Assembly**: Transport.dll
##### **Assembly**: transport.dll
##### Syntax
``` lang-csharp
public struct NetworkSendInterface
```
##
### AbortSendMessage
### Fields
<div class="markdown level1 summary">
#### AbortSendMessage
</div>
<div class="markdown level1 conceptual">
The abort send message function pointer
##### Declaration
</div>
#### Declaration
``` lang-csharp
public TransportFunctionPointer<NetworkSendInterface.AbortSendMessageDelegate> AbortSendMessage
```
##### Field Value
#### Field Value
| Type | Description |
|---------------------------------------------------------------------------|-------------|
| TransportFunctionPointer\<NetworkSendInterface.AbortSendMessageDelegate\> | |
| TransportFunctionPointer\&lt;NetworkSendInterface.AbortSendMessageDelegate&gt; | |
#### BeginSendMessage
### BeginSendMessage
<div class="markdown level1 summary">
The begin send message function pointer
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public TransportFunctionPointer<NetworkSendInterface.BeginSendMessageDelegate> BeginSendMessage
```
##### Field Value
#### Field Value
| Type | Description |
|---------------------------------------------------------------------------|-------------|
| TransportFunctionPointer\<NetworkSendInterface.BeginSendMessageDelegate\> | |
| TransportFunctionPointer\&lt;NetworkSendInterface.BeginSendMessageDelegate&gt; | |
#### EndSendMessage
### EndSendMessage
<div class="markdown level1 summary">
The end send message function pointer
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public TransportFunctionPointer<NetworkSendInterface.EndSendMessageDelegate> EndSendMessage
```
##### Field Value
#### Field Value
| Type | Description |
|-------------------------------------------------------------------------|-------------|
| TransportFunctionPointer\<NetworkSendInterface.EndSendMessageDelegate\> | |
| TransportFunctionPointer\&lt;NetworkSendInterface.EndSendMessageDelegate&gt; | |
#### UserData
### UserData
<div class="markdown level1 summary">
The user data
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public IntPtr UserData
```
##### Field Value
#### Field Value
| Type | Description |
|---------------|-------------|
| System.IntPtr | |

86
transport/api/Unity.Networking.Transport.NetworkSendQueueHandle.md
Просмотреть файл

@ -1,98 +1,88 @@
---
id: Unity.Networking.Transport.NetworkSendQueueHandle
title: Unity.Networking.Transport.NetworkSendQueueHandle
---
id: Unity.Networking.Transport.NetworkSendQueueHandle
title: Unity.Networking.Transport.NetworkSendQueueHandle
---
<div class="markdown level0 summary">
# Struct NetworkSendQueueHandle
The network send queue handle
</div>
<div class="markdown level0 conceptual">
</div>
<div class="inheritedMembers">
##### Inherited Members
<div>
ValueType.Equals(Object)
System.ValueType.Equals(System.Object)
</div>
<div>
ValueType.GetHashCode()
</div>
<div>
System.ValueType.GetHashCode()
ValueType.ToString()
</div>
<div>
Object.Equals(Object, Object)
</div>
System.ValueType.ToString()
<div>
Object.GetType()
</div>
<div>
Object.ReferenceEquals(Object, Object)
System.Object.Equals(System.Object, System.Object)
</div>
</div>
##### **Namespace**: System.Dynamic.ExpandoObject
System.Object.GetType()
System.Object.ReferenceEquals(System.Object, System.Object)
###### **Namespace**: Unity.Networking.Transport
###### **Assembly**: Transport.dll
##### **Assembly**: transport.dll
##### Syntax
``` lang-csharp
public struct NetworkSendQueueHandle
```
##
### FromHandle()
### Methods
<div class="markdown level1 summary">
#### FromHandle()
</div>
<div class="markdown level1 conceptual">
Create from the internal handle
##### Declaration
</div>
#### Declaration
``` lang-csharp
public NativeQueue<QueuedSendMessage>.ParallelWriter FromHandle()
```
##### Returns
#### Returns
| Type | Description |
|--------------------------------|-------------|
| NativeQueue.ParallelWriter\<\> | |
| NativeQueue.ParallelWriter&lt;&gt; | |

214
transport/api/Unity.Networking.Transport.NetworkSettings.md
Просмотреть файл

@ -1,202 +1,197 @@
---
id: Unity.Networking.Transport.NetworkSettings
title: Unity.Networking.Transport.NetworkSettings
---
id: Unity.Networking.Transport.NetworkSettings
title: Unity.Networking.Transport.NetworkSettings
---
# Struct NetworkSettings
<div class="markdown level0 summary">
A list of the parameters that describe the network configuration.
</div>
<div class="markdown level0 conceptual">
</div>
<div classs="implements">
##### Implements
<div>
System.IDisposable
</div>
</div>
<div class="inheritedMembers">
##### Inherited Members
<div>
ValueType.Equals(Object)
System.ValueType.Equals(System.Object)
</div>
<div>
ValueType.GetHashCode()
</div>
<div>
System.ValueType.GetHashCode()
ValueType.ToString()
</div>
<div>
Object.Equals(Object, Object)
</div>
System.ValueType.ToString()
<div>
Object.GetType()
</div>
<div>
Object.ReferenceEquals(Object, Object)
System.Object.Equals(System.Object, System.Object)
</div>
</div>
##### **Namespace**: System.Dynamic.ExpandoObject
System.Object.GetType()
System.Object.ReferenceEquals(System.Object, System.Object)
###### **Namespace**: Unity.Networking.Transport
###### **Assembly**: Transport.dll
##### **Assembly**: transport.dll
##### Syntax
``` lang-csharp
public struct NetworkSettings : IDisposable
```
##
### NetworkSettings(Allocator)
### Constructors
#### NetworkSettings(Allocator)
<div class="markdown level1 summary">
Creates a new NetworkSettings object using the provided allocator. If no
Allocator is provided, Allocator.Temp will be used.
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public NetworkSettings(Allocator allocator)
```
##### Parameters
#### Parameters
| Type | Name | Description |
|-----------|-----------|-------------------------------------------------------------------------------------------------------------------------------|
| Allocator | allocator | The allocator used for the parameters list. When Allocator.Temp is used, the settings are valid to use only during one frame. |
### Methods
##
#### AddRawParameterStruct\<T\>(ref T)
### AddRawParameterStruct\&lt;T&gt;(ref T)
<div class="markdown level1 summary">
Adds a new parameter to the list. There must be only one instance per
parameter type.
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public void AddRawParameterStruct<T>(ref T parameter)
where T : struct, INetworkParameter
```
##### Parameters
#### Parameters
| Type | Name | Description |
|------|-----------|-----------------------|
| T | parameter | The parameter to add. |
##### Type Parameters
#### Type Parameters
| Name | Description |
|------|---------------------------------------|
| T | The type of INetworkParameter to add. |
##### Exceptions
#### Exceptions
| Type | Condition |
|--------------------------|------------------------------------------------------------------------------------------------------------|
| System.ArgumentException | Throws an argument exception if the paramter type is already in the list or if it contains invalid values. |
#### Dispose()
### Dispose()
<div class="markdown level1 summary">
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public void Dispose()
```
### TryGet\&lt;T&gt;(out T)
#### TryGet\<T\>(out T)
<div class="markdown level1 summary">
Try to get the parameter values for the specified type.
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public bool TryGet<T>(out T parameter)
where T : struct, INetworkParameter
```
##### Parameters
#### Parameters
| Type | Name | Description |
|------|-----------|------------------------------|
| T | parameter | The stored parameter values. |
##### Returns
#### Returns
| Type | Description |
|----------------|----------------------------------------------------------|
| System.Boolean | Returns true if the parameter is in the paramaters list. |
##### Type Parameters
#### Type Parameters
| Name | Description |
|------|------------------------------------|
@ -204,125 +199,122 @@ public bool TryGet<T>(out T parameter)
### Implements
<div>
System.IDisposable
</div>
### Extension Methods
<div>
BaselibNetworkParameterExtensions.WithBaselibNetworkInterfaceParameters(ref
NetworkSettings, Int32, Int32, UInt32)
</div>
<div>
BaselibNetworkParameterExtensions.GetBaselibNetworkInterfaceParameters(ref
NetworkSettings)
</div>
<div>
CommonNetworkParametersExtensions.WithDataStreamParameters(ref
NetworkSettings, Int32)
</div>
<div>
CommonNetworkParametersExtensions.GetDataStreamParameters(ref
NetworkSettings)
</div>
<div>
CommonNetworkParametersExtensions.WithNetworkConfigParameters(ref
NetworkSettings, Int32, Int32, Int32, Int32, Int32, Int32)
NetworkSettings, Int32, Int32, Int32, Int32, Int32, Int32, Int32)
</div>
<div>
CommonNetworkParametersExtensions.GetNetworkConfigParameters(ref
NetworkSettings)
</div>
<div>
NetworkPipelineParametersExtensions.WithPipelineParameters(ref
NetworkSettings, Int32)
</div>
<div>
NetworkPipelineParametersExtensions.GetPipelineParameters(ref
NetworkSettings)
</div>
<div>
FragmentationStageParameterExtensions.WithFragmentationStageParameters(ref
NetworkSettings, Int32)
</div>
<div>
FragmentationStageParameterExtensions.GetFragmentationStageParameters(ref
NetworkSettings)
</div>
<div>
ReliableStageParameterExtensions.WithReliableStageParameters(ref
NetworkSettings, Int32)
</div>
<div>
ReliableStageParameterExtensions.GetReliableStageParameters(ref
NetworkSettings)
</div>
<div>
SimulatorStageParameterExtensions.WithSimulatorStageParameters(ref
NetworkSettings, Int32, Int32, Int32, Int32, Int32, Int32, Int32, Int32,
UInt32)
NetworkSettings, Int32, Int32, ApplyMode, Int32, Int32, Int32, Int32,
Int32, Int32, Int32, UInt32)
</div>
<div>
SimulatorStageParameterExtensions.GetSimulatorStageParameters(ref
NetworkSettings)
</div>
<div>
RelayParameterExtensions.WithRelayParameters(ref NetworkSettings, ref
RelayServerData, Int32)
</div>
<div>
RelayParameterExtensions.GetRelayParameters(ref NetworkSettings)
</div>

113
transport/api/Unity.Networking.Transport.NullPipelineStage.md
Просмотреть файл

@ -1,129 +1,123 @@
---
id: Unity.Networking.Transport.NullPipelineStage
title: Unity.Networking.Transport.NullPipelineStage
---
id: Unity.Networking.Transport.NullPipelineStage
title: Unity.Networking.Transport.NullPipelineStage
---
<div class="markdown level0 summary">
# Struct NullPipelineStage
The NullPipelineStage is the default pipeline stage and used to send
packets unreliably
</div>
<div class="markdown level0 conceptual">
</div>
<div classs="implements">
##### Implements
<div>
INetworkPipelineStage
</div>
</div>
<div class="inheritedMembers">
##### Inherited Members
<div>
ValueType.Equals(Object)
System.ValueType.Equals(System.Object)
</div>
<div>
ValueType.GetHashCode()
</div>
<div>
System.ValueType.GetHashCode()
ValueType.ToString()
</div>
<div>
Object.Equals(Object, Object)
</div>
System.ValueType.ToString()
<div>
Object.GetType()
</div>
<div>
Object.ReferenceEquals(Object, Object)
System.Object.Equals(System.Object, System.Object)
</div>
</div>
##### **Namespace**: System.Dynamic.ExpandoObject
System.Object.GetType()
System.Object.ReferenceEquals(System.Object, System.Object)
###### **Namespace**: Unity.Networking.Transport
###### **Assembly**: Transport.dll
##### **Assembly**: transport.dll
##### Syntax
``` lang-csharp
public struct NullPipelineStage : INetworkPipelineStage
```
##
### StaticSize
### Properties
<div class="markdown level1 summary">
#### StaticSize
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public readonly int StaticSize { get; }
```
##### Property Value
#### Property Value
| Type | Description |
|--------------|-------------|
| System.Int32 | |
### Methods
##
#### StaticInitialize(Byte\*, Int32, NetworkSettings)
### StaticInitialize(Byte\*, Int32, NetworkSettings)
<div class="markdown level1 summary">
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public NetworkPipelineStage StaticInitialize(byte *staticInstanceBuffer, int staticInstanceBufferLength, NetworkSettings netParams)
```
##### Parameters
#### Parameters
| Type | Name | Description |
|-----------------|----------------------------|-------------|
@ -131,7 +125,7 @@ public NetworkPipelineStage StaticInitialize(byte *staticInstanceBuffer, int sta
| System.Int32 | staticInstanceBufferLength | |
| NetworkSettings | netParams | |
##### Returns
#### Returns
| Type | Description |
|----------------------|-------------|
@ -139,11 +133,8 @@ public NetworkPipelineStage StaticInitialize(byte *staticInstanceBuffer, int sta
### Implements
<div>
INetworkPipelineStage
</div>

0
transport_versioned_docs/version-2.0.0/api/Unity.Networking.Transport.Protocols.UdpCHeader.HeaderFlags.md → transport/api/Unity.Networking.Transport.Protocols.UdpCHeader.HeaderFlags.md
Просмотреть файл

0
transport_versioned_docs/version-2.0.0/api/Unity.Networking.Transport.Protocols.UdpCHeader.md → transport/api/Unity.Networking.Transport.Protocols.UdpCHeader.md
Просмотреть файл

0
transport_versioned_docs/version-2.0.0/api/Unity.Networking.Transport.Protocols.UdpCProtocol.md → transport/api/Unity.Networking.Transport.Protocols.UdpCProtocol.md
Просмотреть файл

0
transport_versioned_docs/version-2.0.0/api/Unity.Networking.Transport.Protocols.md → transport/api/Unity.Networking.Transport.Protocols.md
Просмотреть файл

110
transport/api/Unity.Networking.Transport.QueuedSendMessage.md
Просмотреть файл

@ -1,140 +1,132 @@
---
id: Unity.Networking.Transport.QueuedSendMessage
title: Unity.Networking.Transport.QueuedSendMessage
---
id: Unity.Networking.Transport.QueuedSendMessage
title: Unity.Networking.Transport.QueuedSendMessage
---
<div class="markdown level0 summary">
# Struct QueuedSendMessage
</div>
<div class="markdown level0 conceptual">
</div>
<div class="inheritedMembers">
##### Inherited Members
<div>
ValueType.Equals(Object)
System.ValueType.Equals(System.Object)
</div>
<div>
ValueType.GetHashCode()
</div>
<div>
System.ValueType.GetHashCode()
ValueType.ToString()
</div>
<div>
Object.Equals(Object, Object)
</div>
System.ValueType.ToString()
<div>
Object.GetType()
</div>
<div>
Object.ReferenceEquals(Object, Object)
System.Object.Equals(System.Object, System.Object)
</div>
</div>
##### **Namespace**: System.Dynamic.ExpandoObject
System.Object.GetType()
System.Object.ReferenceEquals(System.Object, System.Object)
###### **Namespace**: Unity.Networking.Transport
###### **Assembly**: Transport.dll
##### **Assembly**: transport.dll
##### Syntax
``` lang-csharp
public struct QueuedSendMessage
```
##
### Data
### Fields
<div class="markdown level1 summary">
#### Data
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public byte *Data
```
##### Field Value
#### Field Value
| Type | Description |
|---------------|-------------|
| System.Byte\* | |
#### DataLength
### DataLength
<div class="markdown level1 summary">
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public int DataLength
```
##### Field Value
#### Field Value
| Type | Description |
|--------------|-------------|
| System.Int32 | |
#### Dest
### Dest
<div class="markdown level1 summary">
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public NetworkInterfaceEndPoint Dest
```
##### Field Value
#### Field Value
| Type | Description |
|--------------------------|-------------|
| NetworkInterfaceEndPoint | |

265
transport/api/Unity.Networking.Transport.Relay.RelayAllocationId.md
Просмотреть файл

@ -1,354 +1,332 @@
---
id: Unity.Networking.Transport.Relay.RelayAllocationId
title: Unity.Networking.Transport.Relay.RelayAllocationId
---
id: Unity.Networking.Transport.Relay.RelayAllocationId
title: Unity.Networking.Transport.Relay.RelayAllocationId
---
# Struct RelayAllocationId
<div class="markdown level0 summary">
Allocation Id is a unique identifier for a connected client/host to a
Relay server. This identifier is used by the Relay protocol as the
address of the client.
</div>
<div class="markdown level0 conceptual">
</div>
<div classs="implements">
##### Implements
<div>
System.IEquatable\<RelayAllocationId\>
</div>
<div>
System.IComparable\<RelayAllocationId\>
</div>
</div>
<div class="inheritedMembers">
##### Inherited Members
<div>
ValueType.ToString()
System.ValueType.ToString()
</div>
<div>
Object.Equals(Object, Object)
</div>
<div>
System.Object.Equals(System.Object, System.Object)
Object.GetType()
</div>
<div>
Object.ReferenceEquals(Object, Object)
</div>
System.Object.GetType()
</div>
##### **Namespace**: System.Dynamic.ExpandoObject
System.Object.ReferenceEquals(System.Object, System.Object)
###### **Namespace**: Unity.Networking.Transport.Relay
###### **Assembly**: Transport.dll
##### **Assembly**: transport.dll
##### Syntax
``` lang-csharp
public struct RelayAllocationId : IEquatable<RelayAllocationId>, IComparable<RelayAllocationId>
```
##
### k_Length
### Fields
<div class="markdown level1 summary">
#### k_Length
</div>
<div class="markdown level1 conceptual">
The length in bytes of the Allocation Id.
##### Declaration
</div>
#### Declaration
``` lang-csharp
public const int k_Length = 16
```
##### Field Value
#### Field Value
| Type | Description |
|--------------|-------------|
| System.Int32 | |
#### Value
### Value
<div class="markdown level1 summary">
The raw data of the Allocation Id.
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public byte *Value
```
##### Field Value
#### Field Value
| Type | Description |
|---------------|-------------|
| System.Byte\* | |
### Methods
##
#### CompareTo(RelayAllocationId)
### CompareTo(RelayAllocationId)
<div class="markdown level1 summary">
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public int CompareTo(RelayAllocationId other)
```
##### Parameters
#### Parameters
| Type | Name | Description |
|-------------------|-------|-------------|
| RelayAllocationId | other | |
##### Returns
#### Returns
| Type | Description |
|--------------|-------------|
| System.Int32 | |
#### Equals(Object)
### Equals(Object)
<div class="markdown level1 summary">
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public override bool Equals(object other)
```
##### Parameters
#### Parameters
| Type | Name | Description |
|---------------|-------|-------------|
| System.Object | other | |
##### Returns
#### Returns
| Type | Description |
|----------------|-------------|
| System.Boolean | |
##### Overrides
#### Overrides
<div>
System.ValueType.Equals(System.Object)
</div>
### Equals(RelayAllocationId)
#### Equals(RelayAllocationId)
<div class="markdown level1 summary">
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public bool Equals(RelayAllocationId other)
```
##### Parameters
#### Parameters
| Type | Name | Description |
|-------------------|-------|-------------|
| RelayAllocationId | other | |
##### Returns
#### Returns
| Type | Description |
|----------------|-------------|
| System.Boolean | |
#### FromBytePointer(Byte\*, Int32)
### FromBytePointer(Byte\*, Int32)
<div class="markdown level1 summary">
Converts a byte pointer to a RelayAllocationId.
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public static RelayAllocationId FromBytePointer(byte *dataPtr, int length)
```
#### Parameters
| Type | Name | Description |
|---------------|---------|-------------|
| System.Byte\* | dataPtr | |
| System.Int32 | length | |
##### Parameters
#### Returns
| Type | Name | Description |
|---------------|---------|-----------------------------------------------|
| System.Byte\* | dataPtr | The pointer to the data of the Allocation Id. |
| System.Int32 | length | The length of the data. |
| Type | Description |
|-------------------|-------------|
| RelayAllocationId | |
##### Returns
### GetHashCode()
| Type | Description |
|-------------------|-----------------------------------------------------------------|
| RelayAllocationId | Returns a RelayAllocationId constructed from the provided data. |
<div class="markdown level1 summary">
##### Exceptions
</div>
| Type | Condition |
|--------------------------|-----------------------------------------------------------------------------|
| System.ArgumentException | Provided byte array length is invalid, must be {k_Length} but got {length}. |
<div class="markdown level1 conceptual">
#### GetHashCode()
##### Declaration
</div>
#### Declaration
``` lang-csharp
public override int GetHashCode()
```
##### Returns
#### Returns
| Type | Description |
|--------------|-------------|
| System.Int32 | |
##### Overrides
#### Overrides
<div>
System.ValueType.GetHashCode()
</div>
##
### Operators
### Equality(RelayAllocationId, RelayAllocationId)
#### Equality(RelayAllocationId, RelayAllocationId)
<div class="markdown level1 summary">
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public static bool operator ==(RelayAllocationId lhs, RelayAllocationId rhs)
```
##### Parameters
#### Parameters
| Type | Name | Description |
|-------------------|------|-------------|
| RelayAllocationId | lhs | |
| RelayAllocationId | rhs | |
##### Returns
#### Returns
| Type | Description |
|----------------|-------------|
| System.Boolean | |
#### Inequality(RelayAllocationId, RelayAllocationId)
### Inequality(RelayAllocationId, RelayAllocationId)
<div class="markdown level1 summary">
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public static bool operator !=(RelayAllocationId lhs, RelayAllocationId rhs)
```
##### Parameters
#### Parameters
| Type | Name | Description |
|-------------------|------|-------------|
| RelayAllocationId | lhs | |
| RelayAllocationId | rhs | |
##### Returns
#### Returns
| Type | Description |
|----------------|-------------|
@ -356,17 +334,14 @@ public static bool operator !=(RelayAllocationId lhs, RelayAllocationId rhs)
### Implements
<div>
System.IEquatable&lt;T&gt;
System.IEquatable\<T\>
System.IComparable\<T\>
</div>
<div>
System.IComparable&lt;T&gt;
</div>

143
transport/api/Unity.Networking.Transport.Relay.RelayConnectionData.md
Просмотреть файл

@ -1,165 +1,144 @@
---
id: Unity.Networking.Transport.Relay.RelayConnectionData
title: Unity.Networking.Transport.Relay.RelayConnectionData
---
id: Unity.Networking.Transport.Relay.RelayConnectionData
title: Unity.Networking.Transport.Relay.RelayConnectionData
---
# Struct RelayConnectionData
<div class="markdown level0 summary">
This is the encrypted data that the Relay server uses for describing a
connection. Used mainly in the connection establishing process
(Binding).
connection. Used mainly in the connection stablishing process (Binding)
</div>
<div class="markdown level0 conceptual">
</div>
<div class="inheritedMembers">
##### Inherited Members
<div>
ValueType.Equals(Object)
System.ValueType.Equals(System.Object)
</div>
<div>
ValueType.GetHashCode()
</div>
<div>
System.ValueType.GetHashCode()
ValueType.ToString()
</div>
<div>
Object.Equals(Object, Object)
</div>
System.ValueType.ToString()
<div>
Object.GetType()
</div>
<div>
Object.ReferenceEquals(Object, Object)
System.Object.Equals(System.Object, System.Object)
</div>
</div>
##### **Namespace**: System.Dynamic.ExpandoObject
System.Object.GetType()
System.Object.ReferenceEquals(System.Object, System.Object)
###### **Namespace**: Unity.Networking.Transport.Relay
###### **Assembly**: Transport.dll
##### **Assembly**: transport.dll
##### Syntax
``` lang-csharp
public struct RelayConnectionData
```
##
### k_Length
### Fields
<div class="markdown level1 summary">
#### k_Length
</div>
<div class="markdown level1 conceptual">
The length in bytes of the Connection Data.
##### Declaration
</div>
#### Declaration
``` lang-csharp
public const int k_Length = 255
```
##### Field Value
#### Field Value
| Type | Description |
|--------------|-------------|
| System.Int32 | |
#### Value
### Value
<div class="markdown level1 summary">
The raw data of the Connection Data
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public byte *Value
```
##### Field Value
#### Field Value
| Type | Description |
|---------------|-------------|
| System.Byte\* | |
### Methods
##
#### FromBytePointer(Byte\*, Int32)
### FromBytePointer(Byte\*, Int32)
<div class="markdown level1 summary">
Converts a byte pointer to a RelayConnectionData.
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public static RelayConnectionData FromBytePointer(byte *dataPtr, int length)
```
#### Parameters
| Type | Name | Description |
|---------------|---------|-------------|
| System.Byte\* | dataPtr | |
| System.Int32 | length | |
##### Parameters
| Type | Name | Description |
|---------------|---------|-------------------------------------------------|
| System.Byte\* | dataPtr | The pointer to the data of the Connection Data. |
| System.Int32 | length | The length of the data. |
##### Returns
| Type | Description |
|---------------------|-------------------------------------------------------------------|
| RelayConnectionData | Returns a RelayConnectionData constructed from the provided data. |
##### Exceptions
| Type | Condition |
|--------------------------|-----------------------------------------------------------------------------|
| System.ArgumentException | Provided byte array length is invalid, must be {k_Length} but got {length}. |
#### Returns
| Type | Description |
|---------------------|-------------|
| RelayConnectionData | |

142
transport/api/Unity.Networking.Transport.Relay.RelayHMACKey.md
Просмотреть файл

@ -1,163 +1,141 @@
---
id: Unity.Networking.Transport.Relay.RelayHMACKey
title: Unity.Networking.Transport.Relay.RelayHMACKey
---
id: Unity.Networking.Transport.Relay.RelayHMACKey
title: Unity.Networking.Transport.Relay.RelayHMACKey
---
<div class="markdown level0 summary">
# Struct RelayHMACKey
Used to represent the HMACKey for the Relay Service
</div>
<div class="markdown level0 conceptual">
</div>
<div class="inheritedMembers">
##### Inherited Members
<div>
ValueType.Equals(Object)
System.ValueType.Equals(System.Object)
</div>
<div>
ValueType.GetHashCode()
</div>
<div>
System.ValueType.GetHashCode()
ValueType.ToString()
</div>
<div>
Object.Equals(Object, Object)
</div>
System.ValueType.ToString()
<div>
Object.GetType()
</div>
<div>
Object.ReferenceEquals(Object, Object)
System.Object.Equals(System.Object, System.Object)
</div>
</div>
##### **Namespace**: System.Dynamic.ExpandoObject
System.Object.GetType()
System.Object.ReferenceEquals(System.Object, System.Object)
###### **Namespace**: Unity.Networking.Transport.Relay
###### **Assembly**: Transport.dll
##### **Assembly**: transport.dll
##### Syntax
``` lang-csharp
public struct RelayHMACKey
```
##
### k_Length
### Fields
<div class="markdown level1 summary">
#### k_Length
</div>
<div class="markdown level1 conceptual">
The length in bytes of the RelayHMACKey.
##### Declaration
</div>
#### Declaration
``` lang-csharp
public const int k_Length = 64
```
##### Field Value
#### Field Value
| Type | Description |
|--------------|-------------|
| System.Int32 | |
#### Value
### Value
<div class="markdown level1 summary">
The raw data of the HMAC key.
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public byte *Value
```
##### Field Value
#### Field Value
| Type | Description |
|---------------|-------------|
| System.Byte\* | |
### Methods
##
#### FromBytePointer(Byte\*, Int32)
### FromBytePointer(Byte\*, Int32)
<div class="markdown level1 summary">
Converts a byte pointer to a RelayHMACKey.
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public static RelayHMACKey FromBytePointer(byte *data, int length)
```
#### Parameters
| Type | Name | Description |
|---------------|--------|-------------|
| System.Byte\* | data | |
| System.Int32 | length | |
##### Parameters
| Type | Name | Description |
|---------------|--------|-----------------------------------------------|
| System.Byte\* | data | The pointer to the data of the Allocation Id. |
| System.Int32 | length | The length of the data. |
##### Returns
| Type | Description |
|--------------|------------------------------------------------------------|
| RelayHMACKey | Returns a RelayHMACKey constructed from the provided data. |
##### Exceptions
| Type | Condition |
|--------------------------|-----------------------------------------------------------------------------|
| System.ArgumentException | Provided byte array length is invalid, must be {k_Length} but got {length}. |
#### Returns
| Type | Description |
|--------------|-------------|
| RelayHMACKey | |

0
transport_versioned_docs/version-2.0.0/api/Unity.Networking.Transport.Relay.RelayMessageAccepted.md → transport/api/Unity.Networking.Transport.Relay.RelayMessageAccepted.md
Просмотреть файл

0
transport_versioned_docs/version-2.0.0/api/Unity.Networking.Transport.Relay.RelayMessageBind.md → transport/api/Unity.Networking.Transport.Relay.RelayMessageBind.md
Просмотреть файл

0
transport_versioned_docs/version-2.0.0/api/Unity.Networking.Transport.Relay.RelayMessageConnectRequest.md → transport/api/Unity.Networking.Transport.Relay.RelayMessageConnectRequest.md
Просмотреть файл

0
transport_versioned_docs/version-2.0.0/api/Unity.Networking.Transport.Relay.RelayMessageDisconnect.md → transport/api/Unity.Networking.Transport.Relay.RelayMessageDisconnect.md
Просмотреть файл

0
transport_versioned_docs/version-2.0.0/api/Unity.Networking.Transport.Relay.RelayMessageHeader.md → transport/api/Unity.Networking.Transport.Relay.RelayMessageHeader.md
Просмотреть файл

0
transport_versioned_docs/version-2.0.0/api/Unity.Networking.Transport.Relay.RelayMessagePing.md → transport/api/Unity.Networking.Transport.Relay.RelayMessagePing.md
Просмотреть файл

0
transport_versioned_docs/version-2.0.0/api/Unity.Networking.Transport.Relay.RelayMessageRelay.md → transport/api/Unity.Networking.Transport.Relay.RelayMessageRelay.md
Просмотреть файл

0
transport_versioned_docs/version-2.0.0/api/Unity.Networking.Transport.Relay.RelayMessageType.md → transport/api/Unity.Networking.Transport.Relay.RelayMessageType.md
Просмотреть файл

136
transport/api/Unity.Networking.Transport.Relay.RelayNetworkParameter.md
Просмотреть файл

@ -1,158 +1,151 @@
---
id: Unity.Networking.Transport.Relay.RelayNetworkParameter
title: Unity.Networking.Transport.Relay.RelayNetworkParameter
---
id: Unity.Networking.Transport.Relay.RelayNetworkParameter
title: Unity.Networking.Transport.Relay.RelayNetworkParameter
---
<div class="markdown level0 summary">
# Struct RelayNetworkParameter
Relay protocol network parementers used to connect to the Unity Relay
service. This data must be provided to the Create(NetworkSettings)
function in order to be able to use connect to Relay.
</div>
<div class="markdown level0 conceptual">
</div>
<div classs="implements">
##### Implements
<div>
INetworkParameter
</div>
<div>
IValidatableNetworkParameter
</div>
</div>
<div class="inheritedMembers">
##### Inherited Members
<div>
ValueType.Equals(Object)
System.ValueType.Equals(System.Object)
</div>
<div>
ValueType.GetHashCode()
</div>
<div>
System.ValueType.GetHashCode()
ValueType.ToString()
</div>
<div>
Object.Equals(Object, Object)
</div>
System.ValueType.ToString()
<div>
Object.GetType()
</div>
<div>
Object.ReferenceEquals(Object, Object)
System.Object.Equals(System.Object, System.Object)
</div>
</div>
##### **Namespace**: System.Dynamic.ExpandoObject
System.Object.GetType()
System.Object.ReferenceEquals(System.Object, System.Object)
###### **Namespace**: Unity.Networking.Transport.Relay
###### **Assembly**: Transport.dll
##### **Assembly**: transport.dll
##### Syntax
``` lang-csharp
public struct RelayNetworkParameter : INetworkParameter
public struct RelayNetworkParameter : INetworkParameter, IValidatableNetworkParameter
```
##
### RelayConnectionTimeMS
### Fields
<div class="markdown level1 summary">
#### RelayConnectionTimeMS
</div>
<div class="markdown level1 conceptual">
The timeout in milliseconds after which a ping message is sent to the
Relay Server to keep the connection alive.
##### Declaration
</div>
#### Declaration
``` lang-csharp
public int RelayConnectionTimeMS
```
##### Field Value
#### Field Value
| Type | Description |
|--------------|-------------|
| System.Int32 | |
#### ServerData
### ServerData
<div class="markdown level1 summary">
The data that is used to describe the connection to the Relay Server.
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public RelayServerData ServerData
```
##### Field Value
#### Field Value
| Type | Description |
|-----------------|-------------|
| RelayServerData | |
### Methods
##
#### Validate()
### Validate()
<div class="markdown level1 summary">
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public bool Validate()
```
##### Returns
#### Returns
| Type | Description |
|----------------|-------------|
@ -160,11 +153,14 @@ public bool Validate()
### Implements
<div>
INetworkParameter
</div>
<div>
IValidatableNetworkParameter
</div>

140
transport/api/Unity.Networking.Transport.Relay.RelayParameterExtensions.md
Просмотреть файл

@ -1,156 +1,148 @@
---
id: Unity.Networking.Transport.Relay.RelayParameterExtensions
title: Unity.Networking.Transport.Relay.RelayParameterExtensions
---
id: Unity.Networking.Transport.Relay.RelayParameterExtensions
title: Unity.Networking.Transport.Relay.RelayParameterExtensions
---
<div class="markdown level0 summary">
# Class RelayParameterExtensions
</div>
<div class="markdown level0 conceptual">
</div>
<div class="inheritance">
##### Inheritance
<div class="level0">
System.Object
System.Dynamic.ExpandoObject
</div>
<div class="level1">
System.Dynamic.ExpandoObject
RelayParameterExtensions
</div>
</div>
<div class="inheritedMembers">
##### Inherited Members
<div>
Object.Equals(Object)
System.Object.Equals(System.Object)
</div>
<div>
Object.Equals(Object, Object)
</div>
<div>
System.Object.Equals(System.Object, System.Object)
Object.GetHashCode()
</div>
<div>
Object.GetType()
</div>
System.Object.GetHashCode()
<div>
Object.MemberwiseClone()
</div>
<div>
Object.ReferenceEquals(Object, Object)
System.Object.GetType()
</div>
<div>
Object.ToString()
</div>
</div>
System.Object.MemberwiseClone()
##### **Namespace**: System.Dynamic.ExpandoObject
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
###### **Namespace**: Unity.Networking.Transport.Relay
###### **Assembly**: Transport.dll
##### **Assembly**: transport.dll
##### Syntax
``` lang-csharp
public static class RelayParameterExtensions
```
##
### GetRelayParameters(ref NetworkSettings)
### Methods
<div class="markdown level1 summary">
#### GetRelayParameters(ref NetworkSettings)
</div>
<div class="markdown level1 conceptual">
Gets the RelayNetworkParameter
##### Declaration
</div>
#### Declaration
``` lang-csharp
public static RelayNetworkParameter GetRelayParameters(this ref NetworkSettings settings)
```
##### Parameters
#### Parameters
| Type | Name | Description |
|-----------------|----------|-------------|
| NetworkSettings | settings | |
##### Returns
#### Returns
| Type | Description |
|-----------------------|------------------------------------------------------------------|
| RelayNetworkParameter | Returns the RelayNetworkParameter values for the NetworkSettings |
| Type | Description |
|-----------------------|-------------|
| RelayNetworkParameter | |
#### WithRelayParameters(ref NetworkSettings, ref RelayServerData, Int32)
### WithRelayParameters(ref NetworkSettings, ref RelayServerData, Int32)
<div class="markdown level1 summary">
Sets the RelayNetworkParameter values for the NetworkSettings
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public static ref NetworkSettings WithRelayParameters(this ref NetworkSettings settings, ref RelayServerData serverData, int relayConnectionTimeMS = 3000)
public static ref NetworkSettings WithRelayParameters(this ref NetworkSettings settings, ref RelayServerData serverData, int relayConnectionTimeMS = 9000)
```
#### Parameters
| Type | Name | Description |
|-----------------|-----------------------|-------------|
| NetworkSettings | settings | |
| RelayServerData | serverData | |
| System.Int32 | relayConnectionTimeMS | |
##### Parameters
| Type | Name | Description |
|-----------------|-----------------------|-----------------------|
| NetworkSettings | settings | |
| RelayServerData | serverData | ServerData |
| System.Int32 | relayConnectionTimeMS | RelayConnectionTimeMS |
##### Returns
#### Returns
| Type | Description |
|-----------------|-------------|
| NetworkSettings | |

293
transport/api/Unity.Networking.Transport.Relay.RelayServerData.md
Просмотреть файл

@ -1,359 +1,318 @@
---
id: Unity.Networking.Transport.Relay.RelayServerData
title: Unity.Networking.Transport.Relay.RelayServerData
---
id: Unity.Networking.Transport.Relay.RelayServerData
title: Unity.Networking.Transport.Relay.RelayServerData
---
<div class="markdown level0 summary">
# Struct RelayServerData
Used by the Relay Protocol to describe how to connect to the Relay
Service.
</div>
<div class="markdown level0 conceptual">
</div>
<div class="inheritedMembers">
##### Inherited Members
<div>
ValueType.Equals(Object)
System.ValueType.Equals(System.Object)
</div>
<div>
ValueType.GetHashCode()
</div>
<div>
System.ValueType.GetHashCode()
ValueType.ToString()
</div>
<div>
Object.Equals(Object, Object)
</div>
System.ValueType.ToString()
<div>
Object.GetType()
</div>
<div>
Object.ReferenceEquals(Object, Object)
System.Object.Equals(System.Object, System.Object)
</div>
</div>
##### **Namespace**: System.Dynamic.ExpandoObject
System.Object.GetType()
System.Object.ReferenceEquals(System.Object, System.Object)
###### **Namespace**: Unity.Networking.Transport.Relay
###### **Assembly**: Transport.dll
##### **Assembly**: transport.dll
##### Syntax
``` lang-csharp
public struct RelayServerData
```
##
### RelayServerData(ref NetworkEndPoint, UInt16, RelayAllocationId, String, String, String, Boolean)
### Constructors
<div class="markdown level1 summary">
#### RelayServerData(ref NetworkEndPoint, UInt16, RelayAllocationId, String, String, String, Boolean)
</div>
<div class="markdown level1 conceptual">
Initializes a new instance of the RelayServerData class
##### Declaration
</div>
#### Declaration
``` lang-csharp
public RelayServerData(ref NetworkEndPoint endpoint, ushort nonce, RelayAllocationId allocationId, string connectionData, string hostConnectionData, string key, bool isSecure)
```
#### Parameters
| Type | Name | Description |
|-------------------|--------------------|-------------|
| NetworkEndPoint | endpoint | |
| System.UInt16 | nonce | |
| RelayAllocationId | allocationId | |
| System.String | connectionData | |
| System.String | hostConnectionData | |
| System.String | key | |
| System.Boolean | isSecure | |
##### Parameters
### RelayServerData(ref NetworkEndPoint, UInt16, ref RelayAllocationId, ref RelayConnectionData, ref RelayConnectionData, ref RelayHMACKey, Boolean)
| Type | Name | Description |
|-------------------|--------------------|--------------------------|
| NetworkEndPoint | endpoint | The endpoint |
| System.UInt16 | nonce | The nonce |
| RelayAllocationId | allocationId | The allocation id |
| System.String | connectionData | The connection data |
| System.String | hostConnectionData | The host connection data |
| System.String | key | The key |
| System.Boolean | isSecure | The is secure |
<div class="markdown level1 summary">
#### RelayServerData(ref NetworkEndPoint, UInt16, ref RelayAllocationId, ref RelayConnectionData, ref RelayConnectionData, ref RelayHMACKey, Boolean)
</div>
<div class="markdown level1 conceptual">
Initializes a new instance of the RelayServerData class
##### Declaration
</div>
#### Declaration
``` lang-csharp
public RelayServerData(ref NetworkEndPoint endpoint, ushort nonce, ref RelayAllocationId allocationId, ref RelayConnectionData connectionData, ref RelayConnectionData hostConnectionData, ref RelayHMACKey key, bool isSecure)
```
#### Parameters
| Type | Name | Description |
|---------------------|--------------------|-------------|
| NetworkEndPoint | endpoint | |
| System.UInt16 | nonce | |
| RelayAllocationId | allocationId | |
| RelayConnectionData | connectionData | |
| RelayConnectionData | hostConnectionData | |
| RelayHMACKey | key | |
| System.Boolean | isSecure | |
##### Parameters
##
| Type | Name | Description |
|---------------------|--------------------|--------------------------|
| NetworkEndPoint | endpoint | The endpoint |
| System.UInt16 | nonce | The nonce |
| RelayAllocationId | allocationId | The allocation id |
| RelayConnectionData | connectionData | The connection data |
| RelayConnectionData | hostConnectionData | The host connection data |
| RelayHMACKey | key | The key |
| System.Boolean | isSecure | The is secure |
### AllocationId
### Fields
<div class="markdown level1 summary">
#### AllocationId
</div>
<div class="markdown level1 conceptual">
The unique identifier of the client on the Relay Server.
##### Declaration
</div>
#### Declaration
``` lang-csharp
public RelayAllocationId AllocationId
```
##### Field Value
#### Field Value
| Type | Description |
|-------------------|-------------|
| RelayAllocationId | |
#### ConnectionData
### ConnectionData
<div class="markdown level1 summary">
The data that describes the client presence on the Relay Server.
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public RelayConnectionData ConnectionData
```
##### Field Value
#### Field Value
| Type | Description |
|---------------------|-------------|
| RelayConnectionData | |
#### Endpoint
### Endpoint
<div class="markdown level1 summary">
The endpoint of the Relay Server.
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public NetworkEndPoint Endpoint
```
##### Field Value
#### Field Value
| Type | Description |
|-----------------|-------------|
| NetworkEndPoint | |
#### HMAC
### HMAC
<div class="markdown level1 summary">
The computed HMAC.
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public byte *HMAC
```
##### Field Value
#### Field Value
| Type | Description |
|---------------|-------------|
| System.Byte\* | |
#### HMACKey
### HMACKey
<div class="markdown level1 summary">
The HMAC key for the connection.
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public RelayHMACKey HMACKey
```
##### Field Value
#### Field Value
| Type | Description |
|--------------|-------------|
| RelayHMACKey | |
#### HostConnectionData
### HostConnectionData
<div class="markdown level1 summary">
The connection data of the host client on the Relay Server.
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public RelayConnectionData HostConnectionData
```
##### Field Value
#### Field Value
| Type | Description |
|---------------------|-------------|
| RelayConnectionData | |
#### IsSecure
### IsSecure
<div class="markdown level1 summary">
A byte that identifies the connection as secured.
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public readonly byte IsSecure
```
##### Field Value
#### Field Value
| Type | Description |
|-------------|-------------|
| System.Byte | |
#### Nonce
### Nonce
<div class="markdown level1 summary">
The Nonce value used to stablish the connection with the Relay Server.
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public ushort Nonce
```
##### Field Value
#### Field Value
| Type | Description |
|---------------|-------------|
| System.UInt16 | |
### Methods
##
#### ComputeNewNonce()
### ComputeNewNonce()
<div class="markdown level1 summary">
Computes the new nonce, this must be called one time!
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public void ComputeNewNonce()
```

90
transport/api/Unity.Networking.Transport.Relay.md
Просмотреть файл

@ -1,69 +1,115 @@
---
id: Unity.Networking.Transport.Relay
title: Unity.Networking.Transport.Relay
---
id: Unity.Networking.Transport.Relay
title: Unity.Networking.Transport.Relay
---
##
# Namespace Unity.Networking.Transport.Relay
<div class="markdown level0 summary">
</div>
<div class="markdown level0 conceptual">
</div>
<div class="markdown level0 remarks">
</div>
##
### Unity.Networking.Transport.Relay.RelayMessageBind
<div class="section">
### Classes
</div>
#### RelayParameterExtensions
### Unity.Networking.Transport.Relay.RelayParameterExtensions
<div class="section">
</div>
##
### Structs
#### RelayAllocationId
### Unity.Networking.Transport.Relay.RelayAllocationId
<div class="section">
Allocation Id is a unique identifier for a connected client/host to a
Relay server. This identifier is used by the Relay protocol as the
address of the client.
</div>
### Unity.Networking.Transport.Relay.RelayConnectionData
#### RelayConnectionData
<div class="section">
This is the encrypted data that the Relay server uses for describing a
connection. Used mainly in the connection establishing process
(Binding).
connection. Used mainly in the connection stablishing process (Binding)
</div>
### Unity.Networking.Transport.Relay.RelayHMACKey
#### RelayHMACKey
<div class="section">
</div>
Used to represent the HMACKey for the Relay Service
### Unity.Networking.Transport.Relay.RelayMessageAccepted
<div class="section">
</div>
#### RelayNetworkParameter
### Unity.Networking.Transport.Relay.RelayMessageConnectRequest
<div class="section">
Relay protocol network parementers used to connect to the Unity Relay
service. This data must be provided to the Create(NetworkSettings)
function in order to be able to use connect to Relay.
</div>
### Unity.Networking.Transport.Relay.RelayMessageDisconnect
<div class="section">
#### RelayServerData
</div>
### Unity.Networking.Transport.Relay.RelayMessageHeader
Used by the Relay Protocol to describe how to connect to the Relay
Service.
<div class="section">
</div>
### Unity.Networking.Transport.Relay.RelayMessagePing
<div class="section">
</div>
### Unity.Networking.Transport.Relay.RelayMessageRelay
<div class="section">
</div>
### Unity.Networking.Transport.Relay.RelayNetworkParameter
<div class="section">
</div>
### Unity.Networking.Transport.Relay.RelayServerData
<div class="section">
</div>
##
### Unity.Networking.Transport.Relay.RelayMessageType
<div class="section">
</div>

115
transport/api/Unity.Networking.Transport.ReliableSequencedPipelineStage.md
Просмотреть файл

@ -1,131 +1,123 @@
---
id: Unity.Networking.Transport.ReliableSequencedPipelineStage
title: Unity.Networking.Transport.ReliableSequencedPipelineStage
---
id: Unity.Networking.Transport.ReliableSequencedPipelineStage
title: Unity.Networking.Transport.ReliableSequencedPipelineStage
---
<div class="markdown level0 summary">
# Struct ReliableSequencedPipelineStage
The ReliableSequencedPipelineStage is used to send packets reliably and
retain the order in which they are sent. This PipelineStage has a
hardcoded WindowSize of 32 inflight packets and will drop packets if its
unable to track them.
</div>
<div class="markdown level0 conceptual">
</div>
<div classs="implements">
##### Implements
<div>
INetworkPipelineStage
</div>
</div>
<div class="inheritedMembers">
##### Inherited Members
<div>
ValueType.Equals(Object)
System.ValueType.Equals(System.Object)
</div>
<div>
ValueType.GetHashCode()
</div>
<div>
System.ValueType.GetHashCode()
ValueType.ToString()
</div>
<div>
Object.Equals(Object, Object)
</div>
System.ValueType.ToString()
<div>
Object.GetType()
</div>
<div>
Object.ReferenceEquals(Object, Object)
System.Object.Equals(System.Object, System.Object)
</div>
</div>
##### **Namespace**: System.Dynamic.ExpandoObject
System.Object.GetType()
System.Object.ReferenceEquals(System.Object, System.Object)
###### **Namespace**: Unity.Networking.Transport
###### **Assembly**: Transport.dll
##### **Assembly**: transport.dll
##### Syntax
``` lang-csharp
public struct ReliableSequencedPipelineStage : INetworkPipelineStage
```
##
### StaticSize
### Properties
<div class="markdown level1 summary">
#### StaticSize
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public readonly int StaticSize { get; }
```
##### Property Value
#### Property Value
| Type | Description |
|--------------|-------------|
| System.Int32 | |
### Methods
##
#### StaticInitialize(Byte\*, Int32, NetworkSettings)
### StaticInitialize(Byte\*, Int32, NetworkSettings)
<div class="markdown level1 summary">
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public NetworkPipelineStage StaticInitialize(byte *staticInstanceBuffer, int staticInstanceBufferLength, NetworkSettings settings)
```
##### Parameters
#### Parameters
| Type | Name | Description |
|-----------------|----------------------------|-------------|
@ -133,7 +125,7 @@ public NetworkPipelineStage StaticInitialize(byte *staticInstanceBuffer, int sta
| System.Int32 | staticInstanceBufferLength | |
| NetworkSettings | settings | |
##### Returns
#### Returns
| Type | Description |
|----------------------|-------------|
@ -141,11 +133,8 @@ public NetworkPipelineStage StaticInitialize(byte *staticInstanceBuffer, int sta
### Implements
<div>
INetworkPipelineStage
</div>

46
transport/api/Unity.Networking.Transport.SendHandleFlags.md
Просмотреть файл

@ -1,49 +1,29 @@
---
id: Unity.Networking.Transport.SendHandleFlags
title: Unity.Networking.Transport.SendHandleFlags
---
id: Unity.Networking.Transport.SendHandleFlags
title: Unity.Networking.Transport.SendHandleFlags
---
<div class="markdown level0 summary">
# Enum SendHandleFlags
</div>
<div class="markdown level0 conceptual">
The send handle flags enum
</div>
##### **Namespace**: System.Dynamic.ExpandoObject
###### **Namespace**: Unity.Networking.Transport
###### **Assembly**: Transport.dll
##### **Assembly**: transport.dll
##### Syntax
``` lang-csharp
[Flags]
public enum SendHandleFlags
```
##
### Fields
Name
Description
AllocatedByDriver
This SendHandle has been allocated by NetworkDriver
| Name | Description |
|-------------------|-------------|
| AllocatedByDriver | |

133
transport/api/Unity.Networking.Transport.SimulatorPipelineStage.md
Просмотреть файл

@ -1,153 +1,140 @@
---
id: Unity.Networking.Transport.SimulatorPipelineStage
title: Unity.Networking.Transport.SimulatorPipelineStage
---
id: Unity.Networking.Transport.SimulatorPipelineStage
title: Unity.Networking.Transport.SimulatorPipelineStage
---
<div class="markdown level0 summary">
# Struct SimulatorPipelineStage
The SimulatorPipelineStage could be added on either the client or server
to simulate bad network conditions. It's best to add it as the last
stage in the pipeline, then it will either drop the packet or add a
delay right before it would go on the wire.
</div>
<div class="markdown level0 conceptual">
</div>
<div classs="implements">
##### Implements
<div>
INetworkPipelineStage
</div>
</div>
<div class="inheritedMembers">
##### Inherited Members
<div>
ValueType.Equals(Object)
System.ValueType.Equals(System.Object)
</div>
<div>
ValueType.GetHashCode()
</div>
<div>
System.ValueType.GetHashCode()
ValueType.ToString()
</div>
<div>
Object.Equals(Object, Object)
</div>
System.ValueType.ToString()
<div>
Object.GetType()
</div>
<div>
Object.ReferenceEquals(Object, Object)
System.Object.Equals(System.Object, System.Object)
</div>
</div>
##### **Namespace**: System.Dynamic.ExpandoObject
System.Object.GetType()
System.Object.ReferenceEquals(System.Object, System.Object)
###### **Namespace**: Unity.Networking.Transport
###### **Assembly**: Transport.dll
##### **Assembly**: transport.dll
##### Syntax
``` lang-csharp
public struct SimulatorPipelineStage : INetworkPipelineStage
```
##
### StaticSize
### Properties
<div class="markdown level1 summary">
#### StaticSize
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public readonly int StaticSize { get; }
```
##### Property Value
#### Property Value
| Type | Description |
|--------------|-------------|
| System.Int32 | |
### Methods
##
#### StaticInitialize(Byte\*, Int32, NetworkSettings)
### StaticInitialize(Byte\*, Int32, NetworkSettings)
<div class="markdown level1 summary">
Statics the initialize using the specified static instance buffer
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public NetworkPipelineStage StaticInitialize(byte *staticInstanceBuffer, int staticInstanceBufferLength, NetworkSettings settings)
```
#### Parameters
| Type | Name | Description |
|-----------------|----------------------------|-------------|
| System.Byte\* | staticInstanceBuffer | |
| System.Int32 | staticInstanceBufferLength | |
| NetworkSettings | settings | |
##### Parameters
#### Returns
| Type | Name | Description |
|-----------------|----------------------------|-----------------------------------|
| System.Byte\* | staticInstanceBuffer | The static instance buffer |
| System.Int32 | staticInstanceBufferLength | The static instance buffer length |
| NetworkSettings | settings | The net params |
##### Returns
| Type | Description |
|----------------------|----------------------------|
| NetworkPipelineStage | The network pipeline stage |
| Type | Description |
|----------------------|-------------|
| NetworkPipelineStage | |
### Implements
<div>
INetworkPipelineStage
</div>

133
transport/api/Unity.Networking.Transport.SimulatorPipelineStageInSend.md
Просмотреть файл

@ -1,152 +1,141 @@
---
id: Unity.Networking.Transport.SimulatorPipelineStageInSend
title: Unity.Networking.Transport.SimulatorPipelineStageInSend
---
id: Unity.Networking.Transport.SimulatorPipelineStageInSend
title: Unity.Networking.Transport.SimulatorPipelineStageInSend
---
<div class="markdown level0 summary">
# Struct SimulatorPipelineStageInSend
The simulator pipeline stage in send
</div>
<div class="markdown level0 conceptual">
</div>
<div classs="implements">
##### Implements
<div>
INetworkPipelineStage
</div>
</div>
<div class="inheritedMembers">
##### Inherited Members
<div>
ValueType.Equals(Object)
System.ValueType.Equals(System.Object)
</div>
<div>
ValueType.GetHashCode()
</div>
<div>
System.ValueType.GetHashCode()
ValueType.ToString()
</div>
<div>
Object.Equals(Object, Object)
</div>
System.ValueType.ToString()
<div>
Object.GetType()
</div>
<div>
Object.ReferenceEquals(Object, Object)
System.Object.Equals(System.Object, System.Object)
</div>
</div>
##### **Namespace**: System.Dynamic.ExpandoObject
System.Object.GetType()
System.Object.ReferenceEquals(System.Object, System.Object)
###### **Namespace**: Unity.Networking.Transport
###### **Assembly**: Transport.dll
##### **Assembly**: transport.dll
##### Syntax
``` lang-csharp
[Obsolete("SimulatorPipelineStage now supports handling both sending and receiving via ApplyMode.AllPackets. You can safely remove this stage from your pipelines. (RemovedAfter 2022-03-01)")]
public struct SimulatorPipelineStageInSend : INetworkPipelineStage
```
##
### StaticSize
### Properties
<div class="markdown level1 summary">
#### StaticSize
</div>
<div class="markdown level1 conceptual">
Gets the value of the static size
##### Declaration
</div>
#### Declaration
``` lang-csharp
public readonly int StaticSize { get; }
```
##### Property Value
#### Property Value
| Type | Description |
|--------------|-------------|
| System.Int32 | |
### Methods
##
#### StaticInitialize(Byte\*, Int32, NetworkSettings)
### StaticInitialize(Byte\*, Int32, NetworkSettings)
<div class="markdown level1 summary">
Statics the initialize using the specified static instance buffer
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public NetworkPipelineStage StaticInitialize(byte *staticInstanceBuffer, int staticInstanceBufferLength, NetworkSettings settings)
```
#### Parameters
| Type | Name | Description |
|-----------------|----------------------------|-------------|
| System.Byte\* | staticInstanceBuffer | |
| System.Int32 | staticInstanceBufferLength | |
| NetworkSettings | settings | |
##### Parameters
#### Returns
| Type | Name | Description |
|-----------------|----------------------------|-----------------------------------|
| System.Byte\* | staticInstanceBuffer | The static instance buffer |
| System.Int32 | staticInstanceBufferLength | The static instance buffer length |
| NetworkSettings | settings | The net params |
##### Returns
| Type | Description |
|----------------------|----------------------------|
| NetworkPipelineStage | The network pipeline stage |
| Type | Description |
|----------------------|-------------|
| NetworkPipelineStage | |
### Implements
<div>
INetworkPipelineStage
</div>

203
transport/api/Unity.Networking.Transport.TransportFunctionPointer-1.md
Просмотреть файл

@ -1,222 +1,199 @@
---
id: Unity.Networking.Transport.TransportFunctionPointer-1
title: Unity.Networking.Transport.TransportFunctionPointer-1
---
id: Unity.Networking.Transport.TransportFunctionPointer-1
title: Unity.Networking.Transport.TransportFunctionPointer-1
---
<div class="markdown level0 summary">
# Struct TransportFunctionPointer\<T\>
Represents a wrapper around burst compatible function pointers in a
portable way
</div>
<div class="markdown level0 conceptual">
</div>
<div class="inheritedMembers">
##### Inherited Members
<div>
ValueType.Equals(Object)
System.ValueType.Equals(System.Object)
</div>
<div>
ValueType.GetHashCode()
</div>
<div>
System.ValueType.GetHashCode()
ValueType.ToString()
</div>
<div>
Object.Equals(Object, Object)
</div>
System.ValueType.ToString()
<div>
Object.GetType()
</div>
<div>
Object.ReferenceEquals(Object, Object)
System.Object.Equals(System.Object, System.Object)
</div>
</div>
##### **Namespace**: System.Dynamic.ExpandoObject
System.Object.GetType()
System.Object.ReferenceEquals(System.Object, System.Object)
###### **Namespace**: Unity.Networking.Transport
###### **Assembly**: Transport.dll
##### **Assembly**: transport.dll
##### Syntax
``` lang-csharp
public struct TransportFunctionPointer<T>
where T : Delegate
```
##### Type Parameters
| Name | Description |
|------|-------------|
| T | |
### Constructors
##
#### TransportFunctionPointer(T)
### TransportFunctionPointer(T)
<div class="markdown level1 summary">
Initializes a new instance of the class
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public TransportFunctionPointer(T executeDelegate)
```
#### Parameters
| Type | Name | Description |
|------|-----------------|-------------|
| T | executeDelegate | |
##### Parameters
### TransportFunctionPointer(FunctionPointer\&lt;T&gt;)
| Type | Name | Description |
|------|-----------------|----------------------|
| T | executeDelegate | The execute delegate |
<div class="markdown level1 summary">
#### TransportFunctionPointer(FunctionPointer\<T\>)
</div>
<div class="markdown level1 conceptual">
Initializes a new instance of the class
##### Declaration
</div>
#### Declaration
``` lang-csharp
public TransportFunctionPointer(FunctionPointer<T> Pointer)
```
#### Parameters
| Type | Name | Description |
|---------------------|---------|-------------|
| FunctionPointer&lt;T&gt; | Pointer | |
##### Parameters
##
| Type | Name | Description |
|----------------------|---------|-------------|
| FunctionPointer\<T\> | Pointer | The pointer |
### Ptr
### Fields
<div class="markdown level1 summary">
#### Ptr
</div>
<div class="markdown level1 conceptual">
Returns Burst
##### Declaration
</div>
#### Declaration
``` lang-csharp
public readonly FunctionPointer<T> Ptr
```
#### Field Value
| Type | Description |
|---------------------|-------------|
| FunctionPointer&lt;T&gt;| |
##### Field Value
##
| Type | Description |
|----------------------|-------------|
| FunctionPointer\<T\> | |
### Burst(T)
### Methods
<div class="markdown level1 summary">
#### Burst(T)
</div>
<div class="markdown level1 conceptual">
returns a wrapped Burst compiled function pointer
##### Declaration
</div>
#### Declaration
``` lang-csharp
public static TransportFunctionPointer<T> Burst(T burstCompilableDelegate)
```
#### Parameters
| Type | Name | Description |
|------|-------------------------|-------------|
| T | burstCompilableDelegate | |
##### Parameters
#### Returns
| Type | Name | Description |
|------|-------------------------|-------------------------------|
| T | burstCompilableDelegate | The burst compilable delegate |
| Type | Description |
|------------------------------|-------------|
| TransportFunctionPointer&lt;T&gt;| |
##### Returns
### Managed(T)
| Type | Description |
|-------------------------------|-----------------------------------|
| TransportFunctionPointer\<T\> | A transport function pointer of t |
<div class="markdown level1 summary">
#### Managed(T)
</div>
<div class="markdown level1 conceptual">
Returns a wrapped managed function pointer
##### Declaration
</div>
#### Declaration
``` lang-csharp
public static TransportFunctionPointer<T> Managed(T managedDelegate)
```
#### Parameters
| Type | Name | Description |
|------|-----------------|-------------|
| T | managedDelegate | |
##### Parameters
| Type | Name | Description |
|------|-----------------|----------------------|
| T | managedDelegate | The managed delegate |
##### Returns
| Type | Description |
|-------------------------------|-----------------------------------|
| TransportFunctionPointer\<T\> | A transport function pointer of t |
#### Returns
| Type | Description |
|------------------------------|-------------|
| TransportFunctionPointer&lt;T&gt; | |

133
transport/api/Unity.Networking.Transport.UnreliableSequencedPipelineStage.md
Просмотреть файл

@ -1,153 +1,140 @@
---
id: Unity.Networking.Transport.UnreliableSequencePipelineStage
title: Unity.Networking.Transport.UnreliableSequencePipelineStage
---
id: Unity.Networking.Transport.UnreliableSequencedPipelineStage
title: Unity.Networking.Transport.UnreliableSequencedPipelineStage
---
<div class="markdown level0 summary">
# Struct UnreliableSequencedPipelineStage
The UnreliableSequencedPipelineStage is used to send unreliable packets
in order.
</div>
<div class="markdown level0 conceptual">
</div>
<div classs="implements">
##### Implements
<div>
INetworkPipelineStage
</div>
</div>
<div class="inheritedMembers">
##### Inherited Members
<div>
ValueType.Equals(Object)
System.ValueType.Equals(System.Object)
</div>
<div>
ValueType.GetHashCode()
</div>
<div>
System.ValueType.GetHashCode()
ValueType.ToString()
</div>
<div>
Object.Equals(Object, Object)
</div>
System.ValueType.ToString()
<div>
Object.GetType()
</div>
<div>
Object.ReferenceEquals(Object, Object)
System.Object.Equals(System.Object, System.Object)
</div>
</div>
##### **Namespace**: System.Dynamic.ExpandoObject
System.Object.GetType()
System.Object.ReferenceEquals(System.Object, System.Object)
###### **Namespace**: Unity.Networking.Transport
###### **Assembly**: Transport.dll
##### **Assembly**: transport.dll
##### Syntax
``` lang-csharp
public struct UnreliableSequencedPipelineStage : INetworkPipelineStage
```
##
### StaticSize
### Properties
<div class="markdown level1 summary">
#### StaticSize
</div>
<div class="markdown level1 conceptual">
Gets the value of the static size
##### Declaration
</div>
#### Declaration
``` lang-csharp
public readonly int StaticSize { get; }
```
##### Property Value
#### Property Value
| Type | Description |
|--------------|-------------|
| System.Int32 | |
### Methods
##
#### StaticInitialize(Byte\*, Int32, NetworkSettings)
### StaticInitialize(Byte\*, Int32, NetworkSettings)
<div class="markdown level1 summary">
Statics the initialize using the specified static instance buffer
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public NetworkPipelineStage StaticInitialize(byte *staticInstanceBuffer, int staticInstanceBufferLength, NetworkSettings settings)
```
#### Parameters
| Type | Name | Description |
|-----------------|----------------------------|-------------|
| System.Byte\* | staticInstanceBuffer | |
| System.Int32 | staticInstanceBufferLength | |
| NetworkSettings | settings | |
##### Parameters
#### Returns
| Type | Name | Description |
|-----------------|----------------------------|-----------------------------------|
| System.Byte\* | staticInstanceBuffer | The static instance buffer |
| System.Int32 | staticInstanceBufferLength | The static instance buffer length |
| NetworkSettings | settings | The net params |
##### Returns
| Type | Description |
|----------------------|----------------------------|
| NetworkPipelineStage | The network pipeline stage |
| Type | Description |
|----------------------|-------------|
| NetworkPipelineStage | |
### Implements
<div>
INetworkPipelineStage
</div>

0
transport_versioned_docs/version-2.0.0/api/Unity.Networking.Transport.Utilities.ApplyMode.md → transport/api/Unity.Networking.Transport.Utilities.ApplyMode.md
Просмотреть файл

105
transport/api/Unity.Networking.Transport.Utilities.FixedStringHexExt.md
Просмотреть файл

@ -1,131 +1,126 @@
---
id: Unity.Networking.Transport.Utilities.FixedStringHexExt
title: Unity.Networking.Transport.Utilities.FixedStringHexExt
---
id: Unity.Networking.Transport.Utilities.FixedStringHexExt
title: Unity.Networking.Transport.Utilities.FixedStringHexExt
---
<div class="markdown level0 summary">
# Class FixedStringHexExt
Provides Extension methods for FixedStrings
</div>
<div class="markdown level0 conceptual">
</div>
<div class="inheritance">
##### Inheritance
<div class="level0">
System.Object
System.Dynamic.ExpandoObject
</div>
<div class="level1">
System.Dynamic.ExpandoObject
FixedStringHexExt
</div>
</div>
<div class="inheritedMembers">
##### Inherited Members
<div>
Object.Equals(Object)
System.Object.Equals(System.Object)
</div>
<div>
Object.Equals(Object, Object)
</div>
<div>
System.Object.Equals(System.Object, System.Object)
Object.GetHashCode()
</div>
<div>
Object.GetType()
</div>
System.Object.GetHashCode()
<div>
Object.MemberwiseClone()
</div>
<div>
Object.ReferenceEquals(Object, Object)
System.Object.GetType()
</div>
<div>
Object.ToString()
</div>
</div>
System.Object.MemberwiseClone()
##### **Namespace**: System.Dynamic.ExpandoObject
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
###### **Namespace**: Unity.Networking.Transport.Utilities
###### **Assembly**: Transport.dll
##### **Assembly**: transport.dll
##### Syntax
``` lang-csharp
public static class FixedStringHexExt
```
##
### AppendHex&lt;T&gt;(ref T, UInt16)
### Methods
<div class="markdown level1 summary">
#### AppendHex\<T\>(ref T, UInt16)
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public static FormatError AppendHex<T>(this ref T str, ushort val)
where T : struct, INativeList<byte>, IUTF8Bytes
```
##### Parameters
#### Parameters
| Type | Name | Description |
|---------------|------|-------------|
| T | str | |
| System.UInt16 | val | |
##### Returns
#### Returns
| Type | Description |
|-------------|-------------|
| FormatError | |
##### Type Parameters
#### Type Parameters
| Name | Description |
|------|-------------|
| T | |

136
transport/api/Unity.Networking.Transport.Utilities.FragmentationStageParameterExtensions.md
Просмотреть файл

@ -1,155 +1,147 @@
---
id: Unity.Networking.Transport.Utilities.FragmentationStageParameterExtensions
title: Unity.Networking.Transport.Utilities.FragmentationStageParameterExtensions
---
id: Unity.Networking.Transport.Utilities.FragmentationStageParameterExtensions
title: Unity.Networking.Transport.Utilities.FragmentationStageParameterExtensions
---
<div class="markdown level0 summary">
# Class FragmentationStageParameterExtensions
</div>
<div class="markdown level0 conceptual">
</div>
<div class="inheritance">
##### Inheritance
<div class="level0">
System.Object
System.Dynamic.ExpandoObject
</div>
<div class="level1">
System.Dynamic.ExpandoObject
FragmentationStageParameterExtensions
</div>
</div>
<div class="inheritedMembers">
##### Inherited Members
<div>
Object.Equals(Object)
System.Object.Equals(System.Object)
</div>
<div>
Object.Equals(Object, Object)
</div>
<div>
System.Object.Equals(System.Object, System.Object)
Object.GetHashCode()
</div>
<div>
Object.GetType()
</div>
System.Object.GetHashCode()
<div>
Object.MemberwiseClone()
</div>
<div>
Object.ReferenceEquals(Object, Object)
System.Object.GetType()
</div>
<div>
Object.ToString()
</div>
</div>
System.Object.MemberwiseClone()
##### **Namespace**: System.Dynamic.ExpandoObject
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
###### **Namespace**: Unity.Networking.Transport.Utilities
###### **Assembly**: Transport.dll
##### **Assembly**: transport.dll
##### Syntax
``` lang-csharp
public static class FragmentationStageParameterExtensions
```
##
### GetFragmentationStageParameters(ref NetworkSettings)
### Methods
<div class="markdown level1 summary">
#### GetFragmentationStageParameters(ref NetworkSettings)
</div>
<div class="markdown level1 conceptual">
Gets the FragmentationUtility.Parameters
##### Declaration
</div>
#### Declaration
``` lang-csharp
public static FragmentationUtility.Parameters GetFragmentationStageParameters(this ref NetworkSettings settings)
```
##### Parameters
#### Parameters
| Type | Name | Description |
|-----------------|----------|-------------|
| NetworkSettings | settings | |
##### Returns
#### Returns
| Type | Description |
|---------------------------------|----------------------------------------------------------------------------|
| FragmentationUtility.Parameters | Returns the FragmentationUtility.Parameters values for the NetworkSettings |
| Type | Description |
|---------------------------------|-------------|
| FragmentationUtility.Parameters | |
#### WithFragmentationStageParameters(ref NetworkSettings, Int32)
### WithFragmentationStageParameters(ref NetworkSettings, Int32)
<div class="markdown level1 summary">
Sets the FragmentationUtility.Parameters values for the NetworkSettings
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public static ref NetworkSettings WithFragmentationStageParameters(this ref NetworkSettings settings, int payloadCapacity = 4096)
```
#### Parameters
| Type | Name | Description |
|-----------------|-----------------|-------------|
| NetworkSettings | settings | |
| System.Int32 | payloadCapacity | |
##### Parameters
| Type | Name | Description |
|-----------------|-----------------|-----------------|
| NetworkSettings | settings | |
| System.Int32 | payloadCapacity | PayloadCapacity |
##### Returns
#### Returns
| Type | Description |
|-----------------|-------------|
| NetworkSettings | |

114
transport/api/Unity.Networking.Transport.Utilities.FragmentationUtility.Parameters.md
Просмотреть файл

@ -1,128 +1,129 @@
---
id: Unity.Networking.Transport.Utilities.FragmentationUtility.Parameters
title: Unity.Networking.Transport.Utilities.FragmentationUtility.Parameters
---
id: Unity.Networking.Transport.Utilities.FragmentationUtility.Parameters
title: Unity.Networking.Transport.Utilities.FragmentationUtility.Parameters
---
<div class="markdown level0 summary">
# Struct FragmentationUtility.Parameters
</div>
<div class="markdown level0 conceptual">
</div>
<div classs="implements">
##### Implements
<div>
INetworkParameter
</div>
<div>
IValidatableNetworkParameter
</div>
</div>
<div class="inheritedMembers">
##### Inherited Members
<div>
ValueType.Equals(Object)
System.ValueType.Equals(System.Object)
</div>
<div>
ValueType.GetHashCode()
</div>
<div>
System.ValueType.GetHashCode()
ValueType.ToString()
</div>
<div>
Object.Equals(Object, Object)
</div>
System.ValueType.ToString()
<div>
Object.GetType()
</div>
<div>
Object.ReferenceEquals(Object, Object)
System.Object.Equals(System.Object, System.Object)
</div>
</div>
##### **Namespace**: System.Dynamic.ExpandoObject
System.Object.GetType()
System.Object.ReferenceEquals(System.Object, System.Object)
###### **Namespace**: Unity.Networking.Transport.Utilities
###### **Assembly**: Transport.dll
##### **Assembly**: transport.dll
##### Syntax
``` lang-csharp
public struct Parameters : INetworkParameter
public struct Parameters : INetworkParameter, IValidatableNetworkParameter
```
##
### PayloadCapacity
### Fields
<div class="markdown level1 summary">
#### PayloadCapacity
</div>
<div class="markdown level1 conceptual">
Maximum payload size that can be fragmented.
##### Declaration
</div>
#### Declaration
``` lang-csharp
public int PayloadCapacity
```
##### Field Value
#### Field Value
| Type | Description |
|--------------|-------------|
| System.Int32 | |
### Methods
##
#### Validate()
### Validate()
<div class="markdown level1 summary">
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public bool Validate()
```
##### Returns
#### Returns
| Type | Description |
|----------------|-------------|
@ -130,11 +131,14 @@ public bool Validate()
### Implements
<div>
INetworkParameter
</div>
<div>
IValidatableNetworkParameter
</div>

63
transport/api/Unity.Networking.Transport.Utilities.FragmentationUtility.md
Просмотреть файл

@ -1,69 +1,64 @@
---
id: Unity.Networking.Transport.Utilities.FragmentationUtility
title: Unity.Networking.Transport.Utilities.FragmentationUtility
---
id: Unity.Networking.Transport.Utilities.FragmentationUtility
title: Unity.Networking.Transport.Utilities.FragmentationUtility
---
<div class="markdown level0 summary">
# Struct FragmentationUtility
</div>
<div class="markdown level0 conceptual">
</div>
<div class="inheritedMembers">
##### Inherited Members
<div>
ValueType.Equals(Object)
System.ValueType.Equals(System.Object)
</div>
<div>
ValueType.GetHashCode()
</div>
<div>
System.ValueType.GetHashCode()
ValueType.ToString()
</div>
<div>
Object.Equals(Object, Object)
</div>
System.ValueType.ToString()
<div>
Object.GetType()
</div>
<div>
Object.ReferenceEquals(Object, Object)
System.Object.Equals(System.Object, System.Object)
</div>
</div>
##### **Namespace**: System.Dynamic.ExpandoObject
System.Object.GetType()
System.Object.ReferenceEquals(System.Object, System.Object)
###### **Namespace**: Unity.Networking.Transport.Utilities
###### **Assembly**: Transport.dll
##### **Assembly**: transport.dll
##### Syntax
``` lang-csharp
public struct FragmentationUtility
```

109
transport/api/Unity.Networking.Transport.Utilities.NativeListExt.md
Просмотреть файл

@ -1,127 +1,124 @@
---
id: Unity.Networking.Transport.Utilities.NativeListExt
title: Unity.Networking.Transport.Utilities.NativeListExt
---
id: Unity.Networking.Transport.Utilities.NativeListExt
title: Unity.Networking.Transport.Utilities.NativeListExt
---
<div class="markdown level0 summary">
# Class NativeListExt
</div>
<div class="markdown level0 conceptual">
</div>
<div class="inheritance">
##### Inheritance
<div class="level0">
System.Object
System.Dynamic.ExpandoObject
</div>
<div class="level1">
System.Dynamic.ExpandoObject
NativeListExt
</div>
</div>
<div class="inheritedMembers">
##### Inherited Members
<div>
Object.Equals(Object)
System.Object.Equals(System.Object)
</div>
<div>
Object.Equals(Object, Object)
</div>
<div>
System.Object.Equals(System.Object, System.Object)
Object.GetHashCode()
</div>
<div>
Object.GetType()
</div>
System.Object.GetHashCode()
<div>
Object.MemberwiseClone()
</div>
<div>
Object.ReferenceEquals(Object, Object)
System.Object.GetType()
</div>
<div>
Object.ToString()
</div>
</div>
System.Object.MemberwiseClone()
##### **Namespace**: System.Dynamic.ExpandoObject
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
###### **Namespace**: Unity.Networking.Transport.Utilities
###### **Assembly**: Transport.dll
##### **Assembly**: transport.dll
##### Syntax
``` lang-csharp
public static class NativeListExt
```
##
### ResizeUninitializedTillPowerOf2&lt;T&gt;(NativeList&lt;T&gt;, Int32)
### Methods
#### ResizeUninitializedTillPowerOf2\<T\>(NativeList\<T\>, Int32)
<div class="markdown level1 summary">
This function will make sure that can fit into . If \>= 's Length then
will be ResizeUninitialized to a new length. New Length will be the next
highest power of 2 of
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public static void ResizeUninitializedTillPowerOf2<T>(this NativeList<T> list, int sizeToFit)
where T : struct
```
#### Parameters
| Type | Name | Description |
|----------------|-----------|-------------------------------------------------------|
| NativeList&lt;T&gt; | list | List that should be resized if sizeToFit \>= its size |
| System.Int32 | sizeToFit | Requested size that should fit into list |
##### Parameters
| Type | Name | Description |
|-----------------|-----------|-------------------------------------------------------|
| NativeList\<T\> | list | List that should be resized if sizeToFit \>= its size |
| System.Int32 | sizeToFit | Requested size that should fit into list |
##### Type Parameters
#### Type Parameters
| Name | Description |
|------|-------------|
| T | |

0
transport_versioned_docs/version-2.0.0/api/Unity.Networking.Transport.Utilities.NativeMultiQueue-1.md → transport/api/Unity.Networking.Transport.Utilities.NativeMultiQueue-1.md
Просмотреть файл

128
transport/api/Unity.Networking.Transport.Utilities.RandomHelpers.md
Просмотреть файл

@ -1,140 +1,134 @@
---
id: Unity.Networking.Transport.Utilities.RandomHelpers
title: Unity.Networking.Transport.Utilities.RandomHelpers
---
id: Unity.Networking.Transport.Utilities.RandomHelpers
title: Unity.Networking.Transport.Utilities.RandomHelpers
---
<div class="markdown level0 summary">
# Class RandomHelpers
A simple method to obtain a random ushort provided by the class.
</div>
<div class="markdown level0 conceptual">
</div>
<div class="inheritance">
##### Inheritance
<div class="level0">
System.Object
System.Dynamic.ExpandoObject
</div>
<div class="level1">
System.Dynamic.ExpandoObject
RandomHelpers
</div>
</div>
<div class="inheritedMembers">
##### Inherited Members
<div>
Object.Equals(Object)
System.Object.Equals(System.Object)
</div>
<div>
Object.Equals(Object, Object)
</div>
<div>
System.Object.Equals(System.Object, System.Object)
Object.GetHashCode()
</div>
<div>
Object.GetType()
</div>
System.Object.GetHashCode()
<div>
Object.MemberwiseClone()
</div>
<div>
Object.ReferenceEquals(Object, Object)
System.Object.GetType()
</div>
<div>
Object.ToString()
</div>
</div>
System.Object.MemberwiseClone()
##### **Namespace**: System.Dynamic.ExpandoObject
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
###### **Namespace**: Unity.Networking.Transport.Utilities
###### **Assembly**: Transport.dll
##### **Assembly**: transport.dll
##### Syntax
``` lang-csharp
public static class RandomHelpers
```
##
### GetRandomULong()
### Methods
<div class="markdown level1 summary">
#### GetRandomULong()
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public static ulong GetRandomULong()
```
#### Returns
| Type | Description |
|---------------|-------------|
| System.UInt64 | |
##### Returns
### GetRandomUShort()
| Type | Description |
|---------------|--------------------------------------------|
| System.UInt64 | a ushort in \[1..uint.MaxValue - 1\] range |
<div class="markdown level1 summary">
#### GetRandomUShort()
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public static ushort GetRandomUShort()
```
#### Returns
##### Returns
| Type | Description |
|---------------|----------------------------------------------|
| System.UInt16 | a ushort in \[1..ushort.MaxValue - 1\] range |
| Type | Description |
|---------------|-------------|
| System.UInt16 | |

130
transport/api/Unity.Networking.Transport.Utilities.ReliableStageParameterExtensions.md
Просмотреть файл

@ -1,155 +1,147 @@
---
id: Unity.Networking.Transport.Utilities.ReliableStageParameterExtensions
title: Unity.Networking.Transport.Utilities.ReliableStageParameterExtensions
---
id: Unity.Networking.Transport.Utilities.ReliableStageParameterExtensions
title: Unity.Networking.Transport.Utilities.ReliableStageParameterExtensions
---
<div class="markdown level0 summary">
# Class ReliableStageParameterExtensions
</div>
<div class="markdown level0 conceptual">
</div>
<div class="inheritance">
##### Inheritance
<div class="level0">
System.Object
System.Dynamic.ExpandoObject
</div>
<div class="level1">
System.Dynamic.ExpandoObject
ReliableStageParameterExtensions
</div>
</div>
<div class="inheritedMembers">
##### Inherited Members
<div>
Object.Equals(Object)
System.Object.Equals(System.Object)
</div>
<div>
Object.Equals(Object, Object)
</div>
<div>
System.Object.Equals(System.Object, System.Object)
Object.GetHashCode()
</div>
<div>
Object.GetType()
</div>
System.Object.GetHashCode()
<div>
Object.MemberwiseClone()
</div>
<div>
Object.ReferenceEquals(Object, Object)
System.Object.GetType()
</div>
<div>
Object.ToString()
</div>
</div>
System.Object.MemberwiseClone()
##### **Namespace**: System.Dynamic.ExpandoObject
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
###### **Namespace**: Unity.Networking.Transport.Utilities
###### **Assembly**: Transport.dll
##### **Assembly**: transport.dll
##### Syntax
``` lang-csharp
public static class ReliableStageParameterExtensions
```
##
### GetReliableStageParameters(ref NetworkSettings)
### Methods
<div class="markdown level1 summary">
#### GetReliableStageParameters(ref NetworkSettings)
</div>
<div class="markdown level1 conceptual">
Gets the ReliableUtility.Parameters
##### Declaration
</div>
#### Declaration
``` lang-csharp
public static ReliableUtility.Parameters GetReliableStageParameters(this ref NetworkSettings settings)
```
##### Parameters
#### Parameters
| Type | Name | Description |
|-----------------|----------|-------------|
| NetworkSettings | settings | |
##### Returns
#### Returns
| Type | Description |
|----------------------------|-----------------------------------------------------------------------|
| ReliableUtility.Parameters | Returns the ReliableUtility.Parameters values for the NetworkSettings |
| Type | Description |
|----------------------------|-------------|
| ReliableUtility.Parameters | |
#### WithReliableStageParameters(ref NetworkSettings, Int32)
### WithReliableStageParameters(ref NetworkSettings, Int32)
<div class="markdown level1 summary">
Sets the ReliableUtility.Parameters values for the NetworkSettings
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public static ref NetworkSettings WithReliableStageParameters(this ref NetworkSettings settings, int windowSize = 32)
```
##### Parameters
#### Parameters
| Type | Name | Description |
|-----------------|------------|-------------|
| NetworkSettings | settings | |
| System.Int32 | windowSize | WindowSize |
| System.Int32 | windowSize | |
##### Returns
#### Returns
| Type | Description |
|-----------------|-------------|
| NetworkSettings | |

200
transport/api/Unity.Networking.Transport.Utilities.ReliableUtility.Context.md
Просмотреть файл

@ -1,278 +1,264 @@
---
id: Unity.Networking.Transport.Utilities.ReliableUtility.Context
title: Unity.Networking.Transport.Utilities.ReliableUtility.Context
---
id: Unity.Networking.Transport.Utilities.ReliableUtility.Context
title: Unity.Networking.Transport.Utilities.ReliableUtility.Context
---
<div class="markdown level0 summary">
# Struct ReliableUtility.Context
</div>
<div class="markdown level0 conceptual">
</div>
<div class="inheritedMembers">
##### Inherited Members
<div>
ValueType.Equals(Object)
System.ValueType.Equals(System.Object)
</div>
<div>
ValueType.GetHashCode()
</div>
<div>
System.ValueType.GetHashCode()
ValueType.ToString()
</div>
<div>
Object.Equals(Object, Object)
</div>
System.ValueType.ToString()
<div>
Object.GetType()
</div>
<div>
Object.ReferenceEquals(Object, Object)
System.Object.Equals(System.Object, System.Object)
</div>
</div>
##### **Namespace**: System.Dynamic.ExpandoObject
System.Object.GetType()
System.Object.ReferenceEquals(System.Object, System.Object)
###### **Namespace**: Unity.Networking.Transport.Utilities
###### **Assembly**: Transport.dll
##### **Assembly**: transport.dll
##### Syntax
``` lang-csharp
public struct Context
```
##
### Capacity
### Fields
<div class="markdown level1 summary">
#### Capacity
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public int Capacity
```
##### Field Value
#### Field Value
| Type | Description |
|--------------|-------------|
| System.Int32 | |
#### DataPtrOffset
### DataPtrOffset
<div class="markdown level1 summary">
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public int DataPtrOffset
```
##### Field Value
#### Field Value
| Type | Description |
|--------------|-------------|
| System.Int32 | |
#### DataStride
### DataStride
<div class="markdown level1 summary">
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public int DataStride
```
##### Field Value
#### Field Value
| Type | Description |
|--------------|-------------|
| System.Int32 | |
#### Delivered
### Delivered
<div class="markdown level1 summary">
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public int Delivered
```
##### Field Value
#### Field Value
| Type | Description |
|--------------|-------------|
| System.Int32 | |
#### IndexPtrOffset
### IndexPtrOffset
<div class="markdown level1 summary">
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public int IndexPtrOffset
```
##### Field Value
#### Field Value
| Type | Description |
|--------------|-------------|
| System.Int32 | |
#### IndexStride
### IndexStride
<div class="markdown level1 summary">
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public int IndexStride
```
##### Field Value
#### Field Value
| Type | Description |
|--------------|-------------|
| System.Int32 | |
#### LastSentTime
### LastSentTime
<div class="markdown level1 summary">
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public long LastSentTime
```
##### Field Value
#### Field Value
| Type | Description |
|--------------|-------------|
| System.Int64 | |
#### PreviousTimestamp
### PreviousTimestamp
<div class="markdown level1 summary">
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public long PreviousTimestamp
```
##### Field Value
#### Field Value
| Type | Description |
|--------------|-------------|
| System.Int64 | |
#### Resume
### Resume
<div class="markdown level1 summary">
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public int Resume
```
##### Field Value
#### Field Value
| Type | Description |
|--------------|-------------|
| System.Int32 | |

51
transport/api/Unity.Networking.Transport.Utilities.ReliableUtility.ErrorCodes.md
Просмотреть файл

@ -1,50 +1,31 @@
---
id: Unity.Networking.Transport.Utilities.ReliableUtility.ErrorCodes
title: Unity.Networking.Transport.Utilities.ReliableUtility.ErrorCodes
---
id: Unity.Networking.Transport.Utilities.ReliableUtility.ErrorCodes
title: Unity.Networking.Transport.Utilities.ReliableUtility.ErrorCodes
---
<div class="markdown level0 summary">
# Enum ReliableUtility.ErrorCodes
</div>
<div class="markdown level0 conceptual">
</div>
##### **Namespace**: System.Dynamic.ExpandoObject
###### **Namespace**: Unity.Networking.Transport.Utilities
###### **Assembly**: Transport.dll
##### **Assembly**: transport.dll
##### Syntax
``` lang-csharp
public enum ErrorCodes
```
##
### Fields
Name
Description
Duplicated_Packet
InsufficientMemory
OutgoingQueueIsFull
Stale_Packet
| Name | Description |
|---------------------|-------------|
| Duplicated_Packet | |
| InsufficientMemory | |
| OutgoingQueueIsFull | |
| Stale_Packet | |

95
transport/api/Unity.Networking.Transport.Utilities.ReliableUtility.Packet.md
Просмотреть файл

@ -1,117 +1,110 @@
---
id: Unity.Networking.Transport.Utilities.ReliableUtility.Packet
title: Unity.Networking.Transport.Utilities.ReliableUtility.Packet
---
id: Unity.Networking.Transport.Utilities.ReliableUtility.Packet
title: Unity.Networking.Transport.Utilities.ReliableUtility.Packet
---
<div class="markdown level0 summary">
# Struct ReliableUtility.Packet
</div>
<div class="markdown level0 conceptual">
</div>
<div class="inheritedMembers">
##### Inherited Members
<div>
ValueType.Equals(Object)
System.ValueType.Equals(System.Object)
</div>
<div>
ValueType.GetHashCode()
</div>
<div>
System.ValueType.GetHashCode()
ValueType.ToString()
</div>
<div>
Object.Equals(Object, Object)
</div>
System.ValueType.ToString()
<div>
Object.GetType()
</div>
<div>
Object.ReferenceEquals(Object, Object)
System.Object.Equals(System.Object, System.Object)
</div>
</div>
##### **Namespace**: System.Dynamic.ExpandoObject
System.Object.GetType()
System.Object.ReferenceEquals(System.Object, System.Object)
###### **Namespace**: Unity.Networking.Transport.Utilities
###### **Assembly**: Transport.dll
##### **Assembly**: transport.dll
##### Syntax
``` lang-csharp
public struct Packet
```
##
### Buffer
### Fields
<div class="markdown level1 summary">
#### Buffer
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public byte *Buffer
```
##### Field Value
#### Field Value
| Type | Description |
|---------------|-------------|
| System.Byte\* | |
#### Header
### Header
<div class="markdown level1 summary">
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public ReliableUtility.PacketHeader Header
```
##### Field Value
#### Field Value
| Type | Description |
|------------------------------|-------------|
| ReliableUtility.PacketHeader | |

140
transport/api/Unity.Networking.Transport.Utilities.ReliableUtility.PacketHeader.md
Просмотреть файл

@ -1,186 +1,176 @@
---
id: Unity.Networking.Transport.Utilities.ReliableUtility.PacketHeader
title: Unity.Networking.Transport.Utilities.ReliableUtility.PacketHeader
---
id: Unity.Networking.Transport.Utilities.ReliableUtility.PacketHeader
title: Unity.Networking.Transport.Utilities.ReliableUtility.PacketHeader
---
<div class="markdown level0 summary">
# Struct ReliableUtility.PacketHeader
</div>
<div class="markdown level0 conceptual">
</div>
<div class="inheritedMembers">
##### Inherited Members
<div>
ValueType.Equals(Object)
System.ValueType.Equals(System.Object)
</div>
<div>
ValueType.GetHashCode()
</div>
<div>
System.ValueType.GetHashCode()
ValueType.ToString()
</div>
<div>
Object.Equals(Object, Object)
</div>
System.ValueType.ToString()
<div>
Object.GetType()
</div>
<div>
Object.ReferenceEquals(Object, Object)
System.Object.Equals(System.Object, System.Object)
</div>
</div>
##### **Namespace**: System.Dynamic.ExpandoObject
System.Object.GetType()
System.Object.ReferenceEquals(System.Object, System.Object)
###### **Namespace**: Unity.Networking.Transport.Utilities
###### **Assembly**: Transport.dll
##### **Assembly**: transport.dll
##### Syntax
``` lang-csharp
public struct PacketHeader
```
##
### AckedSequenceId
### Fields
<div class="markdown level1 summary">
#### AckedSequenceId
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public ushort AckedSequenceId
```
##### Field Value
#### Field Value
| Type | Description |
|---------------|-------------|
| System.UInt16 | |
#### AckMask
### AckMask
<div class="markdown level1 summary">
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public uint AckMask
```
##### Field Value
#### Field Value
| Type | Description |
|---------------|-------------|
| System.UInt32 | |
#### ProcessingTime
### ProcessingTime
<div class="markdown level1 summary">
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public ushort ProcessingTime
```
##### Field Value
#### Field Value
| Type | Description |
|---------------|-------------|
| System.UInt16 | |
#### SequenceId
### SequenceId
<div class="markdown level1 summary">
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public ushort SequenceId
```
##### Field Value
#### Field Value
| Type | Description |
|---------------|-------------|
| System.UInt16 | |
#### Type
### Type
<div class="markdown level1 summary">
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public ushort Type
```
##### Field Value
#### Field Value
| Type | Description |
|---------------|-------------|
| System.UInt16 | |

125
transport/api/Unity.Networking.Transport.Utilities.ReliableUtility.PacketInformation.md
Просмотреть файл

@ -1,163 +1,154 @@
---
id: Unity.Networking.Transport.Utilities.ReliableUtility.PacketInformation
title: Unity.Networking.Transport.Utilities.ReliableUtility.PacketInformation
---
id: Unity.Networking.Transport.Utilities.ReliableUtility.PacketInformation
title: Unity.Networking.Transport.Utilities.ReliableUtility.PacketInformation
---
<div class="markdown level0 summary">
# Struct ReliableUtility.PacketInformation
</div>
<div class="markdown level0 conceptual">
</div>
<div class="inheritedMembers">
##### Inherited Members
<div>
ValueType.Equals(Object)
System.ValueType.Equals(System.Object)
</div>
<div>
ValueType.GetHashCode()
</div>
<div>
System.ValueType.GetHashCode()
ValueType.ToString()
</div>
<div>
Object.Equals(Object, Object)
</div>
System.ValueType.ToString()
<div>
Object.GetType()
</div>
<div>
Object.ReferenceEquals(Object, Object)
System.Object.Equals(System.Object, System.Object)
</div>
</div>
##### **Namespace**: System.Dynamic.ExpandoObject
System.Object.GetType()
System.Object.ReferenceEquals(System.Object, System.Object)
###### **Namespace**: Unity.Networking.Transport.Utilities
###### **Assembly**: Transport.dll
##### **Assembly**: transport.dll
##### Syntax
``` lang-csharp
public struct PacketInformation
```
##
### HeaderPadding
### Fields
<div class="markdown level1 summary">
#### HeaderPadding
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public ushort HeaderPadding
```
##### Field Value
#### Field Value
| Type | Description |
|---------------|-------------|
| System.UInt16 | |
#### SendTime
### SendTime
<div class="markdown level1 summary">
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public long SendTime
```
##### Field Value
#### Field Value
| Type | Description |
|--------------|-------------|
| System.Int64 | |
#### SequenceId
### SequenceId
<div class="markdown level1 summary">
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public int SequenceId
```
##### Field Value
#### Field Value
| Type | Description |
|--------------|-------------|
| System.Int32 | |
#### Size
### Size
<div class="markdown level1 summary">
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public ushort Size
```
##### Field Value
#### Field Value
| Type | Description |
|---------------|-------------|
| System.UInt16 | |

140
transport/api/Unity.Networking.Transport.Utilities.ReliableUtility.PacketTimers.md
Просмотреть файл

@ -1,186 +1,176 @@
---
id: Unity.Networking.Transport.Utilities.ReliableUtility.PacketTimers
title: Unity.Networking.Transport.Utilities.ReliableUtility.PacketTimers
---
id: Unity.Networking.Transport.Utilities.ReliableUtility.PacketTimers
title: Unity.Networking.Transport.Utilities.ReliableUtility.PacketTimers
---
<div class="markdown level0 summary">
# Struct ReliableUtility.PacketTimers
</div>
<div class="markdown level0 conceptual">
</div>
<div class="inheritedMembers">
##### Inherited Members
<div>
ValueType.Equals(Object)
System.ValueType.Equals(System.Object)
</div>
<div>
ValueType.GetHashCode()
</div>
<div>
System.ValueType.GetHashCode()
ValueType.ToString()
</div>
<div>
Object.Equals(Object, Object)
</div>
System.ValueType.ToString()
<div>
Object.GetType()
</div>
<div>
Object.ReferenceEquals(Object, Object)
System.Object.Equals(System.Object, System.Object)
</div>
</div>
##### **Namespace**: System.Dynamic.ExpandoObject
System.Object.GetType()
System.Object.ReferenceEquals(System.Object, System.Object)
###### **Namespace**: Unity.Networking.Transport.Utilities
###### **Assembly**: Transport.dll
##### **Assembly**: transport.dll
##### Syntax
``` lang-csharp
public struct PacketTimers
```
##
### Padding
### Fields
<div class="markdown level1 summary">
#### Padding
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public ushort Padding
```
##### Field Value
#### Field Value
| Type | Description |
|---------------|-------------|
| System.UInt16 | |
#### ProcessingTime
### ProcessingTime
<div class="markdown level1 summary">
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public ushort ProcessingTime
```
##### Field Value
#### Field Value
| Type | Description |
|---------------|-------------|
| System.UInt16 | |
#### ReceiveTime
### ReceiveTime
<div class="markdown level1 summary">
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public long ReceiveTime
```
##### Field Value
#### Field Value
| Type | Description |
|--------------|-------------|
| System.Int64 | |
#### SentTime
### SentTime
<div class="markdown level1 summary">
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public long SentTime
```
##### Field Value
#### Field Value
| Type | Description |
|--------------|-------------|
| System.Int64 | |
#### SequenceId
### SequenceId
<div class="markdown level1 summary">
</div>
<div class="markdown level1 conceptual">
</div>
##### Declaration
#### Declaration
``` lang-csharp
public int SequenceId
```
##### Field Value
#### Field Value
| Type | Description |
|--------------|-------------|
| System.Int32 | |

45
transport/api/Unity.Networking.Transport.Utilities.ReliableUtility.PacketType.md
Просмотреть файл

@ -1,46 +1,29 @@
---
id: Unity.Networking.Transport.Utilities.ReliableUtility.PacketType
title: Unity.Networking.Transport.Utilities.ReliableUtility.PacketType
---
id: Unity.Networking.Transport.Utilities.ReliableUtility.PacketType
title: Unity.Networking.Transport.Utilities.ReliableUtility.PacketType
---
<div class="markdown level0 summary">
# Enum ReliableUtility.PacketType
</div>
<div class="markdown level0 conceptual">
</div>
##### **Namespace**: System.Dynamic.ExpandoObject
###### **Namespace**: Unity.Networking.Transport.Utilities
###### **Assembly**: Transport.dll
##### **Assembly**: transport.dll
##### Syntax
``` lang-csharp
public enum PacketType : ushort
```
##
### Fields
Name
Description
Ack
Payload
| Name | Description |
|---------|-------------|
| Ack | |
| Payload | |

Некоторые файлы не были показаны из-за слишком большого количества измененных файлов Показать больше