| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417 |
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml">
- <head>
- <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
- <meta http-equiv="X-UA-Compatible" content="IE=9"/>
- <title>RakNet: RakNet::RakPeerInterface Class Reference</title>
- <link href="tabs.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="jquery.js"></script>
- <script type="text/javascript" src="dynsections.js"></script>
- <link href="doxygen.css" rel="stylesheet" type="text/css" />
- </head>
- <body>
- <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
- <div id="titlearea">
- <table cellspacing="0" cellpadding="0">
- <tbody>
- <tr style="height: 56px;">
- <td style="padding-left: 0.5em;">
- <div id="projectname">RakNet
-  <span id="projectnumber">4.0</span>
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <!-- end header part -->
- <!-- Generated by Doxygen 1.8.2 -->
- <div id="navrow1" class="tabs">
- <ul class="tablist">
- <li><a href="index.html"><span>Main Page</span></a></li>
- <li><a href="pages.html"><span>Related Pages</span></a></li>
- <li><a href="modules.html"><span>Modules</span></a></li>
- <li><a href="namespaces.html"><span>Namespaces</span></a></li>
- <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
- <li><a href="files.html"><span>Files</span></a></li>
- </ul>
- </div>
- <div id="navrow2" class="tabs2">
- <ul class="tablist">
- <li><a href="annotated.html"><span>Class List</span></a></li>
- <li><a href="classes.html"><span>Class Index</span></a></li>
- <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
- <li><a href="functions.html"><span>Class Members</span></a></li>
- </ul>
- </div>
- <div id="nav-path" class="navpath">
- <ul>
- <li class="navelem"><a class="el" href="namespaceRakNet.html">RakNet</a></li><li class="navelem"><a class="el" href="classRakNet_1_1RakPeerInterface.html">RakPeerInterface</a></li> </ul>
- </div>
- </div><!-- top -->
- <div class="header">
- <div class="summary">
- <a href="#pub-methods">Public Member Functions</a> |
- <a href="#pub-static-methods">Static Public Member Functions</a> |
- <a href="classRakNet_1_1RakPeerInterface-members.html">List of all members</a> </div>
- <div class="headertitle">
- <div class="title">RakNet::RakPeerInterface Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
- </div><!--header-->
- <div class="contents">
- <p>The main interface for network communications.
- <a href="classRakNet_1_1RakPeerInterface.html#details">More...</a></p>
- <p><code>#include <RakPeerInterface.h></code></p>
- <div class="dynheader">
- Inheritance diagram for RakNet::RakPeerInterface:</div>
- <div class="dyncontent">
- <div class="center">
- <img src="classRakNet_1_1RakPeerInterface.png" usemap="#RakNet::RakPeerInterface_map" alt=""/>
- <map id="RakNet::RakPeerInterface_map" name="RakNet::RakPeerInterface_map">
- <area href="classRakNet_1_1RakPeer.html" title="Main interface for network communications." alt="RakNet::RakPeer" shape="rect" coords="0,56,156,80"/>
- </map>
- </div></div>
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
- Public Member Functions</h2></td></tr>
- <tr class="memitem:a154354ae29d11ac06ef34bd64a8dd6aa"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a154354ae29d11ac06ef34bd64a8dd6aa"></a>
- virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#a154354ae29d11ac06ef34bd64a8dd6aa">~RakPeerInterface</a> ()</td></tr>
- <tr class="memdesc:a154354ae29d11ac06ef34bd64a8dd6aa"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br/></td></tr>
- <tr class="separator:a154354ae29d11ac06ef34bd64a8dd6aa"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad360d12ceb7d7448b598c451fffd2d9c"><td class="memItemLeft" align="right" valign="top">virtual StartupResult </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#ad360d12ceb7d7448b598c451fffd2d9c">Startup</a> (unsigned int maxConnections, <a class="el" href="structRakNet_1_1SocketDescriptor.html">SocketDescriptor</a> *socketDescriptors, unsigned socketDescriptorCount, int threadPriority=-99999)=0</td></tr>
- <tr class="memdesc:ad360d12ceb7d7448b598c451fffd2d9c"><td class="mdescLeft"> </td><td class="mdescRight">Starts the network threads, opens the listen port. <a href="#ad360d12ceb7d7448b598c451fffd2d9c"></a><br/></td></tr>
- <tr class="separator:ad360d12ceb7d7448b598c451fffd2d9c"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab5389821efb5d09470f8429925766eb3"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#ab5389821efb5d09470f8429925766eb3">InitializeSecurity</a> (const char *publicKey, const char *privateKey, bool bRequireClientKey=false)=0</td></tr>
- <tr class="separator:ab5389821efb5d09470f8429925766eb3"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aab566dbe8f666dfed108aaaabc7a0ca6"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#aab566dbe8f666dfed108aaaabc7a0ca6">DisableSecurity</a> (void)=0</td></tr>
- <tr class="separator:aab566dbe8f666dfed108aaaabc7a0ca6"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a5ba3e8713e5d7b150ed393eced79675d"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#a5ba3e8713e5d7b150ed393eced79675d">AddToSecurityExceptionList</a> (const char *ip)=0</td></tr>
- <tr class="separator:a5ba3e8713e5d7b150ed393eced79675d"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a8eba6b20dcba02453d1ed2ad77499f7d"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#a8eba6b20dcba02453d1ed2ad77499f7d">RemoveFromSecurityExceptionList</a> (const char *ip)=0</td></tr>
- <tr class="separator:a8eba6b20dcba02453d1ed2ad77499f7d"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a2672cee4147e50818769e3573fb5c459"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#a2672cee4147e50818769e3573fb5c459">IsInSecurityExceptionList</a> (const char *ip)=0</td></tr>
- <tr class="separator:a2672cee4147e50818769e3573fb5c459"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a1f279ee0d3578de483126f6cfef282f4"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#a1f279ee0d3578de483126f6cfef282f4">SetMaximumIncomingConnections</a> (unsigned short numberAllowed)=0</td></tr>
- <tr class="separator:a1f279ee0d3578de483126f6cfef282f4"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aa2985b696b46b347f5825e11e7219f83"><td class="memItemLeft" align="right" valign="top">virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#aa2985b696b46b347f5825e11e7219f83">GetMaximumIncomingConnections</a> (void) const =0</td></tr>
- <tr class="separator:aa2985b696b46b347f5825e11e7219f83"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a88611e451f6f6e0d5f7cb00ce5bcabf9"><td class="memItemLeft" align="right" valign="top">virtual unsigned short </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#a88611e451f6f6e0d5f7cb00ce5bcabf9">NumberOfConnections</a> (void) const =0</td></tr>
- <tr class="separator:a88611e451f6f6e0d5f7cb00ce5bcabf9"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad18a28a99420006d020125eea1ded4ed"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#ad18a28a99420006d020125eea1ded4ed">SetIncomingPassword</a> (const char *passwordData, int passwordDataLength)=0</td></tr>
- <tr class="separator:ad18a28a99420006d020125eea1ded4ed"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a8b5026f40cf8e6f307e2d3ac82970a30"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#a8b5026f40cf8e6f307e2d3ac82970a30">GetIncomingPassword</a> (char *passwordData, int *passwordDataLength)=0</td></tr>
- <tr class="separator:a8b5026f40cf8e6f307e2d3ac82970a30"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a451dd5d225277fe5806d3d700551fb76"><td class="memItemLeft" align="right" valign="top">virtual ConnectionAttemptResult </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#a451dd5d225277fe5806d3d700551fb76">Connect</a> (const char *host, unsigned short remotePort, const char *passwordData, int passwordDataLength, <a class="el" href="structRakNet_1_1PublicKey.html">PublicKey</a> *publicKey=0, unsigned connectionSocketIndex=0, unsigned sendConnectionAttemptCount=12, unsigned timeBetweenSendConnectionAttemptsMS=500, RakNet::TimeMS timeoutTime=0)=0</td></tr>
- <tr class="memdesc:a451dd5d225277fe5806d3d700551fb76"><td class="mdescLeft"> </td><td class="mdescRight">Connect to the specified host (ip or domain name) and server port. Calling Connect and not calling SetMaximumIncomingConnections acts as a dedicated client. Calling both acts as a true peer. This is a non-blocking connection. You know the connection is successful when <a class="el" href="classRakNet_1_1RakPeerInterface.html#a33744f90a202b8e57d6a825d6af080cc">GetConnectionState()</a> returns IS_CONNECTED or <a class="el" href="classRakNet_1_1RakPeerInterface.html#a1c50453d9dee600920aeabd62ad7c119">Receive()</a> gets a message with the type identifier ID_CONNECTION_REQUEST_ACCEPTED. If the connection is not successful, such as a rejected connection or no response then neither of these things will happen. <a href="#a451dd5d225277fe5806d3d700551fb76"></a><br/></td></tr>
- <tr class="separator:a451dd5d225277fe5806d3d700551fb76"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a818333f4aa6365dc1db5b1e3c4c31f64"><td class="memItemLeft" align="right" valign="top">virtual ConnectionAttemptResult </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#a818333f4aa6365dc1db5b1e3c4c31f64">ConnectWithSocket</a> (const char *host, unsigned short remotePort, const char *passwordData, int passwordDataLength, RakNetSocket2 *socket, <a class="el" href="structRakNet_1_1PublicKey.html">PublicKey</a> *publicKey=0, unsigned sendConnectionAttemptCount=12, unsigned timeBetweenSendConnectionAttemptsMS=500, RakNet::TimeMS timeoutTime=0)=0</td></tr>
- <tr class="memdesc:a818333f4aa6365dc1db5b1e3c4c31f64"><td class="mdescLeft"> </td><td class="mdescRight">Connect to the specified host (ip or domain name) and server port, using a shared socket from another instance of <a class="el" href="namespaceRakNet.html" title="Simple class to send changes between directories. In essence, a simple autopatcher that can be used f...">RakNet</a>. <a href="#a818333f4aa6365dc1db5b1e3c4c31f64"></a><br/></td></tr>
- <tr class="separator:a818333f4aa6365dc1db5b1e3c4c31f64"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a4f4acefdc022555862fd386e31f9a22b"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#a4f4acefdc022555862fd386e31f9a22b">Shutdown</a> (unsigned int blockDuration, unsigned char orderingChannel=0, <a class="el" href="PacketPriority_8h.html#a659378374e516180f93640c79f59705c">PacketPriority</a> disconnectionNotificationPriority=<a class="el" href="PacketPriority_8h.html#a659378374e516180f93640c79f59705cadb8ee22a232a2787f32ba28da55c43c1">LOW_PRIORITY</a>)=0</td></tr>
- <tr class="memdesc:a4f4acefdc022555862fd386e31f9a22b"><td class="mdescLeft"> </td><td class="mdescRight">Connect to the specified network ID (Platform specific console function) <a href="#a4f4acefdc022555862fd386e31f9a22b"></a><br/></td></tr>
- <tr class="separator:a4f4acefdc022555862fd386e31f9a22b"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:affcba03406b89157976cf0e6a8924d66"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#affcba03406b89157976cf0e6a8924d66">IsActive</a> (void) const =0</td></tr>
- <tr class="separator:affcba03406b89157976cf0e6a8924d66"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a5706fd26cf90bd45d0658d8b9a7d8111"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#a5706fd26cf90bd45d0658d8b9a7d8111">GetConnectionList</a> (<a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> *remoteSystems, unsigned short *numberOfSystems) const =0</td></tr>
- <tr class="separator:a5706fd26cf90bd45d0658d8b9a7d8111"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a8587fe2920712adddfa06950ff6b8998"><td class="memItemLeft" align="right" valign="top">virtual uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#a8587fe2920712adddfa06950ff6b8998">GetNextSendReceipt</a> (void)=0</td></tr>
- <tr class="separator:a8587fe2920712adddfa06950ff6b8998"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a9a406f292a6c44f551e9d8606992558e"><td class="memItemLeft" align="right" valign="top">virtual uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#a9a406f292a6c44f551e9d8606992558e">IncrementNextSendReceipt</a> (void)=0</td></tr>
- <tr class="separator:a9a406f292a6c44f551e9d8606992558e"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a543ec5be9cf5f73f5c8733d1829789f9"><td class="memItemLeft" align="right" valign="top">virtual uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#a543ec5be9cf5f73f5c8733d1829789f9">Send</a> (const char *data, const int length, <a class="el" href="PacketPriority_8h.html#a659378374e516180f93640c79f59705c">PacketPriority</a> priority, <a class="el" href="PacketPriority_8h.html#ae41fa01235e99dced384d137fa874a7e">PacketReliability</a> reliability, char orderingChannel, const AddressOrGUID systemIdentifier, bool broadcast, uint32_t forceReceiptNumber=0)=0</td></tr>
- <tr class="separator:a543ec5be9cf5f73f5c8733d1829789f9"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab8e39273dd7fb89d4b29a01bca32f82c"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#ab8e39273dd7fb89d4b29a01bca32f82c">SendLoopback</a> (const char *data, const int length)=0</td></tr>
- <tr class="separator:ab8e39273dd7fb89d4b29a01bca32f82c"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a6d9a5415556a9c138854cc05c707b8e7"><td class="memItemLeft" align="right" valign="top">virtual uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#a6d9a5415556a9c138854cc05c707b8e7">Send</a> (const <a class="el" href="classRakNet_1_1BitStream.html">RakNet::BitStream</a> *bitStream, <a class="el" href="PacketPriority_8h.html#a659378374e516180f93640c79f59705c">PacketPriority</a> priority, <a class="el" href="PacketPriority_8h.html#ae41fa01235e99dced384d137fa874a7e">PacketReliability</a> reliability, char orderingChannel, const AddressOrGUID systemIdentifier, bool broadcast, uint32_t forceReceiptNumber=0)=0</td></tr>
- <tr class="separator:a6d9a5415556a9c138854cc05c707b8e7"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a508111f60de06beb55a65a2b811d557c"><td class="memItemLeft" align="right" valign="top">virtual uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#a508111f60de06beb55a65a2b811d557c">SendList</a> (const char **data, const int *lengths, const int numParameters, <a class="el" href="PacketPriority_8h.html#a659378374e516180f93640c79f59705c">PacketPriority</a> priority, <a class="el" href="PacketPriority_8h.html#ae41fa01235e99dced384d137fa874a7e">PacketReliability</a> reliability, char orderingChannel, const AddressOrGUID systemIdentifier, bool broadcast, uint32_t forceReceiptNumber=0)=0</td></tr>
- <tr class="separator:a508111f60de06beb55a65a2b811d557c"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a1c50453d9dee600920aeabd62ad7c119"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="structRakNet_1_1Packet.html">Packet</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#a1c50453d9dee600920aeabd62ad7c119">Receive</a> (void)=0</td></tr>
- <tr class="separator:a1c50453d9dee600920aeabd62ad7c119"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a21b929aba61ce69aab32871db33d6ede"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#a21b929aba61ce69aab32871db33d6ede">DeallocatePacket</a> (<a class="el" href="structRakNet_1_1Packet.html">Packet</a> *packet)=0</td></tr>
- <tr class="separator:a21b929aba61ce69aab32871db33d6ede"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:abfe4c34f55a92b7c0fd90ff9bbb3f644"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abfe4c34f55a92b7c0fd90ff9bbb3f644"></a>
- virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#abfe4c34f55a92b7c0fd90ff9bbb3f644">GetMaximumNumberOfPeers</a> (void) const =0</td></tr>
- <tr class="memdesc:abfe4c34f55a92b7c0fd90ff9bbb3f644"><td class="mdescLeft"> </td><td class="mdescRight">Return the total number of connections we are allowed. <br/></td></tr>
- <tr class="separator:abfe4c34f55a92b7c0fd90ff9bbb3f644"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:afd637c6f44cb84ce5c151c700bb5cafe"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#afd637c6f44cb84ce5c151c700bb5cafe">CloseConnection</a> (const AddressOrGUID target, bool sendDisconnectionNotification, unsigned char orderingChannel=0, <a class="el" href="PacketPriority_8h.html#a659378374e516180f93640c79f59705c">PacketPriority</a> disconnectionNotificationPriority=<a class="el" href="PacketPriority_8h.html#a659378374e516180f93640c79f59705cadb8ee22a232a2787f32ba28da55c43c1">LOW_PRIORITY</a>)=0</td></tr>
- <tr class="separator:afd637c6f44cb84ce5c151c700bb5cafe"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a33744f90a202b8e57d6a825d6af080cc"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespaceRakNet.html#a84a0fb005391f71130dd341f77f62138">ConnectionState</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#a33744f90a202b8e57d6a825d6af080cc">GetConnectionState</a> (const AddressOrGUID systemIdentifier)=0</td></tr>
- <tr class="separator:a33744f90a202b8e57d6a825d6af080cc"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad70d63c4093c1351f4a0c2949eac312a"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#ad70d63c4093c1351f4a0c2949eac312a">CancelConnectionAttempt</a> (const <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> target)=0</td></tr>
- <tr class="separator:ad70d63c4093c1351f4a0c2949eac312a"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab2015109d6bf787c46880fde513d4276"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#ab2015109d6bf787c46880fde513d4276">GetIndexFromSystemAddress</a> (const <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> systemAddress) const =0</td></tr>
- <tr class="separator:ab2015109d6bf787c46880fde513d4276"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aaf66ca0e72313053922bfb1c1b602889"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#aaf66ca0e72313053922bfb1c1b602889">GetSystemAddressFromIndex</a> (unsigned int index)=0</td></tr>
- <tr class="separator:aaf66ca0e72313053922bfb1c1b602889"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ac86fcbe5e750b08378703197bd9fddcf"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="structRakNet_1_1RakNetGUID.html">RakNetGUID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#ac86fcbe5e750b08378703197bd9fddcf">GetGUIDFromIndex</a> (unsigned int index)=0</td></tr>
- <tr class="separator:ac86fcbe5e750b08378703197bd9fddcf"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aa1939c66f7190e3c647a6a685a6eb248"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#aa1939c66f7190e3c647a6a685a6eb248">GetSystemList</a> (<a class="el" href="classDataStructures_1_1List.html">DataStructures::List</a>< <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> > &addresses, <a class="el" href="classDataStructures_1_1List.html">DataStructures::List</a>< <a class="el" href="structRakNet_1_1RakNetGUID.html">RakNetGUID</a> > &guids) const =0</td></tr>
- <tr class="separator:aa1939c66f7190e3c647a6a685a6eb248"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab44199db81cf4fa834d42efc5eb5ae77"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#ab44199db81cf4fa834d42efc5eb5ae77">AddToBanList</a> (const char *IP, RakNet::TimeMS milliseconds=0)=0</td></tr>
- <tr class="separator:ab44199db81cf4fa834d42efc5eb5ae77"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a9e18c8dae14157432ddc6f19a8114c1b"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#a9e18c8dae14157432ddc6f19a8114c1b">RemoveFromBanList</a> (const char *IP)=0</td></tr>
- <tr class="separator:a9e18c8dae14157432ddc6f19a8114c1b"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a79afdfa5e5e87e66dc54b3336a30b68a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a79afdfa5e5e87e66dc54b3336a30b68a"></a>
- virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#a79afdfa5e5e87e66dc54b3336a30b68a">ClearBanList</a> (void)=0</td></tr>
- <tr class="memdesc:a79afdfa5e5e87e66dc54b3336a30b68a"><td class="mdescLeft"> </td><td class="mdescRight">Allows all previously banned IPs to connect. <br/></td></tr>
- <tr class="separator:a79afdfa5e5e87e66dc54b3336a30b68a"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ae28629f202de81ad4816470cd0f8fd94"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#ae28629f202de81ad4816470cd0f8fd94">IsBanned</a> (const char *IP)=0</td></tr>
- <tr class="separator:ae28629f202de81ad4816470cd0f8fd94"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a1c7d098a1d9a4613f051ae3627831af6"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#a1c7d098a1d9a4613f051ae3627831af6">SetLimitIPConnectionFrequency</a> (bool b)=0</td></tr>
- <tr class="separator:a1c7d098a1d9a4613f051ae3627831af6"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a49dbff7ab8f516361e3d05645c2b7901"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#a49dbff7ab8f516361e3d05645c2b7901">Ping</a> (const <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> target)=0</td></tr>
- <tr class="separator:a49dbff7ab8f516361e3d05645c2b7901"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad5667c9d47585be3a65485f9c81f7045"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#ad5667c9d47585be3a65485f9c81f7045">Ping</a> (const char *host, unsigned short remotePort, bool onlyReplyOnAcceptingConnections, unsigned connectionSocketIndex=0)=0</td></tr>
- <tr class="separator:ad5667c9d47585be3a65485f9c81f7045"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a15627acab7077970975889d4e83dc59b"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#a15627acab7077970975889d4e83dc59b">GetAveragePing</a> (const AddressOrGUID systemIdentifier)=0</td></tr>
- <tr class="separator:a15627acab7077970975889d4e83dc59b"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a0fb0115e5c85094d48239f157d9eccbb"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#a0fb0115e5c85094d48239f157d9eccbb">GetLastPing</a> (const AddressOrGUID systemIdentifier) const =0</td></tr>
- <tr class="separator:a0fb0115e5c85094d48239f157d9eccbb"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a4eb8b0f288db5425906cd72ee5f8fae9"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#a4eb8b0f288db5425906cd72ee5f8fae9">GetLowestPing</a> (const AddressOrGUID systemIdentifier) const =0</td></tr>
- <tr class="separator:a4eb8b0f288db5425906cd72ee5f8fae9"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:afdc6e658512d2f01d6bb211758721f21"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#afdc6e658512d2f01d6bb211758721f21">SetOccasionalPing</a> (bool doPing)=0</td></tr>
- <tr class="separator:afdc6e658512d2f01d6bb211758721f21"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a7fa284803461a09efeffd65d73068c51"><td class="memItemLeft" align="right" valign="top">virtual RakNet::Time </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#a7fa284803461a09efeffd65d73068c51">GetClockDifferential</a> (const AddressOrGUID systemIdentifier)=0</td></tr>
- <tr class="separator:a7fa284803461a09efeffd65d73068c51"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a40b198325a1a4f4a1ff3b1a1741b89eb"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#a40b198325a1a4f4a1ff3b1a1741b89eb">SetOfflinePingResponse</a> (const char *data, const unsigned int length)=0</td></tr>
- <tr class="separator:a40b198325a1a4f4a1ff3b1a1741b89eb"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ae61f8651e8a45acec5bdf04384777a86"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#ae61f8651e8a45acec5bdf04384777a86">GetOfflinePingResponse</a> (char **data, unsigned int *length)=0</td></tr>
- <tr class="separator:ae61f8651e8a45acec5bdf04384777a86"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a928a49c193687ccef547f7ea3634bb54"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#a928a49c193687ccef547f7ea3634bb54">GetInternalID</a> (const <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> systemAddress=<a class="el" href="namespaceRakNet.html#a80c95b4ed53f42911a6fa92b85e929cf">UNASSIGNED_SYSTEM_ADDRESS</a>, const int index=0) const =0</td></tr>
- <tr class="separator:a928a49c193687ccef547f7ea3634bb54"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ac9f163bc4b8b89db10c3f251793e0aca"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#ac9f163bc4b8b89db10c3f251793e0aca">SetInternalID</a> (<a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> systemAddress, int index=0)=0</td></tr>
- <tr class="memdesc:ac9f163bc4b8b89db10c3f251793e0aca"><td class="mdescLeft"> </td><td class="mdescRight">Sets your internal IP address, for platforms that do not support reading it, or to override a value. <a href="#ac9f163bc4b8b89db10c3f251793e0aca"></a><br/></td></tr>
- <tr class="separator:ac9f163bc4b8b89db10c3f251793e0aca"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a94602ad7356b4a99f862f9793327c325"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#a94602ad7356b4a99f862f9793327c325">GetExternalID</a> (const <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> target) const =0</td></tr>
- <tr class="separator:a94602ad7356b4a99f862f9793327c325"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab89d6d78297265c282c22c029a285fa2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab89d6d78297265c282c22c029a285fa2"></a>
- virtual const <a class="el" href="structRakNet_1_1RakNetGUID.html">RakNetGUID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#ab89d6d78297265c282c22c029a285fa2">GetMyGUID</a> (void) const =0</td></tr>
- <tr class="memdesc:ab89d6d78297265c282c22c029a285fa2"><td class="mdescLeft"> </td><td class="mdescRight">Return my own GUID. <br/></td></tr>
- <tr class="separator:ab89d6d78297265c282c22c029a285fa2"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aa6abdf47bc3e2e016ccd0171a05e125b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa6abdf47bc3e2e016ccd0171a05e125b"></a>
- virtual <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#aa6abdf47bc3e2e016ccd0171a05e125b">GetMyBoundAddress</a> (const int socketIndex=0)=0</td></tr>
- <tr class="memdesc:aa6abdf47bc3e2e016ccd0171a05e125b"><td class="mdescLeft"> </td><td class="mdescRight">Return the address bound to a socket at the specified index. <br/></td></tr>
- <tr class="separator:aa6abdf47bc3e2e016ccd0171a05e125b"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aac8203dda2ba1271e753bd113b259173"><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="structRakNet_1_1RakNetGUID.html">RakNetGUID</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#aac8203dda2ba1271e753bd113b259173">GetGuidFromSystemAddress</a> (const <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> input) const =0</td></tr>
- <tr class="separator:aac8203dda2ba1271e753bd113b259173"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:adaaff66118400b6bbcb31c11419cd791"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#adaaff66118400b6bbcb31c11419cd791">GetSystemAddressFromGuid</a> (const <a class="el" href="structRakNet_1_1RakNetGUID.html">RakNetGUID</a> input) const =0</td></tr>
- <tr class="separator:adaaff66118400b6bbcb31c11419cd791"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a7139f333758a31e5a1f44f06b120f085"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#a7139f333758a31e5a1f44f06b120f085">GetClientPublicKeyFromSystemAddress</a> (const <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> input, char *client_public_key) const =0</td></tr>
- <tr class="separator:a7139f333758a31e5a1f44f06b120f085"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a49d2993d5db12a62ce88dc89700c0880"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#a49d2993d5db12a62ce88dc89700c0880">SetTimeoutTime</a> (RakNet::TimeMS timeMS, const <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> target)=0</td></tr>
- <tr class="separator:a49d2993d5db12a62ce88dc89700c0880"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a0fd3a4d282327944ee50b00c79baf420"><td class="memItemLeft" align="right" valign="top">virtual RakNet::TimeMS </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#a0fd3a4d282327944ee50b00c79baf420">GetTimeoutTime</a> (const <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> target)=0</td></tr>
- <tr class="separator:a0fd3a4d282327944ee50b00c79baf420"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:af7359755639152292a3e35b6fb9877bb"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#af7359755639152292a3e35b6fb9877bb">GetMTUSize</a> (const <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> target) const =0</td></tr>
- <tr class="separator:af7359755639152292a3e35b6fb9877bb"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a59b3cee62120132170dcf065b84114b2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a59b3cee62120132170dcf065b84114b2"></a>
- virtual unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#a59b3cee62120132170dcf065b84114b2">GetNumberOfAddresses</a> (void)=0</td></tr>
- <tr class="memdesc:a59b3cee62120132170dcf065b84114b2"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of IP addresses this system has internally. Get the actual addresses from <a class="el" href="classRakNet_1_1RakPeerInterface.html#ad070246537065910a500803bdf6b9cb2">GetLocalIP()</a> <br/></td></tr>
- <tr class="separator:a59b3cee62120132170dcf065b84114b2"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad070246537065910a500803bdf6b9cb2"><td class="memItemLeft" align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#ad070246537065910a500803bdf6b9cb2">GetLocalIP</a> (unsigned int index)=0</td></tr>
- <tr class="separator:ad070246537065910a500803bdf6b9cb2"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ac37fe2c8b35abdc3a441541e539ebd10"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#ac37fe2c8b35abdc3a441541e539ebd10">IsLocalIP</a> (const char *ip)=0</td></tr>
- <tr class="separator:ac37fe2c8b35abdc3a441541e539ebd10"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aa4a2525f004aaf073e1b25b0ffe0c0d2"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#aa4a2525f004aaf073e1b25b0ffe0c0d2">AllowConnectionResponseIPMigration</a> (bool allow)=0</td></tr>
- <tr class="separator:aa4a2525f004aaf073e1b25b0ffe0c0d2"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:adccf6f091e1ac19ad92099d50fe649d7"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#adccf6f091e1ac19ad92099d50fe649d7">AdvertiseSystem</a> (const char *host, unsigned short remotePort, const char *data, int dataLength, unsigned connectionSocketIndex=0)=0</td></tr>
- <tr class="separator:adccf6f091e1ac19ad92099d50fe649d7"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a4112544503b05a7b7dd2dd56adfbc648"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#a4112544503b05a7b7dd2dd56adfbc648">SetSplitMessageProgressInterval</a> (int interval)=0</td></tr>
- <tr class="separator:a4112544503b05a7b7dd2dd56adfbc648"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:abd4be92bcad53af859e502127c060247"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#abd4be92bcad53af859e502127c060247">GetSplitMessageProgressInterval</a> (void) const =0</td></tr>
- <tr class="separator:abd4be92bcad53af859e502127c060247"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a87db4b6410fce078080400f8d58328ed"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#a87db4b6410fce078080400f8d58328ed">SetUnreliableTimeout</a> (RakNet::TimeMS timeoutMS)=0</td></tr>
- <tr class="separator:a87db4b6410fce078080400f8d58328ed"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a700a2c9bc1414da194a35076af3b56e0"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#a700a2c9bc1414da194a35076af3b56e0">SendTTL</a> (const char *host, unsigned short remotePort, int ttl, unsigned connectionSocketIndex=0)=0</td></tr>
- <tr class="separator:a700a2c9bc1414da194a35076af3b56e0"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a2cfd224842b6f1d5e2881901c9f71531"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#a2cfd224842b6f1d5e2881901c9f71531">AttachPlugin</a> (<a class="el" href="classRakNet_1_1PluginInterface2.html">PluginInterface2</a> *plugin)=0</td></tr>
- <tr class="memdesc:a2cfd224842b6f1d5e2881901c9f71531"><td class="mdescLeft"> </td><td class="mdescRight">Attaches a Plugin interface to an instance of the base class (<a class="el" href="classRakNet_1_1RakPeer.html" title="Main interface for network communications.">RakPeer</a> or PacketizedTCP) to run code automatically on message receipt in the Receive call. If the plugin returns false from PluginInterface::UsesReliabilityLayer(), which is the case for all plugins except <a class="el" href="classRakNet_1_1PacketLogger.html" title="Writes incoming and outgoing messages to the screen. This will write all incoming and outgoing messag...">PacketLogger</a>, you can call <a class="el" href="classRakNet_1_1RakPeerInterface.html#a2cfd224842b6f1d5e2881901c9f71531" title="Attaches a Plugin interface to an instance of the base class (RakPeer or PacketizedTCP) to run code a...">AttachPlugin()</a> and <a class="el" href="classRakNet_1_1RakPeerInterface.html#a4960f6a8d37d70e7e98f1f6fe54e323d" title="Detaches a Plugin interface from the instance of the base class (RakPeer or PacketizedTCP) it is atta...">DetachPlugin()</a> for this plugin while <a class="el" href="classRakNet_1_1RakPeer.html" title="Main interface for network communications.">RakPeer</a> is active. <a href="#a2cfd224842b6f1d5e2881901c9f71531"></a><br/></td></tr>
- <tr class="separator:a2cfd224842b6f1d5e2881901c9f71531"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a4960f6a8d37d70e7e98f1f6fe54e323d"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#a4960f6a8d37d70e7e98f1f6fe54e323d">DetachPlugin</a> (<a class="el" href="classRakNet_1_1PluginInterface2.html">PluginInterface2</a> *messageHandler)=0</td></tr>
- <tr class="memdesc:a4960f6a8d37d70e7e98f1f6fe54e323d"><td class="mdescLeft"> </td><td class="mdescRight">Detaches a Plugin interface from the instance of the base class (<a class="el" href="classRakNet_1_1RakPeer.html" title="Main interface for network communications.">RakPeer</a> or PacketizedTCP) it is attached to. <a href="#a4960f6a8d37d70e7e98f1f6fe54e323d"></a><br/></td></tr>
- <tr class="separator:a4960f6a8d37d70e7e98f1f6fe54e323d"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a29c5527b07a3ddc32083d8ec1e24318b"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#a29c5527b07a3ddc32083d8ec1e24318b">PushBackPacket</a> (<a class="el" href="structRakNet_1_1Packet.html">Packet</a> *packet, bool pushAtHead)=0</td></tr>
- <tr class="separator:a29c5527b07a3ddc32083d8ec1e24318b"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a3e38bdd227138f640a942102813ce779"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="structRakNet_1_1Packet.html">Packet</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#a3e38bdd227138f640a942102813ce779">AllocatePacket</a> (unsigned dataSize)=0</td></tr>
- <tr class="separator:a3e38bdd227138f640a942102813ce779"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:adae8cd6baaa718eb5a818f5271a58122"><td class="memItemLeft" align="right" valign="top">virtual RakNetSocket2 * </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#adae8cd6baaa718eb5a818f5271a58122">GetSocket</a> (const <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> target)=0</td></tr>
- <tr class="separator:adae8cd6baaa718eb5a818f5271a58122"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a09ef1181af600ec2c255a295154fe367"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#a09ef1181af600ec2c255a295154fe367">GetSockets</a> (<a class="el" href="classDataStructures_1_1List.html">DataStructures::List</a>< RakNetSocket2 * > &sockets)=0</td></tr>
- <tr class="separator:a09ef1181af600ec2c255a295154fe367"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a0832004c529aa9a0844b61eaf1374b3c"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#a0832004c529aa9a0844b61eaf1374b3c">SetUserUpdateThread</a> (void(*_userUpdateThreadPtr)(<a class="el" href="classRakNet_1_1RakPeerInterface.html">RakPeerInterface</a> *, void *), void *_userUpdateThreadData)=0</td></tr>
- <tr class="separator:a0832004c529aa9a0844b61eaf1374b3c"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a6b70ebc4e2852362b366e8738624ec44"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#a6b70ebc4e2852362b366e8738624ec44">SetIncomingDatagramEventHandler</a> (bool(*_incomingDatagramEventHandler)(RNS2RecvStruct *))=0</td></tr>
- <tr class="separator:a6b70ebc4e2852362b366e8738624ec44"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a03910361629f5cbabe0df0612a1f2709"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#a03910361629f5cbabe0df0612a1f2709">ApplyNetworkSimulator</a> (float packetloss, unsigned short minExtraPing, unsigned short extraPingVariance)=0</td></tr>
- <tr class="separator:a03910361629f5cbabe0df0612a1f2709"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a95daeb743853a4406182e47668c0f33b"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#a95daeb743853a4406182e47668c0f33b">SetPerConnectionOutgoingBandwidthLimit</a> (unsigned maxBitsPerSecond)=0</td></tr>
- <tr class="separator:a95daeb743853a4406182e47668c0f33b"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a917c367bcba491fb243161025b6eab01"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#a917c367bcba491fb243161025b6eab01">IsNetworkSimulatorActive</a> (void)=0</td></tr>
- <tr class="separator:a917c367bcba491fb243161025b6eab01"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a87e528130f7f0f21597a338769fe7139"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="structRakNet_1_1RakNetStatistics.html">RakNetStatistics</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#a87e528130f7f0f21597a338769fe7139">GetStatistics</a> (const <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> systemAddress, <a class="el" href="structRakNet_1_1RakNetStatistics.html">RakNetStatistics</a> *rns=0)=0</td></tr>
- <tr class="separator:a87e528130f7f0f21597a338769fe7139"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a28c5bd84842962e60097512a9f6ff463"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#a28c5bd84842962e60097512a9f6ff463">GetStatistics</a> (const unsigned int index, <a class="el" href="structRakNet_1_1RakNetStatistics.html">RakNetStatistics</a> *rns)=0</td></tr>
- <tr class="memdesc:a28c5bd84842962e60097512a9f6ff463"><td class="mdescLeft"> </td><td class="mdescRight">Returns the network statistics of the system at the given index in the remoteSystemList. <a href="#a28c5bd84842962e60097512a9f6ff463"></a><br/></td></tr>
- <tr class="separator:a28c5bd84842962e60097512a9f6ff463"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad474ee839667fb5e1b667ea5465dc021"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#ad474ee839667fb5e1b667ea5465dc021">GetStatisticsList</a> (<a class="el" href="classDataStructures_1_1List.html">DataStructures::List</a>< <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> > &addresses, <a class="el" href="classDataStructures_1_1List.html">DataStructures::List</a>< <a class="el" href="structRakNet_1_1RakNetGUID.html">RakNetGUID</a> > &guids, <a class="el" href="classDataStructures_1_1List.html">DataStructures::List</a>< <a class="el" href="structRakNet_1_1RakNetStatistics.html">RakNetStatistics</a> > &statistics)=0</td></tr>
- <tr class="memdesc:ad474ee839667fb5e1b667ea5465dc021"><td class="mdescLeft"> </td><td class="mdescRight">Returns the list of systems, and statistics for each of those systems Each system has one entry in each of the lists, in the same order. <a href="#ad474ee839667fb5e1b667ea5465dc021"></a><br/></td></tr>
- <tr class="separator:ad474ee839667fb5e1b667ea5465dc021"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a8f0971a8d45efdf1ce30946195195736"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8f0971a8d45efdf1ce30946195195736"></a>
- virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#a8f0971a8d45efdf1ce30946195195736">GetReceiveBufferSize</a> (void)=0</td></tr>
- <tr class="memdesc:a8f0971a8d45efdf1ce30946195195736"><td class="mdescLeft"> </td><td class="mdescRight">how many messages are waiting when you call <a class="el" href="classRakNet_1_1RakPeerInterface.html#a1c50453d9dee600920aeabd62ad7c119">Receive()</a> <br/></td></tr>
- <tr class="separator:a8f0971a8d45efdf1ce30946195195736"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
- Static Public Member Functions</h2></td></tr>
- <tr class="memitem:a8e05f80c6e0de8f1b6e644700b7ce543"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8e05f80c6e0de8f1b6e644700b7ce543"></a>
- static uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakPeerInterface.html#a8e05f80c6e0de8f1b6e644700b7ce543">Get64BitUniqueRandomNumber</a> (void)</td></tr>
- <tr class="memdesc:a8e05f80c6e0de8f1b6e644700b7ce543"><td class="mdescLeft"> </td><td class="mdescRight">Get a random number (to generate a GUID) <br/></td></tr>
- <tr class="separator:a8e05f80c6e0de8f1b6e644700b7ce543"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <div class="textblock"><p>The main interface for network communications. </p>
- <p>The primary interface for <a class="el" href="namespaceRakNet.html" title="Simple class to send changes between directories. In essence, a simple autopatcher that can be used f...">RakNet</a>, <a class="el" href="classRakNet_1_1RakPeer.html" title="Main interface for network communications.">RakPeer</a> contains all major functions for the library. See the individual functions for what the class can do. </p>
- </div><h2 class="groupheader">Member Function Documentation</h2>
- <a class="anchor" id="ab44199db81cf4fa834d42efc5eb5ae77"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void RakNet::RakPeerInterface::AddToBanList </td>
- <td>(</td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>IP</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">RakNet::TimeMS </td>
- <td class="paramname"><em>milliseconds</em> = <code>0</code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Bans an IP from connecting. Banned IPs persist between connections but are not saved on shutdown nor loaded on startup. param[in] IP Dotted IP address. Can use * as a wildcard, such as 128.0.0.* will ban all IP addresses starting with 128.0.0 </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">milliseconds</td><td>how many ms for a temporary ban. Use 0 for a permanent ban </td></tr>
- </table>
- </dd>
- </dl>
- <p>Implemented in <a class="el" href="classRakNet_1_1RakPeer.html#ad403c131efe8bfe6f3c5280e110b9b2d">RakNet::RakPeer</a>.</p>
- </div>
- </div>
- <a class="anchor" id="a5ba3e8713e5d7b150ed393eced79675d"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void RakNet::RakPeerInterface::AddToSecurityExceptionList </td>
- <td>(</td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>ip</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>If secure connections are on, do not use secure connections for a specific IP address. This is useful if you have a fixed-address internal server behind a LAN. </p>
- <dl class="section note"><dt>Note</dt><dd>Secure connections are determined by the recipient of an incoming connection. This has no effect if called on the system attempting to connect. </dd></dl>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">ip</td><td>IP address to add. * wildcards are supported. </td></tr>
- </table>
- </dd>
- </dl>
- <p>Implemented in <a class="el" href="classRakNet_1_1RakPeer.html#ab927e4b0e70fcc0e06d1ba6a70315eb3">RakNet::RakPeer</a>.</p>
- </div>
- </div>
- <a class="anchor" id="adccf6f091e1ac19ad92099d50fe649d7"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual bool RakNet::RakPeerInterface::AdvertiseSystem </td>
- <td>(</td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>host</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">unsigned short </td>
- <td class="paramname"><em>remotePort</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>data</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>dataLength</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">unsigned </td>
- <td class="paramname"><em>connectionSocketIndex</em> = <code>0</code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Sends a one byte message ID_ADVERTISE_SYSTEM to the remote unconnected system. This will tell the remote system our external IP outside the LAN along with some user data. </p>
- <dl class="section pre"><dt>Precondition</dt><dd>The sender and recipient must already be started via a successful call to Initialize </dd></dl>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">host</td><td>Either a dotted IP address or a domain name </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">remotePort</td><td>Which port to connect to on the remote machine. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>Optional data to append to the packet. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">dataLength</td><td>length of data in bytes. Use 0 if no data. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">connectionSocketIndex</td><td>Index into the array of socket descriptors passed to socketDescriptors in <a class="el" href="classRakNet_1_1RakPeer.html#a92d493cb617381a6e750f7df6e768927" title="Starts the network threads and opens the listen port.">RakPeer::Startup()</a> to send on. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>false if <a class="el" href="classRakNet_1_1RakPeerInterface.html#affcba03406b89157976cf0e6a8924d66">IsActive()</a>==false or the host is unresolvable. True otherwise </dd></dl>
- <p>Implemented in <a class="el" href="classRakNet_1_1RakPeer.html#aecb0396cdb296a5df8b8266c8cce138d">RakNet::RakPeer</a>.</p>
- </div>
- </div>
- <a class="anchor" id="a3e38bdd227138f640a942102813ce779"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual <a class="el" href="structRakNet_1_1Packet.html">Packet</a>* RakNet::RakPeerInterface::AllocatePacket </td>
- <td>(</td>
- <td class="paramtype">unsigned </td>
- <td class="paramname"><em>dataSize</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="section return"><dt>Returns</dt><dd>a packet for you to write to if you want to create a <a class="el" href="structRakNet_1_1Packet.html" title="This represents a user message from another system.">Packet</a> for some reason. You can add it to the receive buffer with PushBackPacket </dd></dl>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">dataSize</td><td>How many bytes to allocate for the buffer </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>A packet you can write to </dd></dl>
- <p>Implemented in <a class="el" href="classRakNet_1_1RakPeer.html#a5be8b42a06fdd32f29f032ba5fc5e7b0">RakNet::RakPeer</a>.</p>
- </div>
- </div>
- <a class="anchor" id="aa4a2525f004aaf073e1b25b0ffe0c0d2"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void RakNet::RakPeerInterface::AllowConnectionResponseIPMigration </td>
- <td>(</td>
- <td class="paramtype">bool </td>
- <td class="paramname"><em>allow</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Allow or disallow connection responses from any IP. Normally this should be false, but may be necessary when connecting to servers with multiple IP addresses. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">allow</td><td>- True to allow this behavior, false to not allow. Defaults to false. Value persists between connections </td></tr>
- </table>
- </dd>
- </dl>
- <p>Implemented in <a class="el" href="classRakNet_1_1RakPeer.html#a3b24a4946b34071621b0b288b869f21f">RakNet::RakPeer</a>.</p>
- </div>
- </div>
- <a class="anchor" id="a03910361629f5cbabe0df0612a1f2709"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void RakNet::RakPeerInterface::ApplyNetworkSimulator </td>
- <td>(</td>
- <td class="paramtype">float </td>
- <td class="paramname"><em>packetloss</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">unsigned short </td>
- <td class="paramname"><em>minExtraPing</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">unsigned short </td>
- <td class="paramname"><em>extraPingVariance</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Adds simulated ping and packet loss to the outgoing data flow. To simulate bi-directional ping and packet loss, you should call this on both the sender and the recipient, with half the total ping and packetloss value on each. You can exclude network simulator code with the _RELEASE #define to decrease code size </p>
- <dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000003">Deprecated:</a></b></dt><dd>Use <a href="http://www.jenkinssoftware.com/forum/index.php?topic=1671.0">http://www.jenkinssoftware.com/forum/index.php?topic=1671.0</a> instead. </dd></dl>
- <dl class="section note"><dt>Note</dt><dd>Doesn't work past version 3.6201 </dd></dl>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">packetloss</td><td>Chance to lose a packet. Ranges from 0 to 1. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">minExtraPing</td><td>The minimum time to delay sends. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">extraPingVariance</td><td>The additional random time to delay sends. </td></tr>
- </table>
- </dd>
- </dl>
- <p>Implemented in <a class="el" href="classRakNet_1_1RakPeer.html#a38a4348d90eb454b4d470d45fb19b99e">RakNet::RakPeer</a>.</p>
- </div>
- </div>
- <a class="anchor" id="a2cfd224842b6f1d5e2881901c9f71531"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void RakNet::RakPeerInterface::AttachPlugin </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="classRakNet_1_1PluginInterface2.html">PluginInterface2</a> * </td>
- <td class="paramname"><em>plugin</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Attaches a Plugin interface to an instance of the base class (<a class="el" href="classRakNet_1_1RakPeer.html" title="Main interface for network communications.">RakPeer</a> or PacketizedTCP) to run code automatically on message receipt in the Receive call. If the plugin returns false from PluginInterface::UsesReliabilityLayer(), which is the case for all plugins except <a class="el" href="classRakNet_1_1PacketLogger.html" title="Writes incoming and outgoing messages to the screen. This will write all incoming and outgoing messag...">PacketLogger</a>, you can call <a class="el" href="classRakNet_1_1RakPeerInterface.html#a2cfd224842b6f1d5e2881901c9f71531" title="Attaches a Plugin interface to an instance of the base class (RakPeer or PacketizedTCP) to run code a...">AttachPlugin()</a> and <a class="el" href="classRakNet_1_1RakPeerInterface.html#a4960f6a8d37d70e7e98f1f6fe54e323d" title="Detaches a Plugin interface from the instance of the base class (RakPeer or PacketizedTCP) it is atta...">DetachPlugin()</a> for this plugin while <a class="el" href="classRakNet_1_1RakPeer.html" title="Main interface for network communications.">RakPeer</a> is active. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">messageHandler</td><td>Pointer to the plugin to attach. </td></tr>
- </table>
- </dd>
- </dl>
- <p>Implemented in <a class="el" href="classRakNet_1_1RakPeer.html#a4ceacd63ae51089a2e36287c54f07ffe">RakNet::RakPeer</a>.</p>
- </div>
- </div>
- <a class="anchor" id="ad70d63c4093c1351f4a0c2949eac312a"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void RakNet::RakPeerInterface::CancelConnectionAttempt </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> </td>
- <td class="paramname"><em>target</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Cancel a pending connection attempt If we are already connected, the connection stays open </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">target</td><td>Which system to cancel </td></tr>
- </table>
- </dd>
- </dl>
- <p>Implemented in <a class="el" href="classRakNet_1_1RakPeer.html#a5f934680b37ffbfdc0047ac406fc2512">RakNet::RakPeer</a>.</p>
- </div>
- </div>
- <a class="anchor" id="afd637c6f44cb84ce5c151c700bb5cafe"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void RakNet::RakPeerInterface::CloseConnection </td>
- <td>(</td>
- <td class="paramtype">const AddressOrGUID </td>
- <td class="paramname"><em>target</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">bool </td>
- <td class="paramname"><em>sendDisconnectionNotification</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">unsigned char </td>
- <td class="paramname"><em>orderingChannel</em> = <code>0</code>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="PacketPriority_8h.html#a659378374e516180f93640c79f59705c">PacketPriority</a> </td>
- <td class="paramname"><em>disconnectionNotificationPriority</em> = <code><a class="el" href="PacketPriority_8h.html#a659378374e516180f93640c79f59705cadb8ee22a232a2787f32ba28da55c43c1">LOW_PRIORITY</a></code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Close the connection to another host (if we initiated the connection it will disconnect, if they did it will kick them out). </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">target</td><td>Which system to close the connection to. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">sendDisconnectionNotification</td><td>True to send ID_DISCONNECTION_NOTIFICATION to the recipient. False to close it silently. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">channel</td><td>Which ordering channel to send the disconnection notification on, if any </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">disconnectionNotificationPriority</td><td>Priority to send ID_DISCONNECTION_NOTIFICATION on. </td></tr>
- </table>
- </dd>
- </dl>
- <p>Implemented in <a class="el" href="classRakNet_1_1RakPeer.html#a95e3806fce8552e322236abcf105cbf9">RakNet::RakPeer</a>.</p>
- </div>
- </div>
- <a class="anchor" id="a451dd5d225277fe5806d3d700551fb76"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual ConnectionAttemptResult RakNet::RakPeerInterface::Connect </td>
- <td>(</td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>host</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">unsigned short </td>
- <td class="paramname"><em>remotePort</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>passwordData</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>passwordDataLength</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="structRakNet_1_1PublicKey.html">PublicKey</a> * </td>
- <td class="paramname"><em>publicKey</em> = <code>0</code>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">unsigned </td>
- <td class="paramname"><em>connectionSocketIndex</em> = <code>0</code>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">unsigned </td>
- <td class="paramname"><em>sendConnectionAttemptCount</em> = <code>12</code>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">unsigned </td>
- <td class="paramname"><em>timeBetweenSendConnectionAttemptsMS</em> = <code>500</code>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">RakNet::TimeMS </td>
- <td class="paramname"><em>timeoutTime</em> = <code>0</code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Connect to the specified host (ip or domain name) and server port. Calling Connect and not calling SetMaximumIncomingConnections acts as a dedicated client. Calling both acts as a true peer. This is a non-blocking connection. You know the connection is successful when <a class="el" href="classRakNet_1_1RakPeerInterface.html#a33744f90a202b8e57d6a825d6af080cc">GetConnectionState()</a> returns IS_CONNECTED or <a class="el" href="classRakNet_1_1RakPeerInterface.html#a1c50453d9dee600920aeabd62ad7c119">Receive()</a> gets a message with the type identifier ID_CONNECTION_REQUEST_ACCEPTED. If the connection is not successful, such as a rejected connection or no response then neither of these things will happen. </p>
- <dl class="section pre"><dt>Precondition</dt><dd>Requires that you first call <a class="el" href="classRakNet_1_1RakPeerInterface.html#ad360d12ceb7d7448b598c451fffd2d9c" title="Starts the network threads, opens the listen port.">Startup()</a> </dd></dl>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">host</td><td>Either a dotted IP address or a domain name </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">remotePort</td><td>Which port to connect to on the remote machine. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">passwordData</td><td>A data block that must match the data block on the server passed to SetIncomingPassword. This can be a string or can be a stream of data. Use 0 for no password. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">passwordDataLength</td><td>The length in bytes of passwordData </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">publicKey</td><td>The public key the server is using. If 0, the server is not using security. If non-zero, the publicKeyMode member determines how to connect </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">connectionSocketIndex</td><td>Index into the array of socket descriptors passed to socketDescriptors in <a class="el" href="classRakNet_1_1RakPeer.html#a92d493cb617381a6e750f7df6e768927" title="Starts the network threads and opens the listen port.">RakPeer::Startup()</a> to send on. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">sendConnectionAttemptCount</td><td>How many datagrams to send to the other system to try to connect. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">timeBetweenSendConnectionAttemptsMS</td><td>Time to elapse before a datagram is sent to the other system to try to connect. After sendConnectionAttemptCount number of attempts, ID_CONNECTION_ATTEMPT_FAILED is returned. Under low bandwidth conditions with multiple simultaneous outgoing connections, this value should be raised to 1000 or higher, or else the MTU detection can overrun the available bandwidth. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">timeoutTime</td><td>How long to keep the connection alive before dropping it on unable to send a reliable message. 0 to use the default from SetTimeoutTime(UNASSIGNED_SYSTEM_ADDRESS); </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>CONNECTION_ATTEMPT_STARTED on successful initiation. Otherwise, an appropriate enumeration indicating failure. </dd></dl>
- <dl class="section note"><dt>Note</dt><dd>CONNECTION_ATTEMPT_STARTED does not mean you are already connected! </dd>
- <dd>
- It is possible to immediately get back ID_CONNECTION_ATTEMPT_FAILED if you exceed the maxConnections parameter passed to <a class="el" href="classRakNet_1_1RakPeerInterface.html#ad360d12ceb7d7448b598c451fffd2d9c" title="Starts the network threads, opens the listen port.">Startup()</a>. This could happen if you call <a class="el" href="classRakNet_1_1RakPeerInterface.html#afd637c6f44cb84ce5c151c700bb5cafe">CloseConnection()</a> with sendDisconnectionNotificaiton true, then immediately call <a class="el" href="classRakNet_1_1RakPeerInterface.html#a451dd5d225277fe5806d3d700551fb76" title="Connect to the specified host (ip or domain name) and server port. Calling Connect and not calling Se...">Connect()</a> before the connection has closed. </dd></dl>
- <p>Implemented in <a class="el" href="classRakNet_1_1RakPeer.html#a19979ff2acc15abe22785fc55c1c656c">RakNet::RakPeer</a>.</p>
- </div>
- </div>
- <a class="anchor" id="a818333f4aa6365dc1db5b1e3c4c31f64"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual ConnectionAttemptResult RakNet::RakPeerInterface::ConnectWithSocket </td>
- <td>(</td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>host</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">unsigned short </td>
- <td class="paramname"><em>remotePort</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>passwordData</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>passwordDataLength</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">RakNetSocket2 * </td>
- <td class="paramname"><em>socket</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="structRakNet_1_1PublicKey.html">PublicKey</a> * </td>
- <td class="paramname"><em>publicKey</em> = <code>0</code>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">unsigned </td>
- <td class="paramname"><em>sendConnectionAttemptCount</em> = <code>12</code>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">unsigned </td>
- <td class="paramname"><em>timeBetweenSendConnectionAttemptsMS</em> = <code>500</code>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">RakNet::TimeMS </td>
- <td class="paramname"><em>timeoutTime</em> = <code>0</code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Connect to the specified host (ip or domain name) and server port, using a shared socket from another instance of <a class="el" href="namespaceRakNet.html" title="Simple class to send changes between directories. In essence, a simple autopatcher that can be used f...">RakNet</a>. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">host</td><td>Either a dotted IP address or a domain name </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">remotePort</td><td>Which port to connect to on the remote machine. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">passwordData</td><td>A data block that must match the data block on the server passed to SetIncomingPassword. This can be a string or can be a stream of data. Use 0 for no password. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">passwordDataLength</td><td>The length in bytes of passwordData </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">socket</td><td>A bound socket returned by another instance of <a class="el" href="classRakNet_1_1RakPeerInterface.html" title="The main interface for network communications.">RakPeerInterface</a> </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">sendConnectionAttemptCount</td><td>How many datagrams to send to the other system to try to connect. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">timeBetweenSendConnectionAttemptsMS</td><td>Time to elapse before a datagram is sent to the other system to try to connect. After sendConnectionAttemptCount number of attempts, ID_CONNECTION_ATTEMPT_FAILED is returned. Under low bandwidth conditions with multiple simultaneous outgoing connections, this value should be raised to 1000 or higher, or else the MTU detection can overrun the available bandwidth. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">timeoutTime</td><td>How long to keep the connection alive before dropping it on unable to send a reliable message. 0 to use the default from SetTimeoutTime(UNASSIGNED_SYSTEM_ADDRESS); </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>CONNECTION_ATTEMPT_STARTED on successful initiation. Otherwise, an appropriate enumeration indicating failure. </dd></dl>
- <dl class="section note"><dt>Note</dt><dd>CONNECTION_ATTEMPT_STARTED does not mean you are already connected! </dd></dl>
- <p>Implemented in <a class="el" href="classRakNet_1_1RakPeer.html#a8852b99f2d8919bee57fd457477292a0">RakNet::RakPeer</a>.</p>
- </div>
- </div>
- <a class="anchor" id="a21b929aba61ce69aab32871db33d6ede"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void RakNet::RakPeerInterface::DeallocatePacket </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="structRakNet_1_1Packet.html">Packet</a> * </td>
- <td class="paramname"><em>packet</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Call this to deallocate a message returned by <a class="el" href="classRakNet_1_1RakPeerInterface.html#a1c50453d9dee600920aeabd62ad7c119">Receive()</a> when you are done handling it. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">packet</td><td>The message to deallocate. </td></tr>
- </table>
- </dd>
- </dl>
- <p>Implemented in <a class="el" href="classRakNet_1_1RakPeer.html#ae3e053f8f77d9b2e7b7fcd03f8f9120e">RakNet::RakPeer</a>.</p>
- </div>
- </div>
- <a class="anchor" id="a4960f6a8d37d70e7e98f1f6fe54e323d"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void RakNet::RakPeerInterface::DetachPlugin </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="classRakNet_1_1PluginInterface2.html">PluginInterface2</a> * </td>
- <td class="paramname"><em>messageHandler</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Detaches a Plugin interface from the instance of the base class (<a class="el" href="classRakNet_1_1RakPeer.html" title="Main interface for network communications.">RakPeer</a> or PacketizedTCP) it is attached to. </p>
- <p>This method disables the plugin code from running automatically on base class's updates or message receipt. If the plugin returns false from PluginInterface::UsesReliabilityLayer(), which is the case for all plugins except <a class="el" href="classRakNet_1_1PacketLogger.html" title="Writes incoming and outgoing messages to the screen. This will write all incoming and outgoing messag...">PacketLogger</a>, you can call <a class="el" href="classRakNet_1_1RakPeerInterface.html#a2cfd224842b6f1d5e2881901c9f71531" title="Attaches a Plugin interface to an instance of the base class (RakPeer or PacketizedTCP) to run code a...">AttachPlugin()</a> and <a class="el" href="classRakNet_1_1RakPeerInterface.html#a4960f6a8d37d70e7e98f1f6fe54e323d" title="Detaches a Plugin interface from the instance of the base class (RakPeer or PacketizedTCP) it is atta...">DetachPlugin()</a> for this plugin while <a class="el" href="classRakNet_1_1RakPeer.html" title="Main interface for network communications.">RakPeer</a> is active. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">messageHandler</td><td>Pointer to a plugin to detach. </td></tr>
- </table>
- </dd>
- </dl>
- <p>Implemented in <a class="el" href="classRakNet_1_1RakPeer.html#a9f29151642a0ad0abdddc6d9a8f25239">RakNet::RakPeer</a>.</p>
- </div>
- </div>
- <a class="anchor" id="aab566dbe8f666dfed108aaaabc7a0ca6"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void RakNet::RakPeerInterface::DisableSecurity </td>
- <td>(</td>
- <td class="paramtype">void </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Disables security for incoming connections. </p>
- <dl class="section note"><dt>Note</dt><dd>Must be called while offline </dd></dl>
- <p>Implemented in <a class="el" href="classRakNet_1_1RakPeer.html#a489dd712e953836042df5711c8eb7e76">RakNet::RakPeer</a>.</p>
- </div>
- </div>
- <a class="anchor" id="a15627acab7077970975889d4e83dc59b"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual int RakNet::RakPeerInterface::GetAveragePing </td>
- <td>(</td>
- <td class="paramtype">const AddressOrGUID </td>
- <td class="paramname"><em>systemIdentifier</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Returns the average of all ping times read for the specific system or -1 if none read yet </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">systemAddress</td><td>Which system we are referring to </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>The ping time for this system, or -1 </dd></dl>
- <p>Implemented in <a class="el" href="classRakNet_1_1RakPeer.html#a2b735d6075d64dcdf5c554989f4a5f98">RakNet::RakPeer</a>.</p>
- </div>
- </div>
- <a class="anchor" id="a7139f333758a31e5a1f44f06b120f085"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual bool RakNet::RakPeerInterface::GetClientPublicKeyFromSystemAddress </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> </td>
- <td class="paramname"><em>input</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">char * </td>
- <td class="paramname"><em>client_public_key</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Given the <a class="el" href="structRakNet_1_1SystemAddress.html" title="Network address for a system.">SystemAddress</a> of a connected system, get the public key they provided as an identity Returns false if system address was not found or client public key is not known </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">input</td><td>The <a class="el" href="structRakNet_1_1RakNetGUID.html">RakNetGUID</a> of the system </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">client_public_key</td><td>The connected client's public key is copied to this address. Buffer must be cat::EasyHandshake::PUBLIC_KEY_BYTES bytes in length. </td></tr>
- </table>
- </dd>
- </dl>
- <p>Implemented in <a class="el" href="classRakNet_1_1RakPeer.html#abc607f77d9724097030d2da6868074b3">RakNet::RakPeer</a>.</p>
- </div>
- </div>
- <a class="anchor" id="a7fa284803461a09efeffd65d73068c51"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual RakNet::Time RakNet::RakPeerInterface::GetClockDifferential </td>
- <td>(</td>
- <td class="paramtype">const AddressOrGUID </td>
- <td class="paramname"><em>systemIdentifier</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Return the clock difference between your system and the specified system Subtract <a class="el" href="classRakNet_1_1RakPeerInterface.html#a7fa284803461a09efeffd65d73068c51">GetClockDifferential()</a> from a time returned by the remote system to get that time relative to your own system Returns 0 if the system is unknown </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">systemIdentifier</td><td>Which system we are referring to </td></tr>
- </table>
- </dd>
- </dl>
- <p>Implemented in <a class="el" href="classRakNet_1_1RakPeer.html#ac1f87a029e47963ae24838ec87c1a076">RakNet::RakPeer</a>.</p>
- </div>
- </div>
- <a class="anchor" id="a5706fd26cf90bd45d0658d8b9a7d8111"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual bool RakNet::RakPeerInterface::GetConnectionList </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> * </td>
- <td class="paramname"><em>remoteSystems</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">unsigned short * </td>
- <td class="paramname"><em>numberOfSystems</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Fills the array remoteSystems with the <a class="el" href="structRakNet_1_1SystemAddress.html" title="Network address for a system.">SystemAddress</a> of all the systems we are connected to </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[out]</td><td class="paramname">remoteSystems</td><td>An array of <a class="el" href="structRakNet_1_1SystemAddress.html" title="Network address for a system.">SystemAddress</a> structures to be filled with the SystemAddresss of the systems we are connected to. Pass 0 to remoteSystems to only get the number of systems we are connected to </td></tr>
- <tr><td class="paramdir">[in,out]</td><td class="paramname">numberOfSystems</td><td>As input, the size of remoteSystems array. As output, the number of elements put into the array </td></tr>
- </table>
- </dd>
- </dl>
- <p>Implemented in <a class="el" href="classRakNet_1_1RakPeer.html#a0af5b69face182410f2abb11da902dd4">RakNet::RakPeer</a>.</p>
- </div>
- </div>
- <a class="anchor" id="a33744f90a202b8e57d6a825d6af080cc"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual <a class="el" href="namespaceRakNet.html#a84a0fb005391f71130dd341f77f62138">ConnectionState</a> RakNet::RakPeerInterface::GetConnectionState </td>
- <td>(</td>
- <td class="paramtype">const AddressOrGUID </td>
- <td class="paramname"><em>systemIdentifier</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Returns if a system is connected, disconnected, connecting in progress, or various other states </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">systemIdentifier</td><td>The system we are referring to </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section note"><dt>Note</dt><dd>This locks a mutex, do not call too frequently during connection attempts or the attempt will take longer and possibly even timeout </dd></dl>
- <dl class="section return"><dt>Returns</dt><dd>What state the remote system is in </dd></dl>
- <p>Implemented in <a class="el" href="classRakNet_1_1RakPeer.html#a514c8d6f1dc75b5e9bb3cb5b9dcb632b">RakNet::RakPeer</a>.</p>
- </div>
- </div>
- <a class="anchor" id="a94602ad7356b4a99f862f9793327c325"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> RakNet::RakPeerInterface::GetExternalID </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> </td>
- <td class="paramname"><em>target</em></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Return the unique address identifier that represents you on the the network and is based on your externalIP / port (the IP / port the specified player uses to communicate with you) </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">target</td><td>Which remote system you are referring to for your external ID. Usually the same for all systems, unless you have two or more network cards. </td></tr>
- </table>
- </dd>
- </dl>
- <p>Implemented in <a class="el" href="classRakNet_1_1RakPeer.html#a96f0e923c413fe2319d17862605d6622">RakNet::RakPeer</a>.</p>
- </div>
- </div>
- <a class="anchor" id="ac86fcbe5e750b08378703197bd9fddcf"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual <a class="el" href="structRakNet_1_1RakNetGUID.html">RakNetGUID</a> RakNet::RakPeerInterface::GetGUIDFromIndex </td>
- <td>(</td>
- <td class="paramtype">unsigned int </td>
- <td class="paramname"><em>index</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Same as GetSystemAddressFromIndex but returns <a class="el" href="structRakNet_1_1RakNetGUID.html">RakNetGUID</a> </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>Index should range between 0 and the maximum number of players allowed - 1. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>The <a class="el" href="structRakNet_1_1RakNetGUID.html">RakNetGUID</a> </dd></dl>
- <p>Implemented in <a class="el" href="classRakNet_1_1RakPeer.html#ab639b98f7b007833b08930de45545433">RakNet::RakPeer</a>.</p>
- </div>
- </div>
- <a class="anchor" id="aac8203dda2ba1271e753bd113b259173"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual const <a class="el" href="structRakNet_1_1RakNetGUID.html">RakNetGUID</a>& RakNet::RakPeerInterface::GetGuidFromSystemAddress </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> </td>
- <td class="paramname"><em>input</em></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Given a connected system, give us the unique GUID representing that instance of <a class="el" href="classRakNet_1_1RakPeer.html" title="Main interface for network communications.">RakPeer</a>. This will be the same on all systems connected to that instance of <a class="el" href="classRakNet_1_1RakPeer.html" title="Main interface for network communications.">RakPeer</a>, even if the external system addresses are different Currently O(log(n)), but this may be improved in the future. If you use this frequently, you may want to cache the value as it won't change. Returns UNASSIGNED_RAKNET_GUID if system address can't be found. If <em>input</em> is UNASSIGNED_SYSTEM_ADDRESS, will return your own GUID </p>
- <dl class="section pre"><dt>Precondition</dt><dd>Call <a class="el" href="classRakNet_1_1RakPeerInterface.html#ad360d12ceb7d7448b598c451fffd2d9c" title="Starts the network threads, opens the listen port.">Startup()</a> first, or the function will return UNASSIGNED_RAKNET_GUID </dd></dl>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">input</td><td>The system address of the system we are connected to </td></tr>
- </table>
- </dd>
- </dl>
- <p>Implemented in <a class="el" href="classRakNet_1_1RakPeer.html#a41fcd1175cb8fee67b12835944ed51da">RakNet::RakPeer</a>.</p>
- </div>
- </div>
- <a class="anchor" id="a8b5026f40cf8e6f307e2d3ac82970a30"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void RakNet::RakPeerInterface::GetIncomingPassword </td>
- <td>(</td>
- <td class="paramtype">char * </td>
- <td class="paramname"><em>passwordData</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">int * </td>
- <td class="paramname"><em>passwordDataLength</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Gets the password passed to SetIncomingPassword </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[out]</td><td class="paramname">passwordData</td><td>Should point to a block large enough to hold the password data you passed to <a class="el" href="classRakNet_1_1RakPeerInterface.html#ad18a28a99420006d020125eea1ded4ed">SetIncomingPassword()</a> </td></tr>
- <tr><td class="paramdir">[in,out]</td><td class="paramname">passwordDataLength</td><td>Maximum size of the array passwordData. Modified to hold the number of bytes actually written </td></tr>
- </table>
- </dd>
- </dl>
- <p>Implemented in <a class="el" href="classRakNet_1_1RakPeer.html#a395e269dce0de14f22bfb870923f22b3">RakNet::RakPeer</a>.</p>
- </div>
- </div>
- <a class="anchor" id="ab2015109d6bf787c46880fde513d4276"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual int RakNet::RakPeerInterface::GetIndexFromSystemAddress </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> </td>
- <td class="paramname"><em>systemAddress</em></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Given a systemAddress, returns an index from 0 to the maximum number of players allowed - 1. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">systemAddress</td><td>The <a class="el" href="structRakNet_1_1SystemAddress.html" title="Network address for a system.">SystemAddress</a> we are referring to </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>The index of this <a class="el" href="structRakNet_1_1SystemAddress.html" title="Network address for a system.">SystemAddress</a> or -1 on system not found. </dd></dl>
- <p>Implemented in <a class="el" href="classRakNet_1_1RakPeer.html#ad77373ffe92c37f01b39bc16c62ac9ba">RakNet::RakPeer</a>.</p>
- </div>
- </div>
- <a class="anchor" id="a928a49c193687ccef547f7ea3634bb54"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> RakNet::RakPeerInterface::GetInternalID </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> </td>
- <td class="paramname"><em>systemAddress</em> = <code><a class="el" href="namespaceRakNet.html#a80c95b4ed53f42911a6fa92b85e929cf">UNASSIGNED_SYSTEM_ADDRESS</a></code>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const int </td>
- <td class="paramname"><em>index</em> = <code>0</code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Return the unique address identifier that represents you or another system on the the network and is based on your local IP / port. </p>
- <dl class="section note"><dt>Note</dt><dd>Not supported by the XBOX </dd></dl>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">systemAddress</td><td>Use UNASSIGNED_SYSTEM_ADDRESS to get your behind-LAN address. Use a connected system to get their behind-LAN address </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>When you have multiple internal IDs, which index to return? Currently limited to MAXIMUM_NUMBER_OF_INTERNAL_IDS (so the maximum value of this variable is MAXIMUM_NUMBER_OF_INTERNAL_IDS-1) </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>the identifier of your system internally, which may not be how other systems see if you if you are behind a NAT or proxy </dd></dl>
- <p>Implemented in <a class="el" href="classRakNet_1_1RakPeer.html#acf82a248aa543c9ec04567c14004fea5">RakNet::RakPeer</a>.</p>
- </div>
- </div>
- <a class="anchor" id="a0fb0115e5c85094d48239f157d9eccbb"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual int RakNet::RakPeerInterface::GetLastPing </td>
- <td>(</td>
- <td class="paramtype">const AddressOrGUID </td>
- <td class="paramname"><em>systemIdentifier</em></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Returns the last ping time read for the specific system or -1 if none read yet </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">systemAddress</td><td>Which system we are referring to </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>The last ping time for this system, or -1 </dd></dl>
- <p>Implemented in <a class="el" href="classRakNet_1_1RakPeer.html#a7a21e884778d65fb4493b29e5c1826c5">RakNet::RakPeer</a>.</p>
- </div>
- </div>
- <a class="anchor" id="ad070246537065910a500803bdf6b9cb2"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual const char* RakNet::RakPeerInterface::GetLocalIP </td>
- <td>(</td>
- <td class="paramtype">unsigned int </td>
- <td class="paramname"><em>index</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Returns an IP address at index 0 to GetNumberOfAddresses-1 </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>index into the list of IP addresses </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>The local IP address at this index </dd></dl>
- <p>Implemented in <a class="el" href="classRakNet_1_1RakPeer.html#aa78c5de86816a54cae137bffb7e49bc5">RakNet::RakPeer</a>.</p>
- </div>
- </div>
- <a class="anchor" id="a4eb8b0f288db5425906cd72ee5f8fae9"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual int RakNet::RakPeerInterface::GetLowestPing </td>
- <td>(</td>
- <td class="paramtype">const AddressOrGUID </td>
- <td class="paramname"><em>systemIdentifier</em></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Returns the lowest ping time read or -1 if none read yet </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">systemAddress</td><td>Which system we are referring to </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>The lowest ping time for this system, or -1 </dd></dl>
- <p>Implemented in <a class="el" href="classRakNet_1_1RakPeer.html#afdb8673a54a5f3926ac93e13a4a20367">RakNet::RakPeer</a>.</p>
- </div>
- </div>
- <a class="anchor" id="aa2985b696b46b347f5825e11e7219f83"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual unsigned int RakNet::RakPeerInterface::GetMaximumIncomingConnections </td>
- <td>(</td>
- <td class="paramtype">void </td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Returns the value passed to <a class="el" href="classRakNet_1_1RakPeerInterface.html#a1f279ee0d3578de483126f6cfef282f4">SetMaximumIncomingConnections()</a> </p>
- <dl class="section return"><dt>Returns</dt><dd>the maximum number of incoming connections, which is always <= maxConnections </dd></dl>
- <p>Implemented in <a class="el" href="classRakNet_1_1RakPeer.html#a21eac8d486bbcb12e350c49c43c92618">RakNet::RakPeer</a>.</p>
- </div>
- </div>
- <a class="anchor" id="af7359755639152292a3e35b6fb9877bb"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual int RakNet::RakPeerInterface::GetMTUSize </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> </td>
- <td class="paramname"><em>target</em></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Returns the current MTU size </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">target</td><td>Which system to get this for. UNASSIGNED_SYSTEM_ADDRESS to get the default </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>The current MTU size </dd></dl>
- <p>Implemented in <a class="el" href="classRakNet_1_1RakPeer.html#af5948dcad656f51305ed20c8b38e529b">RakNet::RakPeer</a>.</p>
- </div>
- </div>
- <a class="anchor" id="a8587fe2920712adddfa06950ff6b8998"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual uint32_t RakNet::RakPeerInterface::GetNextSendReceipt </td>
- <td>(</td>
- <td class="paramtype">void </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Returns the next uint32_t that <a class="el" href="classRakNet_1_1RakPeerInterface.html#a543ec5be9cf5f73f5c8733d1829789f9">Send()</a> will return </p>
- <dl class="section note"><dt>Note</dt><dd>If using <a class="el" href="classRakNet_1_1RakPeer.html" title="Main interface for network communications.">RakPeer</a> from multiple threads, this may not be accurate for your thread. Use <a class="el" href="classRakNet_1_1RakPeerInterface.html#a9a406f292a6c44f551e9d8606992558e">IncrementNextSendReceipt()</a> in that case. </dd></dl>
- <dl class="section return"><dt>Returns</dt><dd>The next uint32_t that <a class="el" href="classRakNet_1_1RakPeerInterface.html#a543ec5be9cf5f73f5c8733d1829789f9">Send()</a> or SendList will return </dd></dl>
- <p>Implemented in <a class="el" href="classRakNet_1_1RakPeer.html#a1d6e283f476bdd4ed8b9b4c56693ecd1">RakNet::RakPeer</a>.</p>
- </div>
- </div>
- <a class="anchor" id="ae61f8651e8a45acec5bdf04384777a86"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void RakNet::RakPeerInterface::GetOfflinePingResponse </td>
- <td>(</td>
- <td class="paramtype">char ** </td>
- <td class="paramname"><em>data</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">unsigned int * </td>
- <td class="paramname"><em>length</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Returns pointers to a copy of the data passed to SetOfflinePingResponse </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[out]</td><td class="paramname">data</td><td>A pointer to a copy of the data passed to <em><a class="el" href="classRakNet_1_1RakPeerInterface.html#a40b198325a1a4f4a1ff3b1a1741b89eb">SetOfflinePingResponse()</a></em> </td></tr>
- <tr><td class="paramdir">[out]</td><td class="paramname">length</td><td>A pointer filled in with the length parameter passed to <a class="el" href="classRakNet_1_1RakPeerInterface.html#a40b198325a1a4f4a1ff3b1a1741b89eb">SetOfflinePingResponse()</a> </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section see"><dt>See Also</dt><dd><a class="el" href="classRakNet_1_1RakPeerInterface.html#a40b198325a1a4f4a1ff3b1a1741b89eb">SetOfflinePingResponse</a> </dd></dl>
- <p>Implemented in <a class="el" href="classRakNet_1_1RakPeer.html#aec33659d51a00eed12bd1dc8a24071b0">RakNet::RakPeer</a>.</p>
- </div>
- </div>
- <a class="anchor" id="adae8cd6baaa718eb5a818f5271a58122"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual RakNetSocket2* RakNet::RakPeerInterface::GetSocket </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> </td>
- <td class="paramname"><em>target</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Get the socket used with a particular active connection The smart pointer reference counts the RakNetSocket2 object, so the socket will remain active as long as the smart pointer does, even if <a class="el" href="namespaceRakNet.html" title="Simple class to send changes between directories. In essence, a simple autopatcher that can be used f...">RakNet</a> were to shutdown or close the connection. </p>
- <dl class="section note"><dt>Note</dt><dd>This sends a query to the thread and blocks on the return value for up to one second. In practice it should only take a millisecond or so. </dd></dl>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">target</td><td>Which system </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>A smart pointer object containing the socket information about the socket. Be sure to check IsNull() which is returned if the update thread is unresponsive, shutting down, or if this system is not connected </dd></dl>
- <p>Implemented in <a class="el" href="classRakNet_1_1RakPeer.html#ab69ef5d63339d36dc99b905586a23151">RakNet::RakPeer</a>.</p>
- </div>
- </div>
- <a class="anchor" id="a09ef1181af600ec2c255a295154fe367"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void RakNet::RakPeerInterface::GetSockets </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="classDataStructures_1_1List.html">DataStructures::List</a>< RakNetSocket2 * > & </td>
- <td class="paramname"><em>sockets</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Get all sockets in use </p>
- <dl class="section note"><dt>Note</dt><dd>This sends a query to the thread and blocks on the return value for up to one second. In practice it should only take a millisecond or so. </dd></dl>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[out]</td><td class="paramname">sockets</td><td>List of RakNetSocket2 structures in use. Sockets will not be closed until <em>sockets</em> goes out of scope </td></tr>
- </table>
- </dd>
- </dl>
- <p>Implemented in <a class="el" href="classRakNet_1_1RakPeer.html#a35c353846b88cb39d4c8d12ba4f5ca42">RakNet::RakPeer</a>.</p>
- </div>
- </div>
- <a class="anchor" id="abd4be92bcad53af859e502127c060247"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual int RakNet::RakPeerInterface::GetSplitMessageProgressInterval </td>
- <td>(</td>
- <td class="paramtype">void </td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Returns what was passed to <a class="el" href="classRakNet_1_1RakPeerInterface.html#a4112544503b05a7b7dd2dd56adfbc648">SetSplitMessageProgressInterval()</a> </p>
- <dl class="section return"><dt>Returns</dt><dd>What was passed to <a class="el" href="classRakNet_1_1RakPeerInterface.html#a4112544503b05a7b7dd2dd56adfbc648">SetSplitMessageProgressInterval()</a>. Default to 0. </dd></dl>
- <p>Implemented in <a class="el" href="classRakNet_1_1RakPeer.html#af9f01256eab673794028fe48980ef6fa">RakNet::RakPeer</a>.</p>
- </div>
- </div>
- <a class="anchor" id="a87e528130f7f0f21597a338769fe7139"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual <a class="el" href="structRakNet_1_1RakNetStatistics.html">RakNetStatistics</a>* RakNet::RakPeerInterface::GetStatistics </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> </td>
- <td class="paramname"><em>systemAddress</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="structRakNet_1_1RakNetStatistics.html">RakNetStatistics</a> * </td>
- <td class="paramname"><em>rns</em> = <code>0</code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Returns a structure containing a large set of network statistics for the specified system. You can map this data to a string using the C style <a class="el" href="namespaceRakNet.html#a49d0ff9db0d324a890e9c08add72a131">StatisticsToString()</a> function </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">systemAddress,:</td><td>Which connected system to get statistics for </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">rns</td><td>If you supply this structure, it will be written to it. Otherwise it will use a static struct, which is not threadsafe </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>0 on can't find the specified system. A pointer to a set of data otherwise. </dd></dl>
- <dl class="section see"><dt>See Also</dt><dd><a class="el" href="RakNetStatistics_8h.html" title="A structure that holds all statistical data returned by RakNet.">RakNetStatistics.h</a> </dd></dl>
- <p>Implemented in <a class="el" href="classRakNet_1_1RakPeer.html#a0d31a8a91862a6c796730dc3a35f98ee">RakNet::RakPeer</a>.</p>
- </div>
- </div>
- <a class="anchor" id="a28c5bd84842962e60097512a9f6ff463"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual bool RakNet::RakPeerInterface::GetStatistics </td>
- <td>(</td>
- <td class="paramtype">const unsigned int </td>
- <td class="paramname"><em>index</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="structRakNet_1_1RakNetStatistics.html">RakNetStatistics</a> * </td>
- <td class="paramname"><em>rns</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Returns the network statistics of the system at the given index in the remoteSystemList. </p>
- <dl class="section return"><dt>Returns</dt><dd>True if the index is less than the maximum number of peers allowed and the system is active. False otherwise. </dd></dl>
- <p>Implemented in <a class="el" href="classRakNet_1_1RakPeer.html#a399f918602df7cb051b038e17ad67ecf">RakNet::RakPeer</a>.</p>
- </div>
- </div>
- <a class="anchor" id="ad474ee839667fb5e1b667ea5465dc021"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void RakNet::RakPeerInterface::GetStatisticsList </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="classDataStructures_1_1List.html">DataStructures::List</a>< <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> > & </td>
- <td class="paramname"><em>addresses</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="classDataStructures_1_1List.html">DataStructures::List</a>< <a class="el" href="structRakNet_1_1RakNetGUID.html">RakNetGUID</a> > & </td>
- <td class="paramname"><em>guids</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="classDataStructures_1_1List.html">DataStructures::List</a>< <a class="el" href="structRakNet_1_1RakNetStatistics.html">RakNetStatistics</a> > & </td>
- <td class="paramname"><em>statistics</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Returns the list of systems, and statistics for each of those systems Each system has one entry in each of the lists, in the same order. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[out]</td><td class="paramname">addresses</td><td><a class="el" href="structRakNet_1_1SystemAddress.html" title="Network address for a system.">SystemAddress</a> for each connected system </td></tr>
- <tr><td class="paramdir">[out]</td><td class="paramname">guids</td><td><a class="el" href="structRakNet_1_1RakNetGUID.html">RakNetGUID</a> for each connected system </td></tr>
- <tr><td class="paramdir">[out]</td><td class="paramname">statistics</td><td>Calculated <a class="el" href="structRakNet_1_1RakNetStatistics.html" title="Network Statisics Usage.">RakNetStatistics</a> for each connected system </td></tr>
- </table>
- </dd>
- </dl>
- <p>Implemented in <a class="el" href="classRakNet_1_1RakPeer.html#acffede0c021450b37b16e6946c694a7d">RakNet::RakPeer</a>.</p>
- </div>
- </div>
- <a class="anchor" id="adaaff66118400b6bbcb31c11419cd791"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> RakNet::RakPeerInterface::GetSystemAddressFromGuid </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="structRakNet_1_1RakNetGUID.html">RakNetGUID</a> </td>
- <td class="paramname"><em>input</em></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Given the GUID of a connected system, give us the system address of that system. The GUID will be the same on all systems connected to that instance of <a class="el" href="classRakNet_1_1RakPeer.html" title="Main interface for network communications.">RakPeer</a>, even if the external system addresses are different Currently O(log(n)), but this may be improved in the future. If you use this frequently, you may want to cache the value as it won't change. If <em>input</em> is UNASSIGNED_RAKNET_GUID, will return UNASSIGNED_SYSTEM_ADDRESS </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">input</td><td>The <a class="el" href="structRakNet_1_1RakNetGUID.html">RakNetGUID</a> of the system we are checking to see if we are connected to </td></tr>
- </table>
- </dd>
- </dl>
- <p>Implemented in <a class="el" href="classRakNet_1_1RakPeer.html#ac591b0ac4b88b9cdf182fc4769d9de98">RakNet::RakPeer</a>.</p>
- </div>
- </div>
- <a class="anchor" id="aaf66ca0e72313053922bfb1c1b602889"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> RakNet::RakPeerInterface::GetSystemAddressFromIndex </td>
- <td>(</td>
- <td class="paramtype">unsigned int </td>
- <td class="paramname"><em>index</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>This function is only useful for looping through all systems Given an index, will return a <a class="el" href="structRakNet_1_1SystemAddress.html" title="Network address for a system.">SystemAddress</a>. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>Index should range between 0 and the maximum number of players allowed - 1. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>The <a class="el" href="structRakNet_1_1SystemAddress.html" title="Network address for a system.">SystemAddress</a> </dd></dl>
- <p>Implemented in <a class="el" href="classRakNet_1_1RakPeer.html#aa3159d6eabc0a1a4298fb67c7fc7146b">RakNet::RakPeer</a>.</p>
- </div>
- </div>
- <a class="anchor" id="aa1939c66f7190e3c647a6a685a6eb248"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void RakNet::RakPeerInterface::GetSystemList </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="classDataStructures_1_1List.html">DataStructures::List</a>< <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> > & </td>
- <td class="paramname"><em>addresses</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="classDataStructures_1_1List.html">DataStructures::List</a>< <a class="el" href="structRakNet_1_1RakNetGUID.html">RakNetGUID</a> > & </td>
- <td class="paramname"><em>guids</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Same as calling GetSystemAddressFromIndex and GetGUIDFromIndex for all systems, but more efficient Indices match each other, so <em>addresses</em>[0] and <em>guids</em>[0] refer to the same system </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[out]</td><td class="paramname">addresses</td><td>All system addresses. Size of the list is the number of connections. Size of the list will match the size of the <em>guids</em> list. </td></tr>
- <tr><td class="paramdir">[out]</td><td class="paramname">guids</td><td>All guids. Size of the list is the number of connections. Size of the list will match the size of the <em>addresses</em> list. </td></tr>
- </table>
- </dd>
- </dl>
- <p>Implemented in <a class="el" href="classRakNet_1_1RakPeer.html#a791779bb9714e830f19a5f12961576d7">RakNet::RakPeer</a>.</p>
- </div>
- </div>
- <a class="anchor" id="a0fd3a4d282327944ee50b00c79baf420"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual RakNet::TimeMS RakNet::RakPeerInterface::GetTimeoutTime </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> </td>
- <td class="paramname"><em>target</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">target</td><td>Which system to do this for. Pass UNASSIGNED_SYSTEM_ADDRESS to get the default value </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>timeoutTime for a given system. </dd></dl>
- <p>Implemented in <a class="el" href="classRakNet_1_1RakPeer.html#a12dc51372f2a5a109f3c6a55ba799763">RakNet::RakPeer</a>.</p>
- </div>
- </div>
- <a class="anchor" id="a9a406f292a6c44f551e9d8606992558e"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual uint32_t RakNet::RakPeerInterface::IncrementNextSendReceipt </td>
- <td>(</td>
- <td class="paramtype">void </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Returns the next uint32_t that <a class="el" href="classRakNet_1_1RakPeerInterface.html#a543ec5be9cf5f73f5c8733d1829789f9">Send()</a> will return, and increments the value by one </p>
- <dl class="section note"><dt>Note</dt><dd>If using <a class="el" href="classRakNet_1_1RakPeer.html" title="Main interface for network communications.">RakPeer</a> from multiple threads, pass this to forceReceipt in the send function </dd></dl>
- <dl class="section return"><dt>Returns</dt><dd>The next uint32_t that <a class="el" href="classRakNet_1_1RakPeerInterface.html#a543ec5be9cf5f73f5c8733d1829789f9">Send()</a> or SendList will return </dd></dl>
- <p>Implemented in <a class="el" href="classRakNet_1_1RakPeer.html#a9232bd1bc9c1a223ecef8682133f95ac">RakNet::RakPeer</a>.</p>
- </div>
- </div>
- <a class="anchor" id="ab5389821efb5d09470f8429925766eb3"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual bool RakNet::RakPeerInterface::InitializeSecurity </td>
- <td>(</td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>publicKey</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>privateKey</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">bool </td>
- <td class="paramname"><em>bRequireClientKey</em> = <code>false</code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>If you accept connections, you must call this or else security will not be enabled for incoming connections. This feature requires more round trips, bandwidth, and CPU time for the connection handshake x64 builds require under 25% of the CPU time of other builds See the Encryption sample for example usage </p>
- <dl class="section pre"><dt>Precondition</dt><dd>Must be called while offline </dd>
- <dd>
- LIBCAT_SECURITY must be defined to 1 in NativeFeatureIncludes.h for this function to have any effect </dd></dl>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">publicKey</td><td>A pointer to the public key for accepting new connections </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">privateKey</td><td>A pointer to the private key for accepting new connections </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">bRequireClientKey,:</td><td>Should be set to false for most servers. Allows the server to accept a public key from connecting clients as a proof of identity but eats twice as much CPU time as a normal connection </td></tr>
- </table>
- </dd>
- </dl>
- <p>Implemented in <a class="el" href="classRakNet_1_1RakPeer.html#a5445d0e8db3e7ef1e38b7fc5bc0d3920">RakNet::RakPeer</a>.</p>
- </div>
- </div>
- <a class="anchor" id="affcba03406b89157976cf0e6a8924d66"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual bool RakNet::RakPeerInterface::IsActive </td>
- <td>(</td>
- <td class="paramtype">void </td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Returns if the network thread is running </p>
- <dl class="section return"><dt>Returns</dt><dd>true if the network thread is running, false otherwise </dd></dl>
- <p>Implemented in <a class="el" href="classRakNet_1_1RakPeer.html#ae6bb2c4de0b24283b231154d29304e00">RakNet::RakPeer</a>.</p>
- </div>
- </div>
- <a class="anchor" id="ae28629f202de81ad4816470cd0f8fd94"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual bool RakNet::RakPeerInterface::IsBanned </td>
- <td>(</td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>IP</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Returns true or false indicating if a particular IP is banned. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">IP</td><td>- Dotted IP address. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>true if IP matches any IPs in the ban list, accounting for any wildcards. False otherwise. </dd></dl>
- <p>Implemented in <a class="el" href="classRakNet_1_1RakPeer.html#a499626110e1409b09e7d955722c4c3fd">RakNet::RakPeer</a>.</p>
- </div>
- </div>
- <a class="anchor" id="a2672cee4147e50818769e3573fb5c459"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual bool RakNet::RakPeerInterface::IsInSecurityExceptionList </td>
- <td>(</td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>ip</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Checks to see if a given IP is in the security exception list </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">IP</td><td>address to check. </td></tr>
- </table>
- </dd>
- </dl>
- <p>Implemented in <a class="el" href="classRakNet_1_1RakPeer.html#a654c29f6f195b0dcd105a856c99222d1">RakNet::RakPeer</a>.</p>
- </div>
- </div>
- <a class="anchor" id="ac37fe2c8b35abdc3a441541e539ebd10"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual bool RakNet::RakPeerInterface::IsLocalIP </td>
- <td>(</td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>ip</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Is this a local IP? </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">An</td><td>IP address to check, excluding the port </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>True if this is one of the IP addresses returned by GetLocalIP </dd></dl>
- <p>Implemented in <a class="el" href="classRakNet_1_1RakPeer.html#ad89d80f939408a620a5e41eeab0a588a">RakNet::RakPeer</a>.</p>
- </div>
- </div>
- <a class="anchor" id="a917c367bcba491fb243161025b6eab01"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual bool RakNet::RakPeerInterface::IsNetworkSimulatorActive </td>
- <td>(</td>
- <td class="paramtype">void </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Returns if you previously called ApplyNetworkSimulator </p>
- <dl class="section return"><dt>Returns</dt><dd>If you previously called ApplyNetworkSimulator </dd></dl>
- <p>Implemented in <a class="el" href="classRakNet_1_1RakPeer.html#adc9c2b58a0970b6a80e50b1ecf470e43">RakNet::RakPeer</a>.</p>
- </div>
- </div>
- <a class="anchor" id="a88611e451f6f6e0d5f7cb00ce5bcabf9"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual unsigned short RakNet::RakPeerInterface::NumberOfConnections </td>
- <td>(</td>
- <td class="paramtype">void </td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Returns how many open connections there are at this time </p>
- <dl class="section return"><dt>Returns</dt><dd>the number of open connections </dd></dl>
- <p>Implemented in <a class="el" href="classRakNet_1_1RakPeer.html#a4d47b849ba6e7ecf2d1fca3198a60ba5">RakNet::RakPeer</a>.</p>
- </div>
- </div>
- <a class="anchor" id="a49dbff7ab8f516361e3d05645c2b7901"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void RakNet::RakPeerInterface::Ping </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> </td>
- <td class="paramname"><em>target</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Send a ping to the specified connected system. </p>
- <dl class="section pre"><dt>Precondition</dt><dd>The sender and recipient must already be started via a successful call to <a class="el" href="classRakNet_1_1RakPeerInterface.html#ad360d12ceb7d7448b598c451fffd2d9c" title="Starts the network threads, opens the listen port.">Startup()</a> </dd></dl>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">target</td><td>Which system to ping </td></tr>
- </table>
- </dd>
- </dl>
- <p>Implemented in <a class="el" href="classRakNet_1_1RakPeer.html#a9bb94828e0ad89e0d6c44a671bf22f8d">RakNet::RakPeer</a>.</p>
- </div>
- </div>
- <a class="anchor" id="ad5667c9d47585be3a65485f9c81f7045"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual bool RakNet::RakPeerInterface::Ping </td>
- <td>(</td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>host</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">unsigned short </td>
- <td class="paramname"><em>remotePort</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">bool </td>
- <td class="paramname"><em>onlyReplyOnAcceptingConnections</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">unsigned </td>
- <td class="paramname"><em>connectionSocketIndex</em> = <code>0</code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Send a ping to the specified unconnected system. The remote system, if it is Initialized, will respond with ID_PONG followed by sizeof(RakNet::TimeMS) containing the system time the ping was sent.(Default is 4 bytes - See __GET_TIME_64BIT in <a class="el" href="RakNetTypes_8h.html" title="Types used by RakNet, most of which involve user code.">RakNetTypes.h</a> System should reply with ID_PONG if it is active </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">host</td><td>Either a dotted IP address or a domain name. Can be 255.255.255.255 for LAN broadcast. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">remotePort</td><td>Which port to connect to on the remote machine. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">onlyReplyOnAcceptingConnections</td><td>Only request a reply if the remote system is accepting connections </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">connectionSocketIndex</td><td>Index into the array of socket descriptors passed to socketDescriptors in <a class="el" href="classRakNet_1_1RakPeer.html#a92d493cb617381a6e750f7df6e768927" title="Starts the network threads and opens the listen port.">RakPeer::Startup()</a> to send on. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>true on success, false on failure (unknown hostname) </dd></dl>
- <p>Implemented in <a class="el" href="classRakNet_1_1RakPeer.html#af7dd13a4c3d38e65bf816a604c6042c7">RakNet::RakPeer</a>.</p>
- </div>
- </div>
- <a class="anchor" id="a29c5527b07a3ddc32083d8ec1e24318b"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void RakNet::RakPeerInterface::PushBackPacket </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="structRakNet_1_1Packet.html">Packet</a> * </td>
- <td class="paramname"><em>packet</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">bool </td>
- <td class="paramname"><em>pushAtHead</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Put a message back at the end of the receive queue in case you don't want to deal with it immediately </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">packet</td><td>The packet you want to push back. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">pushAtHead</td><td>True to push the packet so that the next receive call returns it. False to push it at the end of the queue (obviously pushing it at the end makes the packets out of order) </td></tr>
- </table>
- </dd>
- </dl>
- <p>Implemented in <a class="el" href="classRakNet_1_1RakPeer.html#ac32f687f4bbd396e326be77ac1fa77a8">RakNet::RakPeer</a>.</p>
- </div>
- </div>
- <a class="anchor" id="a1c50453d9dee600920aeabd62ad7c119"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual <a class="el" href="structRakNet_1_1Packet.html">Packet</a>* RakNet::RakPeerInterface::Receive </td>
- <td>(</td>
- <td class="paramtype">void </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Gets a message from the incoming message queue. Use <a class="el" href="classRakNet_1_1RakPeerInterface.html#a21b929aba61ce69aab32871db33d6ede">DeallocatePacket()</a> to deallocate the message after you are done with it. User-thread functions, such as RPC calls and the plugin function PluginInterface::Update occur here. </p>
- <dl class="section return"><dt>Returns</dt><dd>0 if no packets are waiting to be handled, otherwise a pointer to a packet. </dd></dl>
- <dl class="section note"><dt>Note</dt><dd>COMMON MISTAKE: Be sure to call this in a loop, once per game tick, until it returns 0. If you only process one packet per game tick they will buffer up. sa <a class="el" href="RakNetTypes_8h.html" title="Types used by RakNet, most of which involve user code.">RakNetTypes.h</a> contains struct <a class="el" href="structRakNet_1_1Packet.html" title="This represents a user message from another system.">Packet</a> </dd></dl>
- <p>Implemented in <a class="el" href="classRakNet_1_1RakPeer.html#a46d90fb903e747f76d63eb3a96543740">RakNet::RakPeer</a>.</p>
- </div>
- </div>
- <a class="anchor" id="a9e18c8dae14157432ddc6f19a8114c1b"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void RakNet::RakPeerInterface::RemoveFromBanList </td>
- <td>(</td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>IP</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Allows a previously banned IP to connect. param[in] Dotted IP address. Can use * as a wildcard, such as 128.0.0.* will banAll IP addresses starting with 128.0.0 </p>
- <p>Implemented in <a class="el" href="classRakNet_1_1RakPeer.html#a86c426318efc45345df9a348ae822f34">RakNet::RakPeer</a>.</p>
- </div>
- </div>
- <a class="anchor" id="a8eba6b20dcba02453d1ed2ad77499f7d"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void RakNet::RakPeerInterface::RemoveFromSecurityExceptionList </td>
- <td>(</td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>ip</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Remove a specific connection previously added via AddToSecurityExceptionList </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">ip</td><td>IP address to remove. Pass 0 to remove all IP addresses. * wildcards are supported. </td></tr>
- </table>
- </dd>
- </dl>
- <p>Implemented in <a class="el" href="classRakNet_1_1RakPeer.html#a931823b7400d31ad641d6f6da1e69b88">RakNet::RakPeer</a>.</p>
- </div>
- </div>
- <a class="anchor" id="a543ec5be9cf5f73f5c8733d1829789f9"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual uint32_t RakNet::RakPeerInterface::Send </td>
- <td>(</td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>data</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const int </td>
- <td class="paramname"><em>length</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="PacketPriority_8h.html#a659378374e516180f93640c79f59705c">PacketPriority</a> </td>
- <td class="paramname"><em>priority</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="PacketPriority_8h.html#ae41fa01235e99dced384d137fa874a7e">PacketReliability</a> </td>
- <td class="paramname"><em>reliability</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">char </td>
- <td class="paramname"><em>orderingChannel</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const AddressOrGUID </td>
- <td class="paramname"><em>systemIdentifier</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">bool </td>
- <td class="paramname"><em>broadcast</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">uint32_t </td>
- <td class="paramname"><em>forceReceiptNumber</em> = <code>0</code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Sends a block of data to the specified system that you are connected to. This function only works while connected The first byte should be a message identifier starting at ID_USER_PACKET_ENUM </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>The block of data to send </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>The size in bytes of the data to send </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">priority</td><td>What priority level to send on. See <a class="el" href="PacketPriority_8h.html" title="This file contains enumerations for packet priority and reliability enumerations.">PacketPriority.h</a> </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">reliability</td><td>How reliability to send this data. See <a class="el" href="PacketPriority_8h.html" title="This file contains enumerations for packet priority and reliability enumerations.">PacketPriority.h</a> </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">orderingChannel</td><td>When using ordered or sequenced messages, what channel to order these on. Messages are only ordered relative to other messages on the same stream </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">systemIdentifier</td><td>Who to send this packet to, or in the case of broadcasting who not to send it to. Pass either a <a class="el" href="structRakNet_1_1SystemAddress.html" title="Network address for a system.">SystemAddress</a> structure or a <a class="el" href="structRakNet_1_1RakNetGUID.html">RakNetGUID</a> structure. Use UNASSIGNED_SYSTEM_ADDRESS or to specify none </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">broadcast</td><td>True to send this packet to all connected systems. If true, then systemAddress specifies who not to send the packet to. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">forceReceipt</td><td>If 0, will automatically determine the receipt number to return. If non-zero, will return what you give it. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>0 on bad input. Otherwise a number that identifies this message. If <em>reliability</em> is a type that returns a receipt, on a later call to <a class="el" href="classRakNet_1_1RakPeerInterface.html#a1c50453d9dee600920aeabd62ad7c119">Receive()</a> you will get ID_SND_RECEIPT_ACKED or ID_SND_RECEIPT_LOSS with bytes 1-4 inclusive containing this number </dd></dl>
- <p>Implemented in <a class="el" href="classRakNet_1_1RakPeer.html#a1ee7422f744ab606c92b4ed4b28db40e">RakNet::RakPeer</a>.</p>
- </div>
- </div>
- <a class="anchor" id="a6d9a5415556a9c138854cc05c707b8e7"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual uint32_t RakNet::RakPeerInterface::Send </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="classRakNet_1_1BitStream.html">RakNet::BitStream</a> * </td>
- <td class="paramname"><em>bitStream</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="PacketPriority_8h.html#a659378374e516180f93640c79f59705c">PacketPriority</a> </td>
- <td class="paramname"><em>priority</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="PacketPriority_8h.html#ae41fa01235e99dced384d137fa874a7e">PacketReliability</a> </td>
- <td class="paramname"><em>reliability</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">char </td>
- <td class="paramname"><em>orderingChannel</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const AddressOrGUID </td>
- <td class="paramname"><em>systemIdentifier</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">bool </td>
- <td class="paramname"><em>broadcast</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">uint32_t </td>
- <td class="paramname"><em>forceReceiptNumber</em> = <code>0</code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Sends a block of data to the specified system that you are connected to. Same as the above version, but takes a <a class="el" href="classRakNet_1_1BitStream.html">BitStream</a> as input. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">bitStream</td><td>The bitstream to send </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">priority</td><td>What priority level to send on. See <a class="el" href="PacketPriority_8h.html" title="This file contains enumerations for packet priority and reliability enumerations.">PacketPriority.h</a> </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">reliability</td><td>How reliability to send this data. See <a class="el" href="PacketPriority_8h.html" title="This file contains enumerations for packet priority and reliability enumerations.">PacketPriority.h</a> </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">orderingChannel</td><td>When using ordered or sequenced messages, what channel to order these on. Messages are only ordered relative to other messages on the same stream </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">systemIdentifier</td><td>Who to send this packet to, or in the case of broadcasting who not to send it to. Pass either a <a class="el" href="structRakNet_1_1SystemAddress.html" title="Network address for a system.">SystemAddress</a> structure or a <a class="el" href="structRakNet_1_1RakNetGUID.html">RakNetGUID</a> structure. Use UNASSIGNED_SYSTEM_ADDRESS or to specify none </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">broadcast</td><td>True to send this packet to all connected systems. If true, then systemAddress specifies who not to send the packet to. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">forceReceipt</td><td>If 0, will automatically determine the receipt number to return. If non-zero, will return what you give it. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>0 on bad input. Otherwise a number that identifies this message. If <em>reliability</em> is a type that returns a receipt, on a later call to <a class="el" href="classRakNet_1_1RakPeerInterface.html#a1c50453d9dee600920aeabd62ad7c119">Receive()</a> you will get ID_SND_RECEIPT_ACKED or ID_SND_RECEIPT_LOSS with bytes 1-4 inclusive containing this number </dd></dl>
- <dl class="section note"><dt>Note</dt><dd>COMMON MISTAKE: When writing the first byte, bitStream->Write((unsigned char) ID_MY_TYPE) be sure it is casted to a byte, and you are not writing a 4 byte enumeration. </dd></dl>
- <p>Implemented in <a class="el" href="classRakNet_1_1RakPeer.html#ac308204d9c3f5f92ac11b30f1d183d4b">RakNet::RakPeer</a>.</p>
- </div>
- </div>
- <a class="anchor" id="a508111f60de06beb55a65a2b811d557c"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual uint32_t RakNet::RakPeerInterface::SendList </td>
- <td>(</td>
- <td class="paramtype">const char ** </td>
- <td class="paramname"><em>data</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const int * </td>
- <td class="paramname"><em>lengths</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const int </td>
- <td class="paramname"><em>numParameters</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="PacketPriority_8h.html#a659378374e516180f93640c79f59705c">PacketPriority</a> </td>
- <td class="paramname"><em>priority</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="PacketPriority_8h.html#ae41fa01235e99dced384d137fa874a7e">PacketReliability</a> </td>
- <td class="paramname"><em>reliability</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">char </td>
- <td class="paramname"><em>orderingChannel</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const AddressOrGUID </td>
- <td class="paramname"><em>systemIdentifier</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">bool </td>
- <td class="paramname"><em>broadcast</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">uint32_t </td>
- <td class="paramname"><em>forceReceiptNumber</em> = <code>0</code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Sends multiple blocks of data, concatenating them automatically.</p>
- <p>This is equivalent to: <a class="el" href="classRakNet_1_1BitStream.html">RakNet::BitStream</a> bs; bs.WriteAlignedBytes(block1, blockLength1); bs.WriteAlignedBytes(block2, blockLength2); bs.WriteAlignedBytes(block3, blockLength3); Send(&bs, ...)</p>
- <p>This function only works while connected </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>An array of pointers to blocks of data </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">lengths</td><td>An array of integers indicating the length of each block of data </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">numParameters</td><td>Length of the arrays data and lengths </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">priority</td><td>What priority level to send on. See <a class="el" href="PacketPriority_8h.html" title="This file contains enumerations for packet priority and reliability enumerations.">PacketPriority.h</a> </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">reliability</td><td>How reliability to send this data. See <a class="el" href="PacketPriority_8h.html" title="This file contains enumerations for packet priority and reliability enumerations.">PacketPriority.h</a> </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">orderingChannel</td><td>When using ordered or sequenced messages, what channel to order these on. Messages are only ordered relative to other messages on the same stream </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">systemIdentifier</td><td>Who to send this packet to, or in the case of broadcasting who not to send it to. Pass either a <a class="el" href="structRakNet_1_1SystemAddress.html" title="Network address for a system.">SystemAddress</a> structure or a <a class="el" href="structRakNet_1_1RakNetGUID.html">RakNetGUID</a> structure. Use UNASSIGNED_SYSTEM_ADDRESS or to specify none </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">broadcast</td><td>True to send this packet to all connected systems. If true, then systemAddress specifies who not to send the packet to. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">forceReceipt</td><td>If 0, will automatically determine the receipt number to return. If non-zero, will return what you give it. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>0 on bad input. Otherwise a number that identifies this message. If <em>reliability</em> is a type that returns a receipt, on a later call to <a class="el" href="classRakNet_1_1RakPeerInterface.html#a1c50453d9dee600920aeabd62ad7c119">Receive()</a> you will get ID_SND_RECEIPT_ACKED or ID_SND_RECEIPT_LOSS with bytes 1-4 inclusive containing this number </dd></dl>
- <p>Implemented in <a class="el" href="classRakNet_1_1RakPeer.html#a68a9c6f4db253074f3775d164e39195f">RakNet::RakPeer</a>.</p>
- </div>
- </div>
- <a class="anchor" id="ab8e39273dd7fb89d4b29a01bca32f82c"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void RakNet::RakPeerInterface::SendLoopback </td>
- <td>(</td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>data</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const int </td>
- <td class="paramname"><em>length</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>"Send" to yourself rather than a remote system. The message will be processed through the plugins and returned to the game as usual This function works anytime The first byte should be a message identifier starting at ID_USER_PACKET_ENUM </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>The block of data to send </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>The size in bytes of the data to send </td></tr>
- </table>
- </dd>
- </dl>
- <p>Implemented in <a class="el" href="classRakNet_1_1RakPeer.html#ac3f1dcedc63156184962aa184ba69ed2">RakNet::RakPeer</a>.</p>
- </div>
- </div>
- <a class="anchor" id="a700a2c9bc1414da194a35076af3b56e0"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void RakNet::RakPeerInterface::SendTTL </td>
- <td>(</td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>host</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">unsigned short </td>
- <td class="paramname"><em>remotePort</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>ttl</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">unsigned </td>
- <td class="paramname"><em>connectionSocketIndex</em> = <code>0</code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Send a message to host, with the IP socket option TTL set to 3 This message will not reach the host, but will open the router. Used for NAT-Punchthrough </p>
- <p>Implemented in <a class="el" href="classRakNet_1_1RakPeer.html#a86b8b2a8d2e4edc2c1d89f6bde8b9f28">RakNet::RakPeer</a>.</p>
- </div>
- </div>
- <a class="anchor" id="a6b70ebc4e2852362b366e8738624ec44"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void RakNet::RakPeerInterface::SetIncomingDatagramEventHandler </td>
- <td>(</td>
- <td class="paramtype">bool(*)(RNS2RecvStruct *) </td>
- <td class="paramname"><em>_incomingDatagramEventHandler</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Set a C callback to be called whenever a datagram arrives Return true from the callback to have <a class="el" href="classRakNet_1_1RakPeer.html" title="Main interface for network communications.">RakPeer</a> handle the datagram. Return false and <a class="el" href="classRakNet_1_1RakPeer.html" title="Main interface for network communications.">RakPeer</a> will ignore the datagram. This can be used to filter incoming datagrams by system, or to share a recvfrom socket with <a class="el" href="classRakNet_1_1RakPeer.html" title="Main interface for network communications.">RakPeer</a> RNS2RecvStruct will only remain valid for the duration of the call If the incoming datagram is not from your game at all, it is a <a class="el" href="namespaceRakNet.html" title="Simple class to send changes between directories. In essence, a simple autopatcher that can be used f...">RakNet</a> packet. If the incoming datagram has an IP address that matches a known address from your game, then check the first byte of data. For <a class="el" href="namespaceRakNet.html" title="Simple class to send changes between directories. In essence, a simple autopatcher that can be used f...">RakNet</a> connected systems, the first bit is always 1. So for your own game packets, make sure the first bit is always 0. </p>
- <p>Implemented in <a class="el" href="classRakNet_1_1RakPeer.html#a959a1dc3d239d3c5114bc781144d3b73">RakNet::RakPeer</a>.</p>
- </div>
- </div>
- <a class="anchor" id="ad18a28a99420006d020125eea1ded4ed"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void RakNet::RakPeerInterface::SetIncomingPassword </td>
- <td>(</td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>passwordData</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>passwordDataLength</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Sets the password incoming connections must match in the call to Connect (defaults to none). Pass 0 to passwordData to specify no password This is a way to set a low level password for all incoming connections. To selectively reject connections, implement your own scheme using <a class="el" href="classRakNet_1_1RakPeerInterface.html#afd637c6f44cb84ce5c151c700bb5cafe">CloseConnection()</a> to remove unwanted connections </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">passwordData</td><td>A data block that incoming connections must match. This can be just a password, or can be a stream of data. Specify 0 for no password data </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">passwordDataLength</td><td>The length in bytes of passwordData </td></tr>
- </table>
- </dd>
- </dl>
- <p>Implemented in <a class="el" href="classRakNet_1_1RakPeer.html#a6d4071bbbf128604c94a27c46fa7b9ce">RakNet::RakPeer</a>.</p>
- </div>
- </div>
- <a class="anchor" id="ac9f163bc4b8b89db10c3f251793e0aca"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void RakNet::RakPeerInterface::SetInternalID </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> </td>
- <td class="paramname"><em>systemAddress</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>index</em> = <code>0</code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Sets your internal IP address, for platforms that do not support reading it, or to override a value. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">systemAddress.</td><td>The address to set. Use <a class="el" href="structRakNet_1_1SystemAddress.html#ae1ad8bd3b4f24478980437476391d6ab">SystemAddress::FromString()</a> if you want to use a dotted string </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>When you have multiple internal IDs, which index to set? </td></tr>
- </table>
- </dd>
- </dl>
- <p>Implemented in <a class="el" href="classRakNet_1_1RakPeer.html#ad02c3a4e4c4063771fb47fe20d4b47af">RakNet::RakPeer</a>.</p>
- </div>
- </div>
- <a class="anchor" id="a1c7d098a1d9a4613f051ae3627831af6"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void RakNet::RakPeerInterface::SetLimitIPConnectionFrequency </td>
- <td>(</td>
- <td class="paramtype">bool </td>
- <td class="paramname"><em>b</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Enable or disable allowing frequent connections from the same IP adderss This is a security measure which is disabled by default, but can be set to true to prevent attackers from using up all connection slots </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">b</td><td>True to limit connections from the same ip to at most 1 per 100 milliseconds. </td></tr>
- </table>
- </dd>
- </dl>
- <p>Implemented in <a class="el" href="classRakNet_1_1RakPeer.html#ac5e80ab105ac8124d4ee5f94bd1b316a">RakNet::RakPeer</a>.</p>
- </div>
- </div>
- <a class="anchor" id="a1f279ee0d3578de483126f6cfef282f4"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void RakNet::RakPeerInterface::SetMaximumIncomingConnections </td>
- <td>(</td>
- <td class="paramtype">unsigned short </td>
- <td class="paramname"><em>numberAllowed</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Sets how many incoming connections are allowed. If this is less than the number of players currently connected, no more players will be allowed to connect. If this is greater than the maximum number of peers allowed, it will be reduced to the maximum number of peers allowed. Defaults to 0, meaning by default, nobody can connect to you </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">numberAllowed</td><td>Maximum number of incoming connections allowed. </td></tr>
- </table>
- </dd>
- </dl>
- <p>Implemented in <a class="el" href="classRakNet_1_1RakPeer.html#a8ed81856dd81ec1cd00e17fafedee0a7">RakNet::RakPeer</a>.</p>
- </div>
- </div>
- <a class="anchor" id="afdc6e658512d2f01d6bb211758721f21"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void RakNet::RakPeerInterface::SetOccasionalPing </td>
- <td>(</td>
- <td class="paramtype">bool </td>
- <td class="paramname"><em>doPing</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Ping the remote systems every so often, or not. Can be called anytime. By default this is true. Recommended to leave on, because congestion control uses it to determine how often to resend lost packets. It would be true by default to prevent timestamp drift, since in the event of a clock spike, the timestamp deltas would no longer be accurate </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">doPing</td><td>True to start occasional pings. False to stop them. </td></tr>
- </table>
- </dd>
- </dl>
- <p>Implemented in <a class="el" href="classRakNet_1_1RakPeer.html#abb8d47e41f9bc523a555d8f1bc774e4a">RakNet::RakPeer</a>.</p>
- </div>
- </div>
- <a class="anchor" id="a40b198325a1a4f4a1ff3b1a1741b89eb"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void RakNet::RakPeerInterface::SetOfflinePingResponse </td>
- <td>(</td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>data</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const unsigned int </td>
- <td class="paramname"><em>length</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Sets the data to send along with a LAN server discovery or offline ping reply. <em>length</em> should be under 400 bytes, as a security measure against flood attacks </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>a block of data to store, or 0 for none </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>The length of data in bytes, or 0 for none </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section see"><dt>See Also</dt><dd>Ping.cpp </dd></dl>
- <p>Implemented in <a class="el" href="classRakNet_1_1RakPeer.html#a2a534f1c0bb56b3c5b9b56ca8839917c">RakNet::RakPeer</a>.</p>
- </div>
- </div>
- <a class="anchor" id="a95daeb743853a4406182e47668c0f33b"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void RakNet::RakPeerInterface::SetPerConnectionOutgoingBandwidthLimit </td>
- <td>(</td>
- <td class="paramtype">unsigned </td>
- <td class="paramname"><em>maxBitsPerSecond</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Limits how much outgoing bandwidth can be sent per-connection. This limit does not apply to the sum of all connections! Exceeding the limit queues up outgoing traffic </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">maxBitsPerSecond</td><td>Maximum bits per second to send. Use 0 for unlimited (default). Once set, it takes effect immedately and persists until called again. </td></tr>
- </table>
- </dd>
- </dl>
- <p>Implemented in <a class="el" href="classRakNet_1_1RakPeer.html#a9c67c61c6eebed7a4ed8bc2ea2813b56">RakNet::RakPeer</a>.</p>
- </div>
- </div>
- <a class="anchor" id="a4112544503b05a7b7dd2dd56adfbc648"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void RakNet::RakPeerInterface::SetSplitMessageProgressInterval </td>
- <td>(</td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>interval</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Controls how often to return ID_DOWNLOAD_PROGRESS for large message downloads. ID_DOWNLOAD_PROGRESS is returned to indicate a new partial message chunk, roughly the MTU size, has arrived As it can be slow or cumbersome to get this notification for every chunk, you can set the interval at which it is returned. Defaults to 0 (never return this notification) </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">interval</td><td>How many messages to use as an interval </td></tr>
- </table>
- </dd>
- </dl>
- <p>Implemented in <a class="el" href="classRakNet_1_1RakPeer.html#a35e89d9813d6f6e7f2144a6a0437a33b">RakNet::RakPeer</a>.</p>
- </div>
- </div>
- <a class="anchor" id="a49d2993d5db12a62ce88dc89700c0880"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void RakNet::RakPeerInterface::SetTimeoutTime </td>
- <td>(</td>
- <td class="paramtype">RakNet::TimeMS </td>
- <td class="paramname"><em>timeMS</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> </td>
- <td class="paramname"><em>target</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Set the time, in MS, to use before considering ourselves disconnected after not being able to deliver a reliable message. Default time is 10,000 or 10 seconds in release and 30,000 or 30 seconds in debug. Do not set different values for different computers that are connected to each other, or you won't be able to reconnect after ID_CONNECTION_LOST </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">timeMS</td><td>Time, in MS </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">target</td><td>Which system to do this for. Pass UNASSIGNED_SYSTEM_ADDRESS for all systems. </td></tr>
- </table>
- </dd>
- </dl>
- <p>Implemented in <a class="el" href="classRakNet_1_1RakPeer.html#a46305b16342c6f5ec1c1a66623032310">RakNet::RakPeer</a>.</p>
- </div>
- </div>
- <a class="anchor" id="a87db4b6410fce078080400f8d58328ed"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void RakNet::RakPeerInterface::SetUnreliableTimeout </td>
- <td>(</td>
- <td class="paramtype">RakNet::TimeMS </td>
- <td class="paramname"><em>timeoutMS</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Set how long to wait before giving up on sending an unreliable message Useful if the network is clogged up. Set to 0 or less to never timeout. Defaults to 0. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">timeoutMS</td><td>How many ms to wait before simply not sending an unreliable message. </td></tr>
- </table>
- </dd>
- </dl>
- <p>Implemented in <a class="el" href="classRakNet_1_1RakPeer.html#a739faf1ea8c90aded5e11bfc105b956e">RakNet::RakPeer</a>.</p>
- </div>
- </div>
- <a class="anchor" id="a0832004c529aa9a0844b61eaf1374b3c"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void RakNet::RakPeerInterface::SetUserUpdateThread </td>
- <td>(</td>
- <td class="paramtype">void(*)(<a class="el" href="classRakNet_1_1RakPeerInterface.html">RakPeerInterface</a> *, void *) </td>
- <td class="paramname"><em>_userUpdateThreadPtr</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">void * </td>
- <td class="paramname"><em>_userUpdateThreadData</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>If you need code to run in the same thread as <a class="el" href="namespaceRakNet.html" title="Simple class to send changes between directories. In essence, a simple autopatcher that can be used f...">RakNet</a>'s update thread, this function can be used for that </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">_userUpdateThreadPtr</td><td>C callback function </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">_userUpdateThreadData</td><td>Passed to C callback function </td></tr>
- </table>
- </dd>
- </dl>
- <p>Implemented in <a class="el" href="classRakNet_1_1RakPeer.html#a21f59d33d16332dd8dd96d800c33d06e">RakNet::RakPeer</a>.</p>
- </div>
- </div>
- <a class="anchor" id="a4f4acefdc022555862fd386e31f9a22b"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void RakNet::RakPeerInterface::Shutdown </td>
- <td>(</td>
- <td class="paramtype">unsigned int </td>
- <td class="paramname"><em>blockDuration</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">unsigned char </td>
- <td class="paramname"><em>orderingChannel</em> = <code>0</code>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="PacketPriority_8h.html#a659378374e516180f93640c79f59705c">PacketPriority</a> </td>
- <td class="paramname"><em>disconnectionNotificationPriority</em> = <code><a class="el" href="PacketPriority_8h.html#a659378374e516180f93640c79f59705cadb8ee22a232a2787f32ba28da55c43c1">LOW_PRIORITY</a></code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Connect to the specified network ID (Platform specific console function) </p>
- <p>Does built-in NAt traversal </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">passwordData</td><td>A data block that must match the data block on the server passed to SetIncomingPassword. This can be a string or can be a stream of data. Use 0 for no password. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">passwordDataLength</td><td>The length in bytes of passwordData Stops the network threads and closes all connections. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">blockDuration</td><td>How long, in milliseconds, you should wait for all remaining messages to go out, including ID_DISCONNECTION_NOTIFICATION. If 0, it doesn't wait at all. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">orderingChannel</td><td>If blockDuration > 0, ID_DISCONNECTION_NOTIFICATION will be sent on this channel </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">disconnectionNotificationPriority</td><td>Priority to send ID_DISCONNECTION_NOTIFICATION on. If you set it to 0 then the disconnection notification won't be sent </td></tr>
- </table>
- </dd>
- </dl>
- <p>Implemented in <a class="el" href="classRakNet_1_1RakPeer.html#a0a6d4c16c9b489574393a39ab2f99990">RakNet::RakPeer</a>.</p>
- </div>
- </div>
- <a class="anchor" id="ad360d12ceb7d7448b598c451fffd2d9c"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual StartupResult RakNet::RakPeerInterface::Startup </td>
- <td>(</td>
- <td class="paramtype">unsigned int </td>
- <td class="paramname"><em>maxConnections</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="structRakNet_1_1SocketDescriptor.html">SocketDescriptor</a> * </td>
- <td class="paramname"><em>socketDescriptors</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">unsigned </td>
- <td class="paramname"><em>socketDescriptorCount</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>threadPriority</em> = <code>-99999</code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Starts the network threads, opens the listen port. </p>
- <p>You must call this before calling <a class="el" href="classRakNet_1_1RakPeerInterface.html#a451dd5d225277fe5806d3d700551fb76" title="Connect to the specified host (ip or domain name) and server port. Calling Connect and not calling Se...">Connect()</a>. </p>
- <dl class="section pre"><dt>Precondition</dt><dd>On the PS3, call <a class="el" href="classRakNet_1_1RakPeerInterface.html#ad360d12ceb7d7448b598c451fffd2d9c" title="Starts the network threads, opens the listen port.">Startup()</a> after Client_Login() </dd>
- <dd>
- On Android, add the necessary permission to your application's androidmanifest.xml: <uses-permission android:name="android.permission.INTERNET" /> Multiple calls while already active are ignored. To call this function again with different settings, you must first call <a class="el" href="classRakNet_1_1RakPeerInterface.html#a4f4acefdc022555862fd386e31f9a22b" title="Connect to the specified network ID (Platform specific console function)">Shutdown()</a>. </dd></dl>
- <dl class="section note"><dt>Note</dt><dd>Call SetMaximumIncomingConnections if you want to accept incoming connections </dd></dl>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">maxConnections</td><td>The maximum number of connections between this instance of <a class="el" href="classRakNet_1_1RakPeer.html" title="Main interface for network communications.">RakPeer</a> and another instance of <a class="el" href="classRakNet_1_1RakPeer.html" title="Main interface for network communications.">RakPeer</a>. Required so the network can preallocate and for thread safety. A pure client would set this to 1. A pure server would set it to the number of allowed clients.- A hybrid would set it to the sum of both types of connections </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">localPort</td><td>The port to listen for connections on. On linux the system may be set up so thast ports under 1024 are restricted for everything but the root user. Use a higher port for maximum compatibility. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">socketDescriptors</td><td>An array of <a class="el" href="structRakNet_1_1SocketDescriptor.html" title="Describes the local socket to use for RakPeer::Startup.">SocketDescriptor</a> structures to force <a class="el" href="namespaceRakNet.html" title="Simple class to send changes between directories. In essence, a simple autopatcher that can be used f...">RakNet</a> to listen on a particular IP address or port (or both). Each <a class="el" href="structRakNet_1_1SocketDescriptor.html" title="Describes the local socket to use for RakPeer::Startup.">SocketDescriptor</a> will represent one unique socket. Do not pass redundant structures. To listen on a specific port, you can pass SocketDescriptor(myPort,0); such as for a server. For a client, it is usually OK to just pass SocketDescriptor(); However, on the XBOX be sure to use IPPROTO_VDP </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">socketDescriptorCount</td><td>The size of the <em>socketDescriptors</em> array. Pass 1 if you are not sure what to pass. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">threadPriority</td><td>Passed to the thread creation routine. Use THREAD_PRIORITY_NORMAL for Windows. For Linux based systems, you MUST pass something reasonable based on the thread priorities for your application. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>RAKNET_STARTED on success, otherwise appropriate failure enumeration. </dd></dl>
- <p>Implemented in <a class="el" href="classRakNet_1_1RakPeer.html#a92d493cb617381a6e750f7df6e768927">RakNet::RakPeer</a>.</p>
- </div>
- </div>
- <hr/>The documentation for this class was generated from the following file:<ul>
- <li>D:/temp/RakNet_PC/Source/<a class="el" href="RakPeerInterface_8h.html">RakPeerInterface.h</a></li>
- </ul>
- </div><!-- contents -->
- <!-- start footer part -->
- <hr class="footer"/><address class="footer"><small>
- Generated on Mon Jun 2 2014 20:10:29 for RakNet by  <a href="http://www.doxygen.org/index.html">
- <img class="footer" src="doxygen.png" alt="doxygen"/>
- </a> 1.8.2
- </small></address>
- </body>
- </html>
|