69 lines
20 KiB
HTML
69 lines
20 KiB
HTML
<html><head><meta http-equiv="X-UA-Compatible" content="IE=edge" /><link rel="shortcut icon" href="../icons/favicon.ico" /><link rel="stylesheet" type="text/css" href="../styles/branding.css" /><link rel="stylesheet" type="text/css" href="../styles/branding-en-US.css" /><script type="text/javascript" src="../scripts/branding.js"> </script><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>NetworkingConfiguration Class</title><meta name="Language" content="en-us" /><meta name="System.Keywords" content="NetworkingConfiguration class" /><meta name="System.Keywords" content="MLAPI.NetworkingConfiguration class" /><meta name="Microsoft.Help.F1" content="MLAPI.NetworkingConfiguration" /><meta name="Microsoft.Help.Id" content="T:MLAPI.NetworkingConfiguration" /><meta name="Description" content="The configuration object used to start server, client and hosts" /><meta name="Microsoft.Help.ContentType" content="Reference" /><meta name="BrandingAware" content="true" /><meta name="container" content="MLAPI" /><meta name="file" content="T_MLAPI_NetworkingConfiguration" /><meta name="guid" content="T_MLAPI_NetworkingConfiguration" /><link rel="stylesheet" type="text/css" href="../styles/branding-Website.css" /><script type="text/javascript" src="../scripts/jquery-1.11.0.min.js"></script><script type="text/javascript" src="../scripts/branding-Website.js"></script><script type="text/javascript" src="../scripts/clipboard.min.js"></script></head><body onload="OnLoad('cs')"><input type="hidden" id="userDataCache" class="userDataStyle" /><div class="pageHeader" id="PageHeader">MLAPI API Reference<form id="SearchForm" method="get" action="#" onsubmit="javascript:TransferToSearchPage(); return false;"><input id="SearchTextBox" type="text" maxlength="200" /><button id="SearchButton" type="submit"></button></form></div><div class="pageBody"><div class="leftNav" id="leftNav"><div id="tocNav"><div class="toclevel0" data-toclevel="0"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="../html\N_MLAPI.htm" title="MLAPI API Reference" tocid="roottoc">MLAPI API Reference</a></div><div class="toclevel0" data-toclevel="0"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="../html/N_MLAPI.htm" title="MLAPI" tocid="N_MLAPI">MLAPI</a></div><div class="toclevel1 current" data-toclevel="1" data-childrenloaded="true"><a class="tocExpanded" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="../html/T_MLAPI_NetworkingConfiguration.htm" title="NetworkingConfiguration Class" tocid="T_MLAPI_NetworkingConfiguration">NetworkingConfiguration Class</a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="../html/M_MLAPI_NetworkingConfiguration__ctor.htm" title="NetworkingConfiguration Constructor " tocid="M_MLAPI_NetworkingConfiguration__ctor">NetworkingConfiguration Constructor </a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="../html/Methods_T_MLAPI_NetworkingConfiguration.htm" title="NetworkingConfiguration Methods" tocid="Methods_T_MLAPI_NetworkingConfiguration">NetworkingConfiguration Methods</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="../html/Fields_T_MLAPI_NetworkingConfiguration.htm" title="NetworkingConfiguration Fields" tocid="Fields_T_MLAPI_NetworkingConfiguration">NetworkingConfiguration Fields</a></div></div><div id="tocResizableEW" onmousedown="OnMouseDown(event);"></div><div id="TocResize" class="tocResize"><img id="ResizeImageIncrease" src="../icons/TocOpen.gif" onclick="OnIncreaseToc()" alt="Click or drag to resize" title="Click or drag to resize" /><img id="ResizeImageReset" src="../icons/TocClose.gif" style="display:none" onclick="OnResetToc()" alt="Click or drag to resize" title="Click or drag to resize" /></div></div><div class="topicContent" id="TopicContent"><table class="titleTable"><tr><td class="titleColumn"><h1>NetworkingConfiguration Class</h1></td></tr></table><span class="introStyle"></span> <div class="summary">
|
||
The configuration object used to start server, client and hosts
|
||
</div><div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID0RB')" onkeypress="SectionExpandCollapse_CheckKey('ID0RB', event)" tabindex="0"><img id="ID0RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Inheritance Hierarchy</span></div><div id="ID0RBSection" class="collapsibleSection"><a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">System<span id="LST3278DE67_0"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST3278DE67_0?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>Object</a><br /> <span class="selflink">MLAPI<span id="LST3278DE67_1"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST3278DE67_1?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>NetworkingConfiguration</span><br /></div><p> </p>
|
||
<strong>Namespace:</strong>
|
||
<a href="N_MLAPI.htm">MLAPI</a><br />
|
||
<strong>Assembly:</strong>
|
||
MLAPI (in MLAPI.dll) Version: 1.0.0.0 (1.0.0.0)<div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID2RB')" onkeypress="SectionExpandCollapse_CheckKey('ID2RB', event)" tabindex="0"><img id="ID2RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Syntax</span></div><div id="ID2RBSection" class="collapsibleSection"><div class="codeSnippetContainer"><div class="codeSnippetContainerTabs"><div id="ID1EACA_tab1" class="codeSnippetContainerTabSingle">C#</div></div><div class="codeSnippetContainerCodeContainer"><div class="codeSnippetToolBar"><div class="codeSnippetToolBarText"><a id="ID1EACA_copyCode" href="#" class="copyCodeSnippet" onclick="javascript:CopyToClipboard('ID1EACA');return false;" title="Copy">Copy</a></div></div><div id="ID1EACA_code_Div1" class="codeSnippetContainerCode" style="display: block"><pre xml:space="preserve"><span class="keyword">public</span> <span class="keyword">class</span> <span class="identifier">NetworkingConfiguration</span></pre></div></div></div><script type="text/javascript">AddLanguageTabSet("ID1EACA");</script></div><p>The <span class="selflink">NetworkingConfiguration</span> type exposes the following members.</p><div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID3RB')" onkeypress="SectionExpandCollapse_CheckKey('ID3RB', event)" tabindex="0"><img id="ID3RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Constructors</span></div><div id="ID3RBSection" class="collapsibleSection"><table class="members" id="constructorList"><tr><th class="iconColumn">
|
||
|
||
</th><th>Name</th><th>Description</th></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="M_MLAPI_NetworkingConfiguration__ctor.htm">NetworkingConfiguration</a></td><td><div class="summary">Initializes a new instance of the <span class="selflink">NetworkingConfiguration</span> class</div></td></tr></table><a href="#PageHeader">Top</a></div><div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID4RB')" onkeypress="SectionExpandCollapse_CheckKey('ID4RB', event)" tabindex="0"><img id="ID4RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Methods</span></div><div id="ID4RBSection" class="collapsibleSection"><table class="members" id="methodList"><tr><th class="iconColumn">
|
||
|
||
</th><th>Name</th><th>Description</th></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="M_MLAPI_NetworkingConfiguration_CompareConfig.htm">CompareConfig</a></td><td><div class="summary">
|
||
Compares a SHA256 hash with the current NetworkingConfiguration instances hash
|
||
</div></td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="http://msdn2.microsoft.com/en-us/library/bsc2ak47" target="_blank">Equals</a></td><td> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr><tr data="protected;inherited;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="http://msdn2.microsoft.com/en-us/library/4k87zsw7" target="_blank">Finalize</a></td><td> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="M_MLAPI_NetworkingConfiguration_GetConfig.htm">GetConfig</a></td><td><div class="summary">
|
||
Gets a SHA256 hash of parts of the NetworkingConfiguration instance
|
||
</div></td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="http://msdn2.microsoft.com/en-us/library/zdee4b3y" target="_blank">GetHashCode</a></td><td> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="http://msdn2.microsoft.com/en-us/library/dfwy45w9" target="_blank">GetType</a></td><td> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr><tr data="protected;inherited;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="http://msdn2.microsoft.com/en-us/library/57ctke0a" target="_blank">MemberwiseClone</a></td><td> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="http://msdn2.microsoft.com/en-us/library/7bxwbwt2" target="_blank">ToString</a></td><td> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr></table><a href="#PageHeader">Top</a></div><div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID5RB')" onkeypress="SectionExpandCollapse_CheckKey('ID5RB', event)" tabindex="0"><img id="ID5RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Fields</span></div><div id="ID5RBSection" class="collapsibleSection"><table class="members" id="fieldList"><tr><th class="iconColumn">
|
||
|
||
</th><th>Name</th><th>Description</th></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubfield.gif" alt="Public field" title="Public field" /></td><td><a href="F_MLAPI_NetworkingConfiguration_Address.htm">Address</a></td><td><div class="summary">
|
||
The address to connect to
|
||
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubfield.gif" alt="Public field" title="Public field" /></td><td><a href="F_MLAPI_NetworkingConfiguration_AllowPassthroughMessages.htm">AllowPassthroughMessages</a></td><td><div class="summary">
|
||
Wheter or not to allow any type of passthrough messages
|
||
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubfield.gif" alt="Public field" title="Public field" /></td><td><a href="F_MLAPI_NetworkingConfiguration_Channels.htm">Channels</a></td><td><div class="summary">
|
||
Channels used by the NetworkedTransport
|
||
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubfield.gif" alt="Public field" title="Public field" /></td><td><a href="F_MLAPI_NetworkingConfiguration_ClientConnectionBufferTimeout.htm">ClientConnectionBufferTimeout</a></td><td><div class="summary">
|
||
The amount of seconds to wait for handshake to complete before timing out a client
|
||
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubfield.gif" alt="Public field" title="Public field" /></td><td><a href="F_MLAPI_NetworkingConfiguration_ConnectionApproval.htm">ConnectionApproval</a></td><td><div class="summary">
|
||
Wheter or not to use connection approval
|
||
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubfield.gif" alt="Public field" title="Public field" /></td><td><a href="F_MLAPI_NetworkingConfiguration_ConnectionApprovalCallback.htm">ConnectionApprovalCallback</a></td><td><div class="summary">
|
||
The callback to invoke when a connection has to be decided if it should get approved
|
||
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubfield.gif" alt="Public field" title="Public field" /></td><td><a href="F_MLAPI_NetworkingConfiguration_ConnectionData.htm">ConnectionData</a></td><td><div class="summary">
|
||
The data to send during connection which can be used to decide on if a client should get accepted
|
||
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubfield.gif" alt="Public field" title="Public field" /></td><td><a href="F_MLAPI_NetworkingConfiguration_EnableEncryption.htm">EnableEncryption</a></td><td><div class="summary">
|
||
Wheter or not to enable encryption
|
||
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubfield.gif" alt="Public field" title="Public field" /></td><td><a href="F_MLAPI_NetworkingConfiguration_EnableSceneSwitching.htm">EnableSceneSwitching</a></td><td><div class="summary">
|
||
Wheter or not to enable scene switching
|
||
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubfield.gif" alt="Public field" title="Public field" /></td><td><a href="F_MLAPI_NetworkingConfiguration_EncryptedChannels.htm">EncryptedChannels</a></td><td><div class="summary">
|
||
Set of channels that will have all message contents encrypted when used
|
||
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubfield.gif" alt="Public field" title="Public field" /></td><td><a href="F_MLAPI_NetworkingConfiguration_EventTickrate.htm">EventTickrate</a></td><td><div class="summary">
|
||
The amount of times per second internal frame events will occur, examples include SyncedVar send checking.
|
||
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubfield.gif" alt="Public field" title="Public field" /></td><td><a href="F_MLAPI_NetworkingConfiguration_HandleObjectSpawning.htm">HandleObjectSpawning</a></td><td><div class="summary">
|
||
Wheter or not to make the library handle object spawning
|
||
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubfield.gif" alt="Public field" title="Public field" /></td><td><a href="F_MLAPI_NetworkingConfiguration_MaxConnections.htm">MaxConnections</a></td><td><div class="summary">
|
||
The max amount of Clients that can connect.
|
||
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubfield.gif" alt="Public field" title="Public field" /></td><td><a href="F_MLAPI_NetworkingConfiguration_MaxReceiveEventsPerTickRate.htm">MaxReceiveEventsPerTickRate</a></td><td><div class="summary">
|
||
The max amount of messages to process per ReceiveTickrate. This is to prevent flooding.
|
||
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubfield.gif" alt="Public field" title="Public field" /></td><td><a href="F_MLAPI_NetworkingConfiguration_MessageBufferSize.htm">MessageBufferSize</a></td><td><div class="summary">
|
||
The size of the receive message buffer. This is the max message size.
|
||
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubfield.gif" alt="Public field" title="Public field" /></td><td><a href="F_MLAPI_NetworkingConfiguration_MessageTypes.htm">MessageTypes</a></td><td><div class="summary">
|
||
Registered MessageTypes
|
||
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubfield.gif" alt="Public field" title="Public field" /></td><td><a href="F_MLAPI_NetworkingConfiguration_PassthroughMessageTypes.htm">PassthroughMessageTypes</a></td><td><div class="summary">
|
||
List of MessageTypes that can be passed through by Server. MessageTypes in this list should thus not be trusted to as great of an extent as normal messages.
|
||
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubfield.gif" alt="Public field" title="Public field" /></td><td><a href="F_MLAPI_NetworkingConfiguration_Port.htm">Port</a></td><td><div class="summary">
|
||
The port for the NetworkTransport to use
|
||
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubfield.gif" alt="Public field" title="Public field" /></td><td><a href="F_MLAPI_NetworkingConfiguration_ProtocolVersion.htm">ProtocolVersion</a></td><td><div class="summary">
|
||
The protocol version. Different versions doesn't talk to each other.
|
||
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubfield.gif" alt="Public field" title="Public field" /></td><td><a href="F_MLAPI_NetworkingConfiguration_ReceiveTickrate.htm">ReceiveTickrate</a></td><td><div class="summary">
|
||
Amount of times per second the receive queue is emptied and all messages inside are processed.
|
||
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubfield.gif" alt="Public field" title="Public field" /></td><td><a href="F_MLAPI_NetworkingConfiguration_RegisteredScenes.htm">RegisteredScenes</a></td><td><div class="summary">
|
||
A list of SceneNames that can be used during networked games.
|
||
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubfield.gif" alt="Public field" title="Public field" /></td><td><a href="F_MLAPI_NetworkingConfiguration_RSAPrivateKey.htm">RSAPrivateKey</a></td><td><div class="summary">
|
||
Private RSA XML key to use for signing key exchange
|
||
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubfield.gif" alt="Public field" title="Public field" /></td><td><a href="F_MLAPI_NetworkingConfiguration_RSAPublicKey.htm">RSAPublicKey</a></td><td><div class="summary">
|
||
Public RSA XML key to use for signing key exchange
|
||
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubfield.gif" alt="Public field" title="Public field" /></td><td><a href="F_MLAPI_NetworkingConfiguration_SecondsHistory.htm">SecondsHistory</a></td><td><div class="summary">
|
||
The amount of seconds to keep a lag compensation position history
|
||
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubfield.gif" alt="Public field" title="Public field" /></td><td><a href="F_MLAPI_NetworkingConfiguration_SendTickrate.htm">SendTickrate</a></td><td><div class="summary">
|
||
The amount of times per second every pending message will be sent away.
|
||
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubfield.gif" alt="Public field" title="Public field" /></td><td><a href="F_MLAPI_NetworkingConfiguration_SignKeyExchange.htm">SignKeyExchange</a></td><td><div class="summary">
|
||
Wheter or not to enable signed diffie hellman key exchange.
|
||
</div></td></tr></table><a href="#PageHeader">Top</a></div><div class="collapsibleAreaRegion" id="seeAlsoSection"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID6RB')" onkeypress="SectionExpandCollapse_CheckKey('ID6RB', event)" tabindex="0"><img id="ID6RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />See Also</span></div><div id="ID6RBSection" class="collapsibleSection"><h4 class="subHeading">Reference</h4><div class="seeAlsoStyle"><a href="N_MLAPI.htm">MLAPI Namespace</a></div></div></div></div><div id="pageFooter" class="pageFooter"> </div></body></html> |