Interface INetworkTransport
Syntax
[Obsolete("The high level API classes are deprecated and will be removed in the future.")]
public interface INetworkTransport
Properties
IsStarted
Declaration
Property Value
| Type |
Description |
| System.Boolean |
|
Methods
AddHost(HostTopology, Int32, String)
Declaration
int AddHost(HostTopology topology, int port, string ip)
Parameters
| Type |
Name |
Description |
| HostTopology |
topology |
|
| System.Int32 |
port |
|
| System.String |
ip |
|
Returns
| Type |
Description |
| System.Int32 |
|
AddHostWithSimulator(HostTopology, Int32, Int32, Int32)
Declaration
int AddHostWithSimulator(HostTopology topology, int minTimeout, int maxTimeout, int port)
Parameters
| Type |
Name |
Description |
| HostTopology |
topology |
|
| System.Int32 |
minTimeout |
|
| System.Int32 |
maxTimeout |
|
| System.Int32 |
port |
|
Returns
| Type |
Description |
| System.Int32 |
|
AddWebsocketHost(HostTopology, Int32, String)
Declaration
int AddWebsocketHost(HostTopology topology, int port, string ip)
Parameters
| Type |
Name |
Description |
| HostTopology |
topology |
|
| System.Int32 |
port |
|
| System.String |
ip |
|
Returns
| Type |
Description |
| System.Int32 |
|
Connect(Int32, String, Int32, Int32, out Byte)
Declaration
int Connect(int hostId, string address, int port, int specialConnectionId, out byte error)
Parameters
| Type |
Name |
Description |
| System.Int32 |
hostId |
|
| System.String |
address |
|
| System.Int32 |
port |
|
| System.Int32 |
specialConnectionId |
|
| System.Byte |
error |
|
Returns
| Type |
Description |
| System.Int32 |
|
ConnectAsNetworkHost(Int32, String, Int32, NetworkID, SourceID, NodeID, out Byte)
Declaration
void ConnectAsNetworkHost(int hostId, string address, int port, NetworkID network, SourceID source, NodeID node, out byte error)
Parameters
| Type |
Name |
Description |
| System.Int32 |
hostId |
|
| System.String |
address |
|
| System.Int32 |
port |
|
| NetworkID |
network |
|
| SourceID |
source |
|
| NodeID |
node |
|
| System.Byte |
error |
|
ConnectEndPoint(Int32, EndPoint, Int32, out Byte)
Declaration
int ConnectEndPoint(int hostId, EndPoint endPoint, int specialConnectionId, out byte error)
Parameters
| Type |
Name |
Description |
| System.Int32 |
hostId |
|
| EndPoint |
endPoint |
|
| System.Int32 |
specialConnectionId |
|
| System.Byte |
error |
|
Returns
| Type |
Description |
| System.Int32 |
|
ConnectToNetworkPeer(Int32, String, Int32, Int32, Int32, NetworkID, SourceID, NodeID, out Byte)
Declaration
int ConnectToNetworkPeer(int hostId, string address, int port, int specialConnectionId, int relaySlotId, NetworkID network, SourceID source, NodeID node, out byte error)
Parameters
| Type |
Name |
Description |
| System.Int32 |
hostId |
|
| System.String |
address |
|
| System.Int32 |
port |
|
| System.Int32 |
specialConnectionId |
|
| System.Int32 |
relaySlotId |
|
| NetworkID |
network |
|
| SourceID |
source |
|
| NodeID |
node |
|
| System.Byte |
error |
|
Returns
| Type |
Description |
| System.Int32 |
|
ConnectWithSimulator(Int32, String, Int32, Int32, out Byte, ConnectionSimulatorConfig)
Declaration
int ConnectWithSimulator(int hostId, string address, int port, int specialConnectionId, out byte error, ConnectionSimulatorConfig conf)
Parameters
| Type |
Name |
Description |
| System.Int32 |
hostId |
|
| System.String |
address |
|
| System.Int32 |
port |
|
| System.Int32 |
specialConnectionId |
|
| System.Byte |
error |
|
| ConnectionSimulatorConfig |
conf |
|
Returns
| Type |
Description |
| System.Int32 |
|
Disconnect(Int32, Int32, out Byte)
Declaration
bool Disconnect(int hostId, int connectionId, out byte error)
Parameters
| Type |
Name |
Description |
| System.Int32 |
hostId |
|
| System.Int32 |
connectionId |
|
| System.Byte |
error |
|
Returns
| Type |
Description |
| System.Boolean |
|
Declaration
bool DoesEndPointUsePlatformProtocols(EndPoint endPoint)
Parameters
| Type |
Name |
Description |
| EndPoint |
endPoint |
|
Returns
| Type |
Description |
| System.Boolean |
|
GetBroadcastConnectionInfo(Int32, out String, out Int32, out Byte)
Declaration
void GetBroadcastConnectionInfo(int hostId, out string address, out int port, out byte error)
Parameters
| Type |
Name |
Description |
| System.Int32 |
hostId |
|
| System.String |
address |
|
| System.Int32 |
port |
|
| System.Byte |
error |
|
GetBroadcastConnectionMessage(Int32, Byte[], Int32, out Int32, out Byte)
Declaration
void GetBroadcastConnectionMessage(int hostId, byte[] buffer, int bufferSize, out int receivedSize, out byte error)
Parameters
| Type |
Name |
Description |
| System.Int32 |
hostId |
|
| System.Byte[] |
buffer |
|
| System.Int32 |
bufferSize |
|
| System.Int32 |
receivedSize |
|
| System.Byte |
error |
|
GetConnectionInfo(Int32, Int32, out String, out Int32, out NetworkID, out NodeID, out Byte)
Declaration
void GetConnectionInfo(int hostId, int connectionId, out string address, out int port, out NetworkID network, out NodeID dstNode, out byte error)
Parameters
| Type |
Name |
Description |
| System.Int32 |
hostId |
|
| System.Int32 |
connectionId |
|
| System.String |
address |
|
| System.Int32 |
port |
|
| NetworkID |
network |
|
| NodeID |
dstNode |
|
| System.Byte |
error |
|
GetCurrentRTT(Int32, Int32, out Byte)
Declaration
int GetCurrentRTT(int hostId, int connectionId, out byte error)
Parameters
| Type |
Name |
Description |
| System.Int32 |
hostId |
|
| System.Int32 |
connectionId |
|
| System.Byte |
error |
|
Returns
| Type |
Description |
| System.Int32 |
|
Init()
Declaration
Init(GlobalConfig)
Declaration
void Init(GlobalConfig config)
Parameters
| Type |
Name |
Description |
| GlobalConfig |
config |
|
Receive(out Int32, out Int32, out Int32, Byte[], Int32, out Int32, out Byte)
Declaration
NetworkEventType Receive(out int hostId, out int connectionId, out int channelId, byte[] buffer, int bufferSize, out int receivedSize, out byte error)
Parameters
| Type |
Name |
Description |
| System.Int32 |
hostId |
|
| System.Int32 |
connectionId |
|
| System.Int32 |
channelId |
|
| System.Byte[] |
buffer |
|
| System.Int32 |
bufferSize |
|
| System.Int32 |
receivedSize |
|
| System.Byte |
error |
|
Returns
| Type |
Description |
| NetworkEventType |
|
ReceiveFromHost(Int32, out Int32, out Int32, Byte[], Int32, out Int32, out Byte)
Declaration
NetworkEventType ReceiveFromHost(int hostId, out int connectionId, out int channelId, byte[] buffer, int bufferSize, out int receivedSize, out byte error)
Parameters
| Type |
Name |
Description |
| System.Int32 |
hostId |
|
| System.Int32 |
connectionId |
|
| System.Int32 |
channelId |
|
| System.Byte[] |
buffer |
|
| System.Int32 |
bufferSize |
|
| System.Int32 |
receivedSize |
|
| System.Byte |
error |
|
Returns
| Type |
Description |
| NetworkEventType |
|
ReceiveRelayEventFromHost(Int32, out Byte)
Declaration
NetworkEventType ReceiveRelayEventFromHost(int hostId, out byte error)
Parameters
| Type |
Name |
Description |
| System.Int32 |
hostId |
|
| System.Byte |
error |
|
Returns
| Type |
Description |
| NetworkEventType |
|
RemoveHost(Int32)
Declaration
bool RemoveHost(int hostId)
Parameters
| Type |
Name |
Description |
| System.Int32 |
hostId |
|
Returns
| Type |
Description |
| System.Boolean |
|
Send(Int32, Int32, Int32, Byte[], Int32, out Byte)
Declaration
bool Send(int hostId, int connectionId, int channelId, byte[] buffer, int size, out byte error)
Parameters
| Type |
Name |
Description |
| System.Int32 |
hostId |
|
| System.Int32 |
connectionId |
|
| System.Int32 |
channelId |
|
| System.Byte[] |
buffer |
|
| System.Int32 |
size |
|
| System.Byte |
error |
|
Returns
| Type |
Description |
| System.Boolean |
|
SetBroadcastCredentials(Int32, Int32, Int32, Int32, out Byte)
Declaration
void SetBroadcastCredentials(int hostId, int key, int version, int subversion, out byte error)
Parameters
| Type |
Name |
Description |
| System.Int32 |
hostId |
|
| System.Int32 |
key |
|
| System.Int32 |
version |
|
| System.Int32 |
subversion |
|
| System.Byte |
error |
|
SetPacketStat(Int32, Int32, Int32, Int32)
Declaration
void SetPacketStat(int direction, int packetStatId, int numMsgs, int numBytes)
Parameters
| Type |
Name |
Description |
| System.Int32 |
direction |
|
| System.Int32 |
packetStatId |
|
| System.Int32 |
numMsgs |
|
| System.Int32 |
numBytes |
|
Shutdown()
Declaration
StartBroadcastDiscovery(Int32, Int32, Int32, Int32, Int32, Byte[], Int32, Int32, out Byte)
Declaration
bool StartBroadcastDiscovery(int hostId, int broadcastPort, int key, int version, int subversion, byte[] buffer, int size, int timeout, out byte error)
Parameters
| Type |
Name |
Description |
| System.Int32 |
hostId |
|
| System.Int32 |
broadcastPort |
|
| System.Int32 |
key |
|
| System.Int32 |
version |
|
| System.Int32 |
subversion |
|
| System.Byte[] |
buffer |
|
| System.Int32 |
size |
|
| System.Int32 |
timeout |
|
| System.Byte |
error |
|
Returns
| Type |
Description |
| System.Boolean |
|
StopBroadcastDiscovery()
Declaration
void StopBroadcastDiscovery()