SuperSocket.SocketBase.xml 236 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>SuperSocket.SocketBase</name>
  5. </assembly>
  6. <members>
  7. <member name="T:SuperSocket.SocketBase.AppServerBase`2">
  8. <summary>
  9. AppServer base class
  10. </summary>
  11. <typeparam name="TAppSession">The type of the app session.</typeparam>
  12. <typeparam name="TRequestInfo">The type of the request info.</typeparam>
  13. </member>
  14. <member name="T:SuperSocket.SocketBase.IAppServer`2">
  15. <summary>
  16. The interface for AppServer
  17. </summary>
  18. <typeparam name="TAppSession">The type of the app session.</typeparam>
  19. <typeparam name="TRequestInfo">The type of the request info.</typeparam>
  20. </member>
  21. <member name="T:SuperSocket.SocketBase.IAppServer`1">
  22. <summary>
  23. The interface for AppServer
  24. </summary>
  25. <typeparam name="TAppSession">The type of the app session.</typeparam>
  26. </member>
  27. <member name="T:SuperSocket.SocketBase.IAppServer">
  28. <summary>
  29. The interface for AppServer
  30. </summary>
  31. </member>
  32. <member name="T:SuperSocket.SocketBase.IWorkItem">
  33. <summary>
  34. An item can be started and stopped
  35. </summary>
  36. </member>
  37. <member name="T:SuperSocket.SocketBase.IWorkItemBase">
  38. <summary>
  39. An item can be started and stopped
  40. </summary>
  41. </member>
  42. <member name="T:SuperSocket.SocketBase.IStatusInfoSource">
  43. <summary>
  44. StatusInfo source interface
  45. </summary>
  46. </member>
  47. <member name="M:SuperSocket.SocketBase.IStatusInfoSource.GetServerStatusMetadata">
  48. <summary>
  49. Gets the server status metadata.
  50. </summary>
  51. <returns></returns>
  52. </member>
  53. <member name="M:SuperSocket.SocketBase.IStatusInfoSource.CollectServerStatus(SuperSocket.SocketBase.StatusInfoCollection)">
  54. <summary>
  55. Collects the bootstrap status.
  56. </summary>
  57. <param name="bootstrapStatus">The bootstrap status.</param>
  58. <returns></returns>
  59. </member>
  60. <member name="T:SuperSocket.SocketBase.ISystemEndPoint">
  61. <summary>
  62. The interface for endpoint who can send/receive system message with each other
  63. </summary>
  64. </member>
  65. <member name="M:SuperSocket.SocketBase.ISystemEndPoint.TransferSystemMessage(System.String,System.Object)">
  66. <summary>
  67. Transfers the system message.
  68. </summary>
  69. <param name="messageType">Type of the message.</param>
  70. <param name="messageData">The message data.</param>
  71. </member>
  72. <member name="M:SuperSocket.SocketBase.IWorkItemBase.Start">
  73. <summary>
  74. Starts this server instance.
  75. </summary>
  76. <returns>return true if start successfull, else false</returns>
  77. </member>
  78. <member name="M:SuperSocket.SocketBase.IWorkItemBase.ReportPotentialConfigChange(SuperSocket.SocketBase.Config.IServerConfig)">
  79. <summary>
  80. Reports the potential configuration change.
  81. </summary>
  82. <param name="config">The server config which may be changed.</param>
  83. </member>
  84. <member name="M:SuperSocket.SocketBase.IWorkItemBase.Stop">
  85. <summary>
  86. Stops this server instance.
  87. </summary>
  88. </member>
  89. <member name="P:SuperSocket.SocketBase.IWorkItemBase.Name">
  90. <summary>
  91. Gets the name.
  92. </summary>
  93. </member>
  94. <member name="P:SuperSocket.SocketBase.IWorkItemBase.Config">
  95. <summary>
  96. Gets the server's config.
  97. </summary>
  98. <value>
  99. The server's config.
  100. </value>
  101. </member>
  102. <member name="P:SuperSocket.SocketBase.IWorkItemBase.SessionCount">
  103. <summary>
  104. Gets the total session count.
  105. </summary>
  106. </member>
  107. <member name="M:SuperSocket.SocketBase.IWorkItem.Setup(SuperSocket.SocketBase.IBootstrap,SuperSocket.SocketBase.Config.IServerConfig,SuperSocket.SocketBase.Provider.ProviderFactoryInfo[])">
  108. <summary>
  109. Setups with the specified root config.
  110. </summary>
  111. <param name="bootstrap">The bootstrap.</param>
  112. <param name="config">The socket server instance config.</param>
  113. <param name="factories">The factories.</param>
  114. <returns></returns>
  115. </member>
  116. <member name="P:SuperSocket.SocketBase.IWorkItem.State">
  117. <summary>
  118. Gets the current state of the work item.
  119. </summary>
  120. <value>
  121. The state.
  122. </value>
  123. </member>
  124. <member name="T:SuperSocket.SocketBase.ILoggerProvider">
  125. <summary>
  126. The interface for who provides logger
  127. </summary>
  128. </member>
  129. <member name="P:SuperSocket.SocketBase.ILoggerProvider.Logger">
  130. <summary>
  131. Gets the logger assosiated with this object.
  132. </summary>
  133. </member>
  134. <member name="M:SuperSocket.SocketBase.IAppServer.CreateAppSession(SuperSocket.SocketBase.ISocketSession)">
  135. <summary>
  136. Creates the app session.
  137. </summary>
  138. <param name="socketSession">The socket session.</param>
  139. <returns></returns>
  140. </member>
  141. <member name="M:SuperSocket.SocketBase.IAppServer.RegisterSession(SuperSocket.SocketBase.IAppSession)">
  142. <summary>
  143. Registers the new created app session into the appserver's session container.
  144. </summary>
  145. <param name="session">The session.</param>
  146. <returns></returns>
  147. </member>
  148. <member name="M:SuperSocket.SocketBase.IAppServer.GetSessionByID(System.String)">
  149. <summary>
  150. Gets the app session by ID.
  151. </summary>
  152. <param name="sessionID">The session ID.</param>
  153. <returns></returns>
  154. </member>
  155. <member name="M:SuperSocket.SocketBase.IAppServer.ResetSessionSecurity(SuperSocket.SocketBase.IAppSession,System.Security.Authentication.SslProtocols)">
  156. <summary>
  157. Resets the session's security protocol.
  158. </summary>
  159. <param name="session">The session.</param>
  160. <param name="security">The security protocol.</param>
  161. </member>
  162. <member name="P:SuperSocket.SocketBase.IAppServer.StartedTime">
  163. <summary>
  164. Gets the started time.
  165. </summary>
  166. <value>
  167. The started time.
  168. </value>
  169. </member>
  170. <member name="P:SuperSocket.SocketBase.IAppServer.Listeners">
  171. <summary>
  172. Gets or sets the listeners.
  173. </summary>
  174. <value>
  175. The listeners.
  176. </value>
  177. </member>
  178. <member name="P:SuperSocket.SocketBase.IAppServer.ReceiveFilterFactory">
  179. <summary>
  180. Gets the Receive filter factory.
  181. </summary>
  182. </member>
  183. <member name="P:SuperSocket.SocketBase.IAppServer.Certificate">
  184. <summary>
  185. Gets the certificate of current server.
  186. </summary>
  187. </member>
  188. <member name="P:SuperSocket.SocketBase.IAppServer.BasicSecurity">
  189. <summary>
  190. Gets the transfer layer security protocol.
  191. </summary>
  192. </member>
  193. <member name="P:SuperSocket.SocketBase.IAppServer.LogFactory">
  194. <summary>
  195. Gets the log factory.
  196. </summary>
  197. </member>
  198. <member name="M:SuperSocket.SocketBase.IAppServer`1.GetSessions(System.Func{`0,System.Boolean})">
  199. <summary>
  200. Gets the matched sessions from sessions snapshot.
  201. </summary>
  202. <param name="critera">The prediction critera.</param>
  203. <returns></returns>
  204. </member>
  205. <member name="M:SuperSocket.SocketBase.IAppServer`1.GetAllSessions">
  206. <summary>
  207. Gets all sessions in sessions snapshot.
  208. </summary>
  209. <returns></returns>
  210. </member>
  211. <member name="E:SuperSocket.SocketBase.IAppServer`1.NewSessionConnected">
  212. <summary>
  213. Gets/sets the new session connected event handler.
  214. </summary>
  215. </member>
  216. <member name="E:SuperSocket.SocketBase.IAppServer`1.SessionClosed">
  217. <summary>
  218. Gets/sets the session closed event handler.
  219. </summary>
  220. </member>
  221. <member name="E:SuperSocket.SocketBase.IAppServer`2.NewRequestReceived">
  222. <summary>
  223. Occurs when [request comming].
  224. </summary>
  225. </member>
  226. <member name="T:SuperSocket.SocketBase.IRawDataProcessor`1">
  227. <summary>
  228. The raw data processor
  229. </summary>
  230. <typeparam name="TAppSession">The type of the app session.</typeparam>
  231. </member>
  232. <member name="E:SuperSocket.SocketBase.IRawDataProcessor`1.RawDataReceived">
  233. <summary>
  234. Gets or sets the raw binary data received event handler.
  235. TAppSession: session
  236. byte[]: receive buffer
  237. int: receive buffer offset
  238. int: receive lenght
  239. bool: whether process the received data further
  240. </summary>
  241. </member>
  242. <member name="T:SuperSocket.SocketBase.IRequestHandler`1">
  243. <summary>
  244. The interface for handler of session request
  245. </summary>
  246. <typeparam name="TRequestInfo">The type of the request info.</typeparam>
  247. </member>
  248. <member name="M:SuperSocket.SocketBase.IRequestHandler`1.ExecuteCommand(SuperSocket.SocketBase.IAppSession,`0)">
  249. <summary>
  250. Executes the command.
  251. </summary>
  252. <param name="session">The session.</param>
  253. <param name="requestInfo">The request info.</param>
  254. </member>
  255. <member name="T:SuperSocket.SocketBase.ISocketServerAccessor">
  256. <summary>
  257. SocketServer Accessor interface
  258. </summary>
  259. </member>
  260. <member name="P:SuperSocket.SocketBase.ISocketServerAccessor.SocketServer">
  261. <summary>
  262. Gets the socket server.
  263. </summary>
  264. <value>
  265. The socket server.
  266. </value>
  267. </member>
  268. <member name="T:SuperSocket.SocketBase.IRemoteCertificateValidator">
  269. <summary>
  270. The basic interface for RemoteCertificateValidator
  271. </summary>
  272. </member>
  273. <member name="M:SuperSocket.SocketBase.IRemoteCertificateValidator.Validate(SuperSocket.SocketBase.IAppSession,System.Object,System.Security.Cryptography.X509Certificates.X509Certificate,System.Security.Cryptography.X509Certificates.X509Chain,System.Net.Security.SslPolicyErrors)">
  274. <summary>
  275. Validates the remote certificate
  276. </summary>
  277. <param name="session">The session.</param>
  278. <param name="sender">The sender.</param>
  279. <param name="certificate">The certificate.</param>
  280. <param name="chain">The chain.</param>
  281. <param name="sslPolicyErrors">The SSL policy errors.</param>
  282. <returns></returns>
  283. </member>
  284. <member name="T:SuperSocket.SocketBase.IActiveConnector">
  285. <summary>
  286. The inerface to connect the remote endpoint actively
  287. </summary>
  288. </member>
  289. <member name="M:SuperSocket.SocketBase.IActiveConnector.ActiveConnect(System.Net.EndPoint)">
  290. <summary>
  291. Connect the target endpoint actively.
  292. </summary>
  293. <param name="targetEndPoint">The target end point.</param>
  294. <returns></returns>
  295. </member>
  296. <member name="M:SuperSocket.SocketBase.IActiveConnector.ActiveConnect(System.Net.EndPoint,System.Net.EndPoint)">
  297. <summary>
  298. Connect the target endpoint actively.
  299. </summary>
  300. <param name="targetEndPoint">The target end point.</param>
  301. <param name="localEndPoint">The local end point.</param>
  302. <returns></returns>
  303. </member>
  304. <member name="M:SuperSocket.SocketBase.AppServerBase`2.RegisterConfigHandler``1(SuperSocket.SocketBase.Config.IServerConfig,System.String,System.Func{``0,System.Boolean})">
  305. <summary>
  306. Registers the configuration option value handler, it is used for reading configuration value and reload it after the configuration is changed;
  307. </summary>
  308. <typeparam name="TConfigOption">The type of the configuration option.</typeparam>
  309. <param name="config">The server configuration.</param>
  310. <param name="name">The changed config option's name.</param>
  311. <param name="handler">The handler.</param>
  312. </member>
  313. <member name="M:SuperSocket.SocketBase.AppServerBase`2.RegisterConfigHandler(SuperSocket.SocketBase.Config.IServerConfig,System.String,System.Func{System.String,System.Boolean})">
  314. <summary>
  315. Registers the configuration option value handler, it is used for reading configuration value and reload it after the configuration is changed;
  316. </summary>
  317. <param name="config">The server configuration.</param>
  318. <param name="name">The changed config option name.</param>
  319. <param name="handler">The handler.</param>
  320. </member>
  321. <member name="F:SuperSocket.SocketBase.AppServerBase`2.NullAppSession">
  322. <summary>
  323. Null appSession instance
  324. </summary>
  325. </member>
  326. <member name="F:SuperSocket.SocketBase.AppServerBase`2.m_StateCode">
  327. <summary>
  328. the current state's code
  329. </summary>
  330. </member>
  331. <member name="M:SuperSocket.SocketBase.AppServerBase`2.#ctor">
  332. <summary>
  333. Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.AppServerBase`2"/> class.
  334. </summary>
  335. </member>
  336. <member name="M:SuperSocket.SocketBase.AppServerBase`2.#ctor(SuperSocket.SocketBase.Protocol.IReceiveFilterFactory{`1})">
  337. <summary>
  338. Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.AppServerBase`2"/> class.
  339. </summary>
  340. <param name="receiveFilterFactory">The Receive filter factory.</param>
  341. </member>
  342. <member name="M:SuperSocket.SocketBase.AppServerBase`2.GetCommandFilterAttributes(System.Type)">
  343. <summary>
  344. Gets the filter attributes.
  345. </summary>
  346. <param name="type">The type.</param>
  347. <returns></returns>
  348. </member>
  349. <member name="M:SuperSocket.SocketBase.AppServerBase`2.SetupCommands(System.Collections.Generic.Dictionary{System.String,SuperSocket.SocketBase.Command.ICommand{`0,`1}})">
  350. <summary>
  351. Setups the command into command dictionary
  352. </summary>
  353. <param name="discoveredCommands">The discovered commands.</param>
  354. <returns></returns>
  355. </member>
  356. <member name="M:SuperSocket.SocketBase.AppServerBase`2.Setup(SuperSocket.SocketBase.Config.IRootConfig,SuperSocket.SocketBase.Config.IServerConfig)">
  357. <summary>
  358. Setups the specified root config.
  359. </summary>
  360. <param name="rootConfig">The root config.</param>
  361. <param name="config">The config.</param>
  362. <returns></returns>
  363. </member>
  364. <member name="M:SuperSocket.SocketBase.AppServerBase`2.Setup(System.Int32)">
  365. <summary>
  366. Setups with the specified port.
  367. </summary>
  368. <param name="port">The port.</param>
  369. <returns>return setup result</returns>
  370. </member>
  371. <member name="M:SuperSocket.SocketBase.AppServerBase`2.Setup(SuperSocket.SocketBase.Config.IServerConfig,SuperSocket.SocketBase.ISocketServerFactory,SuperSocket.SocketBase.Protocol.IReceiveFilterFactory{`1},SuperSocket.SocketBase.Logging.ILogFactory,System.Collections.Generic.IEnumerable{SuperSocket.SocketBase.IConnectionFilter},System.Collections.Generic.IEnumerable{SuperSocket.SocketBase.Command.ICommandLoader{SuperSocket.SocketBase.Command.ICommand{`0,`1}}})">
  372. <summary>
  373. Setups with the specified config.
  374. </summary>
  375. <param name="config">The server config.</param>
  376. <param name="socketServerFactory">The socket server factory.</param>
  377. <param name="receiveFilterFactory">The receive filter factory.</param>
  378. <param name="logFactory">The log factory.</param>
  379. <param name="connectionFilters">The connection filters.</param>
  380. <param name="commandLoaders">The command loaders.</param>
  381. <returns></returns>
  382. </member>
  383. <member name="M:SuperSocket.SocketBase.AppServerBase`2.Setup(SuperSocket.SocketBase.Config.IRootConfig,SuperSocket.SocketBase.Config.IServerConfig,SuperSocket.SocketBase.ISocketServerFactory,SuperSocket.SocketBase.Protocol.IReceiveFilterFactory{`1},SuperSocket.SocketBase.Logging.ILogFactory,System.Collections.Generic.IEnumerable{SuperSocket.SocketBase.IConnectionFilter},System.Collections.Generic.IEnumerable{SuperSocket.SocketBase.Command.ICommandLoader{SuperSocket.SocketBase.Command.ICommand{`0,`1}}})">
  384. <summary>
  385. Setups the specified root config, this method used for programming setup
  386. </summary>
  387. <param name="rootConfig">The root config.</param>
  388. <param name="config">The server config.</param>
  389. <param name="socketServerFactory">The socket server factory.</param>
  390. <param name="receiveFilterFactory">The Receive filter factory.</param>
  391. <param name="logFactory">The log factory.</param>
  392. <param name="connectionFilters">The connection filters.</param>
  393. <param name="commandLoaders">The command loaders.</param>
  394. <returns></returns>
  395. </member>
  396. <member name="M:SuperSocket.SocketBase.AppServerBase`2.Setup(System.String,System.Int32,SuperSocket.SocketBase.ISocketServerFactory,SuperSocket.SocketBase.Protocol.IReceiveFilterFactory{`1},SuperSocket.SocketBase.Logging.ILogFactory,System.Collections.Generic.IEnumerable{SuperSocket.SocketBase.IConnectionFilter},System.Collections.Generic.IEnumerable{SuperSocket.SocketBase.Command.ICommandLoader{SuperSocket.SocketBase.Command.ICommand{`0,`1}}})">
  397. <summary>
  398. Setups with the specified ip and port.
  399. </summary>
  400. <param name="ip">The ip.</param>
  401. <param name="port">The port.</param>
  402. <param name="socketServerFactory">The socket server factory.</param>
  403. <param name="receiveFilterFactory">The Receive filter factory.</param>
  404. <param name="logFactory">The log factory.</param>
  405. <param name="connectionFilters">The connection filters.</param>
  406. <param name="commandLoaders">The command loaders.</param>
  407. <returns>return setup result</returns>
  408. </member>
  409. <member name="M:SuperSocket.SocketBase.AppServerBase`2.SuperSocket#SocketBase#IWorkItem#Setup(SuperSocket.SocketBase.IBootstrap,SuperSocket.SocketBase.Config.IServerConfig,SuperSocket.SocketBase.Provider.ProviderFactoryInfo[])">
  410. <summary>
  411. Setups the specified root config.
  412. </summary>
  413. <param name="bootstrap">The bootstrap.</param>
  414. <param name="config">The socket server instance config.</param>
  415. <param name="factories">The factories.</param>
  416. <returns></returns>
  417. </member>
  418. <member name="M:SuperSocket.SocketBase.AppServerBase`2.SetupCommandLoaders(System.Collections.Generic.List{SuperSocket.SocketBase.Command.ICommandLoader{SuperSocket.SocketBase.Command.ICommand{`0,`1}}})">
  419. <summary>
  420. Setups the command loaders.
  421. </summary>
  422. <param name="commandLoaders">The command loaders.</param>
  423. <returns></returns>
  424. </member>
  425. <member name="M:SuperSocket.SocketBase.AppServerBase`2.CreateLogger(System.String)">
  426. <summary>
  427. Creates the logger for the AppServer.
  428. </summary>
  429. <param name="loggerName">Name of the logger.</param>
  430. <returns></returns>
  431. </member>
  432. <member name="M:SuperSocket.SocketBase.AppServerBase`2.SetupSecurity(SuperSocket.SocketBase.Config.IServerConfig)">
  433. <summary>
  434. Setups the security option of socket communications.
  435. </summary>
  436. <param name="config">The config of the server instance.</param>
  437. <returns></returns>
  438. </member>
  439. <member name="M:SuperSocket.SocketBase.AppServerBase`2.GetCertificate(SuperSocket.SocketBase.Config.ICertificateConfig)">
  440. <summary>
  441. Gets the certificate from server configuguration.
  442. </summary>
  443. <param name="certificate">The certificate config.</param>
  444. <returns></returns>
  445. </member>
  446. <member name="M:SuperSocket.SocketBase.AppServerBase`2.ValidateClientCertificate(`0,System.Object,System.Security.Cryptography.X509Certificates.X509Certificate,System.Security.Cryptography.X509Certificates.X509Chain,System.Net.Security.SslPolicyErrors)">
  447. <summary>
  448. Validates the client certificate. This method is only used if the certificate configuration attribute "clientCertificateRequired" is true.
  449. </summary>
  450. <param name="session">The session.</param>
  451. <param name="sender">The sender.</param>
  452. <param name="certificate">The certificate.</param>
  453. <param name="chain">The chain.</param>
  454. <param name="sslPolicyErrors">The SSL policy errors.</param>
  455. <returns>return the validation result</returns>
  456. </member>
  457. <member name="M:SuperSocket.SocketBase.AppServerBase`2.SetupSocketServer">
  458. <summary>
  459. Setups the socket server.instance
  460. </summary>
  461. <returns></returns>
  462. </member>
  463. <member name="M:SuperSocket.SocketBase.AppServerBase`2.SetupListeners(SuperSocket.SocketBase.Config.IServerConfig)">
  464. <summary>
  465. Setups the listeners base on server configuration
  466. </summary>
  467. <param name="config">The config.</param>
  468. <returns></returns>
  469. </member>
  470. <member name="M:SuperSocket.SocketBase.AppServerBase`2.Start">
  471. <summary>
  472. Starts this server instance.
  473. </summary>
  474. <returns>
  475. return true if start successfull, else false
  476. </returns>
  477. </member>
  478. <member name="M:SuperSocket.SocketBase.AppServerBase`2.OnStartup">
  479. <summary>
  480. Called when [startup].
  481. </summary>
  482. </member>
  483. <member name="M:SuperSocket.SocketBase.AppServerBase`2.OnStarted">
  484. <summary>
  485. Called when [started].
  486. </summary>
  487. </member>
  488. <member name="M:SuperSocket.SocketBase.AppServerBase`2.OnStopped">
  489. <summary>
  490. Called when [stopped].
  491. </summary>
  492. </member>
  493. <member name="M:SuperSocket.SocketBase.AppServerBase`2.Stop">
  494. <summary>
  495. Stops this server instance.
  496. </summary>
  497. </member>
  498. <member name="M:SuperSocket.SocketBase.AppServerBase`2.GetCommandByName(System.String)">
  499. <summary>
  500. Gets command by command name.
  501. </summary>
  502. <param name="commandName">Name of the command.</param>
  503. <returns></returns>
  504. </member>
  505. <member name="M:SuperSocket.SocketBase.AppServerBase`2.OnRawDataReceived(SuperSocket.SocketBase.IAppSession,System.Byte[],System.Int32,System.Int32)">
  506. <summary>
  507. Called when [raw data received].
  508. </summary>
  509. <param name="session">The session.</param>
  510. <param name="buffer">The buffer.</param>
  511. <param name="offset">The offset.</param>
  512. <param name="length">The length.</param>
  513. </member>
  514. <member name="M:SuperSocket.SocketBase.AppServerBase`2.ExecuteCommand(`0,`1)">
  515. <summary>
  516. Executes the command.
  517. </summary>
  518. <param name="session">The session.</param>
  519. <param name="requestInfo">The request info.</param>
  520. </member>
  521. <member name="M:SuperSocket.SocketBase.AppServerBase`2.ExecuteCommand(SuperSocket.SocketBase.IAppSession,`1)">
  522. <summary>
  523. Executes the command for the session.
  524. </summary>
  525. <param name="session">The session.</param>
  526. <param name="requestInfo">The request info.</param>
  527. </member>
  528. <member name="M:SuperSocket.SocketBase.AppServerBase`2.SuperSocket#SocketBase#IRequestHandler{TRequestInfo}#ExecuteCommand(SuperSocket.SocketBase.IAppSession,`1)">
  529. <summary>
  530. Executes the command.
  531. </summary>
  532. <param name="session">The session.</param>
  533. <param name="requestInfo">The request info.</param>
  534. </member>
  535. <member name="M:SuperSocket.SocketBase.AppServerBase`2.ExecuteConnectionFilters(System.Net.IPEndPoint)">
  536. <summary>
  537. Executes the connection filters.
  538. </summary>
  539. <param name="remoteAddress">The remote address.</param>
  540. <returns></returns>
  541. </member>
  542. <member name="M:SuperSocket.SocketBase.AppServerBase`2.SuperSocket#SocketBase#IAppServer#CreateAppSession(SuperSocket.SocketBase.ISocketSession)">
  543. <summary>
  544. Creates the app session.
  545. </summary>
  546. <param name="socketSession">The socket session.</param>
  547. <returns></returns>
  548. </member>
  549. <member name="M:SuperSocket.SocketBase.AppServerBase`2.CreateAppSession(SuperSocket.SocketBase.ISocketSession)">
  550. <summary>
  551. create a new TAppSession instance, you can override it to create the session instance in your own way
  552. </summary>
  553. <param name="socketSession">the socket session.</param>
  554. <returns>the new created session instance</returns>
  555. </member>
  556. <member name="M:SuperSocket.SocketBase.AppServerBase`2.SuperSocket#SocketBase#IAppServer#RegisterSession(SuperSocket.SocketBase.IAppSession)">
  557. <summary>
  558. Registers the new created app session into the appserver's session container.
  559. </summary>
  560. <param name="session">The session.</param>
  561. <returns></returns>
  562. </member>
  563. <member name="M:SuperSocket.SocketBase.AppServerBase`2.RegisterSession(System.String,`0)">
  564. <summary>
  565. Registers the session into session container.
  566. </summary>
  567. <param name="sessionID">The session ID.</param>
  568. <param name="appSession">The app session.</param>
  569. <returns></returns>
  570. </member>
  571. <member name="M:SuperSocket.SocketBase.AppServerBase`2.OnNewSessionConnected(`0)">
  572. <summary>
  573. Called when [new session connected].
  574. </summary>
  575. <param name="session">The session.</param>
  576. </member>
  577. <member name="M:SuperSocket.SocketBase.AppServerBase`2.ResetSessionSecurity(SuperSocket.SocketBase.IAppSession,System.Security.Authentication.SslProtocols)">
  578. <summary>
  579. Resets the session's security protocol.
  580. </summary>
  581. <param name="session">The session.</param>
  582. <param name="security">The security protocol.</param>
  583. </member>
  584. <member name="M:SuperSocket.SocketBase.AppServerBase`2.OnSocketSessionClosed(SuperSocket.SocketBase.ISocketSession,SuperSocket.SocketBase.CloseReason)">
  585. <summary>
  586. Called when [socket session closed].
  587. </summary>
  588. <param name="session">The socket session.</param>
  589. <param name="reason">The reason.</param>
  590. </member>
  591. <member name="M:SuperSocket.SocketBase.AppServerBase`2.OnSessionClosed(`0,SuperSocket.SocketBase.CloseReason)">
  592. <summary>
  593. Called when [session closed].
  594. </summary>
  595. <param name="session">The appSession.</param>
  596. <param name="reason">The reason.</param>
  597. </member>
  598. <member name="M:SuperSocket.SocketBase.AppServerBase`2.GetSessionByID(System.String)">
  599. <summary>
  600. Gets the app session by ID.
  601. </summary>
  602. <param name="sessionID">The session ID.</param>
  603. <returns></returns>
  604. </member>
  605. <member name="M:SuperSocket.SocketBase.AppServerBase`2.SuperSocket#SocketBase#IAppServer#GetSessionByID(System.String)">
  606. <summary>
  607. Gets the app session by ID.
  608. </summary>
  609. <param name="sessionID"></param>
  610. <returns></returns>
  611. </member>
  612. <member name="M:SuperSocket.SocketBase.AppServerBase`2.GetSessions(System.Func{`0,System.Boolean})">
  613. <summary>
  614. Gets the matched sessions from sessions snapshot.
  615. </summary>
  616. <param name="critera">The prediction critera.</param>
  617. </member>
  618. <member name="M:SuperSocket.SocketBase.AppServerBase`2.GetAllSessions">
  619. <summary>
  620. Gets all sessions in sessions snapshot.
  621. </summary>
  622. </member>
  623. <member name="M:SuperSocket.SocketBase.AppServerBase`2.GetFilePath(System.String)">
  624. <summary>
  625. Gets the physical file path by the relative file path,
  626. search both in the appserver's root and in the supersocket root dir if the isolation level has been set other than 'None'.
  627. </summary>
  628. <param name="relativeFilePath">The relative file path.</param>
  629. <returns></returns>
  630. </member>
  631. <member name="M:SuperSocket.SocketBase.AppServerBase`2.SuperSocket#SocketBase#IActiveConnector#ActiveConnect(System.Net.EndPoint,System.Net.EndPoint)">
  632. <summary>
  633. Connect the remote endpoint actively.
  634. </summary>
  635. <param name="targetEndPoint">The target end point.</param>
  636. <param name="localEndPoint">The local end point.</param>
  637. <returns></returns>
  638. <exception cref="T:System.Exception">This server cannot support active connect.</exception>
  639. </member>
  640. <member name="M:SuperSocket.SocketBase.AppServerBase`2.SuperSocket#SocketBase#IActiveConnector#ActiveConnect(System.Net.EndPoint)">
  641. <summary>
  642. Connect the remote endpoint actively.
  643. </summary>
  644. <param name="targetEndPoint">The target end point.</param>
  645. <returns></returns>
  646. <exception cref="T:System.Exception">This server cannot support active connect.</exception>
  647. </member>
  648. <member name="M:SuperSocket.SocketBase.AppServerBase`2.SuperSocket#SocketBase#ISystemEndPoint#TransferSystemMessage(System.String,System.Object)">
  649. <summary>
  650. Transfers the system message
  651. </summary>
  652. <param name="messageType">Type of the message.</param>
  653. <param name="messageData">The message data.</param>
  654. </member>
  655. <member name="M:SuperSocket.SocketBase.AppServerBase`2.OnSystemMessageReceived(System.String,System.Object)">
  656. <summary>
  657. Called when [system message received].
  658. </summary>
  659. <param name="messageType">Type of the message.</param>
  660. <param name="messageData">The message data.</param>
  661. </member>
  662. <member name="M:SuperSocket.SocketBase.AppServerBase`2.UpdateServerStatus(SuperSocket.SocketBase.StatusInfoCollection)">
  663. <summary>
  664. Updates the summary of the server.
  665. </summary>
  666. <param name="serverStatus">The server status.</param>
  667. </member>
  668. <member name="M:SuperSocket.SocketBase.AppServerBase`2.OnServerStatusCollected(SuperSocket.SocketBase.StatusInfoCollection,SuperSocket.SocketBase.StatusInfoCollection)">
  669. <summary>
  670. Called when [server status collected].
  671. </summary>
  672. <param name="bootstrapStatus">The bootstrapStatus status.</param>
  673. <param name="serverStatus">The server status.</param>
  674. </member>
  675. <member name="M:SuperSocket.SocketBase.AppServerBase`2.Dispose">
  676. <summary>
  677. Releases unmanaged and - optionally - managed resources
  678. </summary>
  679. </member>
  680. <member name="P:SuperSocket.SocketBase.AppServerBase`2.Config">
  681. <summary>
  682. Gets the server's config.
  683. </summary>
  684. </member>
  685. <member name="P:SuperSocket.SocketBase.AppServerBase`2.State">
  686. <summary>
  687. Gets the current state of the work item.
  688. </summary>
  689. <value>
  690. The state.
  691. </value>
  692. </member>
  693. <member name="P:SuperSocket.SocketBase.AppServerBase`2.Certificate">
  694. <summary>
  695. Gets the certificate of current server.
  696. </summary>
  697. </member>
  698. <member name="P:SuperSocket.SocketBase.AppServerBase`2.ReceiveFilterFactory">
  699. <summary>
  700. Gets or sets the receive filter factory.
  701. </summary>
  702. <value>
  703. The receive filter factory.
  704. </value>
  705. </member>
  706. <member name="P:SuperSocket.SocketBase.AppServerBase`2.SuperSocket#SocketBase#IAppServer#ReceiveFilterFactory">
  707. <summary>
  708. Gets the Receive filter factory.
  709. </summary>
  710. </member>
  711. <member name="P:SuperSocket.SocketBase.AppServerBase`2.BasicSecurity">
  712. <summary>
  713. Gets the basic transfer layer security protocol.
  714. </summary>
  715. </member>
  716. <member name="P:SuperSocket.SocketBase.AppServerBase`2.RootConfig">
  717. <summary>
  718. Gets the root config.
  719. </summary>
  720. </member>
  721. <member name="P:SuperSocket.SocketBase.AppServerBase`2.Logger">
  722. <summary>
  723. Gets the logger assosiated with this object.
  724. </summary>
  725. </member>
  726. <member name="P:SuperSocket.SocketBase.AppServerBase`2.Bootstrap">
  727. <summary>
  728. Gets the bootstrap of this appServer instance.
  729. </summary>
  730. </member>
  731. <member name="P:SuperSocket.SocketBase.AppServerBase`2.TotalHandledRequests">
  732. <summary>
  733. Gets the total handled requests number.
  734. </summary>
  735. </member>
  736. <member name="P:SuperSocket.SocketBase.AppServerBase`2.Listeners">
  737. <summary>
  738. Gets or sets the listeners inforamtion.
  739. </summary>
  740. <value>
  741. The listeners.
  742. </value>
  743. </member>
  744. <member name="P:SuperSocket.SocketBase.AppServerBase`2.StartedTime">
  745. <summary>
  746. Gets the started time of this server instance.
  747. </summary>
  748. <value>
  749. The started time.
  750. </value>
  751. </member>
  752. <member name="P:SuperSocket.SocketBase.AppServerBase`2.LogFactory">
  753. <summary>
  754. Gets or sets the log factory.
  755. </summary>
  756. <value>
  757. The log factory.
  758. </value>
  759. </member>
  760. <member name="P:SuperSocket.SocketBase.AppServerBase`2.TextEncoding">
  761. <summary>
  762. Gets the default text encoding.
  763. </summary>
  764. <value>
  765. The text encoding.
  766. </value>
  767. </member>
  768. <member name="P:SuperSocket.SocketBase.AppServerBase`2.Name">
  769. <summary>
  770. Gets the name of the server instance.
  771. </summary>
  772. </member>
  773. <member name="P:SuperSocket.SocketBase.AppServerBase`2.SuperSocket#SocketBase#ISocketServerAccessor#SocketServer">
  774. <summary>
  775. Gets the socket server.
  776. </summary>
  777. <value>
  778. The socket server.
  779. </value>
  780. </member>
  781. <member name="E:SuperSocket.SocketBase.AppServerBase`2.SuperSocket#SocketBase#IRawDataProcessor{TAppSession}#RawDataReceived">
  782. <summary>
  783. Gets or sets the raw binary data received event handler.
  784. TAppSession: session
  785. byte[]: receive buffer
  786. int: receive buffer offset
  787. int: receive lenght
  788. bool: whether process the received data further
  789. </summary>
  790. </member>
  791. <member name="E:SuperSocket.SocketBase.AppServerBase`2.NewRequestReceived">
  792. <summary>
  793. Occurs when a full request item received.
  794. </summary>
  795. </member>
  796. <member name="P:SuperSocket.SocketBase.AppServerBase`2.ConnectionFilters">
  797. <summary>
  798. Gets or sets the server's connection filter
  799. </summary>
  800. <value>
  801. The server's connection filters
  802. </value>
  803. </member>
  804. <member name="E:SuperSocket.SocketBase.AppServerBase`2.NewSessionConnected">
  805. <summary>
  806. The action which will be executed after a new session connect
  807. </summary>
  808. </member>
  809. <member name="E:SuperSocket.SocketBase.AppServerBase`2.SessionClosed">
  810. <summary>
  811. Gets/sets the session closed event handler.
  812. </summary>
  813. </member>
  814. <member name="P:SuperSocket.SocketBase.AppServerBase`2.SessionCount">
  815. <summary>
  816. Gets the total session count.
  817. </summary>
  818. </member>
  819. <member name="T:SuperSocket.SocketBase.Async">
  820. <summary>
  821. Async extension class
  822. </summary>
  823. </member>
  824. <member name="M:SuperSocket.SocketBase.Async.AsyncRun(SuperSocket.SocketBase.ILoggerProvider,System.Action)">
  825. <summary>
  826. Runs the specified task.
  827. </summary>
  828. <param name="logProvider">The log provider.</param>
  829. <param name="task">The task.</param>
  830. <returns></returns>
  831. </member>
  832. <member name="M:SuperSocket.SocketBase.Async.AsyncRun(SuperSocket.SocketBase.ILoggerProvider,System.Action,System.Threading.Tasks.TaskCreationOptions)">
  833. <summary>
  834. Runs the specified task.
  835. </summary>
  836. <param name="logProvider">The log provider.</param>
  837. <param name="task">The task.</param>
  838. <param name="taskOption">The task option.</param>
  839. <returns></returns>
  840. </member>
  841. <member name="M:SuperSocket.SocketBase.Async.AsyncRun(SuperSocket.SocketBase.ILoggerProvider,System.Action,System.Action{System.Exception})">
  842. <summary>
  843. Runs the specified task.
  844. </summary>
  845. <param name="logProvider">The log provider.</param>
  846. <param name="task">The task.</param>
  847. <param name="exceptionHandler">The exception handler.</param>
  848. <returns></returns>
  849. </member>
  850. <member name="M:SuperSocket.SocketBase.Async.AsyncRun(SuperSocket.SocketBase.ILoggerProvider,System.Action,System.Threading.Tasks.TaskCreationOptions,System.Action{System.Exception})">
  851. <summary>
  852. Runs the specified task.
  853. </summary>
  854. <param name="logProvider">The log provider.</param>
  855. <param name="task">The task.</param>
  856. <param name="taskOption">The task option.</param>
  857. <param name="exceptionHandler">The exception handler.</param>
  858. <returns></returns>
  859. </member>
  860. <member name="M:SuperSocket.SocketBase.Async.AsyncRun(SuperSocket.SocketBase.ILoggerProvider,System.Action{System.Object},System.Object)">
  861. <summary>
  862. Runs the specified task.
  863. </summary>
  864. <param name="logProvider">The log provider.</param>
  865. <param name="task">The task.</param>
  866. <param name="state">The state.</param>
  867. <returns></returns>
  868. </member>
  869. <member name="M:SuperSocket.SocketBase.Async.AsyncRun(SuperSocket.SocketBase.ILoggerProvider,System.Action{System.Object},System.Object,System.Threading.Tasks.TaskCreationOptions)">
  870. <summary>
  871. Runs the specified task.
  872. </summary>
  873. <param name="logProvider">The log provider.</param>
  874. <param name="task">The task.</param>
  875. <param name="state">The state.</param>
  876. <param name="taskOption">The task option.</param>
  877. <returns></returns>
  878. </member>
  879. <member name="M:SuperSocket.SocketBase.Async.AsyncRun(SuperSocket.SocketBase.ILoggerProvider,System.Action{System.Object},System.Object,System.Action{System.Exception})">
  880. <summary>
  881. Runs the specified task.
  882. </summary>
  883. <param name="logProvider">The log provider.</param>
  884. <param name="task">The task.</param>
  885. <param name="state">The state.</param>
  886. <param name="exceptionHandler">The exception handler.</param>
  887. <returns></returns>
  888. </member>
  889. <member name="M:SuperSocket.SocketBase.Async.AsyncRun(SuperSocket.SocketBase.ILoggerProvider,System.Action{System.Object},System.Object,System.Threading.Tasks.TaskCreationOptions,System.Action{System.Exception})">
  890. <summary>
  891. Runs the specified task.
  892. </summary>
  893. <param name="logProvider">The log provider.</param>
  894. <param name="task">The task.</param>
  895. <param name="state">The state.</param>
  896. <param name="taskOption">The task option.</param>
  897. <param name="exceptionHandler">The exception handler.</param>
  898. <returns></returns>
  899. </member>
  900. <member name="T:SuperSocket.SocketBase.CommandExecutingContext">
  901. <summary>
  902. Command Executing Context
  903. </summary>
  904. </member>
  905. <member name="M:SuperSocket.SocketBase.CommandExecutingContext.Initialize(SuperSocket.SocketBase.IAppSession,SuperSocket.SocketBase.Protocol.IRequestInfo,SuperSocket.SocketBase.Command.ICommand)">
  906. <summary>
  907. Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.CommandExecutingContext"/> class.
  908. </summary>
  909. <param name="session">The session.</param>
  910. <param name="requestInfo">The request info.</param>
  911. <param name="command">The command.</param>
  912. </member>
  913. <member name="P:SuperSocket.SocketBase.CommandExecutingContext.Session">
  914. <summary>
  915. Gets the session.
  916. </summary>
  917. </member>
  918. <member name="P:SuperSocket.SocketBase.CommandExecutingContext.RequestInfo">
  919. <summary>
  920. Gets the request info.
  921. </summary>
  922. </member>
  923. <member name="P:SuperSocket.SocketBase.CommandExecutingContext.CurrentCommand">
  924. <summary>
  925. Gets the current command.
  926. </summary>
  927. </member>
  928. <member name="P:SuperSocket.SocketBase.CommandExecutingContext.Exception">
  929. <summary>
  930. Gets the exception.
  931. </summary>
  932. <value>
  933. The exception.
  934. </value>
  935. </member>
  936. <member name="P:SuperSocket.SocketBase.CommandExecutingContext.ExceptionHandled">
  937. <summary>
  938. Gets a value indicating whether [exception handled].
  939. </summary>
  940. <value>
  941. <c>true</c> if [exception handled]; otherwise, <c>false</c>.
  942. </value>
  943. </member>
  944. <member name="P:SuperSocket.SocketBase.CommandExecutingContext.Cancel">
  945. <summary>
  946. Gets or sets a value indicating whether this command executing is cancelled.
  947. </summary>
  948. <value>
  949. <c>true</c> if cancel; otherwise, <c>false</c>.
  950. </value>
  951. </member>
  952. <member name="T:SuperSocket.SocketBase.Command.CommandLoaderBase`1">
  953. <summary>
  954. CommandLoader base class
  955. </summary>
  956. </member>
  957. <member name="T:SuperSocket.SocketBase.Command.ICommandLoader`1">
  958. <summary>
  959. Command loader's interface
  960. </summary>
  961. </member>
  962. <member name="T:SuperSocket.SocketBase.Command.ICommandLoader">
  963. <summary>
  964. the empty basic interface for command loader
  965. </summary>
  966. </member>
  967. <member name="M:SuperSocket.SocketBase.Command.ICommandLoader`1.Initialize(SuperSocket.SocketBase.Config.IRootConfig,SuperSocket.SocketBase.IAppServer)">
  968. <summary>
  969. Initializes the command loader by the root config and the server instance.
  970. </summary>
  971. <param name="rootConfig">The root config.</param>
  972. <param name="appServer">The app server.</param>
  973. <returns></returns>
  974. </member>
  975. <member name="M:SuperSocket.SocketBase.Command.ICommandLoader`1.TryLoadCommands(System.Collections.Generic.IEnumerable{`0}@)">
  976. <summary>
  977. Tries to load commands.
  978. </summary>
  979. <param name="commands">The commands.</param>
  980. <returns></returns>
  981. </member>
  982. <member name="E:SuperSocket.SocketBase.Command.ICommandLoader`1.Updated">
  983. <summary>
  984. Occurs when [updated].
  985. </summary>
  986. </member>
  987. <member name="E:SuperSocket.SocketBase.Command.ICommandLoader`1.Error">
  988. <summary>
  989. Occurs when [error].
  990. </summary>
  991. </member>
  992. <member name="M:SuperSocket.SocketBase.Command.CommandLoaderBase`1.Initialize(SuperSocket.SocketBase.Config.IRootConfig,SuperSocket.SocketBase.IAppServer)">
  993. <summary>
  994. Initializes the command loader by the root config and appserver instance.
  995. </summary>
  996. <param name="rootConfig">The root config.</param>
  997. <param name="appServer">The app server.</param>
  998. <returns></returns>
  999. </member>
  1000. <member name="M:SuperSocket.SocketBase.Command.CommandLoaderBase`1.TryLoadCommands(System.Collections.Generic.IEnumerable{`0}@)">
  1001. <summary>
  1002. Tries to load commands.
  1003. </summary>
  1004. <param name="commands">The commands.</param>
  1005. <returns></returns>
  1006. </member>
  1007. <member name="M:SuperSocket.SocketBase.Command.CommandLoaderBase`1.OnUpdated(System.Collections.Generic.IEnumerable{SuperSocket.SocketBase.Command.CommandUpdateInfo{`0}})">
  1008. <summary>
  1009. Called when [updated].
  1010. </summary>
  1011. <param name="commands">The commands.</param>
  1012. </member>
  1013. <member name="M:SuperSocket.SocketBase.Command.CommandLoaderBase`1.OnError(System.String)">
  1014. <summary>
  1015. Called when [error].
  1016. </summary>
  1017. <param name="message">The message.</param>
  1018. </member>
  1019. <member name="M:SuperSocket.SocketBase.Command.CommandLoaderBase`1.OnError(System.Exception)">
  1020. <summary>
  1021. Called when [error].
  1022. </summary>
  1023. <param name="e">The e.</param>
  1024. </member>
  1025. <member name="E:SuperSocket.SocketBase.Command.CommandLoaderBase`1.Updated">
  1026. <summary>
  1027. Occurs when [updated].
  1028. </summary>
  1029. </member>
  1030. <member name="E:SuperSocket.SocketBase.Command.CommandLoaderBase`1.Error">
  1031. <summary>
  1032. Occurs when [error].
  1033. </summary>
  1034. </member>
  1035. <member name="T:SuperSocket.SocketBase.Command.CommandUpdateEventArgs`1">
  1036. <summary>
  1037. CommandUpdateEventArgs
  1038. </summary>
  1039. <typeparam name="T"></typeparam>
  1040. </member>
  1041. <member name="M:SuperSocket.SocketBase.Command.CommandUpdateEventArgs`1.#ctor(System.Collections.Generic.IEnumerable{SuperSocket.SocketBase.Command.CommandUpdateInfo{`0}})">
  1042. <summary>
  1043. Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Command.CommandUpdateEventArgs`1"/> class.
  1044. </summary>
  1045. <param name="commands">The commands.</param>
  1046. </member>
  1047. <member name="P:SuperSocket.SocketBase.Command.CommandUpdateEventArgs`1.Commands">
  1048. <summary>
  1049. Gets the commands updated.
  1050. </summary>
  1051. </member>
  1052. <member name="T:SuperSocket.SocketBase.Command.ICommandFilterProvider">
  1053. <summary>
  1054. The basic interface for CommandFilter
  1055. </summary>
  1056. </member>
  1057. <member name="M:SuperSocket.SocketBase.Command.ICommandFilterProvider.GetFilters">
  1058. <summary>
  1059. Gets the filters which assosiated with this command object.
  1060. </summary>
  1061. <returns></returns>
  1062. </member>
  1063. <member name="T:SuperSocket.SocketBase.Config.CommandAssemblyConfig">
  1064. <summary>
  1065. Command assembly config
  1066. </summary>
  1067. </member>
  1068. <member name="T:SuperSocket.SocketBase.Config.ICommandAssemblyConfig">
  1069. <summary>
  1070. The basic interface for command assembly config
  1071. </summary>
  1072. </member>
  1073. <member name="P:SuperSocket.SocketBase.Config.ICommandAssemblyConfig.Assembly">
  1074. <summary>
  1075. Gets the assembly name.
  1076. </summary>
  1077. <value>
  1078. The assembly.
  1079. </value>
  1080. </member>
  1081. <member name="P:SuperSocket.SocketBase.Config.CommandAssemblyConfig.Assembly">
  1082. <summary>
  1083. Gets or sets the assembly name.
  1084. </summary>
  1085. <value>
  1086. The assembly.
  1087. </value>
  1088. </member>
  1089. <member name="T:SuperSocket.SocketBase.Config.IConfigurationSource">
  1090. <summary>
  1091. Configuration source interface
  1092. </summary>
  1093. </member>
  1094. <member name="T:SuperSocket.SocketBase.Config.IRootConfig">
  1095. <summary>
  1096. IRootConfig, the part compatible with .Net 4.5 or higher
  1097. </summary>
  1098. <summary>
  1099. The root configuration interface
  1100. </summary>
  1101. </member>
  1102. <member name="M:SuperSocket.SocketBase.Config.IRootConfig.GetChildConfig``1(System.String)">
  1103. <summary>
  1104. Gets the child config.
  1105. </summary>
  1106. <typeparam name="TConfig">The type of the config.</typeparam>
  1107. <param name="childConfigName">Name of the child config.</param>
  1108. <returns></returns>
  1109. </member>
  1110. <member name="P:SuperSocket.SocketBase.Config.IRootConfig.DefaultCulture">
  1111. <summary>
  1112. Gets the default culture for all server instances.
  1113. </summary>
  1114. <value>
  1115. The default culture.
  1116. </value>
  1117. </member>
  1118. <member name="P:SuperSocket.SocketBase.Config.IRootConfig.MaxWorkingThreads">
  1119. <summary>
  1120. Gets the max working threads.
  1121. </summary>
  1122. </member>
  1123. <member name="P:SuperSocket.SocketBase.Config.IRootConfig.MinWorkingThreads">
  1124. <summary>
  1125. Gets the min working threads.
  1126. </summary>
  1127. </member>
  1128. <member name="P:SuperSocket.SocketBase.Config.IRootConfig.MaxCompletionPortThreads">
  1129. <summary>
  1130. Gets the max completion port threads.
  1131. </summary>
  1132. </member>
  1133. <member name="P:SuperSocket.SocketBase.Config.IRootConfig.MinCompletionPortThreads">
  1134. <summary>
  1135. Gets the min completion port threads.
  1136. </summary>
  1137. </member>
  1138. <member name="P:SuperSocket.SocketBase.Config.IRootConfig.DisablePerformanceDataCollector">
  1139. <summary>
  1140. Gets a value indicating whether [disable performance data collector].
  1141. </summary>
  1142. <value>
  1143. <c>true</c> if [disable performance data collector]; otherwise, <c>false</c>.
  1144. </value>
  1145. </member>
  1146. <member name="P:SuperSocket.SocketBase.Config.IRootConfig.PerformanceDataCollectInterval">
  1147. <summary>
  1148. Gets the performance data collect interval, in seconds.
  1149. </summary>
  1150. </member>
  1151. <member name="P:SuperSocket.SocketBase.Config.IRootConfig.LogFactory">
  1152. <summary>
  1153. Gets the log factory name.
  1154. </summary>
  1155. <value>
  1156. The log factory.
  1157. </value>
  1158. </member>
  1159. <member name="P:SuperSocket.SocketBase.Config.IRootConfig.Isolation">
  1160. <summary>
  1161. Gets the isolation mode.
  1162. </summary>
  1163. </member>
  1164. <member name="P:SuperSocket.SocketBase.Config.IRootConfig.OptionElements">
  1165. <summary>
  1166. Gets the option elements.
  1167. </summary>
  1168. </member>
  1169. <member name="P:SuperSocket.SocketBase.Config.IConfigurationSource.Servers">
  1170. <summary>
  1171. Gets the servers definitions.
  1172. </summary>
  1173. </member>
  1174. <member name="P:SuperSocket.SocketBase.Config.IConfigurationSource.ServerTypes">
  1175. <summary>
  1176. Gets the appServer types definition.
  1177. </summary>
  1178. </member>
  1179. <member name="P:SuperSocket.SocketBase.Config.IConfigurationSource.ConnectionFilters">
  1180. <summary>
  1181. Gets the connection filters definition.
  1182. </summary>
  1183. </member>
  1184. <member name="P:SuperSocket.SocketBase.Config.IConfigurationSource.LogFactories">
  1185. <summary>
  1186. Gets the log factories definition.
  1187. </summary>
  1188. </member>
  1189. <member name="P:SuperSocket.SocketBase.Config.IConfigurationSource.ReceiveFilterFactories">
  1190. <summary>
  1191. Gets the Receive filter factories definition.
  1192. </summary>
  1193. </member>
  1194. <member name="P:SuperSocket.SocketBase.Config.IConfigurationSource.CommandLoaders">
  1195. <summary>
  1196. Gets the command loaders definition.
  1197. </summary>
  1198. </member>
  1199. <member name="T:SuperSocket.SocketBase.Config.IServerConfig">
  1200. <summary>
  1201. IServerConfig, the part compatible with .Net 4.5 or higher
  1202. </summary>
  1203. <summary>
  1204. Server instance configuation interface
  1205. </summary>
  1206. </member>
  1207. <member name="M:SuperSocket.SocketBase.Config.IServerConfig.GetChildConfig``1(System.String)">
  1208. <summary>
  1209. Gets the child config.
  1210. </summary>
  1211. <typeparam name="TConfig">The type of the config.</typeparam>
  1212. <param name="childConfigName">Name of the child config.</param>
  1213. <returns></returns>
  1214. </member>
  1215. <member name="P:SuperSocket.SocketBase.Config.IServerConfig.DefaultCulture">
  1216. <summary>
  1217. Gets the default culture for this server.
  1218. </summary>
  1219. <value>
  1220. The default culture.
  1221. </value>
  1222. </member>
  1223. <member name="P:SuperSocket.SocketBase.Config.IServerConfig.ServerTypeName">
  1224. <summary>
  1225. Gets the name of the server type this appServer want to use.
  1226. </summary>
  1227. <value>
  1228. The name of the server type.
  1229. </value>
  1230. </member>
  1231. <member name="P:SuperSocket.SocketBase.Config.IServerConfig.ServerType">
  1232. <summary>
  1233. Gets the type definition of the appserver.
  1234. </summary>
  1235. <value>
  1236. The type of the server.
  1237. </value>
  1238. </member>
  1239. <member name="P:SuperSocket.SocketBase.Config.IServerConfig.ReceiveFilterFactory">
  1240. <summary>
  1241. Gets the Receive filter factory.
  1242. </summary>
  1243. </member>
  1244. <member name="P:SuperSocket.SocketBase.Config.IServerConfig.Ip">
  1245. <summary>
  1246. Gets the ip.
  1247. </summary>
  1248. </member>
  1249. <member name="P:SuperSocket.SocketBase.Config.IServerConfig.Port">
  1250. <summary>
  1251. Gets the port.
  1252. </summary>
  1253. </member>
  1254. <member name="P:SuperSocket.SocketBase.Config.IServerConfig.Options">
  1255. <summary>
  1256. Gets the options.
  1257. </summary>
  1258. </member>
  1259. <member name="P:SuperSocket.SocketBase.Config.IServerConfig.OptionElements">
  1260. <summary>
  1261. Gets the option elements.
  1262. </summary>
  1263. </member>
  1264. <member name="P:SuperSocket.SocketBase.Config.IServerConfig.Disabled">
  1265. <summary>
  1266. Gets a value indicating whether this <see cref="T:SuperSocket.SocketBase.Config.IServerConfig"/> is disabled.
  1267. </summary>
  1268. <value>
  1269. <c>true</c> if disabled; otherwise, <c>false</c>.
  1270. </value>
  1271. </member>
  1272. <member name="P:SuperSocket.SocketBase.Config.IServerConfig.Name">
  1273. <summary>
  1274. Gets the name.
  1275. </summary>
  1276. </member>
  1277. <member name="P:SuperSocket.SocketBase.Config.IServerConfig.Mode">
  1278. <summary>
  1279. Gets the mode.
  1280. </summary>
  1281. </member>
  1282. <member name="P:SuperSocket.SocketBase.Config.IServerConfig.SendTimeOut">
  1283. <summary>
  1284. Gets the send time out.
  1285. </summary>
  1286. </member>
  1287. <member name="P:SuperSocket.SocketBase.Config.IServerConfig.MaxConnectionNumber">
  1288. <summary>
  1289. Gets the max connection number.
  1290. </summary>
  1291. </member>
  1292. <member name="P:SuperSocket.SocketBase.Config.IServerConfig.ReceiveBufferSize">
  1293. <summary>
  1294. Gets the size of the receive buffer.
  1295. </summary>
  1296. <value>
  1297. The size of the receive buffer.
  1298. </value>
  1299. </member>
  1300. <member name="P:SuperSocket.SocketBase.Config.IServerConfig.SendBufferSize">
  1301. <summary>
  1302. Gets the size of the send buffer.
  1303. </summary>
  1304. <value>
  1305. The size of the send buffer.
  1306. </value>
  1307. </member>
  1308. <member name="P:SuperSocket.SocketBase.Config.IServerConfig.SyncSend">
  1309. <summary>
  1310. Gets a value indicating whether sending is in synchronous mode.
  1311. </summary>
  1312. <value>
  1313. <c>true</c> if [sync send]; otherwise, <c>false</c>.
  1314. </value>
  1315. </member>
  1316. <member name="P:SuperSocket.SocketBase.Config.IServerConfig.LogCommand">
  1317. <summary>
  1318. Gets a value indicating whether log command in log file.
  1319. </summary>
  1320. <value><c>true</c> if log command; otherwise, <c>false</c>.</value>
  1321. </member>
  1322. <member name="P:SuperSocket.SocketBase.Config.IServerConfig.ClearIdleSession">
  1323. <summary>
  1324. Gets a value indicating whether clear idle session.
  1325. </summary>
  1326. <value><c>true</c> if clear idle session; otherwise, <c>false</c>.</value>
  1327. </member>
  1328. <member name="P:SuperSocket.SocketBase.Config.IServerConfig.ClearIdleSessionInterval">
  1329. <summary>
  1330. Gets the clear idle session interval, in seconds.
  1331. </summary>
  1332. <value>The clear idle session interval.</value>
  1333. </member>
  1334. <member name="P:SuperSocket.SocketBase.Config.IServerConfig.IdleSessionTimeOut">
  1335. <summary>
  1336. Gets the idle session timeout time length, in seconds.
  1337. </summary>
  1338. <value>The idle session time out.</value>
  1339. </member>
  1340. <member name="P:SuperSocket.SocketBase.Config.IServerConfig.Certificate">
  1341. <summary>
  1342. Gets X509Certificate configuration.
  1343. </summary>
  1344. <value>X509Certificate configuration.</value>
  1345. </member>
  1346. <member name="P:SuperSocket.SocketBase.Config.IServerConfig.Security">
  1347. <summary>
  1348. Gets the security protocol, X509 certificate.
  1349. </summary>
  1350. </member>
  1351. <member name="P:SuperSocket.SocketBase.Config.IServerConfig.MaxRequestLength">
  1352. <summary>
  1353. Gets the length of the max request.
  1354. </summary>
  1355. <value>
  1356. The length of the max request.
  1357. </value>
  1358. </member>
  1359. <member name="P:SuperSocket.SocketBase.Config.IServerConfig.DisableSessionSnapshot">
  1360. <summary>
  1361. Gets a value indicating whether [disable session snapshot].
  1362. </summary>
  1363. <value>
  1364. <c>true</c> if [disable session snapshot]; otherwise, <c>false</c>.
  1365. </value>
  1366. </member>
  1367. <member name="P:SuperSocket.SocketBase.Config.IServerConfig.SessionSnapshotInterval">
  1368. <summary>
  1369. Gets the interval to taking snapshot for all live sessions.
  1370. </summary>
  1371. </member>
  1372. <member name="P:SuperSocket.SocketBase.Config.IServerConfig.ConnectionFilter">
  1373. <summary>
  1374. Gets the connection filters used by this server instance.
  1375. </summary>
  1376. <value>
  1377. The connection filter's name list, seperated by comma
  1378. </value>
  1379. </member>
  1380. <member name="P:SuperSocket.SocketBase.Config.IServerConfig.CommandLoader">
  1381. <summary>
  1382. Gets the command loader, multiple values should be separated by comma.
  1383. </summary>
  1384. </member>
  1385. <member name="P:SuperSocket.SocketBase.Config.IServerConfig.KeepAliveTime">
  1386. <summary>
  1387. Gets the start keep alive time, in seconds
  1388. </summary>
  1389. </member>
  1390. <member name="P:SuperSocket.SocketBase.Config.IServerConfig.KeepAliveInterval">
  1391. <summary>
  1392. Gets the keep alive interval, in seconds.
  1393. </summary>
  1394. </member>
  1395. <member name="P:SuperSocket.SocketBase.Config.IServerConfig.ListenBacklog">
  1396. <summary>
  1397. Gets the backlog size of socket listening.
  1398. </summary>
  1399. </member>
  1400. <member name="P:SuperSocket.SocketBase.Config.IServerConfig.StartupOrder">
  1401. <summary>
  1402. Gets the startup order of the server instance.
  1403. </summary>
  1404. </member>
  1405. <member name="P:SuperSocket.SocketBase.Config.IServerConfig.Listeners">
  1406. <summary>
  1407. Gets the listeners' configuration.
  1408. </summary>
  1409. </member>
  1410. <member name="P:SuperSocket.SocketBase.Config.IServerConfig.LogFactory">
  1411. <summary>
  1412. Gets the log factory name.
  1413. </summary>
  1414. </member>
  1415. <member name="P:SuperSocket.SocketBase.Config.IServerConfig.SendingQueueSize">
  1416. <summary>
  1417. Gets the size of the sending queue.
  1418. </summary>
  1419. <value>
  1420. The size of the sending queue.
  1421. </value>
  1422. </member>
  1423. <member name="P:SuperSocket.SocketBase.Config.IServerConfig.LogBasicSessionActivity">
  1424. <summary>
  1425. Gets a value indicating whether [log basic session activity like connected and disconnected].
  1426. </summary>
  1427. <value>
  1428. <c>true</c> if [log basic session activity]; otherwise, <c>false</c>.
  1429. </value>
  1430. </member>
  1431. <member name="P:SuperSocket.SocketBase.Config.IServerConfig.LogAllSocketException">
  1432. <summary>
  1433. Gets a value indicating whether [log all socket exception].
  1434. </summary>
  1435. <value>
  1436. <c>true</c> if [log all socket exception]; otherwise, <c>false</c>.
  1437. </value>
  1438. </member>
  1439. <member name="P:SuperSocket.SocketBase.Config.IServerConfig.TextEncoding">
  1440. <summary>
  1441. Gets the default text encoding.
  1442. </summary>
  1443. <value>
  1444. The text encoding.
  1445. </value>
  1446. </member>
  1447. <member name="P:SuperSocket.SocketBase.Config.IServerConfig.CommandAssemblies">
  1448. <summary>
  1449. Gets the command assemblies configuration.
  1450. </summary>
  1451. <value>
  1452. The command assemblies.
  1453. </value>
  1454. </member>
  1455. <member name="T:SuperSocket.SocketBase.Config.ITypeProvider">
  1456. <summary>
  1457. TypeProvider's interface
  1458. </summary>
  1459. </member>
  1460. <member name="P:SuperSocket.SocketBase.Config.ITypeProvider.Name">
  1461. <summary>
  1462. Gets the name.
  1463. </summary>
  1464. </member>
  1465. <member name="P:SuperSocket.SocketBase.Config.ITypeProvider.Type">
  1466. <summary>
  1467. Gets the type.
  1468. </summary>
  1469. </member>
  1470. <member name="T:SuperSocket.SocketBase.Config.ConfigurationSource">
  1471. <summary>
  1472. Poco configuration source
  1473. </summary>
  1474. </member>
  1475. <member name="T:SuperSocket.SocketBase.Config.RootConfig">
  1476. <summary>
  1477. Root configuration model
  1478. </summary>
  1479. </member>
  1480. <member name="M:SuperSocket.SocketBase.Config.RootConfig.#ctor(SuperSocket.SocketBase.Config.IRootConfig)">
  1481. <summary>
  1482. Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Config.RootConfig"/> class.
  1483. </summary>
  1484. <param name="rootConfig">The root config.</param>
  1485. </member>
  1486. <member name="M:SuperSocket.SocketBase.Config.RootConfig.#ctor">
  1487. <summary>
  1488. Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Config.RootConfig"/> class.
  1489. </summary>
  1490. </member>
  1491. <member name="M:SuperSocket.SocketBase.Config.RootConfig.GetChildConfig``1(System.String)">
  1492. <summary>
  1493. Gets the child config.
  1494. </summary>
  1495. <typeparam name="TConfig">The type of the config.</typeparam>
  1496. <param name="childConfigName">Name of the child config.</param>
  1497. <returns></returns>
  1498. </member>
  1499. <member name="P:SuperSocket.SocketBase.Config.RootConfig.DefaultCulture">
  1500. <summary>
  1501. Gets or sets the default culture.
  1502. </summary>
  1503. <value>
  1504. The default culture.
  1505. </value>
  1506. </member>
  1507. <member name="P:SuperSocket.SocketBase.Config.RootConfig.MaxWorkingThreads">
  1508. <summary>
  1509. Gets/Sets the max working threads.
  1510. </summary>
  1511. </member>
  1512. <member name="P:SuperSocket.SocketBase.Config.RootConfig.MinWorkingThreads">
  1513. <summary>
  1514. Gets/sets the min working threads.
  1515. </summary>
  1516. </member>
  1517. <member name="P:SuperSocket.SocketBase.Config.RootConfig.MaxCompletionPortThreads">
  1518. <summary>
  1519. Gets/sets the max completion port threads.
  1520. </summary>
  1521. </member>
  1522. <member name="P:SuperSocket.SocketBase.Config.RootConfig.MinCompletionPortThreads">
  1523. <summary>
  1524. Gets/sets the min completion port threads.
  1525. </summary>
  1526. </member>
  1527. <member name="P:SuperSocket.SocketBase.Config.RootConfig.PerformanceDataCollectInterval">
  1528. <summary>
  1529. Gets/sets the performance data collect interval, in seconds.
  1530. </summary>
  1531. </member>
  1532. <member name="P:SuperSocket.SocketBase.Config.RootConfig.DisablePerformanceDataCollector">
  1533. <summary>
  1534. Gets/sets a value indicating whether [disable performance data collector].
  1535. </summary>
  1536. <value>
  1537. <c>true</c> if [disable performance data collector]; otherwise, <c>false</c>.
  1538. </value>
  1539. </member>
  1540. <member name="P:SuperSocket.SocketBase.Config.RootConfig.Isolation">
  1541. <summary>
  1542. Gets/sets the isolation mode.
  1543. </summary>
  1544. </member>
  1545. <member name="P:SuperSocket.SocketBase.Config.RootConfig.LogFactory">
  1546. <summary>
  1547. Gets/sets the log factory name.
  1548. </summary>
  1549. <value>
  1550. The log factory.
  1551. </value>
  1552. </member>
  1553. <member name="P:SuperSocket.SocketBase.Config.RootConfig.OptionElements">
  1554. <summary>
  1555. Gets/sets the option elements.
  1556. </summary>
  1557. </member>
  1558. <member name="M:SuperSocket.SocketBase.Config.ConfigurationSource.#ctor">
  1559. <summary>
  1560. Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Config.ConfigurationSource"/> class.
  1561. </summary>
  1562. </member>
  1563. <member name="M:SuperSocket.SocketBase.Config.ConfigurationSource.#ctor(SuperSocket.SocketBase.Config.IConfigurationSource)">
  1564. <summary>
  1565. Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Config.ConfigurationSource"/> class.
  1566. </summary>
  1567. <param name="source">The source.</param>
  1568. </member>
  1569. <member name="P:SuperSocket.SocketBase.Config.ConfigurationSource.Servers">
  1570. <summary>
  1571. Gets the servers definitions.
  1572. </summary>
  1573. </member>
  1574. <member name="P:SuperSocket.SocketBase.Config.ConfigurationSource.ServerTypes">
  1575. <summary>
  1576. Gets/sets the server types definition.
  1577. </summary>
  1578. </member>
  1579. <member name="P:SuperSocket.SocketBase.Config.ConfigurationSource.ConnectionFilters">
  1580. <summary>
  1581. Gets/sets the connection filters definition.
  1582. </summary>
  1583. </member>
  1584. <member name="P:SuperSocket.SocketBase.Config.ConfigurationSource.LogFactories">
  1585. <summary>
  1586. Gets/sets the log factories definition.
  1587. </summary>
  1588. </member>
  1589. <member name="P:SuperSocket.SocketBase.Config.ConfigurationSource.ReceiveFilterFactories">
  1590. <summary>
  1591. Gets/sets the Receive filter factories definition.
  1592. </summary>
  1593. </member>
  1594. <member name="P:SuperSocket.SocketBase.Config.ConfigurationSource.CommandLoaders">
  1595. <summary>
  1596. Gets/sets the command loaders definition.
  1597. </summary>
  1598. </member>
  1599. <member name="T:SuperSocket.SocketBase.Config.ServerConfig">
  1600. <summary>
  1601. Server configruation model
  1602. </summary>
  1603. </member>
  1604. <member name="F:SuperSocket.SocketBase.Config.ServerConfig.DefaultReceiveBufferSize">
  1605. <summary>
  1606. Default ReceiveBufferSize
  1607. </summary>
  1608. </member>
  1609. <member name="F:SuperSocket.SocketBase.Config.ServerConfig.DefaultMaxConnectionNumber">
  1610. <summary>
  1611. Default MaxConnectionNumber
  1612. </summary>
  1613. </member>
  1614. <member name="F:SuperSocket.SocketBase.Config.ServerConfig.DefaultSendingQueueSize">
  1615. <summary>
  1616. Default sending queue size
  1617. </summary>
  1618. </member>
  1619. <member name="F:SuperSocket.SocketBase.Config.ServerConfig.DefaultMaxRequestLength">
  1620. <summary>
  1621. Default MaxRequestLength
  1622. </summary>
  1623. </member>
  1624. <member name="F:SuperSocket.SocketBase.Config.ServerConfig.DefaultSendTimeout">
  1625. <summary>
  1626. Default send timeout value, in milliseconds
  1627. </summary>
  1628. </member>
  1629. <member name="F:SuperSocket.SocketBase.Config.ServerConfig.DefaultClearIdleSessionInterval">
  1630. <summary>
  1631. Default clear idle session interval
  1632. </summary>
  1633. </member>
  1634. <member name="F:SuperSocket.SocketBase.Config.ServerConfig.DefaultIdleSessionTimeOut">
  1635. <summary>
  1636. Default idle session timeout
  1637. </summary>
  1638. </member>
  1639. <member name="F:SuperSocket.SocketBase.Config.ServerConfig.DefaultSendBufferSize">
  1640. <summary>
  1641. The default send buffer size
  1642. </summary>
  1643. </member>
  1644. <member name="F:SuperSocket.SocketBase.Config.ServerConfig.DefaultSessionSnapshotInterval">
  1645. <summary>
  1646. The default session snapshot interval
  1647. </summary>
  1648. </member>
  1649. <member name="F:SuperSocket.SocketBase.Config.ServerConfig.DefaultKeepAliveTime">
  1650. <summary>
  1651. The default keep alive time
  1652. </summary>
  1653. </member>
  1654. <member name="F:SuperSocket.SocketBase.Config.ServerConfig.DefaultKeepAliveInterval">
  1655. <summary>
  1656. The default keep alive interval
  1657. </summary>
  1658. </member>
  1659. <member name="F:SuperSocket.SocketBase.Config.ServerConfig.DefaultListenBacklog">
  1660. <summary>
  1661. The default listen backlog
  1662. </summary>
  1663. </member>
  1664. <member name="M:SuperSocket.SocketBase.Config.ServerConfig.#ctor(SuperSocket.SocketBase.Config.IServerConfig)">
  1665. <summary>
  1666. Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Config.ServerConfig"/> class.
  1667. </summary>
  1668. <param name="serverConfig">The server config.</param>
  1669. </member>
  1670. <member name="M:SuperSocket.SocketBase.Config.ServerConfig.#ctor">
  1671. <summary>
  1672. Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Config.ServerConfig"/> class.
  1673. </summary>
  1674. </member>
  1675. <member name="M:SuperSocket.SocketBase.Config.ServerConfig.GetChildConfig``1(System.String)">
  1676. <summary>
  1677. Gets the child config.
  1678. </summary>
  1679. <typeparam name="TConfig">The type of the config.</typeparam>
  1680. <param name="childConfigName">Name of the child config.</param>
  1681. <returns></returns>
  1682. </member>
  1683. <member name="P:SuperSocket.SocketBase.Config.ServerConfig.DefaultCulture">
  1684. <summary>
  1685. Gets or sets the default culture.
  1686. </summary>
  1687. <value>
  1688. The default culture.
  1689. </value>
  1690. </member>
  1691. <member name="P:SuperSocket.SocketBase.Config.ServerConfig.ServerTypeName">
  1692. <summary>
  1693. Gets/sets the name of the server type of this appServer want to use.
  1694. </summary>
  1695. <value>
  1696. The name of the server type.
  1697. </value>
  1698. </member>
  1699. <member name="P:SuperSocket.SocketBase.Config.ServerConfig.ServerType">
  1700. <summary>
  1701. Gets/sets the type definition of the appserver.
  1702. </summary>
  1703. <value>
  1704. The type of the server.
  1705. </value>
  1706. </member>
  1707. <member name="P:SuperSocket.SocketBase.Config.ServerConfig.ReceiveFilterFactory">
  1708. <summary>
  1709. Gets/sets the Receive filter factory.
  1710. </summary>
  1711. </member>
  1712. <member name="P:SuperSocket.SocketBase.Config.ServerConfig.Ip">
  1713. <summary>
  1714. Gets/sets the ip.
  1715. </summary>
  1716. </member>
  1717. <member name="P:SuperSocket.SocketBase.Config.ServerConfig.Port">
  1718. <summary>
  1719. Gets/sets the port.
  1720. </summary>
  1721. </member>
  1722. <member name="P:SuperSocket.SocketBase.Config.ServerConfig.Options">
  1723. <summary>
  1724. Gets/sets the options.
  1725. </summary>
  1726. </member>
  1727. <member name="P:SuperSocket.SocketBase.Config.ServerConfig.OptionElements">
  1728. <summary>
  1729. Gets the option elements.
  1730. </summary>
  1731. </member>
  1732. <member name="P:SuperSocket.SocketBase.Config.ServerConfig.Disabled">
  1733. <summary>
  1734. Gets/sets a value indicating whether this <see cref="T:SuperSocket.SocketBase.Config.IServerConfig"/> is disabled.
  1735. </summary>
  1736. <value>
  1737. <c>true</c> if disabled; otherwise, <c>false</c>.
  1738. </value>
  1739. </member>
  1740. <member name="P:SuperSocket.SocketBase.Config.ServerConfig.Name">
  1741. <summary>
  1742. Gets the name.
  1743. </summary>
  1744. </member>
  1745. <member name="P:SuperSocket.SocketBase.Config.ServerConfig.Mode">
  1746. <summary>
  1747. Gets/sets the mode.
  1748. </summary>
  1749. </member>
  1750. <member name="P:SuperSocket.SocketBase.Config.ServerConfig.SendTimeOut">
  1751. <summary>
  1752. Gets/sets the send time out.
  1753. </summary>
  1754. </member>
  1755. <member name="P:SuperSocket.SocketBase.Config.ServerConfig.MaxConnectionNumber">
  1756. <summary>
  1757. Gets the max connection number.
  1758. </summary>
  1759. </member>
  1760. <member name="P:SuperSocket.SocketBase.Config.ServerConfig.ReceiveBufferSize">
  1761. <summary>
  1762. Gets the size of the receive buffer.
  1763. </summary>
  1764. <value>
  1765. The size of the receive buffer.
  1766. </value>
  1767. </member>
  1768. <member name="P:SuperSocket.SocketBase.Config.ServerConfig.SendBufferSize">
  1769. <summary>
  1770. Gets the size of the send buffer.
  1771. </summary>
  1772. <value>
  1773. The size of the send buffer.
  1774. </value>
  1775. </member>
  1776. <member name="P:SuperSocket.SocketBase.Config.ServerConfig.SyncSend">
  1777. <summary>
  1778. Gets a value indicating whether sending is in synchronous mode.
  1779. </summary>
  1780. <value>
  1781. <c>true</c> if [sync send]; otherwise, <c>false</c>.
  1782. </value>
  1783. </member>
  1784. <member name="P:SuperSocket.SocketBase.Config.ServerConfig.LogCommand">
  1785. <summary>
  1786. Gets/sets a value indicating whether log command in log file.
  1787. </summary>
  1788. <value>
  1789. <c>true</c> if log command; otherwise, <c>false</c>.
  1790. </value>
  1791. </member>
  1792. <member name="P:SuperSocket.SocketBase.Config.ServerConfig.ClearIdleSession">
  1793. <summary>
  1794. Gets/sets a value indicating whether clear idle session.
  1795. </summary>
  1796. <value>
  1797. <c>true</c> if clear idle session; otherwise, <c>false</c>.
  1798. </value>
  1799. </member>
  1800. <member name="P:SuperSocket.SocketBase.Config.ServerConfig.ClearIdleSessionInterval">
  1801. <summary>
  1802. Gets/sets the clear idle session interval, in seconds.
  1803. </summary>
  1804. <value>
  1805. The clear idle session interval.
  1806. </value>
  1807. </member>
  1808. <member name="P:SuperSocket.SocketBase.Config.ServerConfig.IdleSessionTimeOut">
  1809. <summary>
  1810. Gets/sets the idle session timeout time length, in seconds.
  1811. </summary>
  1812. <value>
  1813. The idle session time out.
  1814. </value>
  1815. </member>
  1816. <member name="P:SuperSocket.SocketBase.Config.ServerConfig.Certificate">
  1817. <summary>
  1818. Gets/sets X509Certificate configuration.
  1819. </summary>
  1820. <value>
  1821. X509Certificate configuration.
  1822. </value>
  1823. </member>
  1824. <member name="P:SuperSocket.SocketBase.Config.ServerConfig.Security">
  1825. <summary>
  1826. Gets/sets the security protocol, X509 certificate.
  1827. </summary>
  1828. </member>
  1829. <member name="P:SuperSocket.SocketBase.Config.ServerConfig.MaxRequestLength">
  1830. <summary>
  1831. Gets/sets the length of the max request.
  1832. </summary>
  1833. <value>
  1834. The length of the max request.
  1835. </value>
  1836. </member>
  1837. <member name="P:SuperSocket.SocketBase.Config.ServerConfig.DisableSessionSnapshot">
  1838. <summary>
  1839. Gets/sets a value indicating whether [disable session snapshot].
  1840. </summary>
  1841. <value>
  1842. <c>true</c> if [disable session snapshot]; otherwise, <c>false</c>.
  1843. </value>
  1844. </member>
  1845. <member name="P:SuperSocket.SocketBase.Config.ServerConfig.SessionSnapshotInterval">
  1846. <summary>
  1847. Gets/sets the interval to taking snapshot for all live sessions.
  1848. </summary>
  1849. </member>
  1850. <member name="P:SuperSocket.SocketBase.Config.ServerConfig.ConnectionFilter">
  1851. <summary>
  1852. Gets/sets the connection filters used by this server instance.
  1853. </summary>
  1854. <value>
  1855. The connection filter's name list, seperated by comma
  1856. </value>
  1857. </member>
  1858. <member name="P:SuperSocket.SocketBase.Config.ServerConfig.CommandLoader">
  1859. <summary>
  1860. Gets the command loader, multiple values should be separated by comma.
  1861. </summary>
  1862. </member>
  1863. <member name="P:SuperSocket.SocketBase.Config.ServerConfig.KeepAliveTime">
  1864. <summary>
  1865. Gets/sets the start keep alive time, in seconds
  1866. </summary>
  1867. </member>
  1868. <member name="P:SuperSocket.SocketBase.Config.ServerConfig.KeepAliveInterval">
  1869. <summary>
  1870. Gets/sets the keep alive interval, in seconds.
  1871. </summary>
  1872. </member>
  1873. <member name="P:SuperSocket.SocketBase.Config.ServerConfig.ListenBacklog">
  1874. <summary>
  1875. Gets the backlog size of socket listening.
  1876. </summary>
  1877. </member>
  1878. <member name="P:SuperSocket.SocketBase.Config.ServerConfig.StartupOrder">
  1879. <summary>
  1880. Gets/sets the startup order of the server instance.
  1881. </summary>
  1882. </member>
  1883. <member name="P:SuperSocket.SocketBase.Config.ServerConfig.Listeners">
  1884. <summary>
  1885. Gets and sets the listeners' configuration.
  1886. </summary>
  1887. </member>
  1888. <member name="P:SuperSocket.SocketBase.Config.ServerConfig.LogFactory">
  1889. <summary>
  1890. Gets/sets the log factory name.
  1891. </summary>
  1892. </member>
  1893. <member name="P:SuperSocket.SocketBase.Config.ServerConfig.SendingQueueSize">
  1894. <summary>
  1895. Gets/sets the size of the sending queue.
  1896. </summary>
  1897. <value>
  1898. The size of the sending queue.
  1899. </value>
  1900. </member>
  1901. <member name="P:SuperSocket.SocketBase.Config.ServerConfig.LogBasicSessionActivity">
  1902. <summary>
  1903. Gets a value indicating whether [log basic session activity like connected and disconnected].
  1904. </summary>
  1905. <value>
  1906. <c>true</c> if [log basic session activity]; otherwise, <c>false</c>.
  1907. </value>
  1908. </member>
  1909. <member name="P:SuperSocket.SocketBase.Config.ServerConfig.LogAllSocketException">
  1910. <summary>
  1911. Gets/sets a value indicating whether [log all socket exception].
  1912. </summary>
  1913. <value>
  1914. <c>true</c> if [log all socket exception]; otherwise, <c>false</c>.
  1915. </value>
  1916. </member>
  1917. <member name="P:SuperSocket.SocketBase.Config.ServerConfig.TextEncoding">
  1918. <summary>
  1919. Gets/sets the default text encoding.
  1920. </summary>
  1921. <value>
  1922. The text encoding.
  1923. </value>
  1924. </member>
  1925. <member name="P:SuperSocket.SocketBase.Config.ServerConfig.CommandAssemblies">
  1926. <summary>
  1927. Gets the command assemblies configuration.
  1928. </summary>
  1929. <value>
  1930. The command assemblies.
  1931. </value>
  1932. </member>
  1933. <member name="T:SuperSocket.SocketBase.Config.HotUpdateAttribute">
  1934. <summary>
  1935. the attribute to mark which property of ServerConfig support hot update
  1936. </summary>
  1937. </member>
  1938. <member name="T:SuperSocket.SocketBase.Config.TypeProvider">
  1939. <summary>
  1940. Type provider configuration
  1941. </summary>
  1942. </member>
  1943. <member name="P:SuperSocket.SocketBase.Config.TypeProvider.Name">
  1944. <summary>
  1945. Gets the name.
  1946. </summary>
  1947. </member>
  1948. <member name="P:SuperSocket.SocketBase.Config.TypeProvider.Type">
  1949. <summary>
  1950. Gets the type.
  1951. </summary>
  1952. </member>
  1953. <member name="T:SuperSocket.SocketBase.Config.TypeProviderCollection">
  1954. <summary>
  1955. Type provider colletion configuration
  1956. </summary>
  1957. </member>
  1958. <member name="M:SuperSocket.SocketBase.Config.TypeProviderCollection.CreateNewElement">
  1959. <summary>
  1960. When overridden in a derived class, creates a new <see cref="T:System.Configuration.ConfigurationElement"/>.
  1961. </summary>
  1962. <returns>
  1963. A new <see cref="T:System.Configuration.ConfigurationElement"/>.
  1964. </returns>
  1965. </member>
  1966. <member name="M:SuperSocket.SocketBase.Config.TypeProviderCollection.GetElementKey(System.Configuration.ConfigurationElement)">
  1967. <summary>
  1968. Gets the element key for a specified configuration element when overridden in a derived class.
  1969. </summary>
  1970. <param name="element">The <see cref="T:System.Configuration.ConfigurationElement"/> to return the key for.</param>
  1971. <returns>
  1972. An <see cref="T:System.Object"/> that acts as the key for the specified <see cref="T:System.Configuration.ConfigurationElement"/>.
  1973. </returns>
  1974. </member>
  1975. <member name="M:SuperSocket.SocketBase.Config.TypeProviderCollection.GetEnumerator">
  1976. <summary>
  1977. Returns an enumerator that iterates through the collection.
  1978. </summary>
  1979. <returns>
  1980. A <see cref="T:System.Collections.Generic.IEnumerator`1"/> that can be used to iterate through the collection.
  1981. </returns>
  1982. </member>
  1983. <member name="T:SuperSocket.SocketBase.Config.TypeProviderConfig">
  1984. <summary>
  1985. TypeProviderConfig
  1986. </summary>
  1987. </member>
  1988. <member name="P:SuperSocket.SocketBase.Config.TypeProviderConfig.Name">
  1989. <summary>
  1990. Gets the name.
  1991. </summary>
  1992. </member>
  1993. <member name="P:SuperSocket.SocketBase.Config.TypeProviderConfig.Type">
  1994. <summary>
  1995. Gets the type.
  1996. </summary>
  1997. </member>
  1998. <member name="T:SuperSocket.SocketBase.Extensions">
  1999. <summary>
  2000. Extensions class for SocketBase project
  2001. </summary>
  2002. </member>
  2003. <member name="M:SuperSocket.SocketBase.Extensions.GetServerByName(SuperSocket.SocketBase.IBootstrap,System.String)">
  2004. <summary>
  2005. Gets the app server instance in the bootstrap by name, ignore case
  2006. </summary>
  2007. <param name="bootstrap">The bootstrap.</param>
  2008. <param name="name">The name of the appserver instance.</param>
  2009. <returns></returns>
  2010. <exception cref="T:System.ArgumentNullException"></exception>
  2011. </member>
  2012. <member name="M:SuperSocket.SocketBase.Extensions.GetStatusInfoMetadata(System.Type)">
  2013. <summary>
  2014. Gets the status info metadata from the server type.
  2015. </summary>
  2016. <param name="serverType">Type of the server.</param>
  2017. <returns></returns>
  2018. <exception cref="T:System.ArgumentNullException"></exception>
  2019. </member>
  2020. <member name="T:SuperSocket.SocketBase.ActiveConnectResult">
  2021. <summary>
  2022. Active connect result model
  2023. </summary>
  2024. </member>
  2025. <member name="P:SuperSocket.SocketBase.ActiveConnectResult.Result">
  2026. <summary>
  2027. Gets or sets a value indicating whether the conecting is sucessfull
  2028. </summary>
  2029. <value>
  2030. <c>true</c> if result; otherwise, <c>false</c>.
  2031. </value>
  2032. </member>
  2033. <member name="P:SuperSocket.SocketBase.ActiveConnectResult.Session">
  2034. <summary>
  2035. Gets or sets the connected session.
  2036. </summary>
  2037. <value>
  2038. The connected session.
  2039. </value>
  2040. </member>
  2041. <member name="T:SuperSocket.SocketBase.StartResult">
  2042. <summary>
  2043. The bootstrap start result
  2044. </summary>
  2045. </member>
  2046. <member name="F:SuperSocket.SocketBase.StartResult.None">
  2047. <summary>
  2048. No appserver has been set in the bootstrap, so nothing was started
  2049. </summary>
  2050. </member>
  2051. <member name="F:SuperSocket.SocketBase.StartResult.Success">
  2052. <summary>
  2053. All appserver instances were started successfully
  2054. </summary>
  2055. </member>
  2056. <member name="F:SuperSocket.SocketBase.StartResult.PartialSuccess">
  2057. <summary>
  2058. Some appserver instances were started successfully, but some of them failed
  2059. </summary>
  2060. </member>
  2061. <member name="F:SuperSocket.SocketBase.StartResult.Failed">
  2062. <summary>
  2063. All appserver instances failed to start
  2064. </summary>
  2065. </member>
  2066. <member name="T:SuperSocket.SocketBase.IBootstrap">
  2067. <summary>
  2068. SuperSocket bootstrap
  2069. </summary>
  2070. </member>
  2071. <member name="M:SuperSocket.SocketBase.IBootstrap.Initialize">
  2072. <summary>
  2073. Initializes the bootstrap with the configuration
  2074. </summary>
  2075. <returns></returns>
  2076. </member>
  2077. <member name="M:SuperSocket.SocketBase.IBootstrap.Initialize(System.Collections.Generic.IDictionary{System.String,System.Net.IPEndPoint})">
  2078. <summary>
  2079. Initializes the bootstrap with a listen endpoint replacement dictionary
  2080. </summary>
  2081. <param name="listenEndPointReplacement">The listen end point replacement.</param>
  2082. <returns></returns>
  2083. </member>
  2084. <member name="M:SuperSocket.SocketBase.IBootstrap.Initialize(System.Func{SuperSocket.SocketBase.Config.IServerConfig,SuperSocket.SocketBase.Config.IServerConfig})">
  2085. <summary>
  2086. Initializes the bootstrap with the configuration
  2087. </summary>
  2088. <param name="serverConfigResolver">The server config resolver.</param>
  2089. <returns></returns>
  2090. </member>
  2091. <member name="M:SuperSocket.SocketBase.IBootstrap.Initialize(SuperSocket.SocketBase.Logging.ILogFactory)">
  2092. <summary>
  2093. Initializes the bootstrap with the configuration
  2094. </summary>
  2095. <param name="logFactory">The log factory.</param>
  2096. <returns></returns>
  2097. </member>
  2098. <member name="M:SuperSocket.SocketBase.IBootstrap.Initialize(System.Func{SuperSocket.SocketBase.Config.IServerConfig,SuperSocket.SocketBase.Config.IServerConfig},SuperSocket.SocketBase.Logging.ILogFactory)">
  2099. <summary>
  2100. Initializes the bootstrap with the configuration
  2101. </summary>
  2102. <param name="serverConfigResolver">The server config resolver.</param>
  2103. <param name="logFactory">The log factory.</param>
  2104. <returns></returns>
  2105. </member>
  2106. <member name="M:SuperSocket.SocketBase.IBootstrap.Start">
  2107. <summary>
  2108. Starts this bootstrap.
  2109. </summary>
  2110. <returns></returns>
  2111. </member>
  2112. <member name="M:SuperSocket.SocketBase.IBootstrap.Stop">
  2113. <summary>
  2114. Stops this bootstrap.
  2115. </summary>
  2116. </member>
  2117. <member name="P:SuperSocket.SocketBase.IBootstrap.AppServers">
  2118. <summary>
  2119. Gets all the app servers running in this bootstrap
  2120. </summary>
  2121. </member>
  2122. <member name="P:SuperSocket.SocketBase.IBootstrap.Config">
  2123. <summary>
  2124. Gets the config.
  2125. </summary>
  2126. </member>
  2127. <member name="P:SuperSocket.SocketBase.IBootstrap.StartupConfigFile">
  2128. <summary>
  2129. Gets the startup config file.
  2130. </summary>
  2131. </member>
  2132. <member name="P:SuperSocket.SocketBase.IBootstrap.BaseDirectory">
  2133. <summary>
  2134. Gets the base directory.
  2135. </summary>
  2136. <value>
  2137. The base directory.
  2138. </value>
  2139. </member>
  2140. <member name="T:SuperSocket.SocketBase.IDynamicBootstrap">
  2141. <summary>
  2142. The bootstrap interface to support add new server instance in runtime
  2143. </summary>
  2144. </member>
  2145. <member name="M:SuperSocket.SocketBase.IDynamicBootstrap.Add(SuperSocket.SocketBase.Config.IServerConfig)">
  2146. <summary>
  2147. Adds a new server into the bootstrap.
  2148. </summary>
  2149. <param name="config">The new server's config.</param>
  2150. <returns></returns>
  2151. </member>
  2152. <member name="M:SuperSocket.SocketBase.IDynamicBootstrap.AddAndStart(SuperSocket.SocketBase.Config.IServerConfig)">
  2153. <summary>
  2154. Adds a new server into the bootstrap and then start it.
  2155. </summary>
  2156. <param name="config">The new server's config.</param>
  2157. <returns></returns>
  2158. </member>
  2159. <member name="M:SuperSocket.SocketBase.IDynamicBootstrap.Remove(System.String)">
  2160. <summary>
  2161. Removes the server instance which is specified by name.
  2162. </summary>
  2163. <param name="name">The name of the server instance to be removed.</param>
  2164. </member>
  2165. <member name="T:SuperSocket.SocketBase.IsolationMode">
  2166. <summary>
  2167. AppServer instance running isolation mode
  2168. </summary>
  2169. </member>
  2170. <member name="F:SuperSocket.SocketBase.IsolationMode.None">
  2171. <summary>
  2172. No isolation
  2173. </summary>
  2174. </member>
  2175. <member name="F:SuperSocket.SocketBase.IsolationMode.AppDomain">
  2176. <summary>
  2177. Isolation by AppDomain
  2178. </summary>
  2179. </member>
  2180. <member name="F:SuperSocket.SocketBase.IsolationMode.Process">
  2181. <summary>
  2182. Isolation by process
  2183. </summary>
  2184. </member>
  2185. <member name="T:SuperSocket.SocketBase.Logging.ConsoleLog">
  2186. <summary>
  2187. Console Log
  2188. </summary>
  2189. </member>
  2190. <member name="T:SuperSocket.SocketBase.Logging.ILog">
  2191. <summary>
  2192. Log interface
  2193. </summary>
  2194. </member>
  2195. <member name="M:SuperSocket.SocketBase.Logging.ILog.Debug(System.Object)">
  2196. <summary>
  2197. Logs the debug message.
  2198. </summary>
  2199. <param name="message">The message.</param>
  2200. </member>
  2201. <member name="M:SuperSocket.SocketBase.Logging.ILog.Debug(System.Object,System.Exception)">
  2202. <summary>
  2203. Logs the debug message.
  2204. </summary>
  2205. <param name="message">The message.</param>
  2206. <param name="exception">The exception.</param>
  2207. </member>
  2208. <member name="M:SuperSocket.SocketBase.Logging.ILog.DebugFormat(System.String,System.Object)">
  2209. <summary>
  2210. Logs the debug message.
  2211. </summary>
  2212. <param name="format">The format.</param>
  2213. <param name="arg0">The arg0.</param>
  2214. </member>
  2215. <member name="M:SuperSocket.SocketBase.Logging.ILog.DebugFormat(System.String,System.Object[])">
  2216. <summary>
  2217. Logs the debug message.
  2218. </summary>
  2219. <param name="format">The format.</param>
  2220. <param name="args">The args.</param>
  2221. </member>
  2222. <member name="M:SuperSocket.SocketBase.Logging.ILog.DebugFormat(System.IFormatProvider,System.String,System.Object[])">
  2223. <summary>
  2224. Logs the debug message.
  2225. </summary>
  2226. <param name="provider">The provider.</param>
  2227. <param name="format">The format.</param>
  2228. <param name="args">The args.</param>
  2229. </member>
  2230. <member name="M:SuperSocket.SocketBase.Logging.ILog.DebugFormat(System.String,System.Object,System.Object)">
  2231. <summary>
  2232. Logs the debug message.
  2233. </summary>
  2234. <param name="format">The format.</param>
  2235. <param name="arg0">The arg0.</param>
  2236. <param name="arg1">The arg1.</param>
  2237. </member>
  2238. <member name="M:SuperSocket.SocketBase.Logging.ILog.DebugFormat(System.String,System.Object,System.Object,System.Object)">
  2239. <summary>
  2240. Logs the debug message.
  2241. </summary>
  2242. <param name="format">The format.</param>
  2243. <param name="arg0">The arg0.</param>
  2244. <param name="arg1">The arg1.</param>
  2245. <param name="arg2">The arg2.</param>
  2246. </member>
  2247. <member name="M:SuperSocket.SocketBase.Logging.ILog.Error(System.Object)">
  2248. <summary>
  2249. Logs the error message.
  2250. </summary>
  2251. <param name="message">The message.</param>
  2252. </member>
  2253. <member name="M:SuperSocket.SocketBase.Logging.ILog.Error(System.Object,System.Exception)">
  2254. <summary>
  2255. Logs the error message.
  2256. </summary>
  2257. <param name="message">The message.</param>
  2258. <param name="exception">The exception.</param>
  2259. </member>
  2260. <member name="M:SuperSocket.SocketBase.Logging.ILog.ErrorFormat(System.String,System.Object)">
  2261. <summary>
  2262. Logs the error message.
  2263. </summary>
  2264. <param name="format">The format.</param>
  2265. <param name="arg0">The arg0.</param>
  2266. </member>
  2267. <member name="M:SuperSocket.SocketBase.Logging.ILog.ErrorFormat(System.String,System.Object[])">
  2268. <summary>
  2269. Logs the error message.
  2270. </summary>
  2271. <param name="format">The format.</param>
  2272. <param name="args">The args.</param>
  2273. </member>
  2274. <member name="M:SuperSocket.SocketBase.Logging.ILog.ErrorFormat(System.IFormatProvider,System.String,System.Object[])">
  2275. <summary>
  2276. Logs the error message.
  2277. </summary>
  2278. <param name="provider">The provider.</param>
  2279. <param name="format">The format.</param>
  2280. <param name="args">The args.</param>
  2281. </member>
  2282. <member name="M:SuperSocket.SocketBase.Logging.ILog.ErrorFormat(System.String,System.Object,System.Object)">
  2283. <summary>
  2284. Logs the error message.
  2285. </summary>
  2286. <param name="format">The format.</param>
  2287. <param name="arg0">The arg0.</param>
  2288. <param name="arg1">The arg1.</param>
  2289. </member>
  2290. <member name="M:SuperSocket.SocketBase.Logging.ILog.ErrorFormat(System.String,System.Object,System.Object,System.Object)">
  2291. <summary>
  2292. Logs the error message.
  2293. </summary>
  2294. <param name="format">The format.</param>
  2295. <param name="arg0">The arg0.</param>
  2296. <param name="arg1">The arg1.</param>
  2297. <param name="arg2">The arg2.</param>
  2298. </member>
  2299. <member name="M:SuperSocket.SocketBase.Logging.ILog.Fatal(System.Object)">
  2300. <summary>
  2301. Logs the fatal error message.
  2302. </summary>
  2303. <param name="message">The message.</param>
  2304. </member>
  2305. <member name="M:SuperSocket.SocketBase.Logging.ILog.Fatal(System.Object,System.Exception)">
  2306. <summary>
  2307. Logs the fatal error message.
  2308. </summary>
  2309. <param name="message">The message.</param>
  2310. <param name="exception">The exception.</param>
  2311. </member>
  2312. <member name="M:SuperSocket.SocketBase.Logging.ILog.FatalFormat(System.String,System.Object)">
  2313. <summary>
  2314. Logs the fatal error message.
  2315. </summary>
  2316. <param name="format">The format.</param>
  2317. <param name="arg0">The arg0.</param>
  2318. </member>
  2319. <member name="M:SuperSocket.SocketBase.Logging.ILog.FatalFormat(System.String,System.Object[])">
  2320. <summary>
  2321. Logs the fatal error message.
  2322. </summary>
  2323. <param name="format">The format.</param>
  2324. <param name="args">The args.</param>
  2325. </member>
  2326. <member name="M:SuperSocket.SocketBase.Logging.ILog.FatalFormat(System.IFormatProvider,System.String,System.Object[])">
  2327. <summary>
  2328. Logs the fatal error message.
  2329. </summary>
  2330. <param name="provider">The provider.</param>
  2331. <param name="format">The format.</param>
  2332. <param name="args">The args.</param>
  2333. </member>
  2334. <member name="M:SuperSocket.SocketBase.Logging.ILog.FatalFormat(System.String,System.Object,System.Object)">
  2335. <summary>
  2336. Logs the fatal error message.
  2337. </summary>
  2338. <param name="format">The format.</param>
  2339. <param name="arg0">The arg0.</param>
  2340. <param name="arg1">The arg1.</param>
  2341. </member>
  2342. <member name="M:SuperSocket.SocketBase.Logging.ILog.FatalFormat(System.String,System.Object,System.Object,System.Object)">
  2343. <summary>
  2344. Logs the fatal error message.
  2345. </summary>
  2346. <param name="format">The format.</param>
  2347. <param name="arg0">The arg0.</param>
  2348. <param name="arg1">The arg1.</param>
  2349. <param name="arg2">The arg2.</param>
  2350. </member>
  2351. <member name="M:SuperSocket.SocketBase.Logging.ILog.Info(System.Object)">
  2352. <summary>
  2353. Logs the info message.
  2354. </summary>
  2355. <param name="message">The message.</param>
  2356. </member>
  2357. <member name="M:SuperSocket.SocketBase.Logging.ILog.Info(System.Object,System.Exception)">
  2358. <summary>
  2359. Logs the info message.
  2360. </summary>
  2361. <param name="message">The message.</param>
  2362. <param name="exception">The exception.</param>
  2363. </member>
  2364. <member name="M:SuperSocket.SocketBase.Logging.ILog.InfoFormat(System.String,System.Object)">
  2365. <summary>
  2366. Logs the info message.
  2367. </summary>
  2368. <param name="format">The format.</param>
  2369. <param name="arg0">The arg0.</param>
  2370. </member>
  2371. <member name="M:SuperSocket.SocketBase.Logging.ILog.InfoFormat(System.String,System.Object[])">
  2372. <summary>
  2373. Logs the info message.
  2374. </summary>
  2375. <param name="format">The format.</param>
  2376. <param name="args">The args.</param>
  2377. </member>
  2378. <member name="M:SuperSocket.SocketBase.Logging.ILog.InfoFormat(System.IFormatProvider,System.String,System.Object[])">
  2379. <summary>
  2380. Logs the info message.
  2381. </summary>
  2382. <param name="provider">The provider.</param>
  2383. <param name="format">The format.</param>
  2384. <param name="args">The args.</param>
  2385. </member>
  2386. <member name="M:SuperSocket.SocketBase.Logging.ILog.InfoFormat(System.String,System.Object,System.Object)">
  2387. <summary>
  2388. Logs the info message.
  2389. </summary>
  2390. <param name="format">The format.</param>
  2391. <param name="arg0">The arg0.</param>
  2392. <param name="arg1">The arg1.</param>
  2393. </member>
  2394. <member name="M:SuperSocket.SocketBase.Logging.ILog.InfoFormat(System.String,System.Object,System.Object,System.Object)">
  2395. <summary>
  2396. Logs the info message.
  2397. </summary>
  2398. <param name="format">The format.</param>
  2399. <param name="arg0">The arg0.</param>
  2400. <param name="arg1">The arg1.</param>
  2401. <param name="arg2">The arg2.</param>
  2402. </member>
  2403. <member name="M:SuperSocket.SocketBase.Logging.ILog.Warn(System.Object)">
  2404. <summary>
  2405. Logs the warning message.
  2406. </summary>
  2407. <param name="message">The message.</param>
  2408. </member>
  2409. <member name="M:SuperSocket.SocketBase.Logging.ILog.Warn(System.Object,System.Exception)">
  2410. <summary>
  2411. Logs the warning message.
  2412. </summary>
  2413. <param name="message">The message.</param>
  2414. <param name="exception">The exception.</param>
  2415. </member>
  2416. <member name="M:SuperSocket.SocketBase.Logging.ILog.WarnFormat(System.String,System.Object)">
  2417. <summary>
  2418. Logs the warning message.
  2419. </summary>
  2420. <param name="format">The format.</param>
  2421. <param name="arg0">The arg0.</param>
  2422. </member>
  2423. <member name="M:SuperSocket.SocketBase.Logging.ILog.WarnFormat(System.String,System.Object[])">
  2424. <summary>
  2425. Logs the warning message.
  2426. </summary>
  2427. <param name="format">The format.</param>
  2428. <param name="args">The args.</param>
  2429. </member>
  2430. <member name="M:SuperSocket.SocketBase.Logging.ILog.WarnFormat(System.IFormatProvider,System.String,System.Object[])">
  2431. <summary>
  2432. Logs the warning message.
  2433. </summary>
  2434. <param name="provider">The provider.</param>
  2435. <param name="format">The format.</param>
  2436. <param name="args">The args.</param>
  2437. </member>
  2438. <member name="M:SuperSocket.SocketBase.Logging.ILog.WarnFormat(System.String,System.Object,System.Object)">
  2439. <summary>
  2440. Logs the warning message.
  2441. </summary>
  2442. <param name="format">The format.</param>
  2443. <param name="arg0">The arg0.</param>
  2444. <param name="arg1">The arg1.</param>
  2445. </member>
  2446. <member name="M:SuperSocket.SocketBase.Logging.ILog.WarnFormat(System.String,System.Object,System.Object,System.Object)">
  2447. <summary>
  2448. Logs the warning message.
  2449. </summary>
  2450. <param name="format">The format.</param>
  2451. <param name="arg0">The arg0.</param>
  2452. <param name="arg1">The arg1.</param>
  2453. <param name="arg2">The arg2.</param>
  2454. </member>
  2455. <member name="P:SuperSocket.SocketBase.Logging.ILog.IsDebugEnabled">
  2456. <summary>
  2457. Gets a value indicating whether this instance is debug enabled.
  2458. </summary>
  2459. <value>
  2460. <c>true</c> if this instance is debug enabled; otherwise, <c>false</c>.
  2461. </value>
  2462. </member>
  2463. <member name="P:SuperSocket.SocketBase.Logging.ILog.IsErrorEnabled">
  2464. <summary>
  2465. Gets a value indicating whether this instance is error enabled.
  2466. </summary>
  2467. <value>
  2468. <c>true</c> if this instance is error enabled; otherwise, <c>false</c>.
  2469. </value>
  2470. </member>
  2471. <member name="P:SuperSocket.SocketBase.Logging.ILog.IsFatalEnabled">
  2472. <summary>
  2473. Gets a value indicating whether this instance is fatal enabled.
  2474. </summary>
  2475. <value>
  2476. <c>true</c> if this instance is fatal enabled; otherwise, <c>false</c>.
  2477. </value>
  2478. </member>
  2479. <member name="P:SuperSocket.SocketBase.Logging.ILog.IsInfoEnabled">
  2480. <summary>
  2481. Gets a value indicating whether this instance is info enabled.
  2482. </summary>
  2483. <value>
  2484. <c>true</c> if this instance is info enabled; otherwise, <c>false</c>.
  2485. </value>
  2486. </member>
  2487. <member name="P:SuperSocket.SocketBase.Logging.ILog.IsWarnEnabled">
  2488. <summary>
  2489. Gets a value indicating whether this instance is warn enabled.
  2490. </summary>
  2491. <value>
  2492. <c>true</c> if this instance is warn enabled; otherwise, <c>false</c>.
  2493. </value>
  2494. </member>
  2495. <member name="M:SuperSocket.SocketBase.Logging.ConsoleLog.#ctor(System.String)">
  2496. <summary>
  2497. Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Logging.ConsoleLog"/> class.
  2498. </summary>
  2499. <param name="name">The name.</param>
  2500. </member>
  2501. <member name="M:SuperSocket.SocketBase.Logging.ConsoleLog.Debug(System.Object)">
  2502. <summary>
  2503. Logs the debug message.
  2504. </summary>
  2505. <param name="message">The message.</param>
  2506. </member>
  2507. <member name="M:SuperSocket.SocketBase.Logging.ConsoleLog.Debug(System.Object,System.Exception)">
  2508. <summary>
  2509. Logs the debug message.
  2510. </summary>
  2511. <param name="message">The message.</param>
  2512. <param name="exception">The exception.</param>
  2513. </member>
  2514. <member name="M:SuperSocket.SocketBase.Logging.ConsoleLog.DebugFormat(System.String,System.Object)">
  2515. <summary>
  2516. Logs the debug message.
  2517. </summary>
  2518. <param name="format">The format.</param>
  2519. <param name="arg0">The arg0.</param>
  2520. </member>
  2521. <member name="M:SuperSocket.SocketBase.Logging.ConsoleLog.DebugFormat(System.String,System.Object[])">
  2522. <summary>
  2523. Logs the debug message.
  2524. </summary>
  2525. <param name="format">The format.</param>
  2526. <param name="args">The args.</param>
  2527. </member>
  2528. <member name="M:SuperSocket.SocketBase.Logging.ConsoleLog.DebugFormat(System.IFormatProvider,System.String,System.Object[])">
  2529. <summary>
  2530. Logs the debug message.
  2531. </summary>
  2532. <param name="provider">The provider.</param>
  2533. <param name="format">The format.</param>
  2534. <param name="args">The args.</param>
  2535. </member>
  2536. <member name="M:SuperSocket.SocketBase.Logging.ConsoleLog.DebugFormat(System.String,System.Object,System.Object)">
  2537. <summary>
  2538. Logs the debug message.
  2539. </summary>
  2540. <param name="format">The format.</param>
  2541. <param name="arg0">The arg0.</param>
  2542. <param name="arg1">The arg1.</param>
  2543. </member>
  2544. <member name="M:SuperSocket.SocketBase.Logging.ConsoleLog.DebugFormat(System.String,System.Object,System.Object,System.Object)">
  2545. <summary>
  2546. Logs the debug message.
  2547. </summary>
  2548. <param name="format">The format.</param>
  2549. <param name="arg0">The arg0.</param>
  2550. <param name="arg1">The arg1.</param>
  2551. <param name="arg2">The arg2.</param>
  2552. </member>
  2553. <member name="M:SuperSocket.SocketBase.Logging.ConsoleLog.Error(System.Object)">
  2554. <summary>
  2555. Logs the error message.
  2556. </summary>
  2557. <param name="message">The message.</param>
  2558. </member>
  2559. <member name="M:SuperSocket.SocketBase.Logging.ConsoleLog.Error(System.Object,System.Exception)">
  2560. <summary>
  2561. Logs the error message.
  2562. </summary>
  2563. <param name="message">The message.</param>
  2564. <param name="exception">The exception.</param>
  2565. </member>
  2566. <member name="M:SuperSocket.SocketBase.Logging.ConsoleLog.ErrorFormat(System.String,System.Object)">
  2567. <summary>
  2568. Logs the error message.
  2569. </summary>
  2570. <param name="format">The format.</param>
  2571. <param name="arg0">The arg0.</param>
  2572. </member>
  2573. <member name="M:SuperSocket.SocketBase.Logging.ConsoleLog.ErrorFormat(System.String,System.Object[])">
  2574. <summary>
  2575. Logs the error message.
  2576. </summary>
  2577. <param name="format">The format.</param>
  2578. <param name="args">The args.</param>
  2579. </member>
  2580. <member name="M:SuperSocket.SocketBase.Logging.ConsoleLog.ErrorFormat(System.IFormatProvider,System.String,System.Object[])">
  2581. <summary>
  2582. Logs the error message.
  2583. </summary>
  2584. <param name="provider">The provider.</param>
  2585. <param name="format">The format.</param>
  2586. <param name="args">The args.</param>
  2587. </member>
  2588. <member name="M:SuperSocket.SocketBase.Logging.ConsoleLog.ErrorFormat(System.String,System.Object,System.Object)">
  2589. <summary>
  2590. Logs the error message.
  2591. </summary>
  2592. <param name="format">The format.</param>
  2593. <param name="arg0">The arg0.</param>
  2594. <param name="arg1">The arg1.</param>
  2595. </member>
  2596. <member name="M:SuperSocket.SocketBase.Logging.ConsoleLog.ErrorFormat(System.String,System.Object,System.Object,System.Object)">
  2597. <summary>
  2598. Logs the error message.
  2599. </summary>
  2600. <param name="format">The format.</param>
  2601. <param name="arg0">The arg0.</param>
  2602. <param name="arg1">The arg1.</param>
  2603. <param name="arg2">The arg2.</param>
  2604. </member>
  2605. <member name="M:SuperSocket.SocketBase.Logging.ConsoleLog.Fatal(System.Object)">
  2606. <summary>
  2607. Logs the fatal error message.
  2608. </summary>
  2609. <param name="message">The message.</param>
  2610. </member>
  2611. <member name="M:SuperSocket.SocketBase.Logging.ConsoleLog.Fatal(System.Object,System.Exception)">
  2612. <summary>
  2613. Logs the fatal error message.
  2614. </summary>
  2615. <param name="message">The message.</param>
  2616. <param name="exception">The exception.</param>
  2617. </member>
  2618. <member name="M:SuperSocket.SocketBase.Logging.ConsoleLog.FatalFormat(System.String,System.Object)">
  2619. <summary>
  2620. Logs the fatal error message.
  2621. </summary>
  2622. <param name="format">The format.</param>
  2623. <param name="arg0">The arg0.</param>
  2624. </member>
  2625. <member name="M:SuperSocket.SocketBase.Logging.ConsoleLog.FatalFormat(System.String,System.Object[])">
  2626. <summary>
  2627. Logs the fatal error message.
  2628. </summary>
  2629. <param name="format">The format.</param>
  2630. <param name="args">The args.</param>
  2631. </member>
  2632. <member name="M:SuperSocket.SocketBase.Logging.ConsoleLog.FatalFormat(System.IFormatProvider,System.String,System.Object[])">
  2633. <summary>
  2634. Logs the fatal error message.
  2635. </summary>
  2636. <param name="provider">The provider.</param>
  2637. <param name="format">The format.</param>
  2638. <param name="args">The args.</param>
  2639. </member>
  2640. <member name="M:SuperSocket.SocketBase.Logging.ConsoleLog.FatalFormat(System.String,System.Object,System.Object)">
  2641. <summary>
  2642. Logs the fatal error message.
  2643. </summary>
  2644. <param name="format">The format.</param>
  2645. <param name="arg0">The arg0.</param>
  2646. <param name="arg1">The arg1.</param>
  2647. </member>
  2648. <member name="M:SuperSocket.SocketBase.Logging.ConsoleLog.FatalFormat(System.String,System.Object,System.Object,System.Object)">
  2649. <summary>
  2650. Logs the fatal error message.
  2651. </summary>
  2652. <param name="format">The format.</param>
  2653. <param name="arg0">The arg0.</param>
  2654. <param name="arg1">The arg1.</param>
  2655. <param name="arg2">The arg2.</param>
  2656. </member>
  2657. <member name="M:SuperSocket.SocketBase.Logging.ConsoleLog.Info(System.Object)">
  2658. <summary>
  2659. Logs the info message.
  2660. </summary>
  2661. <param name="message">The message.</param>
  2662. </member>
  2663. <member name="M:SuperSocket.SocketBase.Logging.ConsoleLog.Info(System.Object,System.Exception)">
  2664. <summary>
  2665. Logs the info message.
  2666. </summary>
  2667. <param name="message">The message.</param>
  2668. <param name="exception">The exception.</param>
  2669. </member>
  2670. <member name="M:SuperSocket.SocketBase.Logging.ConsoleLog.InfoFormat(System.String,System.Object)">
  2671. <summary>
  2672. Logs the info message.
  2673. </summary>
  2674. <param name="format">The format.</param>
  2675. <param name="arg0">The arg0.</param>
  2676. </member>
  2677. <member name="M:SuperSocket.SocketBase.Logging.ConsoleLog.InfoFormat(System.String,System.Object[])">
  2678. <summary>
  2679. Logs the info message.
  2680. </summary>
  2681. <param name="format">The format.</param>
  2682. <param name="args">The args.</param>
  2683. </member>
  2684. <member name="M:SuperSocket.SocketBase.Logging.ConsoleLog.InfoFormat(System.IFormatProvider,System.String,System.Object[])">
  2685. <summary>
  2686. Logs the info message.
  2687. </summary>
  2688. <param name="provider">The provider.</param>
  2689. <param name="format">The format.</param>
  2690. <param name="args">The args.</param>
  2691. </member>
  2692. <member name="M:SuperSocket.SocketBase.Logging.ConsoleLog.InfoFormat(System.String,System.Object,System.Object)">
  2693. <summary>
  2694. Logs the info message.
  2695. </summary>
  2696. <param name="format">The format.</param>
  2697. <param name="arg0">The arg0.</param>
  2698. <param name="arg1">The arg1.</param>
  2699. </member>
  2700. <member name="M:SuperSocket.SocketBase.Logging.ConsoleLog.InfoFormat(System.String,System.Object,System.Object,System.Object)">
  2701. <summary>
  2702. Logs the info message.
  2703. </summary>
  2704. <param name="format">The format.</param>
  2705. <param name="arg0">The arg0.</param>
  2706. <param name="arg1">The arg1.</param>
  2707. <param name="arg2">The arg2.</param>
  2708. </member>
  2709. <member name="M:SuperSocket.SocketBase.Logging.ConsoleLog.Warn(System.Object)">
  2710. <summary>
  2711. Logs the warning message.
  2712. </summary>
  2713. <param name="message">The message.</param>
  2714. </member>
  2715. <member name="M:SuperSocket.SocketBase.Logging.ConsoleLog.Warn(System.Object,System.Exception)">
  2716. <summary>
  2717. Logs the warning message.
  2718. </summary>
  2719. <param name="message">The message.</param>
  2720. <param name="exception">The exception.</param>
  2721. </member>
  2722. <member name="M:SuperSocket.SocketBase.Logging.ConsoleLog.WarnFormat(System.String,System.Object)">
  2723. <summary>
  2724. Logs the warning message.
  2725. </summary>
  2726. <param name="format">The format.</param>
  2727. <param name="arg0">The arg0.</param>
  2728. </member>
  2729. <member name="M:SuperSocket.SocketBase.Logging.ConsoleLog.WarnFormat(System.String,System.Object[])">
  2730. <summary>
  2731. Logs the warning message.
  2732. </summary>
  2733. <param name="format">The format.</param>
  2734. <param name="args">The args.</param>
  2735. </member>
  2736. <member name="M:SuperSocket.SocketBase.Logging.ConsoleLog.WarnFormat(System.IFormatProvider,System.String,System.Object[])">
  2737. <summary>
  2738. Logs the warning message.
  2739. </summary>
  2740. <param name="provider">The provider.</param>
  2741. <param name="format">The format.</param>
  2742. <param name="args">The args.</param>
  2743. </member>
  2744. <member name="M:SuperSocket.SocketBase.Logging.ConsoleLog.WarnFormat(System.String,System.Object,System.Object)">
  2745. <summary>
  2746. Logs the warning message.
  2747. </summary>
  2748. <param name="format">The format.</param>
  2749. <param name="arg0">The arg0.</param>
  2750. <param name="arg1">The arg1.</param>
  2751. </member>
  2752. <member name="M:SuperSocket.SocketBase.Logging.ConsoleLog.WarnFormat(System.String,System.Object,System.Object,System.Object)">
  2753. <summary>
  2754. Logs the warning message.
  2755. </summary>
  2756. <param name="format">The format.</param>
  2757. <param name="arg0">The arg0.</param>
  2758. <param name="arg1">The arg1.</param>
  2759. <param name="arg2">The arg2.</param>
  2760. </member>
  2761. <member name="P:SuperSocket.SocketBase.Logging.ConsoleLog.IsDebugEnabled">
  2762. <summary>
  2763. Gets a value indicating whether this instance is debug enabled.
  2764. </summary>
  2765. <value>
  2766. <c>true</c> if this instance is debug enabled; otherwise, <c>false</c>.
  2767. </value>
  2768. </member>
  2769. <member name="P:SuperSocket.SocketBase.Logging.ConsoleLog.IsErrorEnabled">
  2770. <summary>
  2771. Gets a value indicating whether this instance is error enabled.
  2772. </summary>
  2773. <value>
  2774. <c>true</c> if this instance is error enabled; otherwise, <c>false</c>.
  2775. </value>
  2776. </member>
  2777. <member name="P:SuperSocket.SocketBase.Logging.ConsoleLog.IsFatalEnabled">
  2778. <summary>
  2779. Gets a value indicating whether this instance is fatal enabled.
  2780. </summary>
  2781. <value>
  2782. <c>true</c> if this instance is fatal enabled; otherwise, <c>false</c>.
  2783. </value>
  2784. </member>
  2785. <member name="P:SuperSocket.SocketBase.Logging.ConsoleLog.IsInfoEnabled">
  2786. <summary>
  2787. Gets a value indicating whether this instance is info enabled.
  2788. </summary>
  2789. <value>
  2790. <c>true</c> if this instance is info enabled; otherwise, <c>false</c>.
  2791. </value>
  2792. </member>
  2793. <member name="P:SuperSocket.SocketBase.Logging.ConsoleLog.IsWarnEnabled">
  2794. <summary>
  2795. Gets a value indicating whether this instance is warn enabled.
  2796. </summary>
  2797. <value>
  2798. <c>true</c> if this instance is warn enabled; otherwise, <c>false</c>.
  2799. </value>
  2800. </member>
  2801. <member name="T:SuperSocket.SocketBase.Logging.ConsoleLogFactory">
  2802. <summary>
  2803. Console log factory
  2804. </summary>
  2805. </member>
  2806. <member name="T:SuperSocket.SocketBase.Logging.ILogFactory">
  2807. <summary>
  2808. LogFactory Interface
  2809. </summary>
  2810. </member>
  2811. <member name="M:SuperSocket.SocketBase.Logging.ILogFactory.GetLog(System.String)">
  2812. <summary>
  2813. Gets the log by name.
  2814. </summary>
  2815. <param name="name">The name.</param>
  2816. <returns></returns>
  2817. </member>
  2818. <member name="M:SuperSocket.SocketBase.Logging.ConsoleLogFactory.GetLog(System.String)">
  2819. <summary>
  2820. Gets the log by name.
  2821. </summary>
  2822. <param name="name">The name.</param>
  2823. <returns></returns>
  2824. </member>
  2825. <member name="T:SuperSocket.SocketBase.Logging.Log4NetLog">
  2826. <summary>
  2827. Log4NetLog
  2828. </summary>
  2829. </member>
  2830. <member name="M:SuperSocket.SocketBase.Logging.Log4NetLog.#ctor(log4net.ILog)">
  2831. <summary>
  2832. Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Logging.Log4NetLog"/> class.
  2833. </summary>
  2834. <param name="log">The log.</param>
  2835. </member>
  2836. <member name="M:SuperSocket.SocketBase.Logging.Log4NetLog.Debug(System.Object)">
  2837. <summary>
  2838. Logs the debug message.
  2839. </summary>
  2840. <param name="message">The message.</param>
  2841. </member>
  2842. <member name="M:SuperSocket.SocketBase.Logging.Log4NetLog.Debug(System.Object,System.Exception)">
  2843. <summary>
  2844. Logs the debug message.
  2845. </summary>
  2846. <param name="message">The message.</param>
  2847. <param name="exception">The exception.</param>
  2848. </member>
  2849. <member name="M:SuperSocket.SocketBase.Logging.Log4NetLog.DebugFormat(System.String,System.Object)">
  2850. <summary>
  2851. Logs the debug message.
  2852. </summary>
  2853. <param name="format">The format.</param>
  2854. <param name="arg0">The arg0.</param>
  2855. </member>
  2856. <member name="M:SuperSocket.SocketBase.Logging.Log4NetLog.DebugFormat(System.String,System.Object[])">
  2857. <summary>
  2858. Logs the debug message.
  2859. </summary>
  2860. <param name="format">The format.</param>
  2861. <param name="args">The args.</param>
  2862. </member>
  2863. <member name="M:SuperSocket.SocketBase.Logging.Log4NetLog.DebugFormat(System.IFormatProvider,System.String,System.Object[])">
  2864. <summary>
  2865. Logs the debug message.
  2866. </summary>
  2867. <param name="provider">The provider.</param>
  2868. <param name="format">The format.</param>
  2869. <param name="args">The args.</param>
  2870. </member>
  2871. <member name="M:SuperSocket.SocketBase.Logging.Log4NetLog.DebugFormat(System.String,System.Object,System.Object)">
  2872. <summary>
  2873. Logs the debug message.
  2874. </summary>
  2875. <param name="format">The format.</param>
  2876. <param name="arg0">The arg0.</param>
  2877. <param name="arg1">The arg1.</param>
  2878. </member>
  2879. <member name="M:SuperSocket.SocketBase.Logging.Log4NetLog.DebugFormat(System.String,System.Object,System.Object,System.Object)">
  2880. <summary>
  2881. Logs the debug message.
  2882. </summary>
  2883. <param name="format">The format.</param>
  2884. <param name="arg0">The arg0.</param>
  2885. <param name="arg1">The arg1.</param>
  2886. <param name="arg2">The arg2.</param>
  2887. </member>
  2888. <member name="M:SuperSocket.SocketBase.Logging.Log4NetLog.Error(System.Object)">
  2889. <summary>
  2890. Logs the error message.
  2891. </summary>
  2892. <param name="message">The message.</param>
  2893. </member>
  2894. <member name="M:SuperSocket.SocketBase.Logging.Log4NetLog.Error(System.Object,System.Exception)">
  2895. <summary>
  2896. Logs the error message.
  2897. </summary>
  2898. <param name="message">The message.</param>
  2899. <param name="exception">The exception.</param>
  2900. </member>
  2901. <member name="M:SuperSocket.SocketBase.Logging.Log4NetLog.ErrorFormat(System.String,System.Object)">
  2902. <summary>
  2903. Logs the error message.
  2904. </summary>
  2905. <param name="format">The format.</param>
  2906. <param name="arg0">The arg0.</param>
  2907. </member>
  2908. <member name="M:SuperSocket.SocketBase.Logging.Log4NetLog.ErrorFormat(System.String,System.Object[])">
  2909. <summary>
  2910. Logs the error message.
  2911. </summary>
  2912. <param name="format">The format.</param>
  2913. <param name="args">The args.</param>
  2914. </member>
  2915. <member name="M:SuperSocket.SocketBase.Logging.Log4NetLog.ErrorFormat(System.IFormatProvider,System.String,System.Object[])">
  2916. <summary>
  2917. Logs the error message.
  2918. </summary>
  2919. <param name="provider">The provider.</param>
  2920. <param name="format">The format.</param>
  2921. <param name="args">The args.</param>
  2922. </member>
  2923. <member name="M:SuperSocket.SocketBase.Logging.Log4NetLog.ErrorFormat(System.String,System.Object,System.Object)">
  2924. <summary>
  2925. Logs the error message.
  2926. </summary>
  2927. <param name="format">The format.</param>
  2928. <param name="arg0">The arg0.</param>
  2929. <param name="arg1">The arg1.</param>
  2930. </member>
  2931. <member name="M:SuperSocket.SocketBase.Logging.Log4NetLog.ErrorFormat(System.String,System.Object,System.Object,System.Object)">
  2932. <summary>
  2933. Logs the error message.
  2934. </summary>
  2935. <param name="format">The format.</param>
  2936. <param name="arg0">The arg0.</param>
  2937. <param name="arg1">The arg1.</param>
  2938. <param name="arg2">The arg2.</param>
  2939. </member>
  2940. <member name="M:SuperSocket.SocketBase.Logging.Log4NetLog.Fatal(System.Object)">
  2941. <summary>
  2942. Logs the fatal error message.
  2943. </summary>
  2944. <param name="message">The message.</param>
  2945. </member>
  2946. <member name="M:SuperSocket.SocketBase.Logging.Log4NetLog.Fatal(System.Object,System.Exception)">
  2947. <summary>
  2948. Logs the fatal error message.
  2949. </summary>
  2950. <param name="message">The message.</param>
  2951. <param name="exception">The exception.</param>
  2952. </member>
  2953. <member name="M:SuperSocket.SocketBase.Logging.Log4NetLog.FatalFormat(System.String,System.Object)">
  2954. <summary>
  2955. Logs the fatal error message.
  2956. </summary>
  2957. <param name="format">The format.</param>
  2958. <param name="arg0">The arg0.</param>
  2959. </member>
  2960. <member name="M:SuperSocket.SocketBase.Logging.Log4NetLog.FatalFormat(System.String,System.Object[])">
  2961. <summary>
  2962. Logs the fatal error message.
  2963. </summary>
  2964. <param name="format">The format.</param>
  2965. <param name="args">The args.</param>
  2966. </member>
  2967. <member name="M:SuperSocket.SocketBase.Logging.Log4NetLog.FatalFormat(System.IFormatProvider,System.String,System.Object[])">
  2968. <summary>
  2969. Logs the fatal error message.
  2970. </summary>
  2971. <param name="provider">The provider.</param>
  2972. <param name="format">The format.</param>
  2973. <param name="args">The args.</param>
  2974. </member>
  2975. <member name="M:SuperSocket.SocketBase.Logging.Log4NetLog.FatalFormat(System.String,System.Object,System.Object)">
  2976. <summary>
  2977. Logs the fatal error message.
  2978. </summary>
  2979. <param name="format">The format.</param>
  2980. <param name="arg0">The arg0.</param>
  2981. <param name="arg1">The arg1.</param>
  2982. </member>
  2983. <member name="M:SuperSocket.SocketBase.Logging.Log4NetLog.FatalFormat(System.String,System.Object,System.Object,System.Object)">
  2984. <summary>
  2985. Logs the fatal error message.
  2986. </summary>
  2987. <param name="format">The format.</param>
  2988. <param name="arg0">The arg0.</param>
  2989. <param name="arg1">The arg1.</param>
  2990. <param name="arg2">The arg2.</param>
  2991. </member>
  2992. <member name="M:SuperSocket.SocketBase.Logging.Log4NetLog.Info(System.Object)">
  2993. <summary>
  2994. Logs the info message.
  2995. </summary>
  2996. <param name="message">The message.</param>
  2997. </member>
  2998. <member name="M:SuperSocket.SocketBase.Logging.Log4NetLog.Info(System.Object,System.Exception)">
  2999. <summary>
  3000. Logs the info message.
  3001. </summary>
  3002. <param name="message">The message.</param>
  3003. <param name="exception">The exception.</param>
  3004. </member>
  3005. <member name="M:SuperSocket.SocketBase.Logging.Log4NetLog.InfoFormat(System.String,System.Object)">
  3006. <summary>
  3007. Logs the info message.
  3008. </summary>
  3009. <param name="format">The format.</param>
  3010. <param name="arg0">The arg0.</param>
  3011. </member>
  3012. <member name="M:SuperSocket.SocketBase.Logging.Log4NetLog.InfoFormat(System.String,System.Object[])">
  3013. <summary>
  3014. Logs the info message.
  3015. </summary>
  3016. <param name="format">The format.</param>
  3017. <param name="args">The args.</param>
  3018. </member>
  3019. <member name="M:SuperSocket.SocketBase.Logging.Log4NetLog.InfoFormat(System.IFormatProvider,System.String,System.Object[])">
  3020. <summary>
  3021. Logs the info message.
  3022. </summary>
  3023. <param name="provider">The provider.</param>
  3024. <param name="format">The format.</param>
  3025. <param name="args">The args.</param>
  3026. </member>
  3027. <member name="M:SuperSocket.SocketBase.Logging.Log4NetLog.InfoFormat(System.String,System.Object,System.Object)">
  3028. <summary>
  3029. Logs the info message.
  3030. </summary>
  3031. <param name="format">The format.</param>
  3032. <param name="arg0">The arg0.</param>
  3033. <param name="arg1">The arg1.</param>
  3034. </member>
  3035. <member name="M:SuperSocket.SocketBase.Logging.Log4NetLog.InfoFormat(System.String,System.Object,System.Object,System.Object)">
  3036. <summary>
  3037. Logs the info message.
  3038. </summary>
  3039. <param name="format">The format.</param>
  3040. <param name="arg0">The arg0.</param>
  3041. <param name="arg1">The arg1.</param>
  3042. <param name="arg2">The arg2.</param>
  3043. </member>
  3044. <member name="M:SuperSocket.SocketBase.Logging.Log4NetLog.Warn(System.Object)">
  3045. <summary>
  3046. Logs the warning message.
  3047. </summary>
  3048. <param name="message">The message.</param>
  3049. </member>
  3050. <member name="M:SuperSocket.SocketBase.Logging.Log4NetLog.Warn(System.Object,System.Exception)">
  3051. <summary>
  3052. Logs the warning message.
  3053. </summary>
  3054. <param name="message">The message.</param>
  3055. <param name="exception">The exception.</param>
  3056. </member>
  3057. <member name="M:SuperSocket.SocketBase.Logging.Log4NetLog.WarnFormat(System.String,System.Object)">
  3058. <summary>
  3059. Logs the warning message.
  3060. </summary>
  3061. <param name="format">The format.</param>
  3062. <param name="arg0">The arg0.</param>
  3063. </member>
  3064. <member name="M:SuperSocket.SocketBase.Logging.Log4NetLog.WarnFormat(System.String,System.Object[])">
  3065. <summary>
  3066. Logs the warning message.
  3067. </summary>
  3068. <param name="format">The format.</param>
  3069. <param name="args">The args.</param>
  3070. </member>
  3071. <member name="M:SuperSocket.SocketBase.Logging.Log4NetLog.WarnFormat(System.IFormatProvider,System.String,System.Object[])">
  3072. <summary>
  3073. Logs the warning message.
  3074. </summary>
  3075. <param name="provider">The provider.</param>
  3076. <param name="format">The format.</param>
  3077. <param name="args">The args.</param>
  3078. </member>
  3079. <member name="M:SuperSocket.SocketBase.Logging.Log4NetLog.WarnFormat(System.String,System.Object,System.Object)">
  3080. <summary>
  3081. Logs the warning message.
  3082. </summary>
  3083. <param name="format">The format.</param>
  3084. <param name="arg0">The arg0.</param>
  3085. <param name="arg1">The arg1.</param>
  3086. </member>
  3087. <member name="M:SuperSocket.SocketBase.Logging.Log4NetLog.WarnFormat(System.String,System.Object,System.Object,System.Object)">
  3088. <summary>
  3089. Logs the warning message.
  3090. </summary>
  3091. <param name="format">The format.</param>
  3092. <param name="arg0">The arg0.</param>
  3093. <param name="arg1">The arg1.</param>
  3094. <param name="arg2">The arg2.</param>
  3095. </member>
  3096. <member name="P:SuperSocket.SocketBase.Logging.Log4NetLog.IsDebugEnabled">
  3097. <summary>
  3098. Gets a value indicating whether this instance is debug enabled.
  3099. </summary>
  3100. <value>
  3101. <c>true</c> if this instance is debug enabled; otherwise, <c>false</c>.
  3102. </value>
  3103. </member>
  3104. <member name="P:SuperSocket.SocketBase.Logging.Log4NetLog.IsErrorEnabled">
  3105. <summary>
  3106. Gets a value indicating whether this instance is error enabled.
  3107. </summary>
  3108. <value>
  3109. <c>true</c> if this instance is error enabled; otherwise, <c>false</c>.
  3110. </value>
  3111. </member>
  3112. <member name="P:SuperSocket.SocketBase.Logging.Log4NetLog.IsFatalEnabled">
  3113. <summary>
  3114. Gets a value indicating whether this instance is fatal enabled.
  3115. </summary>
  3116. <value>
  3117. <c>true</c> if this instance is fatal enabled; otherwise, <c>false</c>.
  3118. </value>
  3119. </member>
  3120. <member name="P:SuperSocket.SocketBase.Logging.Log4NetLog.IsInfoEnabled">
  3121. <summary>
  3122. Gets a value indicating whether this instance is info enabled.
  3123. </summary>
  3124. <value>
  3125. <c>true</c> if this instance is info enabled; otherwise, <c>false</c>.
  3126. </value>
  3127. </member>
  3128. <member name="P:SuperSocket.SocketBase.Logging.Log4NetLog.IsWarnEnabled">
  3129. <summary>
  3130. Gets a value indicating whether this instance is warn enabled.
  3131. </summary>
  3132. <value>
  3133. <c>true</c> if this instance is warn enabled; otherwise, <c>false</c>.
  3134. </value>
  3135. </member>
  3136. <member name="T:SuperSocket.SocketBase.Logging.Log4NetLogFactory">
  3137. <summary>
  3138. Log4NetLogFactory
  3139. </summary>
  3140. </member>
  3141. <member name="T:SuperSocket.SocketBase.Logging.LogFactoryBase">
  3142. <summary>
  3143. LogFactory Base class
  3144. </summary>
  3145. </member>
  3146. <member name="M:SuperSocket.SocketBase.Logging.LogFactoryBase.#ctor(System.String)">
  3147. <summary>
  3148. Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Logging.LogFactoryBase"/> class.
  3149. </summary>
  3150. <param name="configFile">The config file.</param>
  3151. </member>
  3152. <member name="M:SuperSocket.SocketBase.Logging.LogFactoryBase.GetLog(System.String)">
  3153. <summary>
  3154. Gets the log by name.
  3155. </summary>
  3156. <param name="name">The name.</param>
  3157. <returns></returns>
  3158. </member>
  3159. <member name="P:SuperSocket.SocketBase.Logging.LogFactoryBase.ConfigFile">
  3160. <summary>
  3161. Gets the config file file path.
  3162. </summary>
  3163. </member>
  3164. <member name="P:SuperSocket.SocketBase.Logging.LogFactoryBase.IsSharedConfig">
  3165. <summary>
  3166. Gets a value indicating whether the server instance is running in isolation mode and the multiple server instances share the same logging configuration.
  3167. </summary>
  3168. </member>
  3169. <member name="M:SuperSocket.SocketBase.Logging.Log4NetLogFactory.#ctor">
  3170. <summary>
  3171. Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Logging.Log4NetLogFactory"/> class.
  3172. </summary>
  3173. </member>
  3174. <member name="M:SuperSocket.SocketBase.Logging.Log4NetLogFactory.#ctor(System.String)">
  3175. <summary>
  3176. Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Logging.Log4NetLogFactory"/> class.
  3177. </summary>
  3178. <param name="log4netConfig">The log4net config.</param>
  3179. </member>
  3180. <member name="M:SuperSocket.SocketBase.Logging.Log4NetLogFactory.GetLog(System.String)">
  3181. <summary>
  3182. Gets the log by name.
  3183. </summary>
  3184. <param name="name">The name.</param>
  3185. <returns></returns>
  3186. </member>
  3187. <member name="T:SuperSocket.SocketBase.Metadata.AppServerMetadataTypeAttribute">
  3188. <summary>
  3189. StatusInfoMetadata type attribute
  3190. </summary>
  3191. </member>
  3192. <member name="M:SuperSocket.SocketBase.Metadata.AppServerMetadataTypeAttribute.#ctor(System.Type)">
  3193. <summary>
  3194. Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Metadata.AppServerMetadataTypeAttribute"/> class.
  3195. </summary>
  3196. <param name="metadataType">Type of the metadata.</param>
  3197. </member>
  3198. <member name="P:SuperSocket.SocketBase.Metadata.AppServerMetadataTypeAttribute.MetadataType">
  3199. <summary>
  3200. Gets the type of the metadata.
  3201. </summary>
  3202. <value>
  3203. The type of the metadata.
  3204. </value>
  3205. </member>
  3206. <member name="T:SuperSocket.SocketBase.Metadata.CommandFilterAttribute">
  3207. <summary>
  3208. Command filter attribute
  3209. </summary>
  3210. </member>
  3211. <member name="M:SuperSocket.SocketBase.Metadata.CommandFilterAttribute.OnCommandExecuting(SuperSocket.SocketBase.CommandExecutingContext)">
  3212. <summary>
  3213. Called when [command executing].
  3214. </summary>
  3215. <param name="commandContext">The command context.</param>
  3216. </member>
  3217. <member name="M:SuperSocket.SocketBase.Metadata.CommandFilterAttribute.OnCommandExecuted(SuperSocket.SocketBase.CommandExecutingContext)">
  3218. <summary>
  3219. Called when [command executed].
  3220. </summary>
  3221. <param name="commandContext">The command context.</param>
  3222. </member>
  3223. <member name="P:SuperSocket.SocketBase.Metadata.CommandFilterAttribute.Order">
  3224. <summary>
  3225. Gets or sets the execution order.
  3226. </summary>
  3227. <value>
  3228. The order.
  3229. </value>
  3230. </member>
  3231. <member name="T:SuperSocket.SocketBase.Metadata.DefaultAppServerMetadata">
  3232. <summary>
  3233. AppServer's default metadata type
  3234. </summary>
  3235. </member>
  3236. <member name="T:SuperSocket.SocketBase.Metadata.StatusInfoAttribute">
  3237. <summary>
  3238. StatusInfo Metadata
  3239. </summary>
  3240. </member>
  3241. <member name="M:SuperSocket.SocketBase.Metadata.StatusInfoAttribute.#ctor">
  3242. <summary>
  3243. Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Metadata.StatusInfoAttribute"/> class.
  3244. </summary>
  3245. </member>
  3246. <member name="M:SuperSocket.SocketBase.Metadata.StatusInfoAttribute.#ctor(System.String)">
  3247. <summary>
  3248. Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Metadata.StatusInfoAttribute"/> class.
  3249. </summary>
  3250. <param name="key">The key.</param>
  3251. </member>
  3252. <member name="P:SuperSocket.SocketBase.Metadata.StatusInfoAttribute.Key">
  3253. <summary>
  3254. Gets or sets the key.
  3255. </summary>
  3256. <value>
  3257. The key.
  3258. </value>
  3259. </member>
  3260. <member name="P:SuperSocket.SocketBase.Metadata.StatusInfoAttribute.Name">
  3261. <summary>
  3262. Gets or sets the name.
  3263. </summary>
  3264. <value>
  3265. The name.
  3266. </value>
  3267. </member>
  3268. <member name="P:SuperSocket.SocketBase.Metadata.StatusInfoAttribute.ShortName">
  3269. <summary>
  3270. Gets or sets the short name.
  3271. </summary>
  3272. <value>
  3273. The short name.
  3274. </value>
  3275. </member>
  3276. <member name="P:SuperSocket.SocketBase.Metadata.StatusInfoAttribute.Format">
  3277. <summary>
  3278. Gets or sets the format.
  3279. </summary>
  3280. <value>
  3281. The format.
  3282. </value>
  3283. </member>
  3284. <member name="P:SuperSocket.SocketBase.Metadata.StatusInfoAttribute.Order">
  3285. <summary>
  3286. Gets or sets the order.
  3287. </summary>
  3288. <value>
  3289. The order.
  3290. </value>
  3291. </member>
  3292. <member name="P:SuperSocket.SocketBase.Metadata.StatusInfoAttribute.OutputInPerfLog">
  3293. <summary>
  3294. Gets or sets a value indicating whether [output in perf log].
  3295. </summary>
  3296. <value>
  3297. <c>true</c> if [output in perf log]; otherwise, <c>false</c>.
  3298. </value>
  3299. </member>
  3300. <member name="P:SuperSocket.SocketBase.Metadata.StatusInfoAttribute.DataType">
  3301. <summary>
  3302. Gets or sets the type of the data.
  3303. </summary>
  3304. <value>
  3305. The type of the data.
  3306. </value>
  3307. </member>
  3308. <member name="T:SuperSocket.SocketBase.Metadata.StatusInfoKeys">
  3309. <summary>
  3310. Server StatusInfo Metadata
  3311. </summary>
  3312. </member>
  3313. <member name="F:SuperSocket.SocketBase.Metadata.StatusInfoKeys.CpuUsage">
  3314. <summary>
  3315. The cpu usage
  3316. </summary>
  3317. </member>
  3318. <member name="F:SuperSocket.SocketBase.Metadata.StatusInfoKeys.MemoryUsage">
  3319. <summary>
  3320. The memory usage
  3321. </summary>
  3322. </member>
  3323. <member name="F:SuperSocket.SocketBase.Metadata.StatusInfoKeys.TotalThreadCount">
  3324. <summary>
  3325. The total thread count
  3326. </summary>
  3327. </member>
  3328. <member name="F:SuperSocket.SocketBase.Metadata.StatusInfoKeys.AvailableWorkingThreads">
  3329. <summary>
  3330. The available working threads count
  3331. </summary>
  3332. </member>
  3333. <member name="F:SuperSocket.SocketBase.Metadata.StatusInfoKeys.AvailableCompletionPortThreads">
  3334. <summary>
  3335. The available completion port threads count
  3336. </summary>
  3337. </member>
  3338. <member name="F:SuperSocket.SocketBase.Metadata.StatusInfoKeys.MaxWorkingThreads">
  3339. <summary>
  3340. The max working threads count
  3341. </summary>
  3342. </member>
  3343. <member name="F:SuperSocket.SocketBase.Metadata.StatusInfoKeys.MaxCompletionPortThreads">
  3344. <summary>
  3345. The max completion port threads count
  3346. </summary>
  3347. </member>
  3348. <member name="F:SuperSocket.SocketBase.Metadata.StatusInfoKeys.StartedTime">
  3349. <summary>
  3350. The started time.
  3351. </summary>
  3352. </member>
  3353. <member name="F:SuperSocket.SocketBase.Metadata.StatusInfoKeys.IsRunning">
  3354. <summary>
  3355. <c>true</c> if this instance is running; otherwise, <c>false</c>.
  3356. </summary>
  3357. </member>
  3358. <member name="F:SuperSocket.SocketBase.Metadata.StatusInfoKeys.TotalConnections">
  3359. <summary>
  3360. The total count of the connections.
  3361. </summary>
  3362. </member>
  3363. <member name="F:SuperSocket.SocketBase.Metadata.StatusInfoKeys.MaxConnectionNumber">
  3364. <summary>
  3365. The max connection number.
  3366. </summary>
  3367. </member>
  3368. <member name="F:SuperSocket.SocketBase.Metadata.StatusInfoKeys.TotalHandledRequests">
  3369. <summary>
  3370. The total handled requests count.
  3371. </summary>
  3372. </member>
  3373. <member name="F:SuperSocket.SocketBase.Metadata.StatusInfoKeys.RequestHandlingSpeed">
  3374. <summary>
  3375. Gets or sets the request handling speed, per second.
  3376. </summary>
  3377. <value>
  3378. The request handling speed.
  3379. </value>
  3380. </member>
  3381. <member name="F:SuperSocket.SocketBase.Metadata.StatusInfoKeys.Listeners">
  3382. <summary>
  3383. Gets or sets the listeners.
  3384. </summary>
  3385. </member>
  3386. <member name="F:SuperSocket.SocketBase.Metadata.StatusInfoKeys.AvialableSendingQueueItems">
  3387. <summary>
  3388. The avialable sending queue items.
  3389. </summary>
  3390. </member>
  3391. <member name="F:SuperSocket.SocketBase.Metadata.StatusInfoKeys.TotalSendingQueueItems">
  3392. <summary>
  3393. The total sending queue items.
  3394. </summary>
  3395. </member>
  3396. <member name="T:SuperSocket.SocketBase.NodeStatus">
  3397. <summary>
  3398. The status of one SuperSocket node (one installation or deployment)
  3399. </summary>
  3400. </member>
  3401. <member name="M:SuperSocket.SocketBase.NodeStatus.Save(System.String)">
  3402. <summary>
  3403. Saves the specified file path.
  3404. </summary>
  3405. <param name="filePath">The file path.</param>
  3406. </member>
  3407. <member name="M:SuperSocket.SocketBase.NodeStatus.LoadFrom(System.String)">
  3408. <summary>
  3409. Loads a NodeStatus instance from a file.
  3410. </summary>
  3411. <param name="filePath">The file path.</param>
  3412. <returns></returns>
  3413. </member>
  3414. <member name="P:SuperSocket.SocketBase.NodeStatus.BootstrapStatus">
  3415. <summary>
  3416. Gets or sets the bootstrap status.
  3417. </summary>
  3418. <value>
  3419. The bootstrap status.
  3420. </value>
  3421. </member>
  3422. <member name="P:SuperSocket.SocketBase.NodeStatus.InstancesStatus">
  3423. <summary>
  3424. Gets or sets the status of all server instances running in this node.
  3425. </summary>
  3426. <value>
  3427. The instances status.
  3428. </value>
  3429. </member>
  3430. <member name="T:SuperSocket.SocketBase.Protocol.CommandLineReceiveFilterFactory">
  3431. <summary>
  3432. CommandLine RequestFilter Factory
  3433. </summary>
  3434. </member>
  3435. <member name="T:SuperSocket.SocketBase.Protocol.TerminatorReceiveFilterFactory">
  3436. <summary>
  3437. Terminator ReceiveFilter Factory
  3438. </summary>
  3439. </member>
  3440. <member name="T:SuperSocket.SocketBase.Protocol.IReceiveFilterFactory`1">
  3441. <summary>
  3442. Receive filter factory interface
  3443. </summary>
  3444. <typeparam name="TRequestInfo">The type of the request info.</typeparam>
  3445. </member>
  3446. <member name="T:SuperSocket.SocketBase.Protocol.IReceiveFilterFactory">
  3447. <summary>
  3448. Receive filter factory interface
  3449. </summary>
  3450. </member>
  3451. <member name="M:SuperSocket.SocketBase.Protocol.IReceiveFilterFactory`1.CreateFilter(SuperSocket.SocketBase.IAppServer,SuperSocket.SocketBase.IAppSession,System.Net.IPEndPoint)">
  3452. <summary>
  3453. Creates the Receive filter.
  3454. </summary>
  3455. <param name="appServer">The app server.</param>
  3456. <param name="appSession">The app session.</param>
  3457. <param name="remoteEndPoint">The remote end point.</param>
  3458. <returns>
  3459. the new created request filer assosiated with this socketSession
  3460. </returns>
  3461. </member>
  3462. <member name="M:SuperSocket.SocketBase.Protocol.TerminatorReceiveFilterFactory.#ctor(System.String)">
  3463. <summary>
  3464. Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Protocol.TerminatorReceiveFilterFactory"/> class.
  3465. </summary>
  3466. <param name="terminator">The terminator.</param>
  3467. </member>
  3468. <member name="M:SuperSocket.SocketBase.Protocol.TerminatorReceiveFilterFactory.#ctor(System.String,System.Text.Encoding)">
  3469. <summary>
  3470. Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Protocol.TerminatorReceiveFilterFactory"/> class.
  3471. </summary>
  3472. <param name="terminator">The terminator.</param>
  3473. <param name="encoding">The encoding.</param>
  3474. </member>
  3475. <member name="M:SuperSocket.SocketBase.Protocol.TerminatorReceiveFilterFactory.#ctor(System.String,System.Text.Encoding,SuperSocket.SocketBase.Protocol.IRequestInfoParser{SuperSocket.SocketBase.Protocol.StringRequestInfo})">
  3476. <summary>
  3477. Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Protocol.TerminatorReceiveFilterFactory"/> class.
  3478. </summary>
  3479. <param name="terminator">The terminator.</param>
  3480. <param name="encoding">The encoding.</param>
  3481. <param name="requestInfoParser">The line parser.</param>
  3482. </member>
  3483. <member name="M:SuperSocket.SocketBase.Protocol.TerminatorReceiveFilterFactory.CreateFilter(SuperSocket.SocketBase.IAppServer,SuperSocket.SocketBase.IAppSession,System.Net.IPEndPoint)">
  3484. <summary>
  3485. Creates the Receive filter.
  3486. </summary>
  3487. <param name="appServer">The app server.</param>
  3488. <param name="appSession">The app session.</param>
  3489. <param name="remoteEndPoint">The remote end point.</param>
  3490. <returns>
  3491. the new created request filer assosiated with this socketSession
  3492. </returns>
  3493. </member>
  3494. <member name="M:SuperSocket.SocketBase.Protocol.CommandLineReceiveFilterFactory.#ctor">
  3495. <summary>
  3496. Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Protocol.CommandLineReceiveFilterFactory"/> class.
  3497. </summary>
  3498. </member>
  3499. <member name="M:SuperSocket.SocketBase.Protocol.CommandLineReceiveFilterFactory.#ctor(System.Text.Encoding)">
  3500. <summary>
  3501. Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Protocol.CommandLineReceiveFilterFactory"/> class.
  3502. </summary>
  3503. <param name="encoding">The encoding.</param>
  3504. </member>
  3505. <member name="M:SuperSocket.SocketBase.Protocol.CommandLineReceiveFilterFactory.#ctor(System.Text.Encoding,SuperSocket.SocketBase.Protocol.IRequestInfoParser{SuperSocket.SocketBase.Protocol.StringRequestInfo})">
  3506. <summary>
  3507. Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Protocol.CommandLineReceiveFilterFactory"/> class.
  3508. </summary>
  3509. <param name="encoding">The encoding.</param>
  3510. <param name="requestInfoParser">The request info parser.</param>
  3511. </member>
  3512. <member name="T:SuperSocket.SocketBase.Protocol.DefaultReceiveFilterFactory`2">
  3513. <summary>
  3514. DefaultreceiveFilterFactory
  3515. </summary>
  3516. <typeparam name="TReceiveFilter">The type of the Receive filter.</typeparam>
  3517. <typeparam name="TRequestInfo">The type of the request info.</typeparam>
  3518. </member>
  3519. <member name="M:SuperSocket.SocketBase.Protocol.DefaultReceiveFilterFactory`2.CreateFilter(SuperSocket.SocketBase.IAppServer,SuperSocket.SocketBase.IAppSession,System.Net.IPEndPoint)">
  3520. <summary>
  3521. Creates the Receive filter.
  3522. </summary>
  3523. <param name="appServer">The app server.</param>
  3524. <param name="appSession">The app session.</param>
  3525. <param name="remoteEndPoint">The remote end point.</param>
  3526. <returns>
  3527. the new created request filer assosiated with this socketSession
  3528. </returns>
  3529. </member>
  3530. <member name="T:SuperSocket.SocketBase.Protocol.FilterState">
  3531. <summary>
  3532. Filter state enum
  3533. </summary>
  3534. </member>
  3535. <member name="F:SuperSocket.SocketBase.Protocol.FilterState.Normal">
  3536. <summary>
  3537. Normal state
  3538. </summary>
  3539. </member>
  3540. <member name="F:SuperSocket.SocketBase.Protocol.FilterState.Error">
  3541. <summary>
  3542. Error state
  3543. </summary>
  3544. </member>
  3545. <member name="T:SuperSocket.SocketBase.Protocol.IOffsetAdapter">
  3546. <summary>
  3547. The interface for a Receive filter to adapt receiving buffer offset
  3548. </summary>
  3549. </member>
  3550. <member name="P:SuperSocket.SocketBase.Protocol.IOffsetAdapter.OffsetDelta">
  3551. <summary>
  3552. Gets the offset delta.
  3553. </summary>
  3554. </member>
  3555. <member name="T:SuperSocket.SocketBase.Protocol.IReceiveFilter`1">
  3556. <summary>
  3557. Receive filter interface
  3558. </summary>
  3559. <typeparam name="TRequestInfo">The type of the request info.</typeparam>
  3560. </member>
  3561. <member name="M:SuperSocket.SocketBase.Protocol.IReceiveFilter`1.Filter(System.Byte[],System.Int32,System.Int32,System.Boolean,System.Int32@)">
  3562. <summary>
  3563. Filters received data of the specific session into request info.
  3564. </summary>
  3565. <param name="readBuffer">The read buffer.</param>
  3566. <param name="offset">The offset of the current received data in this read buffer.</param>
  3567. <param name="length">The length of the current received data.</param>
  3568. <param name="toBeCopied">if set to <c>true</c> [to be copied].</param>
  3569. <param name="rest">The rest, the length of the data which hasn't been parsed.</param>
  3570. <returns></returns>
  3571. </member>
  3572. <member name="M:SuperSocket.SocketBase.Protocol.IReceiveFilter`1.Reset">
  3573. <summary>
  3574. Resets this instance to initial state.
  3575. </summary>
  3576. </member>
  3577. <member name="P:SuperSocket.SocketBase.Protocol.IReceiveFilter`1.LeftBufferSize">
  3578. <summary>
  3579. Gets the size of the rest buffer.
  3580. </summary>
  3581. <value>
  3582. The size of the rest buffer.
  3583. </value>
  3584. </member>
  3585. <member name="P:SuperSocket.SocketBase.Protocol.IReceiveFilter`1.NextReceiveFilter">
  3586. <summary>
  3587. Gets the next Receive filter.
  3588. </summary>
  3589. </member>
  3590. <member name="P:SuperSocket.SocketBase.Protocol.IReceiveFilter`1.State">
  3591. <summary>
  3592. Gets the filter state.
  3593. </summary>
  3594. <value>
  3595. The filter state.
  3596. </value>
  3597. </member>
  3598. <member name="T:SuperSocket.SocketBase.Protocol.IReceiveFilterInitializer">
  3599. <summary>
  3600. Provide the initializing interface for ReceiveFilter
  3601. </summary>
  3602. </member>
  3603. <member name="M:SuperSocket.SocketBase.Protocol.IReceiveFilterInitializer.Initialize(SuperSocket.SocketBase.IAppServer,SuperSocket.SocketBase.IAppSession)">
  3604. <summary>
  3605. Initializes the ReceiveFilter with the specified appServer and appSession
  3606. </summary>
  3607. <param name="appServer">The app server.</param>
  3608. <param name="session">The session.</param>
  3609. </member>
  3610. <member name="T:SuperSocket.SocketBase.Protocol.ReceiveFilterBase`1">
  3611. <summary>
  3612. Receive filter base class
  3613. </summary>
  3614. <typeparam name="TRequestInfo">The type of the request info.</typeparam>
  3615. </member>
  3616. <member name="M:SuperSocket.SocketBase.Protocol.ReceiveFilterBase`1.#ctor">
  3617. <summary>
  3618. Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Protocol.ReceiveFilterBase`1"/> class.
  3619. </summary>
  3620. </member>
  3621. <member name="M:SuperSocket.SocketBase.Protocol.ReceiveFilterBase`1.#ctor(SuperSocket.SocketBase.Protocol.ReceiveFilterBase{`0})">
  3622. <summary>
  3623. Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Protocol.ReceiveFilterBase`1"/> class.
  3624. </summary>
  3625. <param name="previousRequestFilter">The previous Receive filter.</param>
  3626. </member>
  3627. <member name="M:SuperSocket.SocketBase.Protocol.ReceiveFilterBase`1.Initialize(SuperSocket.SocketBase.Protocol.ReceiveFilterBase{`0})">
  3628. <summary>
  3629. Initializes the specified previous Receive filter.
  3630. </summary>
  3631. <param name="previousRequestFilter">The previous Receive filter.</param>
  3632. </member>
  3633. <member name="M:SuperSocket.SocketBase.Protocol.ReceiveFilterBase`1.Filter(System.Byte[],System.Int32,System.Int32,System.Boolean,System.Int32@)">
  3634. <summary>
  3635. Filters received data of the specific session into request info.
  3636. </summary>
  3637. <param name="readBuffer">The read buffer.</param>
  3638. <param name="offset">The offset of the current received data in this read buffer.</param>
  3639. <param name="length">The length of the current received data.</param>
  3640. <param name="toBeCopied">if set to <c>true</c> [to be copied].</param>
  3641. <param name="rest">The rest, the length of the data which hasn't been parsed.</param>
  3642. <returns></returns>
  3643. </member>
  3644. <member name="M:SuperSocket.SocketBase.Protocol.ReceiveFilterBase`1.AddArraySegment(System.Byte[],System.Int32,System.Int32,System.Boolean)">
  3645. <summary>
  3646. Adds the array segment.
  3647. </summary>
  3648. <param name="buffer">The buffer.</param>
  3649. <param name="offset">The offset.</param>
  3650. <param name="length">The length.</param>
  3651. <param name="toBeCopied">if set to <c>true</c> [to be copied].</param>
  3652. </member>
  3653. <member name="M:SuperSocket.SocketBase.Protocol.ReceiveFilterBase`1.ClearBufferSegments">
  3654. <summary>
  3655. Clears the buffer segments.
  3656. </summary>
  3657. </member>
  3658. <member name="M:SuperSocket.SocketBase.Protocol.ReceiveFilterBase`1.Reset">
  3659. <summary>
  3660. Resets this instance to initial state.
  3661. </summary>
  3662. </member>
  3663. <member name="P:SuperSocket.SocketBase.Protocol.ReceiveFilterBase`1.BufferSegments">
  3664. <summary>
  3665. Gets the buffer segments which can help you parse your request info conviniently.
  3666. </summary>
  3667. </member>
  3668. <member name="P:SuperSocket.SocketBase.Protocol.ReceiveFilterBase`1.LeftBufferSize">
  3669. <summary>
  3670. Gets the size of the rest buffer.
  3671. </summary>
  3672. <value>
  3673. The size of the rest buffer.
  3674. </value>
  3675. </member>
  3676. <member name="P:SuperSocket.SocketBase.Protocol.ReceiveFilterBase`1.NextReceiveFilter">
  3677. <summary>
  3678. Gets or sets the next Receive filter.
  3679. </summary>
  3680. <value>
  3681. The next Receive filter.
  3682. </value>
  3683. </member>
  3684. <member name="P:SuperSocket.SocketBase.Protocol.ReceiveFilterBase`1.State">
  3685. <summary>
  3686. Gets the filter state.
  3687. </summary>
  3688. <value>
  3689. The state.
  3690. </value>
  3691. </member>
  3692. <member name="T:SuperSocket.SocketBase.Protocol.TerminatorReceiveFilter`1">
  3693. <summary>
  3694. Terminator Receive filter
  3695. </summary>
  3696. <typeparam name="TRequestInfo">The type of the request info.</typeparam>
  3697. </member>
  3698. <member name="F:SuperSocket.SocketBase.Protocol.TerminatorReceiveFilter`1.NullRequestInfo">
  3699. <summary>
  3700. Null RequestInfo
  3701. </summary>
  3702. </member>
  3703. <member name="M:SuperSocket.SocketBase.Protocol.TerminatorReceiveFilter`1.#ctor(System.Byte[])">
  3704. <summary>
  3705. Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Protocol.TerminatorReceiveFilter`1"/> class.
  3706. </summary>
  3707. <param name="terminator">The terminator.</param>
  3708. </member>
  3709. <member name="M:SuperSocket.SocketBase.Protocol.TerminatorReceiveFilter`1.Filter(System.Byte[],System.Int32,System.Int32,System.Boolean,System.Int32@)">
  3710. <summary>
  3711. Filters received data of the specific session into request info.
  3712. </summary>
  3713. <param name="readBuffer">The read buffer.</param>
  3714. <param name="offset">The offset of the current received data in this read buffer.</param>
  3715. <param name="length">The length of the current received data.</param>
  3716. <param name="toBeCopied">if set to <c>true</c> [to be copied].</param>
  3717. <param name="rest">The rest, the length of the data which hasn't been parsed.</param>
  3718. <returns>return the parsed TRequestInfo</returns>
  3719. </member>
  3720. <member name="M:SuperSocket.SocketBase.Protocol.TerminatorReceiveFilter`1.Reset">
  3721. <summary>
  3722. Resets this instance.
  3723. </summary>
  3724. </member>
  3725. <member name="M:SuperSocket.SocketBase.Protocol.TerminatorReceiveFilter`1.ProcessMatchedRequest(System.Byte[],System.Int32,System.Int32)">
  3726. <summary>
  3727. Resolves the specified data to TRequestInfo.
  3728. </summary>
  3729. <param name="data">The data.</param>
  3730. <param name="offset">The offset.</param>
  3731. <param name="length">The length.</param>
  3732. <returns></returns>
  3733. </member>
  3734. <member name="P:SuperSocket.SocketBase.Protocol.TerminatorReceiveFilter`1.Session">
  3735. <summary>
  3736. Gets the session assosiated with the Receive filter.
  3737. </summary>
  3738. </member>
  3739. <member name="T:SuperSocket.SocketBase.Protocol.TerminatorReceiveFilter">
  3740. <summary>
  3741. TerminatorRequestFilter
  3742. </summary>
  3743. </member>
  3744. <member name="M:SuperSocket.SocketBase.Protocol.TerminatorReceiveFilter.#ctor(System.Byte[],System.Text.Encoding)">
  3745. <summary>
  3746. Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Protocol.TerminatorReceiveFilter"/> class.
  3747. </summary>
  3748. <param name="terminator">The terminator.</param>
  3749. <param name="encoding">The encoding.</param>
  3750. </member>
  3751. <member name="M:SuperSocket.SocketBase.Protocol.TerminatorReceiveFilter.#ctor(System.Byte[],System.Text.Encoding,SuperSocket.SocketBase.Protocol.IRequestInfoParser{SuperSocket.SocketBase.Protocol.StringRequestInfo})">
  3752. <summary>
  3753. Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Protocol.TerminatorReceiveFilter"/> class.
  3754. </summary>
  3755. <param name="terminator">The terminator.</param>
  3756. <param name="encoding">The encoding.</param>
  3757. <param name="requestParser">The request parser.</param>
  3758. </member>
  3759. <member name="M:SuperSocket.SocketBase.Protocol.TerminatorReceiveFilter.ProcessMatchedRequest(System.Byte[],System.Int32,System.Int32)">
  3760. <summary>
  3761. Resolves the specified data to StringRequestInfo.
  3762. </summary>
  3763. <param name="data">The data.</param>
  3764. <param name="offset">The offset.</param>
  3765. <param name="length">The length.</param>
  3766. <returns></returns>
  3767. </member>
  3768. <member name="T:SuperSocket.SocketBase.Provider.ExportFactory">
  3769. <summary>
  3770. Export Factory
  3771. </summary>
  3772. </member>
  3773. <member name="M:SuperSocket.SocketBase.Provider.ExportFactory.#ctor">
  3774. <summary>
  3775. Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Provider.ExportFactory"/> class.
  3776. </summary>
  3777. </member>
  3778. <member name="M:SuperSocket.SocketBase.Provider.ExportFactory.#ctor(System.Object)">
  3779. <summary>
  3780. Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Provider.ExportFactory"/> class.
  3781. </summary>
  3782. <param name="instance">The instance.</param>
  3783. </member>
  3784. <member name="M:SuperSocket.SocketBase.Provider.ExportFactory.#ctor(System.String)">
  3785. <summary>
  3786. Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Provider.ExportFactory"/> class.
  3787. </summary>
  3788. <param name="typeName">Name of the type.</param>
  3789. </member>
  3790. <member name="M:SuperSocket.SocketBase.Provider.ExportFactory.EnsureInstance">
  3791. <summary>
  3792. Ensures the instance's existance.
  3793. </summary>
  3794. </member>
  3795. <member name="M:SuperSocket.SocketBase.Provider.ExportFactory.CreateExport``1">
  3796. <summary>
  3797. Creates the export type instance.
  3798. </summary>
  3799. <typeparam name="T"></typeparam>
  3800. <returns></returns>
  3801. </member>
  3802. <member name="M:SuperSocket.SocketBase.Provider.ExportFactory.CreateExport``1(System.Func{System.Type,System.Object})">
  3803. <summary>
  3804. Creates the export type instance from the instance creator.
  3805. </summary>
  3806. <typeparam name="T"></typeparam>
  3807. <param name="creator">The creator.</param>
  3808. <returns></returns>
  3809. </member>
  3810. <member name="P:SuperSocket.SocketBase.Provider.ExportFactory.TypeName">
  3811. <summary>
  3812. Gets or sets the type.
  3813. </summary>
  3814. <value>
  3815. The type.
  3816. </value>
  3817. </member>
  3818. <member name="T:SuperSocket.SocketBase.Provider.ProviderFactoryInfo">
  3819. <summary>
  3820. Provider factory infomation
  3821. </summary>
  3822. </member>
  3823. <member name="M:SuperSocket.SocketBase.Provider.ProviderFactoryInfo.#ctor">
  3824. <summary>
  3825. Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Provider.ProviderFactoryInfo"/> class.
  3826. </summary>
  3827. </member>
  3828. <member name="M:SuperSocket.SocketBase.Provider.ProviderFactoryInfo.#ctor(SuperSocket.SocketBase.Provider.ProviderKey,System.String,System.Object)">
  3829. <summary>
  3830. Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Provider.ProviderFactoryInfo"/> class.
  3831. </summary>
  3832. <param name="key">The key.</param>
  3833. <param name="name">The name.</param>
  3834. <param name="instance">The instance.</param>
  3835. </member>
  3836. <member name="M:SuperSocket.SocketBase.Provider.ProviderFactoryInfo.#ctor(SuperSocket.SocketBase.Provider.ProviderKey,System.String,System.String)">
  3837. <summary>
  3838. Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Provider.ProviderFactoryInfo"/> class.
  3839. </summary>
  3840. <param name="key">The key.</param>
  3841. <param name="name">The name.</param>
  3842. <param name="typeName">Name of the type.</param>
  3843. </member>
  3844. <member name="M:SuperSocket.SocketBase.Provider.ProviderFactoryInfo.#ctor(SuperSocket.SocketBase.Provider.ProviderKey,System.String,System.Type)">
  3845. <summary>
  3846. Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Provider.ProviderFactoryInfo"/> class.
  3847. </summary>
  3848. <param name="key">The key.</param>
  3849. <param name="name">The name.</param>
  3850. <param name="type">The type.</param>
  3851. </member>
  3852. <member name="P:SuperSocket.SocketBase.Provider.ProviderFactoryInfo.Key">
  3853. <summary>
  3854. Gets the key.
  3855. </summary>
  3856. </member>
  3857. <member name="P:SuperSocket.SocketBase.Provider.ProviderFactoryInfo.Name">
  3858. <summary>
  3859. Gets or sets the name.
  3860. </summary>
  3861. <value>
  3862. The name.
  3863. </value>
  3864. </member>
  3865. <member name="P:SuperSocket.SocketBase.Provider.ProviderFactoryInfo.ExportFactory">
  3866. <summary>
  3867. Gets or sets the export factory.
  3868. </summary>
  3869. <value>
  3870. The export factory.
  3871. </value>
  3872. </member>
  3873. <member name="T:SuperSocket.SocketBase.Provider.ProviderKey">
  3874. <summary>
  3875. ProviderKey
  3876. </summary>
  3877. </member>
  3878. <member name="P:SuperSocket.SocketBase.Provider.ProviderKey.Name">
  3879. <summary>
  3880. Gets or sets the name.
  3881. </summary>
  3882. <value>
  3883. The name.
  3884. </value>
  3885. </member>
  3886. <member name="P:SuperSocket.SocketBase.Provider.ProviderKey.Type">
  3887. <summary>
  3888. Gets or sets the type.
  3889. </summary>
  3890. <value>
  3891. The type.
  3892. </value>
  3893. </member>
  3894. <member name="P:SuperSocket.SocketBase.Provider.ProviderKey.ServerType">
  3895. <summary>
  3896. Gets the service.
  3897. </summary>
  3898. </member>
  3899. <member name="P:SuperSocket.SocketBase.Provider.ProviderKey.SocketServerFactory">
  3900. <summary>
  3901. Gets the socket server factory.
  3902. </summary>
  3903. </member>
  3904. <member name="P:SuperSocket.SocketBase.Provider.ProviderKey.ConnectionFilter">
  3905. <summary>
  3906. Gets the connection filter.
  3907. </summary>
  3908. </member>
  3909. <member name="P:SuperSocket.SocketBase.Provider.ProviderKey.LogFactory">
  3910. <summary>
  3911. Gets the log factory.
  3912. </summary>
  3913. </member>
  3914. <member name="P:SuperSocket.SocketBase.Provider.ProviderKey.ReceiveFilterFactory">
  3915. <summary>
  3916. Gets the Receive filter factory.
  3917. </summary>
  3918. </member>
  3919. <member name="P:SuperSocket.SocketBase.Provider.ProviderKey.CommandLoader">
  3920. <summary>
  3921. Gets the command loader.
  3922. </summary>
  3923. </member>
  3924. <member name="T:SuperSocket.SocketBase.RequestHandler`2">
  3925. <summary>
  3926. Request handler
  3927. </summary>
  3928. <typeparam name="TAppSession">The type of the app session.</typeparam>
  3929. <typeparam name="TRequestInfo">The type of the request info.</typeparam>
  3930. <param name="session">The session.</param>
  3931. <param name="requestInfo">The request info.</param>
  3932. </member>
  3933. <member name="T:SuperSocket.SocketBase.Config.IListenerConfig">
  3934. <summary>
  3935. The listener configuration interface
  3936. </summary>
  3937. </member>
  3938. <member name="P:SuperSocket.SocketBase.Config.IListenerConfig.Ip">
  3939. <summary>
  3940. Gets the ip of listener
  3941. </summary>
  3942. </member>
  3943. <member name="P:SuperSocket.SocketBase.Config.IListenerConfig.Port">
  3944. <summary>
  3945. Gets the port of listener
  3946. </summary>
  3947. </member>
  3948. <member name="P:SuperSocket.SocketBase.Config.IListenerConfig.Backlog">
  3949. <summary>
  3950. Gets the backlog.
  3951. </summary>
  3952. </member>
  3953. <member name="P:SuperSocket.SocketBase.Config.IListenerConfig.Security">
  3954. <summary>
  3955. Gets the security option, None/Default/Tls/Ssl/...
  3956. </summary>
  3957. </member>
  3958. <member name="T:SuperSocket.SocketBase.Config.ListenerConfig">
  3959. <summary>
  3960. Listener configuration model
  3961. </summary>
  3962. </member>
  3963. <member name="M:SuperSocket.SocketBase.Config.ListenerConfig.#ctor">
  3964. <summary>
  3965. Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Config.ListenerConfig"/> class.
  3966. </summary>
  3967. </member>
  3968. <member name="P:SuperSocket.SocketBase.Config.ListenerConfig.Ip">
  3969. <summary>
  3970. Gets the ip of listener
  3971. </summary>
  3972. </member>
  3973. <member name="P:SuperSocket.SocketBase.Config.ListenerConfig.Port">
  3974. <summary>
  3975. Gets the port of listener
  3976. </summary>
  3977. </member>
  3978. <member name="P:SuperSocket.SocketBase.Config.ListenerConfig.Backlog">
  3979. <summary>
  3980. Gets the backlog.
  3981. </summary>
  3982. </member>
  3983. <member name="P:SuperSocket.SocketBase.Config.ListenerConfig.Security">
  3984. <summary>
  3985. Gets/sets the security option, None/Default/Tls/Ssl/...
  3986. </summary>
  3987. </member>
  3988. <member name="T:SuperSocket.SocketBase.ListenerInfo">
  3989. <summary>
  3990. Listener inforamtion
  3991. </summary>
  3992. </member>
  3993. <member name="P:SuperSocket.SocketBase.ListenerInfo.EndPoint">
  3994. <summary>
  3995. Gets or sets the listen endpoint.
  3996. </summary>
  3997. <value>
  3998. The end point.
  3999. </value>
  4000. </member>
  4001. <member name="P:SuperSocket.SocketBase.ListenerInfo.BackLog">
  4002. <summary>
  4003. Gets or sets the listen backlog.
  4004. </summary>
  4005. <value>
  4006. The back log.
  4007. </value>
  4008. </member>
  4009. <member name="P:SuperSocket.SocketBase.ListenerInfo.Security">
  4010. <summary>
  4011. Gets or sets the security protocol.
  4012. </summary>
  4013. <value>
  4014. The security.
  4015. </value>
  4016. </member>
  4017. <member name="T:SuperSocket.SocketBase.Protocol.BinaryRequestInfo">
  4018. <summary>
  4019. Binary type request information
  4020. </summary>
  4021. </member>
  4022. <member name="T:SuperSocket.SocketBase.Protocol.RequestInfo`1">
  4023. <summary>
  4024. RequestInfo basic class
  4025. </summary>
  4026. <typeparam name="TRequestBody">The type of the request body.</typeparam>
  4027. </member>
  4028. <member name="T:SuperSocket.SocketBase.Protocol.IRequestInfo`1">
  4029. <summary>
  4030. Request information interface
  4031. </summary>
  4032. <typeparam name="TRequestBody">The type of the request body.</typeparam>
  4033. </member>
  4034. <member name="T:SuperSocket.SocketBase.Protocol.IRequestInfo">
  4035. <summary>
  4036. Request information interface
  4037. </summary>
  4038. </member>
  4039. <member name="P:SuperSocket.SocketBase.Protocol.IRequestInfo.Key">
  4040. <summary>
  4041. Gets the key of this request.
  4042. </summary>
  4043. </member>
  4044. <member name="P:SuperSocket.SocketBase.Protocol.IRequestInfo`1.Body">
  4045. <summary>
  4046. Gets the body of this request.
  4047. </summary>
  4048. </member>
  4049. <member name="M:SuperSocket.SocketBase.Protocol.RequestInfo`1.#ctor">
  4050. <summary>
  4051. Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Protocol.RequestInfo`1"/> class.
  4052. </summary>
  4053. </member>
  4054. <member name="M:SuperSocket.SocketBase.Protocol.RequestInfo`1.#ctor(System.String,`0)">
  4055. <summary>
  4056. Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Protocol.RequestInfo`1"/> class.
  4057. </summary>
  4058. <param name="key">The key.</param>
  4059. <param name="body">The body.</param>
  4060. </member>
  4061. <member name="M:SuperSocket.SocketBase.Protocol.RequestInfo`1.Initialize(System.String,`0)">
  4062. <summary>
  4063. Initializes the specified key.
  4064. </summary>
  4065. <param name="key">The key.</param>
  4066. <param name="body">The body.</param>
  4067. </member>
  4068. <member name="P:SuperSocket.SocketBase.Protocol.RequestInfo`1.Key">
  4069. <summary>
  4070. Gets the key of this request.
  4071. </summary>
  4072. </member>
  4073. <member name="P:SuperSocket.SocketBase.Protocol.RequestInfo`1.Body">
  4074. <summary>
  4075. Gets the body.
  4076. </summary>
  4077. </member>
  4078. <member name="M:SuperSocket.SocketBase.Protocol.BinaryRequestInfo.#ctor(System.String,System.Byte[])">
  4079. <summary>
  4080. Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Protocol.BinaryRequestInfo"/> class.
  4081. </summary>
  4082. <param name="key">The key.</param>
  4083. <param name="body">The body.</param>
  4084. </member>
  4085. <member name="T:SuperSocket.SocketBase.Command.CommandBase`2">
  4086. <summary>
  4087. Command base class
  4088. </summary>
  4089. <typeparam name="TAppSession">The type of the app session.</typeparam>
  4090. <typeparam name="TRequestInfo">The type of the request info.</typeparam>
  4091. </member>
  4092. <member name="T:SuperSocket.SocketBase.Command.ICommand`2">
  4093. <summary>
  4094. Command basic interface
  4095. </summary>
  4096. <typeparam name="TAppSession">The type of the app session.</typeparam>
  4097. <typeparam name="TRequestInfo">The type of the request info.</typeparam>
  4098. </member>
  4099. <member name="T:SuperSocket.SocketBase.Command.ICommand">
  4100. <summary>
  4101. Command basic interface
  4102. </summary>
  4103. </member>
  4104. <member name="P:SuperSocket.SocketBase.Command.ICommand.Name">
  4105. <summary>
  4106. Gets the name.
  4107. </summary>
  4108. </member>
  4109. <member name="M:SuperSocket.SocketBase.Command.ICommand`2.ExecuteCommand(`0,`1)">
  4110. <summary>
  4111. Executes the command.
  4112. </summary>
  4113. <param name="session">The session.</param>
  4114. <param name="requestInfo">The request info.</param>
  4115. </member>
  4116. <member name="M:SuperSocket.SocketBase.Command.CommandBase`2.ExecuteCommand(`0,`1)">
  4117. <summary>
  4118. Executes the command.
  4119. </summary>
  4120. <param name="session">The session.</param>
  4121. <param name="requestInfo">The request info.</param>
  4122. </member>
  4123. <member name="M:SuperSocket.SocketBase.Command.CommandBase`2.ToString">
  4124. <summary>
  4125. Returns a <see cref="T:System.String"/> that represents this instance.
  4126. </summary>
  4127. <returns>
  4128. A <see cref="T:System.String"/> that represents this instance.
  4129. </returns>
  4130. </member>
  4131. <member name="P:SuperSocket.SocketBase.Command.CommandBase`2.Name">
  4132. <summary>
  4133. Gets the name.
  4134. </summary>
  4135. </member>
  4136. <member name="T:SuperSocket.SocketBase.Command.CommandUpdateAction">
  4137. <summary>
  4138. Command update action enum
  4139. </summary>
  4140. </member>
  4141. <member name="F:SuperSocket.SocketBase.Command.CommandUpdateAction.Add">
  4142. <summary>
  4143. Add command
  4144. </summary>
  4145. </member>
  4146. <member name="F:SuperSocket.SocketBase.Command.CommandUpdateAction.Remove">
  4147. <summary>
  4148. Remove command
  4149. </summary>
  4150. </member>
  4151. <member name="F:SuperSocket.SocketBase.Command.CommandUpdateAction.Update">
  4152. <summary>
  4153. Update command
  4154. </summary>
  4155. </member>
  4156. <member name="T:SuperSocket.SocketBase.Command.CommandUpdateInfo`1">
  4157. <summary>
  4158. Command update information
  4159. </summary>
  4160. <typeparam name="T"></typeparam>
  4161. </member>
  4162. <member name="P:SuperSocket.SocketBase.Command.CommandUpdateInfo`1.UpdateAction">
  4163. <summary>
  4164. Gets or sets the update action.
  4165. </summary>
  4166. <value>
  4167. The update action.
  4168. </value>
  4169. </member>
  4170. <member name="P:SuperSocket.SocketBase.Command.CommandUpdateInfo`1.Command">
  4171. <summary>
  4172. Gets or sets the target command.
  4173. </summary>
  4174. <value>
  4175. The command.
  4176. </value>
  4177. </member>
  4178. <member name="T:SuperSocket.SocketBase.Command.MockupCommand`2">
  4179. <summary>
  4180. Mockup command
  4181. </summary>
  4182. <typeparam name="TAppSession">The type of the app session.</typeparam>
  4183. <typeparam name="TRequestInfo">The type of the request info.</typeparam>
  4184. </member>
  4185. <member name="M:SuperSocket.SocketBase.Command.MockupCommand`2.#ctor(System.String)">
  4186. <summary>
  4187. Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Command.MockupCommand`2"/> class.
  4188. </summary>
  4189. <param name="name">The name.</param>
  4190. </member>
  4191. <member name="M:SuperSocket.SocketBase.Command.MockupCommand`2.ExecuteCommand(`0,`1)">
  4192. <summary>
  4193. Executes the command.
  4194. </summary>
  4195. <param name="session">The session.</param>
  4196. <param name="requestInfo">The request info.</param>
  4197. </member>
  4198. <member name="P:SuperSocket.SocketBase.Command.MockupCommand`2.Name">
  4199. <summary>
  4200. Gets the name.
  4201. </summary>
  4202. </member>
  4203. <member name="T:SuperSocket.SocketBase.Protocol.IRequestInfo`2">
  4204. <summary>
  4205. Request information interface
  4206. </summary>
  4207. <typeparam name="TRequestHeader">The type of the request header.</typeparam>
  4208. <typeparam name="TRequestBody">The type of the request body.</typeparam>
  4209. </member>
  4210. <member name="P:SuperSocket.SocketBase.Protocol.IRequestInfo`2.Header">
  4211. <summary>
  4212. Gets the header of the request.
  4213. </summary>
  4214. </member>
  4215. <member name="T:SuperSocket.SocketBase.Protocol.RequestInfo`2">
  4216. <summary>
  4217. RequestInfo with header
  4218. </summary>
  4219. <typeparam name="TRequestHeader">The type of the request header.</typeparam>
  4220. <typeparam name="TRequestBody">The type of the request body.</typeparam>
  4221. </member>
  4222. <member name="M:SuperSocket.SocketBase.Protocol.RequestInfo`2.#ctor">
  4223. <summary>
  4224. Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Protocol.RequestInfo`2"/> class.
  4225. </summary>
  4226. </member>
  4227. <member name="M:SuperSocket.SocketBase.Protocol.RequestInfo`2.#ctor(System.String,`0,`1)">
  4228. <summary>
  4229. Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Protocol.RequestInfo`2"/> class.
  4230. </summary>
  4231. <param name="key">The key.</param>
  4232. <param name="header">The header.</param>
  4233. <param name="body">The body.</param>
  4234. </member>
  4235. <member name="M:SuperSocket.SocketBase.Protocol.RequestInfo`2.Initialize(System.String,`0,`1)">
  4236. <summary>
  4237. Initializes the specified key.
  4238. </summary>
  4239. <param name="key">The key.</param>
  4240. <param name="header">The header.</param>
  4241. <param name="body">The body.</param>
  4242. </member>
  4243. <member name="P:SuperSocket.SocketBase.Protocol.RequestInfo`2.Header">
  4244. <summary>
  4245. Gets the header.
  4246. </summary>
  4247. </member>
  4248. <member name="T:SuperSocket.SocketBase.Protocol.StringRequestInfo">
  4249. <summary>
  4250. String type request information
  4251. </summary>
  4252. </member>
  4253. <member name="M:SuperSocket.SocketBase.Protocol.StringRequestInfo.#ctor(System.String,System.String,System.String[])">
  4254. <summary>
  4255. Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Protocol.StringRequestInfo"/> class.
  4256. </summary>
  4257. <param name="key">The key.</param>
  4258. <param name="body">The body.</param>
  4259. <param name="parameters">The parameters.</param>
  4260. </member>
  4261. <member name="M:SuperSocket.SocketBase.Protocol.StringRequestInfo.GetFirstParam">
  4262. <summary>
  4263. Gets the first param.
  4264. </summary>
  4265. <returns></returns>
  4266. </member>
  4267. <member name="P:SuperSocket.SocketBase.Protocol.StringRequestInfo.Parameters">
  4268. <summary>
  4269. Gets the parameters.
  4270. </summary>
  4271. </member>
  4272. <member name="P:SuperSocket.SocketBase.Protocol.StringRequestInfo.Item(System.Int32)">
  4273. <summary>
  4274. Gets the <see cref="T:System.String"/> at the specified index.
  4275. </summary>
  4276. </member>
  4277. <member name="T:SuperSocket.SocketBase.Command.ReflectCommandLoader`1">
  4278. <summary>
  4279. A command loader which loads commands from assembly by reflection
  4280. </summary>
  4281. </member>
  4282. <member name="M:SuperSocket.SocketBase.Command.ReflectCommandLoader`1.#ctor">
  4283. <summary>
  4284. Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Command.ReflectCommandLoader`1"/> class.
  4285. </summary>
  4286. </member>
  4287. <member name="M:SuperSocket.SocketBase.Command.ReflectCommandLoader`1.Initialize(SuperSocket.SocketBase.Config.IRootConfig,SuperSocket.SocketBase.IAppServer)">
  4288. <summary>
  4289. Initializes the command loader by the root config and the server instance.
  4290. </summary>
  4291. <param name="rootConfig">The root config.</param>
  4292. <param name="appServer">The app server.</param>
  4293. <returns></returns>
  4294. </member>
  4295. <member name="M:SuperSocket.SocketBase.Command.ReflectCommandLoader`1.TryLoadCommands(System.Collections.Generic.IEnumerable{`0}@)">
  4296. <summary>
  4297. Tries to load commands.
  4298. </summary>
  4299. <param name="commands">The commands.</param>
  4300. <returns></returns>
  4301. </member>
  4302. <member name="T:SuperSocket.SocketBase.Protocol.UdpRequestInfo">
  4303. <summary>
  4304. UdpRequestInfo, it is designed for passing in business session ID to udp request info
  4305. </summary>
  4306. </member>
  4307. <member name="M:SuperSocket.SocketBase.Protocol.UdpRequestInfo.#ctor(System.String,System.String)">
  4308. <summary>
  4309. Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Protocol.UdpRequestInfo"/> class.
  4310. </summary>
  4311. <param name="key">The key.</param>
  4312. <param name="sessionID">The session ID.</param>
  4313. </member>
  4314. <member name="P:SuperSocket.SocketBase.Protocol.UdpRequestInfo.Key">
  4315. <summary>
  4316. Gets the key of this request.
  4317. </summary>
  4318. </member>
  4319. <member name="P:SuperSocket.SocketBase.Protocol.UdpRequestInfo.SessionID">
  4320. <summary>
  4321. Gets the session ID.
  4322. </summary>
  4323. </member>
  4324. <member name="T:SuperSocket.SocketBase.Config.CertificateConfig">
  4325. <summary>
  4326. Certificate config model class
  4327. </summary>
  4328. </member>
  4329. <member name="T:SuperSocket.SocketBase.Config.ICertificateConfig">
  4330. <summary>
  4331. Certificate configuration interface
  4332. </summary>
  4333. </member>
  4334. <member name="P:SuperSocket.SocketBase.Config.ICertificateConfig.FilePath">
  4335. <summary>
  4336. Gets the file path.
  4337. </summary>
  4338. </member>
  4339. <member name="P:SuperSocket.SocketBase.Config.ICertificateConfig.Password">
  4340. <summary>
  4341. Gets the password.
  4342. </summary>
  4343. </member>
  4344. <member name="P:SuperSocket.SocketBase.Config.ICertificateConfig.StoreName">
  4345. <summary>
  4346. Gets the the store where certificate locates.
  4347. </summary>
  4348. <value>
  4349. The name of the store.
  4350. </value>
  4351. </member>
  4352. <member name="P:SuperSocket.SocketBase.Config.ICertificateConfig.Thumbprint">
  4353. <summary>
  4354. Gets the thumbprint.
  4355. </summary>
  4356. </member>
  4357. <member name="P:SuperSocket.SocketBase.Config.ICertificateConfig.StoreLocation">
  4358. <summary>
  4359. Gets the store location of the certificate.
  4360. </summary>
  4361. <value>
  4362. The store location.
  4363. </value>
  4364. </member>
  4365. <member name="P:SuperSocket.SocketBase.Config.ICertificateConfig.ClientCertificateRequired">
  4366. <summary>
  4367. Gets a value indicating whether [client certificate required].
  4368. </summary>
  4369. <value>
  4370. <c>true</c> if [client certificate required]; otherwise, <c>false</c>.
  4371. </value>
  4372. </member>
  4373. <member name="P:SuperSocket.SocketBase.Config.ICertificateConfig.KeyStorageFlags">
  4374. <summary>
  4375. Gets a value that will be used to instantiate the X509Certificate2 object in the CertificateManager
  4376. </summary>
  4377. </member>
  4378. <member name="P:SuperSocket.SocketBase.Config.CertificateConfig.FilePath">
  4379. <summary>
  4380. Gets/sets the file path.
  4381. </summary>
  4382. </member>
  4383. <member name="P:SuperSocket.SocketBase.Config.CertificateConfig.Password">
  4384. <summary>
  4385. Gets/sets the password.
  4386. </summary>
  4387. </member>
  4388. <member name="P:SuperSocket.SocketBase.Config.CertificateConfig.StoreName">
  4389. <summary>
  4390. Gets/sets the the store where certificate locates.
  4391. </summary>
  4392. <value>
  4393. The name of the store.
  4394. </value>
  4395. </member>
  4396. <member name="P:SuperSocket.SocketBase.Config.CertificateConfig.StoreLocation">
  4397. <summary>
  4398. Gets/sets the store location of the certificate.
  4399. </summary>
  4400. <value>
  4401. The store location.
  4402. </value>
  4403. </member>
  4404. <member name="P:SuperSocket.SocketBase.Config.CertificateConfig.Thumbprint">
  4405. <summary>
  4406. Gets/sets the thumbprint.
  4407. </summary>
  4408. </member>
  4409. <member name="P:SuperSocket.SocketBase.Config.CertificateConfig.ClientCertificateRequired">
  4410. <summary>
  4411. Gets/sets a value indicating whether [client certificate required].
  4412. </summary>
  4413. <value>
  4414. <c>true</c> if [client certificate required]; otherwise, <c>false</c>.
  4415. </value>
  4416. </member>
  4417. <member name="P:SuperSocket.SocketBase.Config.CertificateConfig.KeyStorageFlags">
  4418. <summary>
  4419. Gets/sets a value that will be used to instantiate the X509Certificate2 object in the CertificateManager
  4420. </summary>
  4421. </member>
  4422. <member name="T:SuperSocket.SocketBase.IAppSession">
  4423. <summary>
  4424. The basic interface for appSession
  4425. </summary>
  4426. </member>
  4427. <member name="T:SuperSocket.SocketBase.ISessionBase">
  4428. <summary>
  4429. The basic session interface
  4430. </summary>
  4431. </member>
  4432. <member name="P:SuperSocket.SocketBase.ISessionBase.SessionID">
  4433. <summary>
  4434. Gets the session ID.
  4435. </summary>
  4436. </member>
  4437. <member name="P:SuperSocket.SocketBase.ISessionBase.RemoteEndPoint">
  4438. <summary>
  4439. Gets the remote endpoint.
  4440. </summary>
  4441. </member>
  4442. <member name="M:SuperSocket.SocketBase.IAppSession.Close">
  4443. <summary>
  4444. Closes this session.
  4445. </summary>
  4446. </member>
  4447. <member name="M:SuperSocket.SocketBase.IAppSession.Close(SuperSocket.SocketBase.CloseReason)">
  4448. <summary>
  4449. Closes the session by the specified reason.
  4450. </summary>
  4451. <param name="reason">The close reason.</param>
  4452. </member>
  4453. <member name="M:SuperSocket.SocketBase.IAppSession.ProcessRequest(System.Byte[],System.Int32,System.Int32,System.Boolean)">
  4454. <summary>
  4455. Processes the request.
  4456. </summary>
  4457. <param name="readBuffer">The read buffer.</param>
  4458. <param name="offset">The offset.</param>
  4459. <param name="length">The length.</param>
  4460. <param name="toBeCopied">if set to <c>true</c> [to be copied].</param>
  4461. <returns>return offset delta of next receiving buffer</returns>
  4462. </member>
  4463. <member name="M:SuperSocket.SocketBase.IAppSession.StartSession">
  4464. <summary>
  4465. Starts the session.
  4466. </summary>
  4467. </member>
  4468. <member name="P:SuperSocket.SocketBase.IAppSession.AppServer">
  4469. <summary>
  4470. Gets the app server.
  4471. </summary>
  4472. </member>
  4473. <member name="P:SuperSocket.SocketBase.IAppSession.SocketSession">
  4474. <summary>
  4475. Gets the socket session of the AppSession.
  4476. </summary>
  4477. </member>
  4478. <member name="P:SuperSocket.SocketBase.IAppSession.Items">
  4479. <summary>
  4480. Gets the items.
  4481. </summary>
  4482. </member>
  4483. <member name="P:SuperSocket.SocketBase.IAppSession.Config">
  4484. <summary>
  4485. Gets the config of the server.
  4486. </summary>
  4487. </member>
  4488. <member name="P:SuperSocket.SocketBase.IAppSession.LocalEndPoint">
  4489. <summary>
  4490. Gets the local listening endpoint.
  4491. </summary>
  4492. </member>
  4493. <member name="P:SuperSocket.SocketBase.IAppSession.LastActiveTime">
  4494. <summary>
  4495. Gets or sets the last active time of the session.
  4496. </summary>
  4497. <value>
  4498. The last active time.
  4499. </value>
  4500. </member>
  4501. <member name="P:SuperSocket.SocketBase.IAppSession.StartTime">
  4502. <summary>
  4503. Gets the start time of the session.
  4504. </summary>
  4505. </member>
  4506. <member name="P:SuperSocket.SocketBase.IAppSession.Connected">
  4507. <summary>
  4508. Gets a value indicating whether this <see cref="T:SuperSocket.SocketBase.IAppSession"/> is connected.
  4509. </summary>
  4510. <value>
  4511. <c>true</c> if connected; otherwise, <c>false</c>.
  4512. </value>
  4513. </member>
  4514. <member name="P:SuperSocket.SocketBase.IAppSession.Charset">
  4515. <summary>
  4516. Gets or sets the charset which is used for transfering text message.
  4517. </summary>
  4518. <value>The charset.</value>
  4519. </member>
  4520. <member name="P:SuperSocket.SocketBase.IAppSession.PrevCommand">
  4521. <summary>
  4522. Gets or sets the previous command.
  4523. </summary>
  4524. <value>
  4525. The prev command.
  4526. </value>
  4527. </member>
  4528. <member name="P:SuperSocket.SocketBase.IAppSession.CurrentCommand">
  4529. <summary>
  4530. Gets or sets the current executing command.
  4531. </summary>
  4532. <value>
  4533. The current command.
  4534. </value>
  4535. </member>
  4536. <member name="P:SuperSocket.SocketBase.IAppSession.Logger">
  4537. <summary>
  4538. Gets the logger assosiated with this session.
  4539. </summary>
  4540. </member>
  4541. <member name="T:SuperSocket.SocketBase.IAppSession`2">
  4542. <summary>
  4543. The interface for appSession
  4544. </summary>
  4545. <typeparam name="TAppSession">The type of the app session.</typeparam>
  4546. <typeparam name="TRequestInfo">The type of the request info.</typeparam>
  4547. </member>
  4548. <member name="M:SuperSocket.SocketBase.IAppSession`2.Initialize(SuperSocket.SocketBase.IAppServer{`0,`1},SuperSocket.SocketBase.ISocketSession)">
  4549. <summary>
  4550. Initializes the specified session.
  4551. </summary>
  4552. <param name="server">The server.</param>
  4553. <param name="socketSession">The socket session.</param>
  4554. </member>
  4555. <member name="T:SuperSocket.SocketBase.IConnectionFilter">
  4556. <summary>
  4557. The basic interface of connection filter
  4558. </summary>
  4559. </member>
  4560. <member name="M:SuperSocket.SocketBase.IConnectionFilter.Initialize(System.String,SuperSocket.SocketBase.IAppServer)">
  4561. <summary>
  4562. Initializes the connection filter
  4563. </summary>
  4564. <param name="name">The name.</param>
  4565. <param name="appServer">The app server.</param>
  4566. <returns></returns>
  4567. </member>
  4568. <member name="M:SuperSocket.SocketBase.IConnectionFilter.AllowConnect(System.Net.IPEndPoint)">
  4569. <summary>
  4570. Whether allows the connect according the remote endpoint
  4571. </summary>
  4572. <param name="remoteAddress">The remote address.</param>
  4573. <returns></returns>
  4574. </member>
  4575. <member name="P:SuperSocket.SocketBase.IConnectionFilter.Name">
  4576. <summary>
  4577. Gets the name of the filter.
  4578. </summary>
  4579. </member>
  4580. <member name="T:SuperSocket.SocketBase.ISocketServer">
  4581. <summary>
  4582. It is the basic interface of SocketServer,
  4583. SocketServer is the abstract server who really listen the comming sockets directly.
  4584. </summary>
  4585. </member>
  4586. <member name="M:SuperSocket.SocketBase.ISocketServer.Start">
  4587. <summary>
  4588. Starts this instance.
  4589. </summary>
  4590. <returns></returns>
  4591. </member>
  4592. <member name="M:SuperSocket.SocketBase.ISocketServer.ResetSessionSecurity(SuperSocket.SocketBase.IAppSession,System.Security.Authentication.SslProtocols)">
  4593. <summary>
  4594. Resets the session's security protocol.
  4595. </summary>
  4596. <param name="session">The session.</param>
  4597. <param name="security">The security protocol.</param>
  4598. </member>
  4599. <member name="M:SuperSocket.SocketBase.ISocketServer.Stop">
  4600. <summary>
  4601. Stops this instance.
  4602. </summary>
  4603. </member>
  4604. <member name="P:SuperSocket.SocketBase.ISocketServer.IsRunning">
  4605. <summary>
  4606. Gets a value indicating whether this instance is running.
  4607. </summary>
  4608. <value>
  4609. <c>true</c> if this instance is running; otherwise, <c>false</c>.
  4610. </value>
  4611. </member>
  4612. <member name="P:SuperSocket.SocketBase.ISocketServer.SendingQueuePool">
  4613. <summary>
  4614. Gets the information of the sending queue pool.
  4615. </summary>
  4616. <value>
  4617. The sending queue pool.
  4618. </value>
  4619. </member>
  4620. <member name="T:SuperSocket.SocketBase.ISocketServerFactory">
  4621. <summary>
  4622. The interface for socket server factory
  4623. </summary>
  4624. </member>
  4625. <member name="M:SuperSocket.SocketBase.ISocketServerFactory.CreateSocketServer``1(SuperSocket.SocketBase.IAppServer,SuperSocket.SocketBase.ListenerInfo[],SuperSocket.SocketBase.Config.IServerConfig)">
  4626. <summary>
  4627. Creates the socket server instance.
  4628. </summary>
  4629. <typeparam name="TRequestInfo">The type of the request info.</typeparam>
  4630. <param name="appServer">The app server.</param>
  4631. <param name="listeners">The listeners.</param>
  4632. <param name="config">The config.</param>
  4633. <returns></returns>
  4634. </member>
  4635. <member name="T:SuperSocket.SocketBase.CloseReason">
  4636. <summary>
  4637. CloseReason enum
  4638. </summary>
  4639. </member>
  4640. <member name="F:SuperSocket.SocketBase.CloseReason.Unknown">
  4641. <summary>
  4642. The socket is closed for unknown reason
  4643. </summary>
  4644. </member>
  4645. <member name="F:SuperSocket.SocketBase.CloseReason.ServerShutdown">
  4646. <summary>
  4647. Close for server shutdown
  4648. </summary>
  4649. </member>
  4650. <member name="F:SuperSocket.SocketBase.CloseReason.ClientClosing">
  4651. <summary>
  4652. The client close the socket
  4653. </summary>
  4654. </member>
  4655. <member name="F:SuperSocket.SocketBase.CloseReason.ServerClosing">
  4656. <summary>
  4657. The server side close the socket
  4658. </summary>
  4659. </member>
  4660. <member name="F:SuperSocket.SocketBase.CloseReason.ApplicationError">
  4661. <summary>
  4662. Application error
  4663. </summary>
  4664. </member>
  4665. <member name="F:SuperSocket.SocketBase.CloseReason.SocketError">
  4666. <summary>
  4667. The socket is closed for a socket error
  4668. </summary>
  4669. </member>
  4670. <member name="F:SuperSocket.SocketBase.CloseReason.TimeOut">
  4671. <summary>
  4672. The socket is closed by server for timeout
  4673. </summary>
  4674. </member>
  4675. <member name="F:SuperSocket.SocketBase.CloseReason.ProtocolError">
  4676. <summary>
  4677. Protocol error
  4678. </summary>
  4679. </member>
  4680. <member name="F:SuperSocket.SocketBase.CloseReason.InternalError">
  4681. <summary>
  4682. SuperSocket internal error
  4683. </summary>
  4684. </member>
  4685. <member name="T:SuperSocket.SocketBase.ISocketSession">
  4686. <summary>
  4687. The interface for socket session
  4688. </summary>
  4689. </member>
  4690. <member name="M:SuperSocket.SocketBase.ISocketSession.Initialize(SuperSocket.SocketBase.IAppSession)">
  4691. <summary>
  4692. Initializes the specified app session.
  4693. </summary>
  4694. <param name="appSession">The app session.</param>
  4695. </member>
  4696. <member name="M:SuperSocket.SocketBase.ISocketSession.Start">
  4697. <summary>
  4698. Starts this instance.
  4699. </summary>
  4700. </member>
  4701. <member name="M:SuperSocket.SocketBase.ISocketSession.Close(SuperSocket.SocketBase.CloseReason)">
  4702. <summary>
  4703. Closes the socket session for the specified reason.
  4704. </summary>
  4705. <param name="reason">The reason.</param>
  4706. </member>
  4707. <member name="M:SuperSocket.SocketBase.ISocketSession.TrySend(System.Collections.Generic.IList{System.ArraySegment{System.Byte}})">
  4708. <summary>
  4709. Tries to send array segment.
  4710. </summary>
  4711. <param name="segments">The segments.</param>
  4712. </member>
  4713. <member name="M:SuperSocket.SocketBase.ISocketSession.TrySend(System.ArraySegment{System.Byte})">
  4714. <summary>
  4715. Tries to send array segment.
  4716. </summary>
  4717. <param name="segment">The segment.</param>
  4718. </member>
  4719. <member name="M:SuperSocket.SocketBase.ISocketSession.ApplySecureProtocol">
  4720. <summary>
  4721. Applies the secure protocol.
  4722. </summary>
  4723. </member>
  4724. <member name="P:SuperSocket.SocketBase.ISocketSession.Client">
  4725. <summary>
  4726. Gets the client socket.
  4727. </summary>
  4728. </member>
  4729. <member name="P:SuperSocket.SocketBase.ISocketSession.LocalEndPoint">
  4730. <summary>
  4731. Gets the local listening endpoint.
  4732. </summary>
  4733. </member>
  4734. <member name="P:SuperSocket.SocketBase.ISocketSession.SecureProtocol">
  4735. <summary>
  4736. Gets or sets the secure protocol.
  4737. </summary>
  4738. <value>
  4739. The secure protocol.
  4740. </value>
  4741. </member>
  4742. <member name="P:SuperSocket.SocketBase.ISocketSession.Closed">
  4743. <summary>
  4744. Occurs when [closed].
  4745. </summary>
  4746. </member>
  4747. <member name="P:SuperSocket.SocketBase.ISocketSession.AppSession">
  4748. <summary>
  4749. Gets the app session assosiated with this socket session.
  4750. </summary>
  4751. </member>
  4752. <member name="P:SuperSocket.SocketBase.ISocketSession.OrigReceiveOffset">
  4753. <summary>
  4754. Gets the original receive buffer offset.
  4755. </summary>
  4756. <value>
  4757. The original receive buffer offset.
  4758. </value>
  4759. </member>
  4760. <member name="T:SuperSocket.SocketBase.LoggerExtension">
  4761. <summary>
  4762. Logger extension class
  4763. </summary>
  4764. </member>
  4765. <member name="M:SuperSocket.SocketBase.LoggerExtension.Error(SuperSocket.SocketBase.Logging.ILog,SuperSocket.SocketBase.ISessionBase,System.String,System.Exception)">
  4766. <summary>
  4767. Logs the error
  4768. </summary>
  4769. <param name="logger">The logger.</param>
  4770. <param name="session">The session.</param>
  4771. <param name="title">The title.</param>
  4772. <param name="e">The e.</param>
  4773. </member>
  4774. <member name="M:SuperSocket.SocketBase.LoggerExtension.Error(SuperSocket.SocketBase.Logging.ILog,SuperSocket.SocketBase.ISessionBase,System.String)">
  4775. <summary>
  4776. Logs the error
  4777. </summary>
  4778. <param name="logger">The logger.</param>
  4779. <param name="session">The session.</param>
  4780. <param name="message">The message.</param>
  4781. </member>
  4782. <member name="M:SuperSocket.SocketBase.LoggerExtension.Info(SuperSocket.SocketBase.Logging.ILog,SuperSocket.SocketBase.ISessionBase,System.String)">
  4783. <summary>
  4784. Logs the information
  4785. </summary>
  4786. <param name="logger">The logger.</param>
  4787. <param name="session">The session.</param>
  4788. <param name="message">The message.</param>
  4789. </member>
  4790. <member name="M:SuperSocket.SocketBase.LoggerExtension.Debug(SuperSocket.SocketBase.Logging.ILog,SuperSocket.SocketBase.ISessionBase,System.String)">
  4791. <summary>
  4792. Logs the debug message
  4793. </summary>
  4794. <param name="logger">The logger.</param>
  4795. <param name="session">The session.</param>
  4796. <param name="message">The message.</param>
  4797. </member>
  4798. <member name="M:SuperSocket.SocketBase.LoggerExtension.LogPerf(SuperSocket.SocketBase.IAppServer,System.String)">
  4799. <summary>
  4800. Logs the performance message
  4801. </summary>
  4802. <param name="appServer">The app server.</param>
  4803. <param name="message">The message.</param>
  4804. </member>
  4805. <member name="T:SuperSocket.SocketBase.Protocol.BasicRequestInfoParser">
  4806. <summary>
  4807. Basic request info parser, which parse request info by separating
  4808. </summary>
  4809. </member>
  4810. <member name="T:SuperSocket.SocketBase.Protocol.IRequestInfoParser`1">
  4811. <summary>
  4812. The interface for request info parser
  4813. </summary>
  4814. </member>
  4815. <member name="M:SuperSocket.SocketBase.Protocol.IRequestInfoParser`1.ParseRequestInfo(System.String)">
  4816. <summary>
  4817. Parses the request info from the source string.
  4818. </summary>
  4819. <param name="source">The source.</param>
  4820. <returns></returns>
  4821. </member>
  4822. <member name="F:SuperSocket.SocketBase.Protocol.BasicRequestInfoParser.DefaultInstance">
  4823. <summary>
  4824. The default singlegton instance
  4825. </summary>
  4826. </member>
  4827. <member name="M:SuperSocket.SocketBase.Protocol.BasicRequestInfoParser.#ctor">
  4828. <summary>
  4829. Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Protocol.BasicRequestInfoParser"/> class.
  4830. </summary>
  4831. </member>
  4832. <member name="M:SuperSocket.SocketBase.Protocol.BasicRequestInfoParser.#ctor(System.String,System.String)">
  4833. <summary>
  4834. Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Protocol.BasicRequestInfoParser"/> class.
  4835. </summary>
  4836. <param name="spliter">The spliter between command name and command parameters.</param>
  4837. <param name="parameterSpliter">The parameter spliter.</param>
  4838. </member>
  4839. <member name="M:SuperSocket.SocketBase.Protocol.BasicRequestInfoParser.ParseRequestInfo(System.String)">
  4840. <summary>
  4841. Parses the request info.
  4842. </summary>
  4843. <param name="source">The source.</param>
  4844. <returns></returns>
  4845. </member>
  4846. <member name="T:SuperSocket.SocketBase.ServerState">
  4847. <summary>
  4848. Server's state enum class
  4849. </summary>
  4850. </member>
  4851. <member name="F:SuperSocket.SocketBase.ServerState.NotInitialized">
  4852. <summary>
  4853. Not initialized
  4854. </summary>
  4855. </member>
  4856. <member name="F:SuperSocket.SocketBase.ServerState.Initializing">
  4857. <summary>
  4858. In initializing
  4859. </summary>
  4860. </member>
  4861. <member name="F:SuperSocket.SocketBase.ServerState.NotStarted">
  4862. <summary>
  4863. Has been initialized, but not started
  4864. </summary>
  4865. </member>
  4866. <member name="F:SuperSocket.SocketBase.ServerState.Starting">
  4867. <summary>
  4868. In starting
  4869. </summary>
  4870. </member>
  4871. <member name="F:SuperSocket.SocketBase.ServerState.Running">
  4872. <summary>
  4873. In running
  4874. </summary>
  4875. </member>
  4876. <member name="F:SuperSocket.SocketBase.ServerState.Stopping">
  4877. <summary>
  4878. In stopping
  4879. </summary>
  4880. </member>
  4881. <member name="T:SuperSocket.SocketBase.SessionHandler`1">
  4882. <summary>
  4883. Used for session level event handler
  4884. </summary>
  4885. <typeparam name="TAppSession">the type of the target session</typeparam>
  4886. <param name="session">the target session</param>
  4887. </member>
  4888. <member name="T:SuperSocket.SocketBase.SessionHandler`2">
  4889. <summary>
  4890. Used for session level event handler
  4891. </summary>
  4892. <typeparam name="TAppSession">the type of the target session</typeparam>
  4893. <typeparam name="TParam">the target session</typeparam>
  4894. <param name="session">the target session</param>
  4895. <param name="value">the event parameter</param>
  4896. </member>
  4897. <member name="T:SuperSocket.SocketBase.SocketMode">
  4898. <summary>
  4899. Socket server running mode
  4900. </summary>
  4901. </member>
  4902. <member name="F:SuperSocket.SocketBase.SocketMode.Tcp">
  4903. <summary>
  4904. Tcp mode
  4905. </summary>
  4906. </member>
  4907. <member name="F:SuperSocket.SocketBase.SocketMode.Udp">
  4908. <summary>
  4909. Udp mode
  4910. </summary>
  4911. </member>
  4912. <member name="T:SuperSocket.SocketBase.AppServer">
  4913. <summary>
  4914. AppServer class
  4915. </summary>
  4916. </member>
  4917. <member name="T:SuperSocket.SocketBase.AppServer`1">
  4918. <summary>
  4919. AppServer class
  4920. </summary>
  4921. <typeparam name="TAppSession">The type of the app session.</typeparam>
  4922. </member>
  4923. <member name="T:SuperSocket.SocketBase.AppServer`2">
  4924. <summary>
  4925. AppServer basic class
  4926. </summary>
  4927. <typeparam name="TAppSession">The type of the app session.</typeparam>
  4928. <typeparam name="TRequestInfo">The type of the request info.</typeparam>
  4929. </member>
  4930. <member name="M:SuperSocket.SocketBase.AppServer`2.#ctor">
  4931. <summary>
  4932. Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.AppServer`2"/> class.
  4933. </summary>
  4934. </member>
  4935. <member name="M:SuperSocket.SocketBase.AppServer`2.#ctor(SuperSocket.SocketBase.Protocol.IReceiveFilterFactory{`1})">
  4936. <summary>
  4937. Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.AppServer`2"/> class.
  4938. </summary>
  4939. <param name="protocol">The protocol.</param>
  4940. </member>
  4941. <member name="M:SuperSocket.SocketBase.AppServer`2.Start">
  4942. <summary>
  4943. Starts this AppServer instance.
  4944. </summary>
  4945. <returns></returns>
  4946. </member>
  4947. <member name="M:SuperSocket.SocketBase.AppServer`2.RegisterSession(System.String,`0)">
  4948. <summary>
  4949. Registers the session into the session container.
  4950. </summary>
  4951. <param name="sessionID">The session ID.</param>
  4952. <param name="appSession">The app session.</param>
  4953. <returns></returns>
  4954. </member>
  4955. <member name="M:SuperSocket.SocketBase.AppServer`2.GetAppSessionByID(System.String)">
  4956. <summary>
  4957. Gets the app session by ID.
  4958. </summary>
  4959. <param name="sessionID">The session ID.</param>
  4960. <returns></returns>
  4961. </member>
  4962. <member name="M:SuperSocket.SocketBase.AppServer`2.GetSessionByID(System.String)">
  4963. <summary>
  4964. Gets the app session by ID.
  4965. </summary>
  4966. <param name="sessionID">The session ID.</param>
  4967. <returns></returns>
  4968. </member>
  4969. <member name="M:SuperSocket.SocketBase.AppServer`2.OnSessionClosed(`0,SuperSocket.SocketBase.CloseReason)">
  4970. <summary>
  4971. Called when [socket session closed].
  4972. </summary>
  4973. <param name="session">The session.</param>
  4974. <param name="reason">The reason.</param>
  4975. </member>
  4976. <member name="M:SuperSocket.SocketBase.AppServer`2.ClearIdleSession(System.Object)">
  4977. <summary>
  4978. Clears the idle session.
  4979. </summary>
  4980. <param name="state">The state.</param>
  4981. </member>
  4982. <member name="M:SuperSocket.SocketBase.AppServer`2.GetSessions(System.Func{`0,System.Boolean})">
  4983. <summary>
  4984. Gets the matched sessions from sessions snapshot.
  4985. </summary>
  4986. <param name="critera">The prediction critera.</param>
  4987. <returns></returns>
  4988. </member>
  4989. <member name="M:SuperSocket.SocketBase.AppServer`2.GetAllSessions">
  4990. <summary>
  4991. Gets all sessions in sessions snapshot.
  4992. </summary>
  4993. <returns></returns>
  4994. </member>
  4995. <member name="M:SuperSocket.SocketBase.AppServer`2.Stop">
  4996. <summary>
  4997. Stops this instance.
  4998. </summary>
  4999. </member>
  5000. <member name="P:SuperSocket.SocketBase.AppServer`2.SessionCount">
  5001. <summary>
  5002. Gets the total session count.
  5003. </summary>
  5004. </member>
  5005. <member name="M:SuperSocket.SocketBase.AppServer`1.#ctor">
  5006. <summary>
  5007. Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.AppServer`1"/> class.
  5008. </summary>
  5009. </member>
  5010. <member name="M:SuperSocket.SocketBase.AppServer`1.#ctor(SuperSocket.SocketBase.Protocol.IReceiveFilterFactory{SuperSocket.SocketBase.Protocol.StringRequestInfo})">
  5011. <summary>
  5012. Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.AppServer`1"/> class.
  5013. </summary>
  5014. <param name="receiveFilterFactory">The Receive filter factory.</param>
  5015. </member>
  5016. <member name="M:SuperSocket.SocketBase.AppServer.#ctor">
  5017. <summary>
  5018. Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.AppServer"/> class.
  5019. </summary>
  5020. </member>
  5021. <member name="M:SuperSocket.SocketBase.AppServer.#ctor(SuperSocket.SocketBase.Protocol.IReceiveFilterFactory{SuperSocket.SocketBase.Protocol.StringRequestInfo})">
  5022. <summary>
  5023. Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.AppServer"/> class.
  5024. </summary>
  5025. <param name="receiveFilterFactory">The Receive filter factory.</param>
  5026. </member>
  5027. <member name="T:SuperSocket.SocketBase.AppSession`2">
  5028. <summary>
  5029. AppSession base class
  5030. </summary>
  5031. <typeparam name="TAppSession">The type of the app session.</typeparam>
  5032. <typeparam name="TRequestInfo">The type of the request info.</typeparam>
  5033. </member>
  5034. <member name="M:SuperSocket.SocketBase.AppSession`2.#ctor">
  5035. <summary>
  5036. Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.AppSession`2"/> class.
  5037. </summary>
  5038. </member>
  5039. <member name="M:SuperSocket.SocketBase.AppSession`2.Initialize(SuperSocket.SocketBase.IAppServer{`0,`1},SuperSocket.SocketBase.ISocketSession)">
  5040. <summary>
  5041. Initializes the specified app session by AppServer and SocketSession.
  5042. </summary>
  5043. <param name="appServer">The app server.</param>
  5044. <param name="socketSession">The socket session.</param>
  5045. </member>
  5046. <member name="M:SuperSocket.SocketBase.AppSession`2.SuperSocket#SocketBase#IAppSession#StartSession">
  5047. <summary>
  5048. Starts the session.
  5049. </summary>
  5050. </member>
  5051. <member name="M:SuperSocket.SocketBase.AppSession`2.OnInit">
  5052. <summary>
  5053. Called when [init].
  5054. </summary>
  5055. </member>
  5056. <member name="M:SuperSocket.SocketBase.AppSession`2.OnSessionStarted">
  5057. <summary>
  5058. Called when [session started].
  5059. </summary>
  5060. </member>
  5061. <member name="M:SuperSocket.SocketBase.AppSession`2.OnSessionClosed(SuperSocket.SocketBase.CloseReason)">
  5062. <summary>
  5063. Called when [session closed].
  5064. </summary>
  5065. <param name="reason">The reason.</param>
  5066. </member>
  5067. <member name="M:SuperSocket.SocketBase.AppSession`2.HandleException(System.Exception)">
  5068. <summary>
  5069. Handles the exceptional error, it only handles application error.
  5070. </summary>
  5071. <param name="e">The exception.</param>
  5072. </member>
  5073. <member name="M:SuperSocket.SocketBase.AppSession`2.HandleUnknownRequest(`1)">
  5074. <summary>
  5075. Handles the unknown request.
  5076. </summary>
  5077. <param name="requestInfo">The request info.</param>
  5078. </member>
  5079. <member name="M:SuperSocket.SocketBase.AppSession`2.Close(SuperSocket.SocketBase.CloseReason)">
  5080. <summary>
  5081. Closes the session by the specified reason.
  5082. </summary>
  5083. <param name="reason">The close reason.</param>
  5084. </member>
  5085. <member name="M:SuperSocket.SocketBase.AppSession`2.Close">
  5086. <summary>
  5087. Closes this session.
  5088. </summary>
  5089. </member>
  5090. <member name="M:SuperSocket.SocketBase.AppSession`2.TrySend(System.String)">
  5091. <summary>
  5092. Try to send the message to client.
  5093. </summary>
  5094. <param name="message">The message which will be sent.</param>
  5095. <returns>Indicate whether the message was pushed into the sending queue</returns>
  5096. </member>
  5097. <member name="M:SuperSocket.SocketBase.AppSession`2.Send(System.String)">
  5098. <summary>
  5099. Sends the message to client.
  5100. </summary>
  5101. <param name="message">The message which will be sent.</param>
  5102. </member>
  5103. <member name="M:SuperSocket.SocketBase.AppSession`2.TrySend(System.Byte[],System.Int32,System.Int32)">
  5104. <summary>
  5105. Try to send the data to client.
  5106. </summary>
  5107. <param name="data">The data which will be sent.</param>
  5108. <param name="offset">The offset.</param>
  5109. <param name="length">The length.</param>
  5110. <returns>Indicate whether the message was pushed into the sending queue</returns>
  5111. </member>
  5112. <member name="M:SuperSocket.SocketBase.AppSession`2.Send(System.Byte[],System.Int32,System.Int32)">
  5113. <summary>
  5114. Sends the data to client.
  5115. </summary>
  5116. <param name="data">The data which will be sent.</param>
  5117. <param name="offset">The offset.</param>
  5118. <param name="length">The length.</param>
  5119. </member>
  5120. <member name="M:SuperSocket.SocketBase.AppSession`2.TrySend(System.ArraySegment{System.Byte})">
  5121. <summary>
  5122. Try to send the data segment to client.
  5123. </summary>
  5124. <param name="segment">The segment which will be sent.</param>
  5125. <returns>Indicate whether the message was pushed into the sending queue</returns>
  5126. </member>
  5127. <member name="M:SuperSocket.SocketBase.AppSession`2.Send(System.ArraySegment{System.Byte})">
  5128. <summary>
  5129. Sends the data segment to client.
  5130. </summary>
  5131. <param name="segment">The segment which will be sent.</param>
  5132. </member>
  5133. <member name="M:SuperSocket.SocketBase.AppSession`2.TrySend(System.Collections.Generic.IList{System.ArraySegment{System.Byte}})">
  5134. <summary>
  5135. Try to send the data segments to client.
  5136. </summary>
  5137. <param name="segments">The segments.</param>
  5138. <returns>Indicate whether the message was pushed into the sending queue; if it returns false, the sending queue may be full or the socket is not connected</returns>
  5139. </member>
  5140. <member name="M:SuperSocket.SocketBase.AppSession`2.Send(System.Collections.Generic.IList{System.ArraySegment{System.Byte}})">
  5141. <summary>
  5142. Sends the data segments to client.
  5143. </summary>
  5144. <param name="segments">The segments.</param>
  5145. </member>
  5146. <member name="M:SuperSocket.SocketBase.AppSession`2.Send(System.String,System.Object[])">
  5147. <summary>
  5148. Sends the response.
  5149. </summary>
  5150. <param name="message">The message which will be sent.</param>
  5151. <param name="paramValues">The parameter values.</param>
  5152. </member>
  5153. <member name="M:SuperSocket.SocketBase.AppSession`2.SetNextReceiveFilter(SuperSocket.SocketBase.Protocol.IReceiveFilter{`1})">
  5154. <summary>
  5155. Sets the next Receive filter which will be used when next data block received
  5156. </summary>
  5157. <param name="nextReceiveFilter">The next receive filter.</param>
  5158. </member>
  5159. <member name="M:SuperSocket.SocketBase.AppSession`2.GetMaxRequestLength">
  5160. <summary>
  5161. Gets the maximum allowed length of the request.
  5162. </summary>
  5163. <returns></returns>
  5164. </member>
  5165. <member name="M:SuperSocket.SocketBase.AppSession`2.FilterRequest(System.Byte[],System.Int32,System.Int32,System.Boolean,System.Int32@,System.Int32@)">
  5166. <summary>
  5167. Filters the request.
  5168. </summary>
  5169. <param name="readBuffer">The read buffer.</param>
  5170. <param name="offset">The offset.</param>
  5171. <param name="length">The length.</param>
  5172. <param name="toBeCopied">if set to <c>true</c> [to be copied].</param>
  5173. <param name="rest">The rest, the size of the data which has not been processed</param>
  5174. <param name="offsetDelta">return offset delta of next receiving buffer.</param>
  5175. <returns></returns>
  5176. </member>
  5177. <member name="M:SuperSocket.SocketBase.AppSession`2.SuperSocket#SocketBase#IAppSession#ProcessRequest(System.Byte[],System.Int32,System.Int32,System.Boolean)">
  5178. <summary>
  5179. Processes the request data.
  5180. </summary>
  5181. <param name="readBuffer">The read buffer.</param>
  5182. <param name="offset">The offset.</param>
  5183. <param name="length">The length.</param>
  5184. <param name="toBeCopied">if set to <c>true</c> [to be copied].</param>
  5185. <returns>
  5186. return offset delta of next receiving buffer
  5187. </returns>
  5188. </member>
  5189. <member name="P:SuperSocket.SocketBase.AppSession`2.AppServer">
  5190. <summary>
  5191. Gets the app server instance assosiated with the session.
  5192. </summary>
  5193. </member>
  5194. <member name="P:SuperSocket.SocketBase.AppSession`2.SuperSocket#SocketBase#IAppSession#AppServer">
  5195. <summary>
  5196. Gets the app server instance assosiated with the session.
  5197. </summary>
  5198. </member>
  5199. <member name="P:SuperSocket.SocketBase.AppSession`2.Charset">
  5200. <summary>
  5201. Gets or sets the charset which is used for transfering text message.
  5202. </summary>
  5203. <value>
  5204. The charset.
  5205. </value>
  5206. </member>
  5207. <member name="P:SuperSocket.SocketBase.AppSession`2.Items">
  5208. <summary>
  5209. Gets the items dictionary, only support 10 items maximum
  5210. </summary>
  5211. </member>
  5212. <member name="P:SuperSocket.SocketBase.AppSession`2.Connected">
  5213. <summary>
  5214. Gets a value indicating whether this <see cref="T:SuperSocket.SocketBase.IAppSession"/> is connected.
  5215. </summary>
  5216. <value>
  5217. <c>true</c> if connected; otherwise, <c>false</c>.
  5218. </value>
  5219. </member>
  5220. <member name="P:SuperSocket.SocketBase.AppSession`2.PrevCommand">
  5221. <summary>
  5222. Gets or sets the previous command.
  5223. </summary>
  5224. <value>
  5225. The prev command.
  5226. </value>
  5227. </member>
  5228. <member name="P:SuperSocket.SocketBase.AppSession`2.CurrentCommand">
  5229. <summary>
  5230. Gets or sets the current executing command.
  5231. </summary>
  5232. <value>
  5233. The current command.
  5234. </value>
  5235. </member>
  5236. <member name="P:SuperSocket.SocketBase.AppSession`2.SecureProtocol">
  5237. <summary>
  5238. Gets or sets the secure protocol of transportation layer.
  5239. </summary>
  5240. <value>
  5241. The secure protocol.
  5242. </value>
  5243. </member>
  5244. <member name="P:SuperSocket.SocketBase.AppSession`2.LocalEndPoint">
  5245. <summary>
  5246. Gets the local listening endpoint.
  5247. </summary>
  5248. </member>
  5249. <member name="P:SuperSocket.SocketBase.AppSession`2.RemoteEndPoint">
  5250. <summary>
  5251. Gets the remote endpoint of client.
  5252. </summary>
  5253. </member>
  5254. <member name="P:SuperSocket.SocketBase.AppSession`2.Logger">
  5255. <summary>
  5256. Gets the logger.
  5257. </summary>
  5258. </member>
  5259. <member name="P:SuperSocket.SocketBase.AppSession`2.LastActiveTime">
  5260. <summary>
  5261. Gets or sets the last active time of the session.
  5262. </summary>
  5263. <value>
  5264. The last active time.
  5265. </value>
  5266. </member>
  5267. <member name="P:SuperSocket.SocketBase.AppSession`2.StartTime">
  5268. <summary>
  5269. Gets the start time of the session.
  5270. </summary>
  5271. </member>
  5272. <member name="P:SuperSocket.SocketBase.AppSession`2.SessionID">
  5273. <summary>
  5274. Gets the session ID.
  5275. </summary>
  5276. </member>
  5277. <member name="P:SuperSocket.SocketBase.AppSession`2.SocketSession">
  5278. <summary>
  5279. Gets the socket session of the AppSession.
  5280. </summary>
  5281. </member>
  5282. <member name="P:SuperSocket.SocketBase.AppSession`2.Config">
  5283. <summary>
  5284. Gets the config of the server.
  5285. </summary>
  5286. </member>
  5287. <member name="T:SuperSocket.SocketBase.AppSession`1">
  5288. <summary>
  5289. AppServer basic class for whose request infoe type is StringRequestInfo
  5290. </summary>
  5291. <typeparam name="TAppSession">The type of the app session.</typeparam>
  5292. </member>
  5293. <member name="M:SuperSocket.SocketBase.AppSession`1.#ctor">
  5294. <summary>
  5295. Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.AppSession`1"/> class.
  5296. </summary>
  5297. </member>
  5298. <member name="M:SuperSocket.SocketBase.AppSession`1.#ctor(System.Boolean)">
  5299. <summary>
  5300. Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.AppSession`1"/> class.
  5301. </summary>
  5302. <param name="appendNewLineForResponse">if set to <c>true</c> [append new line for response].</param>
  5303. </member>
  5304. <member name="M:SuperSocket.SocketBase.AppSession`1.HandleUnknownRequest(SuperSocket.SocketBase.Protocol.StringRequestInfo)">
  5305. <summary>
  5306. Handles the unknown request.
  5307. </summary>
  5308. <param name="requestInfo">The request info.</param>
  5309. </member>
  5310. <member name="M:SuperSocket.SocketBase.AppSession`1.ProcessSendingMessage(System.String)">
  5311. <summary>
  5312. Processes the sending message.
  5313. </summary>
  5314. <param name="rawMessage">The raw message.</param>
  5315. <returns></returns>
  5316. </member>
  5317. <member name="M:SuperSocket.SocketBase.AppSession`1.Send(System.String)">
  5318. <summary>
  5319. Sends the specified message.
  5320. </summary>
  5321. <param name="message">The message.</param>
  5322. <returns></returns>
  5323. </member>
  5324. <member name="M:SuperSocket.SocketBase.AppSession`1.Send(System.String,System.Object[])">
  5325. <summary>
  5326. Sends the response.
  5327. </summary>
  5328. <param name="message">The message.</param>
  5329. <param name="paramValues">The param values.</param>
  5330. <returns>Indicate whether the message was pushed into the sending queue</returns>
  5331. </member>
  5332. <member name="T:SuperSocket.SocketBase.AppSession">
  5333. <summary>
  5334. AppServer basic class for whose request infoe type is StringRequestInfo
  5335. </summary>
  5336. </member>
  5337. <member name="T:SuperSocket.SocketBase.Command.StringCommandBase`1">
  5338. <summary>
  5339. A command type for whose request info type is StringRequestInfo
  5340. </summary>
  5341. <typeparam name="TAppSession">The type of the app session.</typeparam>
  5342. </member>
  5343. <member name="T:SuperSocket.SocketBase.Command.StringCommandBase">
  5344. <summary>
  5345. A command type for whose request info type is StringRequestInfo
  5346. </summary>
  5347. </member>
  5348. <member name="T:SuperSocket.SocketBase.StatusInfoCollection">
  5349. <summary>
  5350. Status information collection
  5351. </summary>
  5352. </member>
  5353. <member name="M:SuperSocket.SocketBase.StatusInfoCollection.GetValue``1(System.String,``0)">
  5354. <summary>
  5355. Gets the value.
  5356. </summary>
  5357. <typeparam name="T"></typeparam>
  5358. <param name="name">The name.</param>
  5359. <param name="defaultValue">The default value.</param>
  5360. <returns></returns>
  5361. </member>
  5362. <member name="P:SuperSocket.SocketBase.StatusInfoCollection.Values">
  5363. <summary>
  5364. Gets the values.
  5365. </summary>
  5366. <value>
  5367. The values.
  5368. </value>
  5369. </member>
  5370. <member name="P:SuperSocket.SocketBase.StatusInfoCollection.Name">
  5371. <summary>
  5372. Gets or sets the name.
  5373. </summary>
  5374. <value>
  5375. The name.
  5376. </value>
  5377. </member>
  5378. <member name="P:SuperSocket.SocketBase.StatusInfoCollection.Tag">
  5379. <summary>
  5380. Gets or sets the tag.
  5381. </summary>
  5382. <value>
  5383. The tag.
  5384. </value>
  5385. </member>
  5386. <member name="P:SuperSocket.SocketBase.StatusInfoCollection.CollectedTime">
  5387. <summary>
  5388. Gets or sets the collected time.
  5389. </summary>
  5390. <value>
  5391. The collected time.
  5392. </value>
  5393. </member>
  5394. <member name="P:SuperSocket.SocketBase.StatusInfoCollection.Item(System.String)">
  5395. <summary>
  5396. Gets or sets the <see cref="T:System.Object"/> with the specified name.
  5397. </summary>
  5398. <value>
  5399. The <see cref="T:System.Object"/>.
  5400. </value>
  5401. <param name="name">The name.</param>
  5402. <returns></returns>
  5403. </member>
  5404. </members>
  5405. </doc>