123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367 |
- <?xml version="1.0"?>
- <doc>
- <assembly>
- <name>SuperSocket.SocketBase</name>
- </assembly>
- <members>
- <member name="T:SuperSocket.SocketBase.AppServerBase`2">
- <summary>
- AppServer base class
- </summary>
- <typeparam name="TAppSession">The type of the app session.</typeparam>
- <typeparam name="TRequestInfo">The type of the request info.</typeparam>
- </member>
- <member name="T:SuperSocket.SocketBase.IAppServer`2">
- <summary>
- The interface for AppServer
- </summary>
- <typeparam name="TAppSession">The type of the app session.</typeparam>
- <typeparam name="TRequestInfo">The type of the request info.</typeparam>
- </member>
- <member name="T:SuperSocket.SocketBase.IAppServer`1">
- <summary>
- The interface for AppServer
- </summary>
- <typeparam name="TAppSession">The type of the app session.</typeparam>
- </member>
- <member name="T:SuperSocket.SocketBase.IAppServer">
- <summary>
- The interface for AppServer
- </summary>
- </member>
- <member name="T:SuperSocket.SocketBase.IWorkItem">
- <summary>
- An item can be started and stopped
- </summary>
- </member>
- <member name="T:SuperSocket.SocketBase.IWorkItemBase">
- <summary>
- An item can be started and stopped
- </summary>
- </member>
- <member name="T:SuperSocket.SocketBase.IStatusInfoSource">
- <summary>
- StatusInfo source interface
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.IStatusInfoSource.GetServerStatusMetadata">
- <summary>
- Gets the server status metadata.
- </summary>
- <returns></returns>
- </member>
- <member name="M:SuperSocket.SocketBase.IStatusInfoSource.CollectServerStatus(SuperSocket.SocketBase.StatusInfoCollection)">
- <summary>
- Collects the bootstrap status.
- </summary>
- <param name="bootstrapStatus">The bootstrap status.</param>
- <returns></returns>
- </member>
- <member name="T:SuperSocket.SocketBase.ISystemEndPoint">
- <summary>
- The interface for endpoint who can send/receive system message with each other
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.ISystemEndPoint.TransferSystemMessage(System.String,System.Object)">
- <summary>
- Transfers the system message.
- </summary>
- <param name="messageType">Type of the message.</param>
- <param name="messageData">The message data.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.IWorkItemBase.Start">
- <summary>
- Starts this server instance.
- </summary>
- <returns>return true if start successfull, else false</returns>
- </member>
- <member name="M:SuperSocket.SocketBase.IWorkItemBase.ReportPotentialConfigChange(SuperSocket.SocketBase.Config.IServerConfig)">
- <summary>
- Reports the potential configuration change.
- </summary>
- <param name="config">The server config which may be changed.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.IWorkItemBase.Stop">
- <summary>
- Stops this server instance.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.IWorkItemBase.Name">
- <summary>
- Gets the name.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.IWorkItemBase.Config">
- <summary>
- Gets the server's config.
- </summary>
- <value>
- The server's config.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.IWorkItemBase.SessionCount">
- <summary>
- Gets the total session count.
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.IWorkItem.Setup(SuperSocket.SocketBase.IBootstrap,SuperSocket.SocketBase.Config.IServerConfig,SuperSocket.SocketBase.Provider.ProviderFactoryInfo[])">
- <summary>
- Setups with the specified root config.
- </summary>
- <param name="bootstrap">The bootstrap.</param>
- <param name="config">The socket server instance config.</param>
- <param name="factories">The factories.</param>
- <returns></returns>
- </member>
- <member name="P:SuperSocket.SocketBase.IWorkItem.State">
- <summary>
- Gets the current state of the work item.
- </summary>
- <value>
- The state.
- </value>
- </member>
- <member name="T:SuperSocket.SocketBase.ILoggerProvider">
- <summary>
- The interface for who provides logger
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.ILoggerProvider.Logger">
- <summary>
- Gets the logger assosiated with this object.
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.IAppServer.CreateAppSession(SuperSocket.SocketBase.ISocketSession)">
- <summary>
- Creates the app session.
- </summary>
- <param name="socketSession">The socket session.</param>
- <returns></returns>
- </member>
- <member name="M:SuperSocket.SocketBase.IAppServer.RegisterSession(SuperSocket.SocketBase.IAppSession)">
- <summary>
- Registers the new created app session into the appserver's session container.
- </summary>
- <param name="session">The session.</param>
- <returns></returns>
- </member>
- <member name="M:SuperSocket.SocketBase.IAppServer.GetSessionByID(System.String)">
- <summary>
- Gets the app session by ID.
- </summary>
- <param name="sessionID">The session ID.</param>
- <returns></returns>
- </member>
- <member name="M:SuperSocket.SocketBase.IAppServer.ResetSessionSecurity(SuperSocket.SocketBase.IAppSession,System.Security.Authentication.SslProtocols)">
- <summary>
- Resets the session's security protocol.
- </summary>
- <param name="session">The session.</param>
- <param name="security">The security protocol.</param>
- </member>
- <member name="P:SuperSocket.SocketBase.IAppServer.StartedTime">
- <summary>
- Gets the started time.
- </summary>
- <value>
- The started time.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.IAppServer.Listeners">
- <summary>
- Gets or sets the listeners.
- </summary>
- <value>
- The listeners.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.IAppServer.ReceiveFilterFactory">
- <summary>
- Gets the Receive filter factory.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.IAppServer.Certificate">
- <summary>
- Gets the certificate of current server.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.IAppServer.BasicSecurity">
- <summary>
- Gets the transfer layer security protocol.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.IAppServer.LogFactory">
- <summary>
- Gets the log factory.
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.IAppServer`1.GetSessions(System.Func{`0,System.Boolean})">
- <summary>
- Gets the matched sessions from sessions snapshot.
- </summary>
- <param name="critera">The prediction critera.</param>
- <returns></returns>
- </member>
- <member name="M:SuperSocket.SocketBase.IAppServer`1.GetAllSessions">
- <summary>
- Gets all sessions in sessions snapshot.
- </summary>
- <returns></returns>
- </member>
- <member name="E:SuperSocket.SocketBase.IAppServer`1.NewSessionConnected">
- <summary>
- Gets/sets the new session connected event handler.
- </summary>
- </member>
- <member name="E:SuperSocket.SocketBase.IAppServer`1.SessionClosed">
- <summary>
- Gets/sets the session closed event handler.
- </summary>
- </member>
- <member name="E:SuperSocket.SocketBase.IAppServer`2.NewRequestReceived">
- <summary>
- Occurs when [request comming].
- </summary>
- </member>
- <member name="T:SuperSocket.SocketBase.IRawDataProcessor`1">
- <summary>
- The raw data processor
- </summary>
- <typeparam name="TAppSession">The type of the app session.</typeparam>
- </member>
- <member name="E:SuperSocket.SocketBase.IRawDataProcessor`1.RawDataReceived">
- <summary>
- Gets or sets the raw binary data received event handler.
- TAppSession: session
- byte[]: receive buffer
- int: receive buffer offset
- int: receive lenght
- bool: whether process the received data further
- </summary>
- </member>
- <member name="T:SuperSocket.SocketBase.IRequestHandler`1">
- <summary>
- The interface for handler of session request
- </summary>
- <typeparam name="TRequestInfo">The type of the request info.</typeparam>
- </member>
- <member name="M:SuperSocket.SocketBase.IRequestHandler`1.ExecuteCommand(SuperSocket.SocketBase.IAppSession,`0)">
- <summary>
- Executes the command.
- </summary>
- <param name="session">The session.</param>
- <param name="requestInfo">The request info.</param>
- </member>
- <member name="T:SuperSocket.SocketBase.ISocketServerAccessor">
- <summary>
- SocketServer Accessor interface
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.ISocketServerAccessor.SocketServer">
- <summary>
- Gets the socket server.
- </summary>
- <value>
- The socket server.
- </value>
- </member>
- <member name="T:SuperSocket.SocketBase.IRemoteCertificateValidator">
- <summary>
- The basic interface for RemoteCertificateValidator
- </summary>
- </member>
- <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)">
- <summary>
- Validates the remote certificate
- </summary>
- <param name="session">The session.</param>
- <param name="sender">The sender.</param>
- <param name="certificate">The certificate.</param>
- <param name="chain">The chain.</param>
- <param name="sslPolicyErrors">The SSL policy errors.</param>
- <returns></returns>
- </member>
- <member name="T:SuperSocket.SocketBase.IActiveConnector">
- <summary>
- The inerface to connect the remote endpoint actively
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.IActiveConnector.ActiveConnect(System.Net.EndPoint)">
- <summary>
- Connect the target endpoint actively.
- </summary>
- <param name="targetEndPoint">The target end point.</param>
- <returns></returns>
- </member>
- <member name="M:SuperSocket.SocketBase.IActiveConnector.ActiveConnect(System.Net.EndPoint,System.Net.EndPoint)">
- <summary>
- Connect the target endpoint actively.
- </summary>
- <param name="targetEndPoint">The target end point.</param>
- <param name="localEndPoint">The local end point.</param>
- <returns></returns>
- </member>
- <member name="M:SuperSocket.SocketBase.AppServerBase`2.RegisterConfigHandler``1(SuperSocket.SocketBase.Config.IServerConfig,System.String,System.Func{``0,System.Boolean})">
- <summary>
- Registers the configuration option value handler, it is used for reading configuration value and reload it after the configuration is changed;
- </summary>
- <typeparam name="TConfigOption">The type of the configuration option.</typeparam>
- <param name="config">The server configuration.</param>
- <param name="name">The changed config option's name.</param>
- <param name="handler">The handler.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.AppServerBase`2.RegisterConfigHandler(SuperSocket.SocketBase.Config.IServerConfig,System.String,System.Func{System.String,System.Boolean})">
- <summary>
- Registers the configuration option value handler, it is used for reading configuration value and reload it after the configuration is changed;
- </summary>
- <param name="config">The server configuration.</param>
- <param name="name">The changed config option name.</param>
- <param name="handler">The handler.</param>
- </member>
- <member name="F:SuperSocket.SocketBase.AppServerBase`2.NullAppSession">
- <summary>
- Null appSession instance
- </summary>
- </member>
- <member name="F:SuperSocket.SocketBase.AppServerBase`2.m_StateCode">
- <summary>
- the current state's code
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.AppServerBase`2.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.AppServerBase`2"/> class.
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.AppServerBase`2.#ctor(SuperSocket.SocketBase.Protocol.IReceiveFilterFactory{`1})">
- <summary>
- Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.AppServerBase`2"/> class.
- </summary>
- <param name="receiveFilterFactory">The Receive filter factory.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.AppServerBase`2.GetCommandFilterAttributes(System.Type)">
- <summary>
- Gets the filter attributes.
- </summary>
- <param name="type">The type.</param>
- <returns></returns>
- </member>
- <member name="M:SuperSocket.SocketBase.AppServerBase`2.SetupCommands(System.Collections.Generic.Dictionary{System.String,SuperSocket.SocketBase.Command.ICommand{`0,`1}})">
- <summary>
- Setups the command into command dictionary
- </summary>
- <param name="discoveredCommands">The discovered commands.</param>
- <returns></returns>
- </member>
- <member name="M:SuperSocket.SocketBase.AppServerBase`2.Setup(SuperSocket.SocketBase.Config.IRootConfig,SuperSocket.SocketBase.Config.IServerConfig)">
- <summary>
- Setups the specified root config.
- </summary>
- <param name="rootConfig">The root config.</param>
- <param name="config">The config.</param>
- <returns></returns>
- </member>
- <member name="M:SuperSocket.SocketBase.AppServerBase`2.Setup(System.Int32)">
- <summary>
- Setups with the specified port.
- </summary>
- <param name="port">The port.</param>
- <returns>return setup result</returns>
- </member>
- <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}}})">
- <summary>
- Setups with the specified config.
- </summary>
- <param name="config">The server config.</param>
- <param name="socketServerFactory">The socket server factory.</param>
- <param name="receiveFilterFactory">The receive filter factory.</param>
- <param name="logFactory">The log factory.</param>
- <param name="connectionFilters">The connection filters.</param>
- <param name="commandLoaders">The command loaders.</param>
- <returns></returns>
- </member>
- <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}}})">
- <summary>
- Setups the specified root config, this method used for programming setup
- </summary>
- <param name="rootConfig">The root config.</param>
- <param name="config">The server config.</param>
- <param name="socketServerFactory">The socket server factory.</param>
- <param name="receiveFilterFactory">The Receive filter factory.</param>
- <param name="logFactory">The log factory.</param>
- <param name="connectionFilters">The connection filters.</param>
- <param name="commandLoaders">The command loaders.</param>
- <returns></returns>
- </member>
- <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}}})">
- <summary>
- Setups with the specified ip and port.
- </summary>
- <param name="ip">The ip.</param>
- <param name="port">The port.</param>
- <param name="socketServerFactory">The socket server factory.</param>
- <param name="receiveFilterFactory">The Receive filter factory.</param>
- <param name="logFactory">The log factory.</param>
- <param name="connectionFilters">The connection filters.</param>
- <param name="commandLoaders">The command loaders.</param>
- <returns>return setup result</returns>
- </member>
- <member name="M:SuperSocket.SocketBase.AppServerBase`2.SuperSocket#SocketBase#IWorkItem#Setup(SuperSocket.SocketBase.IBootstrap,SuperSocket.SocketBase.Config.IServerConfig,SuperSocket.SocketBase.Provider.ProviderFactoryInfo[])">
- <summary>
- Setups the specified root config.
- </summary>
- <param name="bootstrap">The bootstrap.</param>
- <param name="config">The socket server instance config.</param>
- <param name="factories">The factories.</param>
- <returns></returns>
- </member>
- <member name="M:SuperSocket.SocketBase.AppServerBase`2.SetupCommandLoaders(System.Collections.Generic.List{SuperSocket.SocketBase.Command.ICommandLoader{SuperSocket.SocketBase.Command.ICommand{`0,`1}}})">
- <summary>
- Setups the command loaders.
- </summary>
- <param name="commandLoaders">The command loaders.</param>
- <returns></returns>
- </member>
- <member name="M:SuperSocket.SocketBase.AppServerBase`2.CreateLogger(System.String)">
- <summary>
- Creates the logger for the AppServer.
- </summary>
- <param name="loggerName">Name of the logger.</param>
- <returns></returns>
- </member>
- <member name="M:SuperSocket.SocketBase.AppServerBase`2.SetupSecurity(SuperSocket.SocketBase.Config.IServerConfig)">
- <summary>
- Setups the security option of socket communications.
- </summary>
- <param name="config">The config of the server instance.</param>
- <returns></returns>
- </member>
- <member name="M:SuperSocket.SocketBase.AppServerBase`2.GetCertificate(SuperSocket.SocketBase.Config.ICertificateConfig)">
- <summary>
- Gets the certificate from server configuguration.
- </summary>
- <param name="certificate">The certificate config.</param>
- <returns></returns>
- </member>
- <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)">
- <summary>
- Validates the client certificate. This method is only used if the certificate configuration attribute "clientCertificateRequired" is true.
- </summary>
- <param name="session">The session.</param>
- <param name="sender">The sender.</param>
- <param name="certificate">The certificate.</param>
- <param name="chain">The chain.</param>
- <param name="sslPolicyErrors">The SSL policy errors.</param>
- <returns>return the validation result</returns>
- </member>
- <member name="M:SuperSocket.SocketBase.AppServerBase`2.SetupSocketServer">
- <summary>
- Setups the socket server.instance
- </summary>
- <returns></returns>
- </member>
- <member name="M:SuperSocket.SocketBase.AppServerBase`2.SetupListeners(SuperSocket.SocketBase.Config.IServerConfig)">
- <summary>
- Setups the listeners base on server configuration
- </summary>
- <param name="config">The config.</param>
- <returns></returns>
- </member>
- <member name="M:SuperSocket.SocketBase.AppServerBase`2.Start">
- <summary>
- Starts this server instance.
- </summary>
- <returns>
- return true if start successfull, else false
- </returns>
- </member>
- <member name="M:SuperSocket.SocketBase.AppServerBase`2.OnStartup">
- <summary>
- Called when [startup].
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.AppServerBase`2.OnStarted">
- <summary>
- Called when [started].
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.AppServerBase`2.OnStopped">
- <summary>
- Called when [stopped].
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.AppServerBase`2.Stop">
- <summary>
- Stops this server instance.
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.AppServerBase`2.GetCommandByName(System.String)">
- <summary>
- Gets command by command name.
- </summary>
- <param name="commandName">Name of the command.</param>
- <returns></returns>
- </member>
- <member name="M:SuperSocket.SocketBase.AppServerBase`2.OnRawDataReceived(SuperSocket.SocketBase.IAppSession,System.Byte[],System.Int32,System.Int32)">
- <summary>
- Called when [raw data received].
- </summary>
- <param name="session">The session.</param>
- <param name="buffer">The buffer.</param>
- <param name="offset">The offset.</param>
- <param name="length">The length.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.AppServerBase`2.ExecuteCommand(`0,`1)">
- <summary>
- Executes the command.
- </summary>
- <param name="session">The session.</param>
- <param name="requestInfo">The request info.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.AppServerBase`2.ExecuteCommand(SuperSocket.SocketBase.IAppSession,`1)">
- <summary>
- Executes the command for the session.
- </summary>
- <param name="session">The session.</param>
- <param name="requestInfo">The request info.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.AppServerBase`2.SuperSocket#SocketBase#IRequestHandler{TRequestInfo}#ExecuteCommand(SuperSocket.SocketBase.IAppSession,`1)">
- <summary>
- Executes the command.
- </summary>
- <param name="session">The session.</param>
- <param name="requestInfo">The request info.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.AppServerBase`2.ExecuteConnectionFilters(System.Net.IPEndPoint)">
- <summary>
- Executes the connection filters.
- </summary>
- <param name="remoteAddress">The remote address.</param>
- <returns></returns>
- </member>
- <member name="M:SuperSocket.SocketBase.AppServerBase`2.SuperSocket#SocketBase#IAppServer#CreateAppSession(SuperSocket.SocketBase.ISocketSession)">
- <summary>
- Creates the app session.
- </summary>
- <param name="socketSession">The socket session.</param>
- <returns></returns>
- </member>
- <member name="M:SuperSocket.SocketBase.AppServerBase`2.CreateAppSession(SuperSocket.SocketBase.ISocketSession)">
- <summary>
- create a new TAppSession instance, you can override it to create the session instance in your own way
- </summary>
- <param name="socketSession">the socket session.</param>
- <returns>the new created session instance</returns>
- </member>
- <member name="M:SuperSocket.SocketBase.AppServerBase`2.SuperSocket#SocketBase#IAppServer#RegisterSession(SuperSocket.SocketBase.IAppSession)">
- <summary>
- Registers the new created app session into the appserver's session container.
- </summary>
- <param name="session">The session.</param>
- <returns></returns>
- </member>
- <member name="M:SuperSocket.SocketBase.AppServerBase`2.RegisterSession(System.String,`0)">
- <summary>
- Registers the session into session container.
- </summary>
- <param name="sessionID">The session ID.</param>
- <param name="appSession">The app session.</param>
- <returns></returns>
- </member>
- <member name="M:SuperSocket.SocketBase.AppServerBase`2.OnNewSessionConnected(`0)">
- <summary>
- Called when [new session connected].
- </summary>
- <param name="session">The session.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.AppServerBase`2.ResetSessionSecurity(SuperSocket.SocketBase.IAppSession,System.Security.Authentication.SslProtocols)">
- <summary>
- Resets the session's security protocol.
- </summary>
- <param name="session">The session.</param>
- <param name="security">The security protocol.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.AppServerBase`2.OnSocketSessionClosed(SuperSocket.SocketBase.ISocketSession,SuperSocket.SocketBase.CloseReason)">
- <summary>
- Called when [socket session closed].
- </summary>
- <param name="session">The socket session.</param>
- <param name="reason">The reason.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.AppServerBase`2.OnSessionClosed(`0,SuperSocket.SocketBase.CloseReason)">
- <summary>
- Called when [session closed].
- </summary>
- <param name="session">The appSession.</param>
- <param name="reason">The reason.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.AppServerBase`2.GetSessionByID(System.String)">
- <summary>
- Gets the app session by ID.
- </summary>
- <param name="sessionID">The session ID.</param>
- <returns></returns>
- </member>
- <member name="M:SuperSocket.SocketBase.AppServerBase`2.SuperSocket#SocketBase#IAppServer#GetSessionByID(System.String)">
- <summary>
- Gets the app session by ID.
- </summary>
- <param name="sessionID"></param>
- <returns></returns>
- </member>
- <member name="M:SuperSocket.SocketBase.AppServerBase`2.GetSessions(System.Func{`0,System.Boolean})">
- <summary>
- Gets the matched sessions from sessions snapshot.
- </summary>
- <param name="critera">The prediction critera.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.AppServerBase`2.GetAllSessions">
- <summary>
- Gets all sessions in sessions snapshot.
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.AppServerBase`2.GetFilePath(System.String)">
- <summary>
- Gets the physical file path by the relative file path,
- search both in the appserver's root and in the supersocket root dir if the isolation level has been set other than 'None'.
- </summary>
- <param name="relativeFilePath">The relative file path.</param>
- <returns></returns>
- </member>
- <member name="M:SuperSocket.SocketBase.AppServerBase`2.SuperSocket#SocketBase#IActiveConnector#ActiveConnect(System.Net.EndPoint,System.Net.EndPoint)">
- <summary>
- Connect the remote endpoint actively.
- </summary>
- <param name="targetEndPoint">The target end point.</param>
- <param name="localEndPoint">The local end point.</param>
- <returns></returns>
- <exception cref="T:System.Exception">This server cannot support active connect.</exception>
- </member>
- <member name="M:SuperSocket.SocketBase.AppServerBase`2.SuperSocket#SocketBase#IActiveConnector#ActiveConnect(System.Net.EndPoint)">
- <summary>
- Connect the remote endpoint actively.
- </summary>
- <param name="targetEndPoint">The target end point.</param>
- <returns></returns>
- <exception cref="T:System.Exception">This server cannot support active connect.</exception>
- </member>
- <member name="M:SuperSocket.SocketBase.AppServerBase`2.SuperSocket#SocketBase#ISystemEndPoint#TransferSystemMessage(System.String,System.Object)">
- <summary>
- Transfers the system message
- </summary>
- <param name="messageType">Type of the message.</param>
- <param name="messageData">The message data.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.AppServerBase`2.OnSystemMessageReceived(System.String,System.Object)">
- <summary>
- Called when [system message received].
- </summary>
- <param name="messageType">Type of the message.</param>
- <param name="messageData">The message data.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.AppServerBase`2.UpdateServerStatus(SuperSocket.SocketBase.StatusInfoCollection)">
- <summary>
- Updates the summary of the server.
- </summary>
- <param name="serverStatus">The server status.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.AppServerBase`2.OnServerStatusCollected(SuperSocket.SocketBase.StatusInfoCollection,SuperSocket.SocketBase.StatusInfoCollection)">
- <summary>
- Called when [server status collected].
- </summary>
- <param name="bootstrapStatus">The bootstrapStatus status.</param>
- <param name="serverStatus">The server status.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.AppServerBase`2.Dispose">
- <summary>
- Releases unmanaged and - optionally - managed resources
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.AppServerBase`2.Config">
- <summary>
- Gets the server's config.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.AppServerBase`2.State">
- <summary>
- Gets the current state of the work item.
- </summary>
- <value>
- The state.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.AppServerBase`2.Certificate">
- <summary>
- Gets the certificate of current server.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.AppServerBase`2.ReceiveFilterFactory">
- <summary>
- Gets or sets the receive filter factory.
- </summary>
- <value>
- The receive filter factory.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.AppServerBase`2.SuperSocket#SocketBase#IAppServer#ReceiveFilterFactory">
- <summary>
- Gets the Receive filter factory.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.AppServerBase`2.BasicSecurity">
- <summary>
- Gets the basic transfer layer security protocol.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.AppServerBase`2.RootConfig">
- <summary>
- Gets the root config.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.AppServerBase`2.Logger">
- <summary>
- Gets the logger assosiated with this object.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.AppServerBase`2.Bootstrap">
- <summary>
- Gets the bootstrap of this appServer instance.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.AppServerBase`2.TotalHandledRequests">
- <summary>
- Gets the total handled requests number.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.AppServerBase`2.Listeners">
- <summary>
- Gets or sets the listeners inforamtion.
- </summary>
- <value>
- The listeners.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.AppServerBase`2.StartedTime">
- <summary>
- Gets the started time of this server instance.
- </summary>
- <value>
- The started time.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.AppServerBase`2.LogFactory">
- <summary>
- Gets or sets the log factory.
- </summary>
- <value>
- The log factory.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.AppServerBase`2.TextEncoding">
- <summary>
- Gets the default text encoding.
- </summary>
- <value>
- The text encoding.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.AppServerBase`2.Name">
- <summary>
- Gets the name of the server instance.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.AppServerBase`2.SuperSocket#SocketBase#ISocketServerAccessor#SocketServer">
- <summary>
- Gets the socket server.
- </summary>
- <value>
- The socket server.
- </value>
- </member>
- <member name="E:SuperSocket.SocketBase.AppServerBase`2.SuperSocket#SocketBase#IRawDataProcessor{TAppSession}#RawDataReceived">
- <summary>
- Gets or sets the raw binary data received event handler.
- TAppSession: session
- byte[]: receive buffer
- int: receive buffer offset
- int: receive lenght
- bool: whether process the received data further
- </summary>
- </member>
- <member name="E:SuperSocket.SocketBase.AppServerBase`2.NewRequestReceived">
- <summary>
- Occurs when a full request item received.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.AppServerBase`2.ConnectionFilters">
- <summary>
- Gets or sets the server's connection filter
- </summary>
- <value>
- The server's connection filters
- </value>
- </member>
- <member name="E:SuperSocket.SocketBase.AppServerBase`2.NewSessionConnected">
- <summary>
- The action which will be executed after a new session connect
- </summary>
- </member>
- <member name="E:SuperSocket.SocketBase.AppServerBase`2.SessionClosed">
- <summary>
- Gets/sets the session closed event handler.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.AppServerBase`2.SessionCount">
- <summary>
- Gets the total session count.
- </summary>
- </member>
- <member name="T:SuperSocket.SocketBase.Async">
- <summary>
- Async extension class
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.Async.AsyncRun(SuperSocket.SocketBase.ILoggerProvider,System.Action)">
- <summary>
- Runs the specified task.
- </summary>
- <param name="logProvider">The log provider.</param>
- <param name="task">The task.</param>
- <returns></returns>
- </member>
- <member name="M:SuperSocket.SocketBase.Async.AsyncRun(SuperSocket.SocketBase.ILoggerProvider,System.Action,System.Threading.Tasks.TaskCreationOptions)">
- <summary>
- Runs the specified task.
- </summary>
- <param name="logProvider">The log provider.</param>
- <param name="task">The task.</param>
- <param name="taskOption">The task option.</param>
- <returns></returns>
- </member>
- <member name="M:SuperSocket.SocketBase.Async.AsyncRun(SuperSocket.SocketBase.ILoggerProvider,System.Action,System.Action{System.Exception})">
- <summary>
- Runs the specified task.
- </summary>
- <param name="logProvider">The log provider.</param>
- <param name="task">The task.</param>
- <param name="exceptionHandler">The exception handler.</param>
- <returns></returns>
- </member>
- <member name="M:SuperSocket.SocketBase.Async.AsyncRun(SuperSocket.SocketBase.ILoggerProvider,System.Action,System.Threading.Tasks.TaskCreationOptions,System.Action{System.Exception})">
- <summary>
- Runs the specified task.
- </summary>
- <param name="logProvider">The log provider.</param>
- <param name="task">The task.</param>
- <param name="taskOption">The task option.</param>
- <param name="exceptionHandler">The exception handler.</param>
- <returns></returns>
- </member>
- <member name="M:SuperSocket.SocketBase.Async.AsyncRun(SuperSocket.SocketBase.ILoggerProvider,System.Action{System.Object},System.Object)">
- <summary>
- Runs the specified task.
- </summary>
- <param name="logProvider">The log provider.</param>
- <param name="task">The task.</param>
- <param name="state">The state.</param>
- <returns></returns>
- </member>
- <member name="M:SuperSocket.SocketBase.Async.AsyncRun(SuperSocket.SocketBase.ILoggerProvider,System.Action{System.Object},System.Object,System.Threading.Tasks.TaskCreationOptions)">
- <summary>
- Runs the specified task.
- </summary>
- <param name="logProvider">The log provider.</param>
- <param name="task">The task.</param>
- <param name="state">The state.</param>
- <param name="taskOption">The task option.</param>
- <returns></returns>
- </member>
- <member name="M:SuperSocket.SocketBase.Async.AsyncRun(SuperSocket.SocketBase.ILoggerProvider,System.Action{System.Object},System.Object,System.Action{System.Exception})">
- <summary>
- Runs the specified task.
- </summary>
- <param name="logProvider">The log provider.</param>
- <param name="task">The task.</param>
- <param name="state">The state.</param>
- <param name="exceptionHandler">The exception handler.</param>
- <returns></returns>
- </member>
- <member name="M:SuperSocket.SocketBase.Async.AsyncRun(SuperSocket.SocketBase.ILoggerProvider,System.Action{System.Object},System.Object,System.Threading.Tasks.TaskCreationOptions,System.Action{System.Exception})">
- <summary>
- Runs the specified task.
- </summary>
- <param name="logProvider">The log provider.</param>
- <param name="task">The task.</param>
- <param name="state">The state.</param>
- <param name="taskOption">The task option.</param>
- <param name="exceptionHandler">The exception handler.</param>
- <returns></returns>
- </member>
- <member name="T:SuperSocket.SocketBase.CommandExecutingContext">
- <summary>
- Command Executing Context
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.CommandExecutingContext.Initialize(SuperSocket.SocketBase.IAppSession,SuperSocket.SocketBase.Protocol.IRequestInfo,SuperSocket.SocketBase.Command.ICommand)">
- <summary>
- Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.CommandExecutingContext"/> class.
- </summary>
- <param name="session">The session.</param>
- <param name="requestInfo">The request info.</param>
- <param name="command">The command.</param>
- </member>
- <member name="P:SuperSocket.SocketBase.CommandExecutingContext.Session">
- <summary>
- Gets the session.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.CommandExecutingContext.RequestInfo">
- <summary>
- Gets the request info.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.CommandExecutingContext.CurrentCommand">
- <summary>
- Gets the current command.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.CommandExecutingContext.Exception">
- <summary>
- Gets the exception.
- </summary>
- <value>
- The exception.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.CommandExecutingContext.ExceptionHandled">
- <summary>
- Gets a value indicating whether [exception handled].
- </summary>
- <value>
- <c>true</c> if [exception handled]; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.CommandExecutingContext.Cancel">
- <summary>
- Gets or sets a value indicating whether this command executing is cancelled.
- </summary>
- <value>
- <c>true</c> if cancel; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="T:SuperSocket.SocketBase.Command.ICommandFilterProvider">
- <summary>
- The basic interface for CommandFilter
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.Command.ICommandFilterProvider.GetFilters">
- <summary>
- Gets the filters which assosiated with this command object.
- </summary>
- <returns></returns>
- </member>
- <member name="T:SuperSocket.SocketBase.Config.HotUpdateAttribute">
- <summary>
- the attribute to mark which property of ServerConfig support hot update
- </summary>
- </member>
- <member name="T:SuperSocket.SocketBase.ActiveConnectResult">
- <summary>
- Active connect result model
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.ActiveConnectResult.Result">
- <summary>
- Gets or sets a value indicating whether the conecting is sucessfull
- </summary>
- <value>
- <c>true</c> if result; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.ActiveConnectResult.Session">
- <summary>
- Gets or sets the connected session.
- </summary>
- <value>
- The connected session.
- </value>
- </member>
- <member name="T:SuperSocket.SocketBase.Metadata.CommandFilterAttribute">
- <summary>
- Command filter attribute
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.Metadata.CommandFilterAttribute.OnCommandExecuting(SuperSocket.SocketBase.CommandExecutingContext)">
- <summary>
- Called when [command executing].
- </summary>
- <param name="commandContext">The command context.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Metadata.CommandFilterAttribute.OnCommandExecuted(SuperSocket.SocketBase.CommandExecutingContext)">
- <summary>
- Called when [command executed].
- </summary>
- <param name="commandContext">The command context.</param>
- </member>
- <member name="P:SuperSocket.SocketBase.Metadata.CommandFilterAttribute.Order">
- <summary>
- Gets or sets the execution order.
- </summary>
- <value>
- The order.
- </value>
- </member>
- <member name="T:SuperSocket.SocketBase.Command.CommandLoaderBase`1">
- <summary>
- CommandLoader base class
- </summary>
- </member>
- <member name="T:SuperSocket.SocketBase.Command.ICommandLoader`1">
- <summary>
- Command loader's interface
- </summary>
- </member>
- <member name="T:SuperSocket.SocketBase.Command.ICommandLoader">
- <summary>
- the empty basic interface for command loader
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.Command.ICommandLoader`1.Initialize(SuperSocket.SocketBase.Config.IRootConfig,SuperSocket.SocketBase.IAppServer)">
- <summary>
- Initializes the command loader by the root config and the server instance.
- </summary>
- <param name="rootConfig">The root config.</param>
- <param name="appServer">The app server.</param>
- <returns></returns>
- </member>
- <member name="M:SuperSocket.SocketBase.Command.ICommandLoader`1.TryLoadCommands(System.Collections.Generic.IEnumerable{`0}@)">
- <summary>
- Tries to load commands.
- </summary>
- <param name="commands">The commands.</param>
- <returns></returns>
- </member>
- <member name="E:SuperSocket.SocketBase.Command.ICommandLoader`1.Updated">
- <summary>
- Occurs when [updated].
- </summary>
- </member>
- <member name="E:SuperSocket.SocketBase.Command.ICommandLoader`1.Error">
- <summary>
- Occurs when [error].
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.Command.CommandLoaderBase`1.Initialize(SuperSocket.SocketBase.Config.IRootConfig,SuperSocket.SocketBase.IAppServer)">
- <summary>
- Initializes the command loader by the root config and appserver instance.
- </summary>
- <param name="rootConfig">The root config.</param>
- <param name="appServer">The app server.</param>
- <returns></returns>
- </member>
- <member name="M:SuperSocket.SocketBase.Command.CommandLoaderBase`1.TryLoadCommands(System.Collections.Generic.IEnumerable{`0}@)">
- <summary>
- Tries to load commands.
- </summary>
- <param name="commands">The commands.</param>
- <returns></returns>
- </member>
- <member name="M:SuperSocket.SocketBase.Command.CommandLoaderBase`1.OnUpdated(System.Collections.Generic.IEnumerable{SuperSocket.SocketBase.Command.CommandUpdateInfo{`0}})">
- <summary>
- Called when [updated].
- </summary>
- <param name="commands">The commands.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Command.CommandLoaderBase`1.OnError(System.String)">
- <summary>
- Called when [error].
- </summary>
- <param name="message">The message.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Command.CommandLoaderBase`1.OnError(System.Exception)">
- <summary>
- Called when [error].
- </summary>
- <param name="e">The e.</param>
- </member>
- <member name="E:SuperSocket.SocketBase.Command.CommandLoaderBase`1.Updated">
- <summary>
- Occurs when [updated].
- </summary>
- </member>
- <member name="E:SuperSocket.SocketBase.Command.CommandLoaderBase`1.Error">
- <summary>
- Occurs when [error].
- </summary>
- </member>
- <member name="T:SuperSocket.SocketBase.Command.CommandUpdateEventArgs`1">
- <summary>
- CommandUpdateEventArgs
- </summary>
- <typeparam name="T"></typeparam>
- </member>
- <member name="M:SuperSocket.SocketBase.Command.CommandUpdateEventArgs`1.#ctor(System.Collections.Generic.IEnumerable{SuperSocket.SocketBase.Command.CommandUpdateInfo{`0}})">
- <summary>
- Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Command.CommandUpdateEventArgs`1"/> class.
- </summary>
- <param name="commands">The commands.</param>
- </member>
- <member name="P:SuperSocket.SocketBase.Command.CommandUpdateEventArgs`1.Commands">
- <summary>
- Gets the commands updated.
- </summary>
- </member>
- <member name="T:SuperSocket.SocketBase.Config.CommandAssemblyConfig">
- <summary>
- Command assembly config
- </summary>
- </member>
- <member name="T:SuperSocket.SocketBase.Config.ICommandAssemblyConfig">
- <summary>
- The basic interface for command assembly config
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.ICommandAssemblyConfig.Assembly">
- <summary>
- Gets the assembly name.
- </summary>
- <value>
- The assembly.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.CommandAssemblyConfig.Assembly">
- <summary>
- Gets or sets the assembly name.
- </summary>
- <value>
- The assembly.
- </value>
- </member>
- <member name="T:SuperSocket.SocketBase.Config.IConfigurationSource">
- <summary>
- Configuration source interface
- </summary>
- </member>
- <member name="T:SuperSocket.SocketBase.Config.IRootConfig">
- <summary>
- The root configuration interface
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.Config.IRootConfig.GetChildConfig``1(System.String)">
- <summary>
- Gets the child config.
- </summary>
- <typeparam name="TConfig">The type of the config.</typeparam>
- <param name="childConfigName">Name of the child config.</param>
- <returns></returns>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.IRootConfig.MaxWorkingThreads">
- <summary>
- Gets the max working threads.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.IRootConfig.MinWorkingThreads">
- <summary>
- Gets the min working threads.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.IRootConfig.MaxCompletionPortThreads">
- <summary>
- Gets the max completion port threads.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.IRootConfig.MinCompletionPortThreads">
- <summary>
- Gets the min completion port threads.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.IRootConfig.DisablePerformanceDataCollector">
- <summary>
- Gets a value indicating whether [disable performance data collector].
- </summary>
- <value>
- <c>true</c> if [disable performance data collector]; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.IRootConfig.PerformanceDataCollectInterval">
- <summary>
- Gets the performance data collect interval, in seconds.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.IRootConfig.LogFactory">
- <summary>
- Gets the log factory name.
- </summary>
- <value>
- The log factory.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.IRootConfig.Isolation">
- <summary>
- Gets the isolation mode.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.IRootConfig.OptionElements">
- <summary>
- Gets the option elements.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.IConfigurationSource.Servers">
- <summary>
- Gets the servers definitions.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.IConfigurationSource.ServerTypes">
- <summary>
- Gets the appServer types definition.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.IConfigurationSource.ConnectionFilters">
- <summary>
- Gets the connection filters definition.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.IConfigurationSource.LogFactories">
- <summary>
- Gets the log factories definition.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.IConfigurationSource.ReceiveFilterFactories">
- <summary>
- Gets the Receive filter factories definition.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.IConfigurationSource.CommandLoaders">
- <summary>
- Gets the command loaders definition.
- </summary>
- </member>
- <member name="T:SuperSocket.SocketBase.Config.ITypeProvider">
- <summary>
- TypeProvider's interface
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.ITypeProvider.Name">
- <summary>
- Gets the name.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.ITypeProvider.Type">
- <summary>
- Gets the type.
- </summary>
- </member>
- <member name="T:SuperSocket.SocketBase.Config.ConfigurationSource">
- <summary>
- Poco configuration source
- </summary>
- </member>
- <member name="T:SuperSocket.SocketBase.Config.RootConfig">
- <summary>
- Root configuration model
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.Config.RootConfig.#ctor(SuperSocket.SocketBase.Config.IRootConfig)">
- <summary>
- Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Config.RootConfig"/> class.
- </summary>
- <param name="rootConfig">The root config.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Config.RootConfig.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Config.RootConfig"/> class.
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.Config.RootConfig.GetChildConfig``1(System.String)">
- <summary>
- Gets the child config.
- </summary>
- <typeparam name="TConfig">The type of the config.</typeparam>
- <param name="childConfigName">Name of the child config.</param>
- <returns></returns>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.RootConfig.MaxWorkingThreads">
- <summary>
- Gets/Sets the max working threads.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.RootConfig.MinWorkingThreads">
- <summary>
- Gets/sets the min working threads.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.RootConfig.MaxCompletionPortThreads">
- <summary>
- Gets/sets the max completion port threads.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.RootConfig.MinCompletionPortThreads">
- <summary>
- Gets/sets the min completion port threads.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.RootConfig.PerformanceDataCollectInterval">
- <summary>
- Gets/sets the performance data collect interval, in seconds.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.RootConfig.DisablePerformanceDataCollector">
- <summary>
- Gets/sets a value indicating whether [disable performance data collector].
- </summary>
- <value>
- <c>true</c> if [disable performance data collector]; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.RootConfig.Isolation">
- <summary>
- Gets/sets the isolation mode.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.RootConfig.LogFactory">
- <summary>
- Gets/sets the log factory name.
- </summary>
- <value>
- The log factory.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.RootConfig.OptionElements">
- <summary>
- Gets/sets the option elements.
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.Config.ConfigurationSource.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Config.ConfigurationSource"/> class.
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.Config.ConfigurationSource.#ctor(SuperSocket.SocketBase.Config.IConfigurationSource)">
- <summary>
- Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Config.ConfigurationSource"/> class.
- </summary>
- <param name="source">The source.</param>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.ConfigurationSource.Servers">
- <summary>
- Gets the servers definitions.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.ConfigurationSource.ServerTypes">
- <summary>
- Gets/sets the server types definition.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.ConfigurationSource.ConnectionFilters">
- <summary>
- Gets/sets the connection filters definition.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.ConfigurationSource.LogFactories">
- <summary>
- Gets/sets the log factories definition.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.ConfigurationSource.ReceiveFilterFactories">
- <summary>
- Gets/sets the Receive filter factories definition.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.ConfigurationSource.CommandLoaders">
- <summary>
- Gets/sets the command loaders definition.
- </summary>
- </member>
- <member name="T:SuperSocket.SocketBase.Config.TypeProvider">
- <summary>
- Type provider configuration
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.TypeProvider.Name">
- <summary>
- Gets the name.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.TypeProvider.Type">
- <summary>
- Gets the type.
- </summary>
- </member>
- <member name="T:SuperSocket.SocketBase.Config.TypeProviderCollection">
- <summary>
- Type provider colletion configuration
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.Config.TypeProviderCollection.CreateNewElement">
- <summary>
- When overridden in a derived class, creates a new <see cref="T:System.Configuration.ConfigurationElement"/>.
- </summary>
- <returns>
- A new <see cref="T:System.Configuration.ConfigurationElement"/>.
- </returns>
- </member>
- <member name="M:SuperSocket.SocketBase.Config.TypeProviderCollection.GetElementKey(System.Configuration.ConfigurationElement)">
- <summary>
- Gets the element key for a specified configuration element when overridden in a derived class.
- </summary>
- <param name="element">The <see cref="T:System.Configuration.ConfigurationElement"/> to return the key for.</param>
- <returns>
- An <see cref="T:System.Object"/> that acts as the key for the specified <see cref="T:System.Configuration.ConfigurationElement"/>.
- </returns>
- </member>
- <member name="M:SuperSocket.SocketBase.Config.TypeProviderCollection.GetEnumerator">
- <summary>
- Returns an enumerator that iterates through the collection.
- </summary>
- <returns>
- A <see cref="T:System.Collections.Generic.IEnumerator`1"/> that can be used to iterate through the collection.
- </returns>
- </member>
- <member name="T:SuperSocket.SocketBase.Config.TypeProviderConfig">
- <summary>
- TypeProviderConfig
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.TypeProviderConfig.Name">
- <summary>
- Gets the name.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.TypeProviderConfig.Type">
- <summary>
- Gets the type.
- </summary>
- </member>
- <member name="T:SuperSocket.SocketBase.Extensions">
- <summary>
- Extensions class for SocketBase project
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.Extensions.GetServerByName(SuperSocket.SocketBase.IBootstrap,System.String)">
- <summary>
- Gets the app server instance in the bootstrap by name, ignore case
- </summary>
- <param name="bootstrap">The bootstrap.</param>
- <param name="name">The name of the appserver instance.</param>
- <returns></returns>
- <exception cref="T:System.ArgumentNullException"></exception>
- </member>
- <member name="M:SuperSocket.SocketBase.Extensions.GetStatusInfoMetadata(System.Type)">
- <summary>
- Gets the status info metadata from the server type.
- </summary>
- <param name="serverType">Type of the server.</param>
- <returns></returns>
- <exception cref="T:System.ArgumentNullException"></exception>
- </member>
- <member name="T:SuperSocket.SocketBase.Metadata.StatusInfoAttribute">
- <summary>
- StatusInfo Metadata
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.Metadata.StatusInfoAttribute.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Metadata.StatusInfoAttribute"/> class.
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.Metadata.StatusInfoAttribute.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Metadata.StatusInfoAttribute"/> class.
- </summary>
- <param name="key">The key.</param>
- </member>
- <member name="P:SuperSocket.SocketBase.Metadata.StatusInfoAttribute.Key">
- <summary>
- Gets or sets the key.
- </summary>
- <value>
- The key.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.Metadata.StatusInfoAttribute.Name">
- <summary>
- Gets or sets the name.
- </summary>
- <value>
- The name.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.Metadata.StatusInfoAttribute.ShortName">
- <summary>
- Gets or sets the short name.
- </summary>
- <value>
- The short name.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.Metadata.StatusInfoAttribute.Format">
- <summary>
- Gets or sets the format.
- </summary>
- <value>
- The format.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.Metadata.StatusInfoAttribute.Order">
- <summary>
- Gets or sets the order.
- </summary>
- <value>
- The order.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.Metadata.StatusInfoAttribute.OutputInPerfLog">
- <summary>
- Gets or sets a value indicating whether [output in perf log].
- </summary>
- <value>
- <c>true</c> if [output in perf log]; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.Metadata.StatusInfoAttribute.DataType">
- <summary>
- Gets or sets the type of the data.
- </summary>
- <value>
- The type of the data.
- </value>
- </member>
- <member name="T:SuperSocket.SocketBase.StartResult">
- <summary>
- The bootstrap start result
- </summary>
- </member>
- <member name="F:SuperSocket.SocketBase.StartResult.None">
- <summary>
- No appserver has been set in the bootstrap, so nothing was started
- </summary>
- </member>
- <member name="F:SuperSocket.SocketBase.StartResult.Success">
- <summary>
- All appserver instances were started successfully
- </summary>
- </member>
- <member name="F:SuperSocket.SocketBase.StartResult.PartialSuccess">
- <summary>
- Some appserver instances were started successfully, but some of them failed
- </summary>
- </member>
- <member name="F:SuperSocket.SocketBase.StartResult.Failed">
- <summary>
- All appserver instances failed to start
- </summary>
- </member>
- <member name="T:SuperSocket.SocketBase.IBootstrap">
- <summary>
- SuperSocket bootstrap
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.IBootstrap.Initialize">
- <summary>
- Initializes the bootstrap with the configuration
- </summary>
- <returns></returns>
- </member>
- <member name="M:SuperSocket.SocketBase.IBootstrap.Initialize(System.Collections.Generic.IDictionary{System.String,System.Net.IPEndPoint})">
- <summary>
- Initializes the bootstrap with a listen endpoint replacement dictionary
- </summary>
- <param name="listenEndPointReplacement">The listen end point replacement.</param>
- <returns></returns>
- </member>
- <member name="M:SuperSocket.SocketBase.IBootstrap.Initialize(System.Func{SuperSocket.SocketBase.Config.IServerConfig,SuperSocket.SocketBase.Config.IServerConfig})">
- <summary>
- Initializes the bootstrap with the configuration
- </summary>
- <param name="serverConfigResolver">The server config resolver.</param>
- <returns></returns>
- </member>
- <member name="M:SuperSocket.SocketBase.IBootstrap.Initialize(SuperSocket.SocketBase.Logging.ILogFactory)">
- <summary>
- Initializes the bootstrap with the configuration
- </summary>
- <param name="logFactory">The log factory.</param>
- <returns></returns>
- </member>
- <member name="M:SuperSocket.SocketBase.IBootstrap.Initialize(System.Func{SuperSocket.SocketBase.Config.IServerConfig,SuperSocket.SocketBase.Config.IServerConfig},SuperSocket.SocketBase.Logging.ILogFactory)">
- <summary>
- Initializes the bootstrap with the configuration
- </summary>
- <param name="serverConfigResolver">The server config resolver.</param>
- <param name="logFactory">The log factory.</param>
- <returns></returns>
- </member>
- <member name="M:SuperSocket.SocketBase.IBootstrap.Start">
- <summary>
- Starts this bootstrap.
- </summary>
- <returns></returns>
- </member>
- <member name="M:SuperSocket.SocketBase.IBootstrap.Stop">
- <summary>
- Stops this bootstrap.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.IBootstrap.AppServers">
- <summary>
- Gets all the app servers running in this bootstrap
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.IBootstrap.Config">
- <summary>
- Gets the config.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.IBootstrap.StartupConfigFile">
- <summary>
- Gets the startup config file.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.IBootstrap.BaseDirectory">
- <summary>
- Gets the base directory.
- </summary>
- <value>
- The base directory.
- </value>
- </member>
- <member name="T:SuperSocket.SocketBase.IDynamicBootstrap">
- <summary>
- The bootstrap interface to support add new server instance in runtime
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.IDynamicBootstrap.Add(SuperSocket.SocketBase.Config.IServerConfig)">
- <summary>
- Adds a new server into the bootstrap.
- </summary>
- <param name="config">The new server's config.</param>
- <returns></returns>
- </member>
- <member name="M:SuperSocket.SocketBase.IDynamicBootstrap.AddAndStart(SuperSocket.SocketBase.Config.IServerConfig)">
- <summary>
- Adds a new server into the bootstrap and then start it.
- </summary>
- <param name="config">The new server's config.</param>
- <returns></returns>
- </member>
- <member name="M:SuperSocket.SocketBase.IDynamicBootstrap.Remove(System.String)">
- <summary>
- Removes the server instance which is specified by name.
- </summary>
- <param name="name">The name of the server instance to be removed.</param>
- </member>
- <member name="T:SuperSocket.SocketBase.IsolationMode">
- <summary>
- AppServer instance running isolation mode
- </summary>
- </member>
- <member name="F:SuperSocket.SocketBase.IsolationMode.None">
- <summary>
- No isolation
- </summary>
- </member>
- <member name="F:SuperSocket.SocketBase.IsolationMode.AppDomain">
- <summary>
- Isolation by AppDomain
- </summary>
- </member>
- <member name="F:SuperSocket.SocketBase.IsolationMode.Process">
- <summary>
- Isolation by process
- </summary>
- </member>
- <member name="T:SuperSocket.SocketBase.Logging.ConsoleLog">
- <summary>
- Console Log
- </summary>
- </member>
- <member name="T:SuperSocket.SocketBase.Logging.ILog">
- <summary>
- Log interface
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.ILog.Debug(System.Object)">
- <summary>
- Logs the debug message.
- </summary>
- <param name="message">The message.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.ILog.Debug(System.Object,System.Exception)">
- <summary>
- Logs the debug message.
- </summary>
- <param name="message">The message.</param>
- <param name="exception">The exception.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.ILog.DebugFormat(System.String,System.Object)">
- <summary>
- Logs the debug message.
- </summary>
- <param name="format">The format.</param>
- <param name="arg0">The arg0.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.ILog.DebugFormat(System.String,System.Object[])">
- <summary>
- Logs the debug message.
- </summary>
- <param name="format">The format.</param>
- <param name="args">The args.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.ILog.DebugFormat(System.IFormatProvider,System.String,System.Object[])">
- <summary>
- Logs the debug message.
- </summary>
- <param name="provider">The provider.</param>
- <param name="format">The format.</param>
- <param name="args">The args.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.ILog.DebugFormat(System.String,System.Object,System.Object)">
- <summary>
- Logs the debug message.
- </summary>
- <param name="format">The format.</param>
- <param name="arg0">The arg0.</param>
- <param name="arg1">The arg1.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.ILog.DebugFormat(System.String,System.Object,System.Object,System.Object)">
- <summary>
- Logs the debug message.
- </summary>
- <param name="format">The format.</param>
- <param name="arg0">The arg0.</param>
- <param name="arg1">The arg1.</param>
- <param name="arg2">The arg2.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.ILog.Error(System.Object)">
- <summary>
- Logs the error message.
- </summary>
- <param name="message">The message.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.ILog.Error(System.Object,System.Exception)">
- <summary>
- Logs the error message.
- </summary>
- <param name="message">The message.</param>
- <param name="exception">The exception.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.ILog.ErrorFormat(System.String,System.Object)">
- <summary>
- Logs the error message.
- </summary>
- <param name="format">The format.</param>
- <param name="arg0">The arg0.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.ILog.ErrorFormat(System.String,System.Object[])">
- <summary>
- Logs the error message.
- </summary>
- <param name="format">The format.</param>
- <param name="args">The args.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.ILog.ErrorFormat(System.IFormatProvider,System.String,System.Object[])">
- <summary>
- Logs the error message.
- </summary>
- <param name="provider">The provider.</param>
- <param name="format">The format.</param>
- <param name="args">The args.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.ILog.ErrorFormat(System.String,System.Object,System.Object)">
- <summary>
- Logs the error message.
- </summary>
- <param name="format">The format.</param>
- <param name="arg0">The arg0.</param>
- <param name="arg1">The arg1.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.ILog.ErrorFormat(System.String,System.Object,System.Object,System.Object)">
- <summary>
- Logs the error message.
- </summary>
- <param name="format">The format.</param>
- <param name="arg0">The arg0.</param>
- <param name="arg1">The arg1.</param>
- <param name="arg2">The arg2.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.ILog.Fatal(System.Object)">
- <summary>
- Logs the fatal error message.
- </summary>
- <param name="message">The message.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.ILog.Fatal(System.Object,System.Exception)">
- <summary>
- Logs the fatal error message.
- </summary>
- <param name="message">The message.</param>
- <param name="exception">The exception.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.ILog.FatalFormat(System.String,System.Object)">
- <summary>
- Logs the fatal error message.
- </summary>
- <param name="format">The format.</param>
- <param name="arg0">The arg0.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.ILog.FatalFormat(System.String,System.Object[])">
- <summary>
- Logs the fatal error message.
- </summary>
- <param name="format">The format.</param>
- <param name="args">The args.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.ILog.FatalFormat(System.IFormatProvider,System.String,System.Object[])">
- <summary>
- Logs the fatal error message.
- </summary>
- <param name="provider">The provider.</param>
- <param name="format">The format.</param>
- <param name="args">The args.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.ILog.FatalFormat(System.String,System.Object,System.Object)">
- <summary>
- Logs the fatal error message.
- </summary>
- <param name="format">The format.</param>
- <param name="arg0">The arg0.</param>
- <param name="arg1">The arg1.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.ILog.FatalFormat(System.String,System.Object,System.Object,System.Object)">
- <summary>
- Logs the fatal error message.
- </summary>
- <param name="format">The format.</param>
- <param name="arg0">The arg0.</param>
- <param name="arg1">The arg1.</param>
- <param name="arg2">The arg2.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.ILog.Info(System.Object)">
- <summary>
- Logs the info message.
- </summary>
- <param name="message">The message.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.ILog.Info(System.Object,System.Exception)">
- <summary>
- Logs the info message.
- </summary>
- <param name="message">The message.</param>
- <param name="exception">The exception.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.ILog.InfoFormat(System.String,System.Object)">
- <summary>
- Logs the info message.
- </summary>
- <param name="format">The format.</param>
- <param name="arg0">The arg0.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.ILog.InfoFormat(System.String,System.Object[])">
- <summary>
- Logs the info message.
- </summary>
- <param name="format">The format.</param>
- <param name="args">The args.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.ILog.InfoFormat(System.IFormatProvider,System.String,System.Object[])">
- <summary>
- Logs the info message.
- </summary>
- <param name="provider">The provider.</param>
- <param name="format">The format.</param>
- <param name="args">The args.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.ILog.InfoFormat(System.String,System.Object,System.Object)">
- <summary>
- Logs the info message.
- </summary>
- <param name="format">The format.</param>
- <param name="arg0">The arg0.</param>
- <param name="arg1">The arg1.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.ILog.InfoFormat(System.String,System.Object,System.Object,System.Object)">
- <summary>
- Logs the info message.
- </summary>
- <param name="format">The format.</param>
- <param name="arg0">The arg0.</param>
- <param name="arg1">The arg1.</param>
- <param name="arg2">The arg2.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.ILog.Warn(System.Object)">
- <summary>
- Logs the warning message.
- </summary>
- <param name="message">The message.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.ILog.Warn(System.Object,System.Exception)">
- <summary>
- Logs the warning message.
- </summary>
- <param name="message">The message.</param>
- <param name="exception">The exception.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.ILog.WarnFormat(System.String,System.Object)">
- <summary>
- Logs the warning message.
- </summary>
- <param name="format">The format.</param>
- <param name="arg0">The arg0.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.ILog.WarnFormat(System.String,System.Object[])">
- <summary>
- Logs the warning message.
- </summary>
- <param name="format">The format.</param>
- <param name="args">The args.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.ILog.WarnFormat(System.IFormatProvider,System.String,System.Object[])">
- <summary>
- Logs the warning message.
- </summary>
- <param name="provider">The provider.</param>
- <param name="format">The format.</param>
- <param name="args">The args.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.ILog.WarnFormat(System.String,System.Object,System.Object)">
- <summary>
- Logs the warning message.
- </summary>
- <param name="format">The format.</param>
- <param name="arg0">The arg0.</param>
- <param name="arg1">The arg1.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.ILog.WarnFormat(System.String,System.Object,System.Object,System.Object)">
- <summary>
- Logs the warning message.
- </summary>
- <param name="format">The format.</param>
- <param name="arg0">The arg0.</param>
- <param name="arg1">The arg1.</param>
- <param name="arg2">The arg2.</param>
- </member>
- <member name="P:SuperSocket.SocketBase.Logging.ILog.IsDebugEnabled">
- <summary>
- Gets a value indicating whether this instance is debug enabled.
- </summary>
- <value>
- <c>true</c> if this instance is debug enabled; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.Logging.ILog.IsErrorEnabled">
- <summary>
- Gets a value indicating whether this instance is error enabled.
- </summary>
- <value>
- <c>true</c> if this instance is error enabled; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.Logging.ILog.IsFatalEnabled">
- <summary>
- Gets a value indicating whether this instance is fatal enabled.
- </summary>
- <value>
- <c>true</c> if this instance is fatal enabled; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.Logging.ILog.IsInfoEnabled">
- <summary>
- Gets a value indicating whether this instance is info enabled.
- </summary>
- <value>
- <c>true</c> if this instance is info enabled; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.Logging.ILog.IsWarnEnabled">
- <summary>
- Gets a value indicating whether this instance is warn enabled.
- </summary>
- <value>
- <c>true</c> if this instance is warn enabled; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.ConsoleLog.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Logging.ConsoleLog"/> class.
- </summary>
- <param name="name">The name.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.ConsoleLog.Debug(System.Object)">
- <summary>
- Logs the debug message.
- </summary>
- <param name="message">The message.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.ConsoleLog.Debug(System.Object,System.Exception)">
- <summary>
- Logs the debug message.
- </summary>
- <param name="message">The message.</param>
- <param name="exception">The exception.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.ConsoleLog.DebugFormat(System.String,System.Object)">
- <summary>
- Logs the debug message.
- </summary>
- <param name="format">The format.</param>
- <param name="arg0">The arg0.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.ConsoleLog.DebugFormat(System.String,System.Object[])">
- <summary>
- Logs the debug message.
- </summary>
- <param name="format">The format.</param>
- <param name="args">The args.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.ConsoleLog.DebugFormat(System.IFormatProvider,System.String,System.Object[])">
- <summary>
- Logs the debug message.
- </summary>
- <param name="provider">The provider.</param>
- <param name="format">The format.</param>
- <param name="args">The args.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.ConsoleLog.DebugFormat(System.String,System.Object,System.Object)">
- <summary>
- Logs the debug message.
- </summary>
- <param name="format">The format.</param>
- <param name="arg0">The arg0.</param>
- <param name="arg1">The arg1.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.ConsoleLog.DebugFormat(System.String,System.Object,System.Object,System.Object)">
- <summary>
- Logs the debug message.
- </summary>
- <param name="format">The format.</param>
- <param name="arg0">The arg0.</param>
- <param name="arg1">The arg1.</param>
- <param name="arg2">The arg2.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.ConsoleLog.Error(System.Object)">
- <summary>
- Logs the error message.
- </summary>
- <param name="message">The message.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.ConsoleLog.Error(System.Object,System.Exception)">
- <summary>
- Logs the error message.
- </summary>
- <param name="message">The message.</param>
- <param name="exception">The exception.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.ConsoleLog.ErrorFormat(System.String,System.Object)">
- <summary>
- Logs the error message.
- </summary>
- <param name="format">The format.</param>
- <param name="arg0">The arg0.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.ConsoleLog.ErrorFormat(System.String,System.Object[])">
- <summary>
- Logs the error message.
- </summary>
- <param name="format">The format.</param>
- <param name="args">The args.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.ConsoleLog.ErrorFormat(System.IFormatProvider,System.String,System.Object[])">
- <summary>
- Logs the error message.
- </summary>
- <param name="provider">The provider.</param>
- <param name="format">The format.</param>
- <param name="args">The args.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.ConsoleLog.ErrorFormat(System.String,System.Object,System.Object)">
- <summary>
- Logs the error message.
- </summary>
- <param name="format">The format.</param>
- <param name="arg0">The arg0.</param>
- <param name="arg1">The arg1.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.ConsoleLog.ErrorFormat(System.String,System.Object,System.Object,System.Object)">
- <summary>
- Logs the error message.
- </summary>
- <param name="format">The format.</param>
- <param name="arg0">The arg0.</param>
- <param name="arg1">The arg1.</param>
- <param name="arg2">The arg2.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.ConsoleLog.Fatal(System.Object)">
- <summary>
- Logs the fatal error message.
- </summary>
- <param name="message">The message.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.ConsoleLog.Fatal(System.Object,System.Exception)">
- <summary>
- Logs the fatal error message.
- </summary>
- <param name="message">The message.</param>
- <param name="exception">The exception.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.ConsoleLog.FatalFormat(System.String,System.Object)">
- <summary>
- Logs the fatal error message.
- </summary>
- <param name="format">The format.</param>
- <param name="arg0">The arg0.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.ConsoleLog.FatalFormat(System.String,System.Object[])">
- <summary>
- Logs the fatal error message.
- </summary>
- <param name="format">The format.</param>
- <param name="args">The args.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.ConsoleLog.FatalFormat(System.IFormatProvider,System.String,System.Object[])">
- <summary>
- Logs the fatal error message.
- </summary>
- <param name="provider">The provider.</param>
- <param name="format">The format.</param>
- <param name="args">The args.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.ConsoleLog.FatalFormat(System.String,System.Object,System.Object)">
- <summary>
- Logs the fatal error message.
- </summary>
- <param name="format">The format.</param>
- <param name="arg0">The arg0.</param>
- <param name="arg1">The arg1.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.ConsoleLog.FatalFormat(System.String,System.Object,System.Object,System.Object)">
- <summary>
- Logs the fatal error message.
- </summary>
- <param name="format">The format.</param>
- <param name="arg0">The arg0.</param>
- <param name="arg1">The arg1.</param>
- <param name="arg2">The arg2.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.ConsoleLog.Info(System.Object)">
- <summary>
- Logs the info message.
- </summary>
- <param name="message">The message.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.ConsoleLog.Info(System.Object,System.Exception)">
- <summary>
- Logs the info message.
- </summary>
- <param name="message">The message.</param>
- <param name="exception">The exception.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.ConsoleLog.InfoFormat(System.String,System.Object)">
- <summary>
- Logs the info message.
- </summary>
- <param name="format">The format.</param>
- <param name="arg0">The arg0.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.ConsoleLog.InfoFormat(System.String,System.Object[])">
- <summary>
- Logs the info message.
- </summary>
- <param name="format">The format.</param>
- <param name="args">The args.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.ConsoleLog.InfoFormat(System.IFormatProvider,System.String,System.Object[])">
- <summary>
- Logs the info message.
- </summary>
- <param name="provider">The provider.</param>
- <param name="format">The format.</param>
- <param name="args">The args.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.ConsoleLog.InfoFormat(System.String,System.Object,System.Object)">
- <summary>
- Logs the info message.
- </summary>
- <param name="format">The format.</param>
- <param name="arg0">The arg0.</param>
- <param name="arg1">The arg1.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.ConsoleLog.InfoFormat(System.String,System.Object,System.Object,System.Object)">
- <summary>
- Logs the info message.
- </summary>
- <param name="format">The format.</param>
- <param name="arg0">The arg0.</param>
- <param name="arg1">The arg1.</param>
- <param name="arg2">The arg2.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.ConsoleLog.Warn(System.Object)">
- <summary>
- Logs the warning message.
- </summary>
- <param name="message">The message.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.ConsoleLog.Warn(System.Object,System.Exception)">
- <summary>
- Logs the warning message.
- </summary>
- <param name="message">The message.</param>
- <param name="exception">The exception.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.ConsoleLog.WarnFormat(System.String,System.Object)">
- <summary>
- Logs the warning message.
- </summary>
- <param name="format">The format.</param>
- <param name="arg0">The arg0.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.ConsoleLog.WarnFormat(System.String,System.Object[])">
- <summary>
- Logs the warning message.
- </summary>
- <param name="format">The format.</param>
- <param name="args">The args.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.ConsoleLog.WarnFormat(System.IFormatProvider,System.String,System.Object[])">
- <summary>
- Logs the warning message.
- </summary>
- <param name="provider">The provider.</param>
- <param name="format">The format.</param>
- <param name="args">The args.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.ConsoleLog.WarnFormat(System.String,System.Object,System.Object)">
- <summary>
- Logs the warning message.
- </summary>
- <param name="format">The format.</param>
- <param name="arg0">The arg0.</param>
- <param name="arg1">The arg1.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.ConsoleLog.WarnFormat(System.String,System.Object,System.Object,System.Object)">
- <summary>
- Logs the warning message.
- </summary>
- <param name="format">The format.</param>
- <param name="arg0">The arg0.</param>
- <param name="arg1">The arg1.</param>
- <param name="arg2">The arg2.</param>
- </member>
- <member name="P:SuperSocket.SocketBase.Logging.ConsoleLog.IsDebugEnabled">
- <summary>
- Gets a value indicating whether this instance is debug enabled.
- </summary>
- <value>
- <c>true</c> if this instance is debug enabled; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.Logging.ConsoleLog.IsErrorEnabled">
- <summary>
- Gets a value indicating whether this instance is error enabled.
- </summary>
- <value>
- <c>true</c> if this instance is error enabled; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.Logging.ConsoleLog.IsFatalEnabled">
- <summary>
- Gets a value indicating whether this instance is fatal enabled.
- </summary>
- <value>
- <c>true</c> if this instance is fatal enabled; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.Logging.ConsoleLog.IsInfoEnabled">
- <summary>
- Gets a value indicating whether this instance is info enabled.
- </summary>
- <value>
- <c>true</c> if this instance is info enabled; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.Logging.ConsoleLog.IsWarnEnabled">
- <summary>
- Gets a value indicating whether this instance is warn enabled.
- </summary>
- <value>
- <c>true</c> if this instance is warn enabled; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="T:SuperSocket.SocketBase.Logging.ConsoleLogFactory">
- <summary>
- Console log factory
- </summary>
- </member>
- <member name="T:SuperSocket.SocketBase.Logging.ILogFactory">
- <summary>
- LogFactory Interface
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.ILogFactory.GetLog(System.String)">
- <summary>
- Gets the log by name.
- </summary>
- <param name="name">The name.</param>
- <returns></returns>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.ConsoleLogFactory.GetLog(System.String)">
- <summary>
- Gets the log by name.
- </summary>
- <param name="name">The name.</param>
- <returns></returns>
- </member>
- <member name="T:SuperSocket.SocketBase.Logging.Log4NetLog">
- <summary>
- Log4NetLog
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.Log4NetLog.#ctor(log4net.ILog)">
- <summary>
- Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Logging.Log4NetLog"/> class.
- </summary>
- <param name="log">The log.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.Log4NetLog.Debug(System.Object)">
- <summary>
- Logs the debug message.
- </summary>
- <param name="message">The message.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.Log4NetLog.Debug(System.Object,System.Exception)">
- <summary>
- Logs the debug message.
- </summary>
- <param name="message">The message.</param>
- <param name="exception">The exception.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.Log4NetLog.DebugFormat(System.String,System.Object)">
- <summary>
- Logs the debug message.
- </summary>
- <param name="format">The format.</param>
- <param name="arg0">The arg0.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.Log4NetLog.DebugFormat(System.String,System.Object[])">
- <summary>
- Logs the debug message.
- </summary>
- <param name="format">The format.</param>
- <param name="args">The args.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.Log4NetLog.DebugFormat(System.IFormatProvider,System.String,System.Object[])">
- <summary>
- Logs the debug message.
- </summary>
- <param name="provider">The provider.</param>
- <param name="format">The format.</param>
- <param name="args">The args.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.Log4NetLog.DebugFormat(System.String,System.Object,System.Object)">
- <summary>
- Logs the debug message.
- </summary>
- <param name="format">The format.</param>
- <param name="arg0">The arg0.</param>
- <param name="arg1">The arg1.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.Log4NetLog.DebugFormat(System.String,System.Object,System.Object,System.Object)">
- <summary>
- Logs the debug message.
- </summary>
- <param name="format">The format.</param>
- <param name="arg0">The arg0.</param>
- <param name="arg1">The arg1.</param>
- <param name="arg2">The arg2.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.Log4NetLog.Error(System.Object)">
- <summary>
- Logs the error message.
- </summary>
- <param name="message">The message.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.Log4NetLog.Error(System.Object,System.Exception)">
- <summary>
- Logs the error message.
- </summary>
- <param name="message">The message.</param>
- <param name="exception">The exception.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.Log4NetLog.ErrorFormat(System.String,System.Object)">
- <summary>
- Logs the error message.
- </summary>
- <param name="format">The format.</param>
- <param name="arg0">The arg0.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.Log4NetLog.ErrorFormat(System.String,System.Object[])">
- <summary>
- Logs the error message.
- </summary>
- <param name="format">The format.</param>
- <param name="args">The args.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.Log4NetLog.ErrorFormat(System.IFormatProvider,System.String,System.Object[])">
- <summary>
- Logs the error message.
- </summary>
- <param name="provider">The provider.</param>
- <param name="format">The format.</param>
- <param name="args">The args.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.Log4NetLog.ErrorFormat(System.String,System.Object,System.Object)">
- <summary>
- Logs the error message.
- </summary>
- <param name="format">The format.</param>
- <param name="arg0">The arg0.</param>
- <param name="arg1">The arg1.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.Log4NetLog.ErrorFormat(System.String,System.Object,System.Object,System.Object)">
- <summary>
- Logs the error message.
- </summary>
- <param name="format">The format.</param>
- <param name="arg0">The arg0.</param>
- <param name="arg1">The arg1.</param>
- <param name="arg2">The arg2.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.Log4NetLog.Fatal(System.Object)">
- <summary>
- Logs the fatal error message.
- </summary>
- <param name="message">The message.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.Log4NetLog.Fatal(System.Object,System.Exception)">
- <summary>
- Logs the fatal error message.
- </summary>
- <param name="message">The message.</param>
- <param name="exception">The exception.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.Log4NetLog.FatalFormat(System.String,System.Object)">
- <summary>
- Logs the fatal error message.
- </summary>
- <param name="format">The format.</param>
- <param name="arg0">The arg0.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.Log4NetLog.FatalFormat(System.String,System.Object[])">
- <summary>
- Logs the fatal error message.
- </summary>
- <param name="format">The format.</param>
- <param name="args">The args.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.Log4NetLog.FatalFormat(System.IFormatProvider,System.String,System.Object[])">
- <summary>
- Logs the fatal error message.
- </summary>
- <param name="provider">The provider.</param>
- <param name="format">The format.</param>
- <param name="args">The args.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.Log4NetLog.FatalFormat(System.String,System.Object,System.Object)">
- <summary>
- Logs the fatal error message.
- </summary>
- <param name="format">The format.</param>
- <param name="arg0">The arg0.</param>
- <param name="arg1">The arg1.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.Log4NetLog.FatalFormat(System.String,System.Object,System.Object,System.Object)">
- <summary>
- Logs the fatal error message.
- </summary>
- <param name="format">The format.</param>
- <param name="arg0">The arg0.</param>
- <param name="arg1">The arg1.</param>
- <param name="arg2">The arg2.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.Log4NetLog.Info(System.Object)">
- <summary>
- Logs the info message.
- </summary>
- <param name="message">The message.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.Log4NetLog.Info(System.Object,System.Exception)">
- <summary>
- Logs the info message.
- </summary>
- <param name="message">The message.</param>
- <param name="exception">The exception.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.Log4NetLog.InfoFormat(System.String,System.Object)">
- <summary>
- Logs the info message.
- </summary>
- <param name="format">The format.</param>
- <param name="arg0">The arg0.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.Log4NetLog.InfoFormat(System.String,System.Object[])">
- <summary>
- Logs the info message.
- </summary>
- <param name="format">The format.</param>
- <param name="args">The args.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.Log4NetLog.InfoFormat(System.IFormatProvider,System.String,System.Object[])">
- <summary>
- Logs the info message.
- </summary>
- <param name="provider">The provider.</param>
- <param name="format">The format.</param>
- <param name="args">The args.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.Log4NetLog.InfoFormat(System.String,System.Object,System.Object)">
- <summary>
- Logs the info message.
- </summary>
- <param name="format">The format.</param>
- <param name="arg0">The arg0.</param>
- <param name="arg1">The arg1.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.Log4NetLog.InfoFormat(System.String,System.Object,System.Object,System.Object)">
- <summary>
- Logs the info message.
- </summary>
- <param name="format">The format.</param>
- <param name="arg0">The arg0.</param>
- <param name="arg1">The arg1.</param>
- <param name="arg2">The arg2.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.Log4NetLog.Warn(System.Object)">
- <summary>
- Logs the warning message.
- </summary>
- <param name="message">The message.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.Log4NetLog.Warn(System.Object,System.Exception)">
- <summary>
- Logs the warning message.
- </summary>
- <param name="message">The message.</param>
- <param name="exception">The exception.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.Log4NetLog.WarnFormat(System.String,System.Object)">
- <summary>
- Logs the warning message.
- </summary>
- <param name="format">The format.</param>
- <param name="arg0">The arg0.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.Log4NetLog.WarnFormat(System.String,System.Object[])">
- <summary>
- Logs the warning message.
- </summary>
- <param name="format">The format.</param>
- <param name="args">The args.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.Log4NetLog.WarnFormat(System.IFormatProvider,System.String,System.Object[])">
- <summary>
- Logs the warning message.
- </summary>
- <param name="provider">The provider.</param>
- <param name="format">The format.</param>
- <param name="args">The args.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.Log4NetLog.WarnFormat(System.String,System.Object,System.Object)">
- <summary>
- Logs the warning message.
- </summary>
- <param name="format">The format.</param>
- <param name="arg0">The arg0.</param>
- <param name="arg1">The arg1.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.Log4NetLog.WarnFormat(System.String,System.Object,System.Object,System.Object)">
- <summary>
- Logs the warning message.
- </summary>
- <param name="format">The format.</param>
- <param name="arg0">The arg0.</param>
- <param name="arg1">The arg1.</param>
- <param name="arg2">The arg2.</param>
- </member>
- <member name="P:SuperSocket.SocketBase.Logging.Log4NetLog.IsDebugEnabled">
- <summary>
- Gets a value indicating whether this instance is debug enabled.
- </summary>
- <value>
- <c>true</c> if this instance is debug enabled; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.Logging.Log4NetLog.IsErrorEnabled">
- <summary>
- Gets a value indicating whether this instance is error enabled.
- </summary>
- <value>
- <c>true</c> if this instance is error enabled; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.Logging.Log4NetLog.IsFatalEnabled">
- <summary>
- Gets a value indicating whether this instance is fatal enabled.
- </summary>
- <value>
- <c>true</c> if this instance is fatal enabled; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.Logging.Log4NetLog.IsInfoEnabled">
- <summary>
- Gets a value indicating whether this instance is info enabled.
- </summary>
- <value>
- <c>true</c> if this instance is info enabled; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.Logging.Log4NetLog.IsWarnEnabled">
- <summary>
- Gets a value indicating whether this instance is warn enabled.
- </summary>
- <value>
- <c>true</c> if this instance is warn enabled; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="T:SuperSocket.SocketBase.Logging.Log4NetLogFactory">
- <summary>
- Log4NetLogFactory
- </summary>
- </member>
- <member name="T:SuperSocket.SocketBase.Logging.LogFactoryBase">
- <summary>
- LogFactory Base class
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.LogFactoryBase.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Logging.LogFactoryBase"/> class.
- </summary>
- <param name="configFile">The config file.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.LogFactoryBase.GetLog(System.String)">
- <summary>
- Gets the log by name.
- </summary>
- <param name="name">The name.</param>
- <returns></returns>
- </member>
- <member name="P:SuperSocket.SocketBase.Logging.LogFactoryBase.ConfigFile">
- <summary>
- Gets the config file file path.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Logging.LogFactoryBase.IsSharedConfig">
- <summary>
- Gets a value indicating whether the server instance is running in isolation mode and the multiple server instances share the same logging configuration.
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.Log4NetLogFactory.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Logging.Log4NetLogFactory"/> class.
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.Log4NetLogFactory.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Logging.Log4NetLogFactory"/> class.
- </summary>
- <param name="log4netConfig">The log4net config.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Logging.Log4NetLogFactory.GetLog(System.String)">
- <summary>
- Gets the log by name.
- </summary>
- <param name="name">The name.</param>
- <returns></returns>
- </member>
- <member name="T:SuperSocket.SocketBase.Metadata.DefaultAppServerMetadata">
- <summary>
- AppServer's default metadata type
- </summary>
- </member>
- <member name="T:SuperSocket.SocketBase.Metadata.AppServerMetadataTypeAttribute">
- <summary>
- StatusInfoMetadata type attribute
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.Metadata.AppServerMetadataTypeAttribute.#ctor(System.Type)">
- <summary>
- Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Metadata.AppServerMetadataTypeAttribute"/> class.
- </summary>
- <param name="metadataType">Type of the metadata.</param>
- </member>
- <member name="P:SuperSocket.SocketBase.Metadata.AppServerMetadataTypeAttribute.MetadataType">
- <summary>
- Gets the type of the metadata.
- </summary>
- <value>
- The type of the metadata.
- </value>
- </member>
- <member name="T:SuperSocket.SocketBase.NodeStatus">
- <summary>
- The status of one SuperSocket node (one installation or deployment)
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.NodeStatus.Save(System.String)">
- <summary>
- Saves the specified file path.
- </summary>
- <param name="filePath">The file path.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.NodeStatus.LoadFrom(System.String)">
- <summary>
- Loads a NodeStatus instance from a file.
- </summary>
- <param name="filePath">The file path.</param>
- <returns></returns>
- </member>
- <member name="P:SuperSocket.SocketBase.NodeStatus.BootstrapStatus">
- <summary>
- Gets or sets the bootstrap status.
- </summary>
- <value>
- The bootstrap status.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.NodeStatus.InstancesStatus">
- <summary>
- Gets or sets the status of all server instances running in this node.
- </summary>
- <value>
- The instances status.
- </value>
- </member>
- <member name="T:SuperSocket.SocketBase.Protocol.FilterState">
- <summary>
- Filter state enum
- </summary>
- </member>
- <member name="F:SuperSocket.SocketBase.Protocol.FilterState.Normal">
- <summary>
- Normal state
- </summary>
- </member>
- <member name="F:SuperSocket.SocketBase.Protocol.FilterState.Error">
- <summary>
- Error state
- </summary>
- </member>
- <member name="T:SuperSocket.SocketBase.Protocol.IReceiveFilterInitializer">
- <summary>
- Provide the initializing interface for ReceiveFilter
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.Protocol.IReceiveFilterInitializer.Initialize(SuperSocket.SocketBase.IAppServer,SuperSocket.SocketBase.IAppSession)">
- <summary>
- Initializes the ReceiveFilter with the specified appServer and appSession
- </summary>
- <param name="appServer">The app server.</param>
- <param name="session">The session.</param>
- </member>
- <member name="T:SuperSocket.SocketBase.Protocol.IOffsetAdapter">
- <summary>
- The interface for a Receive filter to adapt receiving buffer offset
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Protocol.IOffsetAdapter.OffsetDelta">
- <summary>
- Gets the offset delta.
- </summary>
- </member>
- <member name="T:SuperSocket.SocketBase.Protocol.TerminatorReceiveFilterFactory">
- <summary>
- Terminator ReceiveFilter Factory
- </summary>
- </member>
- <member name="T:SuperSocket.SocketBase.Protocol.IReceiveFilterFactory`1">
- <summary>
- Receive filter factory interface
- </summary>
- <typeparam name="TRequestInfo">The type of the request info.</typeparam>
- </member>
- <member name="T:SuperSocket.SocketBase.Protocol.IReceiveFilterFactory">
- <summary>
- Receive filter factory interface
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.Protocol.IReceiveFilterFactory`1.CreateFilter(SuperSocket.SocketBase.IAppServer,SuperSocket.SocketBase.IAppSession,System.Net.IPEndPoint)">
- <summary>
- Creates the Receive filter.
- </summary>
- <param name="appServer">The app server.</param>
- <param name="appSession">The app session.</param>
- <param name="remoteEndPoint">The remote end point.</param>
- <returns>
- the new created request filer assosiated with this socketSession
- </returns>
- </member>
- <member name="M:SuperSocket.SocketBase.Protocol.TerminatorReceiveFilterFactory.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Protocol.TerminatorReceiveFilterFactory"/> class.
- </summary>
- <param name="terminator">The terminator.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Protocol.TerminatorReceiveFilterFactory.#ctor(System.String,System.Text.Encoding)">
- <summary>
- Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Protocol.TerminatorReceiveFilterFactory"/> class.
- </summary>
- <param name="terminator">The terminator.</param>
- <param name="encoding">The encoding.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Protocol.TerminatorReceiveFilterFactory.#ctor(System.String,System.Text.Encoding,SuperSocket.SocketBase.Protocol.IRequestInfoParser{SuperSocket.SocketBase.Protocol.StringRequestInfo})">
- <summary>
- Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Protocol.TerminatorReceiveFilterFactory"/> class.
- </summary>
- <param name="terminator">The terminator.</param>
- <param name="encoding">The encoding.</param>
- <param name="requestInfoParser">The line parser.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Protocol.TerminatorReceiveFilterFactory.CreateFilter(SuperSocket.SocketBase.IAppServer,SuperSocket.SocketBase.IAppSession,System.Net.IPEndPoint)">
- <summary>
- Creates the Receive filter.
- </summary>
- <param name="appServer">The app server.</param>
- <param name="appSession">The app session.</param>
- <param name="remoteEndPoint">The remote end point.</param>
- <returns>
- the new created request filer assosiated with this socketSession
- </returns>
- </member>
- <member name="T:SuperSocket.SocketBase.Provider.ExportFactory">
- <summary>
- Export Factory
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.Provider.ExportFactory.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Provider.ExportFactory"/> class.
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.Provider.ExportFactory.#ctor(System.Object)">
- <summary>
- Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Provider.ExportFactory"/> class.
- </summary>
- <param name="instance">The instance.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Provider.ExportFactory.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Provider.ExportFactory"/> class.
- </summary>
- <param name="typeName">Name of the type.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Provider.ExportFactory.EnsureInstance">
- <summary>
- Ensures the instance's existance.
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.Provider.ExportFactory.CreateExport``1">
- <summary>
- Creates the export type instance.
- </summary>
- <typeparam name="T"></typeparam>
- <returns></returns>
- </member>
- <member name="M:SuperSocket.SocketBase.Provider.ExportFactory.CreateExport``1(System.Func{System.Type,System.Object})">
- <summary>
- Creates the export type instance from the instance creator.
- </summary>
- <typeparam name="T"></typeparam>
- <param name="creator">The creator.</param>
- <returns></returns>
- </member>
- <member name="P:SuperSocket.SocketBase.Provider.ExportFactory.TypeName">
- <summary>
- Gets or sets the type.
- </summary>
- <value>
- The type.
- </value>
- </member>
- <member name="T:SuperSocket.SocketBase.Provider.ProviderFactoryInfo">
- <summary>
- Provider factory infomation
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.Provider.ProviderFactoryInfo.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Provider.ProviderFactoryInfo"/> class.
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.Provider.ProviderFactoryInfo.#ctor(SuperSocket.SocketBase.Provider.ProviderKey,System.String,System.Object)">
- <summary>
- Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Provider.ProviderFactoryInfo"/> class.
- </summary>
- <param name="key">The key.</param>
- <param name="name">The name.</param>
- <param name="instance">The instance.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Provider.ProviderFactoryInfo.#ctor(SuperSocket.SocketBase.Provider.ProviderKey,System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Provider.ProviderFactoryInfo"/> class.
- </summary>
- <param name="key">The key.</param>
- <param name="name">The name.</param>
- <param name="typeName">Name of the type.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Provider.ProviderFactoryInfo.#ctor(SuperSocket.SocketBase.Provider.ProviderKey,System.String,System.Type)">
- <summary>
- Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Provider.ProviderFactoryInfo"/> class.
- </summary>
- <param name="key">The key.</param>
- <param name="name">The name.</param>
- <param name="type">The type.</param>
- </member>
- <member name="P:SuperSocket.SocketBase.Provider.ProviderFactoryInfo.Key">
- <summary>
- Gets the key.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Provider.ProviderFactoryInfo.Name">
- <summary>
- Gets or sets the name.
- </summary>
- <value>
- The name.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.Provider.ProviderFactoryInfo.ExportFactory">
- <summary>
- Gets or sets the export factory.
- </summary>
- <value>
- The export factory.
- </value>
- </member>
- <member name="T:SuperSocket.SocketBase.Provider.ProviderKey">
- <summary>
- ProviderKey
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Provider.ProviderKey.Name">
- <summary>
- Gets or sets the name.
- </summary>
- <value>
- The name.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.Provider.ProviderKey.Type">
- <summary>
- Gets or sets the type.
- </summary>
- <value>
- The type.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.Provider.ProviderKey.ServerType">
- <summary>
- Gets the service.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Provider.ProviderKey.SocketServerFactory">
- <summary>
- Gets the socket server factory.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Provider.ProviderKey.ConnectionFilter">
- <summary>
- Gets the connection filter.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Provider.ProviderKey.LogFactory">
- <summary>
- Gets the log factory.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Provider.ProviderKey.ReceiveFilterFactory">
- <summary>
- Gets the Receive filter factory.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Provider.ProviderKey.CommandLoader">
- <summary>
- Gets the command loader.
- </summary>
- </member>
- <member name="T:SuperSocket.SocketBase.RequestHandler`2">
- <summary>
- Request handler
- </summary>
- <typeparam name="TAppSession">The type of the app session.</typeparam>
- <typeparam name="TRequestInfo">The type of the request info.</typeparam>
- <param name="session">The session.</param>
- <param name="requestInfo">The request info.</param>
- </member>
- <member name="T:SuperSocket.SocketBase.Config.IListenerConfig">
- <summary>
- The listener configuration interface
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.IListenerConfig.Ip">
- <summary>
- Gets the ip of listener
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.IListenerConfig.Port">
- <summary>
- Gets the port of listener
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.IListenerConfig.Backlog">
- <summary>
- Gets the backlog.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.IListenerConfig.Security">
- <summary>
- Gets the security option, None/Default/Tls/Ssl/...
- </summary>
- </member>
- <member name="T:SuperSocket.SocketBase.Config.ListenerConfig">
- <summary>
- Listener configuration model
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.Config.ListenerConfig.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Config.ListenerConfig"/> class.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.ListenerConfig.Ip">
- <summary>
- Gets the ip of listener
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.ListenerConfig.Port">
- <summary>
- Gets the port of listener
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.ListenerConfig.Backlog">
- <summary>
- Gets the backlog.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.ListenerConfig.Security">
- <summary>
- Gets/sets the security option, None/Default/Tls/Ssl/...
- </summary>
- </member>
- <member name="T:SuperSocket.SocketBase.ListenerInfo">
- <summary>
- Listener inforamtion
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.ListenerInfo.EndPoint">
- <summary>
- Gets or sets the listen endpoint.
- </summary>
- <value>
- The end point.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.ListenerInfo.BackLog">
- <summary>
- Gets or sets the listen backlog.
- </summary>
- <value>
- The back log.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.ListenerInfo.Security">
- <summary>
- Gets or sets the security protocol.
- </summary>
- <value>
- The security.
- </value>
- </member>
- <member name="T:SuperSocket.SocketBase.Protocol.BinaryRequestInfo">
- <summary>
- Binary type request information
- </summary>
- </member>
- <member name="T:SuperSocket.SocketBase.Protocol.RequestInfo`1">
- <summary>
- RequestInfo basic class
- </summary>
- <typeparam name="TRequestBody">The type of the request body.</typeparam>
- </member>
- <member name="T:SuperSocket.SocketBase.Protocol.IRequestInfo`1">
- <summary>
- Request information interface
- </summary>
- <typeparam name="TRequestBody">The type of the request body.</typeparam>
- </member>
- <member name="T:SuperSocket.SocketBase.Protocol.IRequestInfo">
- <summary>
- Request information interface
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Protocol.IRequestInfo.Key">
- <summary>
- Gets the key of this request.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Protocol.IRequestInfo`1.Body">
- <summary>
- Gets the body of this request.
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.Protocol.RequestInfo`1.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Protocol.RequestInfo`1"/> class.
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.Protocol.RequestInfo`1.#ctor(System.String,`0)">
- <summary>
- Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Protocol.RequestInfo`1"/> class.
- </summary>
- <param name="key">The key.</param>
- <param name="body">The body.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Protocol.RequestInfo`1.Initialize(System.String,`0)">
- <summary>
- Initializes the specified key.
- </summary>
- <param name="key">The key.</param>
- <param name="body">The body.</param>
- </member>
- <member name="P:SuperSocket.SocketBase.Protocol.RequestInfo`1.Key">
- <summary>
- Gets the key of this request.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Protocol.RequestInfo`1.Body">
- <summary>
- Gets the body.
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.Protocol.BinaryRequestInfo.#ctor(System.String,System.Byte[])">
- <summary>
- Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Protocol.BinaryRequestInfo"/> class.
- </summary>
- <param name="key">The key.</param>
- <param name="body">The body.</param>
- </member>
- <member name="T:SuperSocket.SocketBase.Command.CommandBase`2">
- <summary>
- Command base class
- </summary>
- <typeparam name="TAppSession">The type of the app session.</typeparam>
- <typeparam name="TRequestInfo">The type of the request info.</typeparam>
- </member>
- <member name="T:SuperSocket.SocketBase.Command.ICommand`2">
- <summary>
- Command basic interface
- </summary>
- <typeparam name="TAppSession">The type of the app session.</typeparam>
- <typeparam name="TRequestInfo">The type of the request info.</typeparam>
- </member>
- <member name="T:SuperSocket.SocketBase.Command.ICommand">
- <summary>
- Command basic interface
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Command.ICommand.Name">
- <summary>
- Gets the name.
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.Command.ICommand`2.ExecuteCommand(`0,`1)">
- <summary>
- Executes the command.
- </summary>
- <param name="session">The session.</param>
- <param name="requestInfo">The request info.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Command.CommandBase`2.ExecuteCommand(`0,`1)">
- <summary>
- Executes the command.
- </summary>
- <param name="session">The session.</param>
- <param name="requestInfo">The request info.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Command.CommandBase`2.ToString">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="P:SuperSocket.SocketBase.Command.CommandBase`2.Name">
- <summary>
- Gets the name.
- </summary>
- </member>
- <member name="T:SuperSocket.SocketBase.Command.CommandUpdateAction">
- <summary>
- Command update action enum
- </summary>
- </member>
- <member name="F:SuperSocket.SocketBase.Command.CommandUpdateAction.Add">
- <summary>
- Add command
- </summary>
- </member>
- <member name="F:SuperSocket.SocketBase.Command.CommandUpdateAction.Remove">
- <summary>
- Remove command
- </summary>
- </member>
- <member name="F:SuperSocket.SocketBase.Command.CommandUpdateAction.Update">
- <summary>
- Update command
- </summary>
- </member>
- <member name="T:SuperSocket.SocketBase.Command.CommandUpdateInfo`1">
- <summary>
- Command update information
- </summary>
- <typeparam name="T"></typeparam>
- </member>
- <member name="P:SuperSocket.SocketBase.Command.CommandUpdateInfo`1.UpdateAction">
- <summary>
- Gets or sets the update action.
- </summary>
- <value>
- The update action.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.Command.CommandUpdateInfo`1.Command">
- <summary>
- Gets or sets the target command.
- </summary>
- <value>
- The command.
- </value>
- </member>
- <member name="T:SuperSocket.SocketBase.Command.MockupCommand`2">
- <summary>
- Mockup command
- </summary>
- <typeparam name="TAppSession">The type of the app session.</typeparam>
- <typeparam name="TRequestInfo">The type of the request info.</typeparam>
- </member>
- <member name="M:SuperSocket.SocketBase.Command.MockupCommand`2.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Command.MockupCommand`2"/> class.
- </summary>
- <param name="name">The name.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Command.MockupCommand`2.ExecuteCommand(`0,`1)">
- <summary>
- Executes the command.
- </summary>
- <param name="session">The session.</param>
- <param name="requestInfo">The request info.</param>
- </member>
- <member name="P:SuperSocket.SocketBase.Command.MockupCommand`2.Name">
- <summary>
- Gets the name.
- </summary>
- </member>
- <member name="T:SuperSocket.SocketBase.Protocol.CommandLineReceiveFilterFactory">
- <summary>
- CommandLine RequestFilter Factory
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.Protocol.CommandLineReceiveFilterFactory.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Protocol.CommandLineReceiveFilterFactory"/> class.
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.Protocol.CommandLineReceiveFilterFactory.#ctor(System.Text.Encoding)">
- <summary>
- Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Protocol.CommandLineReceiveFilterFactory"/> class.
- </summary>
- <param name="encoding">The encoding.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Protocol.CommandLineReceiveFilterFactory.#ctor(System.Text.Encoding,SuperSocket.SocketBase.Protocol.IRequestInfoParser{SuperSocket.SocketBase.Protocol.StringRequestInfo})">
- <summary>
- Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Protocol.CommandLineReceiveFilterFactory"/> class.
- </summary>
- <param name="encoding">The encoding.</param>
- <param name="requestInfoParser">The request info parser.</param>
- </member>
- <member name="T:SuperSocket.SocketBase.Protocol.DefaultReceiveFilterFactory`2">
- <summary>
- DefaultreceiveFilterFactory
- </summary>
- <typeparam name="TReceiveFilter">The type of the Receive filter.</typeparam>
- <typeparam name="TRequestInfo">The type of the request info.</typeparam>
- </member>
- <member name="M:SuperSocket.SocketBase.Protocol.DefaultReceiveFilterFactory`2.CreateFilter(SuperSocket.SocketBase.IAppServer,SuperSocket.SocketBase.IAppSession,System.Net.IPEndPoint)">
- <summary>
- Creates the Receive filter.
- </summary>
- <param name="appServer">The app server.</param>
- <param name="appSession">The app session.</param>
- <param name="remoteEndPoint">The remote end point.</param>
- <returns>
- the new created request filer assosiated with this socketSession
- </returns>
- </member>
- <member name="T:SuperSocket.SocketBase.Protocol.IRequestInfo`2">
- <summary>
- Request information interface
- </summary>
- <typeparam name="TRequestHeader">The type of the request header.</typeparam>
- <typeparam name="TRequestBody">The type of the request body.</typeparam>
- </member>
- <member name="P:SuperSocket.SocketBase.Protocol.IRequestInfo`2.Header">
- <summary>
- Gets the header of the request.
- </summary>
- </member>
- <member name="T:SuperSocket.SocketBase.Protocol.ReceiveFilterBase`1">
- <summary>
- Receive filter base class
- </summary>
- <typeparam name="TRequestInfo">The type of the request info.</typeparam>
- </member>
- <member name="T:SuperSocket.SocketBase.Protocol.IReceiveFilter`1">
- <summary>
- Receive filter interface
- </summary>
- <typeparam name="TRequestInfo">The type of the request info.</typeparam>
- </member>
- <member name="M:SuperSocket.SocketBase.Protocol.IReceiveFilter`1.Filter(System.Byte[],System.Int32,System.Int32,System.Boolean,System.Int32@)">
- <summary>
- Filters received data of the specific session into request info.
- </summary>
- <param name="readBuffer">The read buffer.</param>
- <param name="offset">The offset of the current received data in this read buffer.</param>
- <param name="length">The length of the current received data.</param>
- <param name="toBeCopied">if set to <c>true</c> [to be copied].</param>
- <param name="rest">The rest, the length of the data which hasn't been parsed.</param>
- <returns></returns>
- </member>
- <member name="M:SuperSocket.SocketBase.Protocol.IReceiveFilter`1.Reset">
- <summary>
- Resets this instance to initial state.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Protocol.IReceiveFilter`1.LeftBufferSize">
- <summary>
- Gets the size of the rest buffer.
- </summary>
- <value>
- The size of the rest buffer.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.Protocol.IReceiveFilter`1.NextReceiveFilter">
- <summary>
- Gets the next Receive filter.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Protocol.IReceiveFilter`1.State">
- <summary>
- Gets the filter state.
- </summary>
- <value>
- The filter state.
- </value>
- </member>
- <member name="M:SuperSocket.SocketBase.Protocol.ReceiveFilterBase`1.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Protocol.ReceiveFilterBase`1"/> class.
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.Protocol.ReceiveFilterBase`1.#ctor(SuperSocket.SocketBase.Protocol.ReceiveFilterBase{`0})">
- <summary>
- Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Protocol.ReceiveFilterBase`1"/> class.
- </summary>
- <param name="previousRequestFilter">The previous Receive filter.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Protocol.ReceiveFilterBase`1.Initialize(SuperSocket.SocketBase.Protocol.ReceiveFilterBase{`0})">
- <summary>
- Initializes the specified previous Receive filter.
- </summary>
- <param name="previousRequestFilter">The previous Receive filter.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Protocol.ReceiveFilterBase`1.Filter(System.Byte[],System.Int32,System.Int32,System.Boolean,System.Int32@)">
- <summary>
- Filters received data of the specific session into request info.
- </summary>
- <param name="readBuffer">The read buffer.</param>
- <param name="offset">The offset of the current received data in this read buffer.</param>
- <param name="length">The length of the current received data.</param>
- <param name="toBeCopied">if set to <c>true</c> [to be copied].</param>
- <param name="rest">The rest, the length of the data which hasn't been parsed.</param>
- <returns></returns>
- </member>
- <member name="M:SuperSocket.SocketBase.Protocol.ReceiveFilterBase`1.AddArraySegment(System.Byte[],System.Int32,System.Int32,System.Boolean)">
- <summary>
- Adds the array segment.
- </summary>
- <param name="buffer">The buffer.</param>
- <param name="offset">The offset.</param>
- <param name="length">The length.</param>
- <param name="toBeCopied">if set to <c>true</c> [to be copied].</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Protocol.ReceiveFilterBase`1.ClearBufferSegments">
- <summary>
- Clears the buffer segments.
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.Protocol.ReceiveFilterBase`1.Reset">
- <summary>
- Resets this instance to initial state.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Protocol.ReceiveFilterBase`1.BufferSegments">
- <summary>
- Gets the buffer segments which can help you parse your request info conviniently.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Protocol.ReceiveFilterBase`1.LeftBufferSize">
- <summary>
- Gets the size of the rest buffer.
- </summary>
- <value>
- The size of the rest buffer.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.Protocol.ReceiveFilterBase`1.NextReceiveFilter">
- <summary>
- Gets or sets the next Receive filter.
- </summary>
- <value>
- The next Receive filter.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.Protocol.ReceiveFilterBase`1.State">
- <summary>
- Gets the filter state.
- </summary>
- <value>
- The state.
- </value>
- </member>
- <member name="T:SuperSocket.SocketBase.Protocol.RequestInfo`2">
- <summary>
- RequestInfo with header
- </summary>
- <typeparam name="TRequestHeader">The type of the request header.</typeparam>
- <typeparam name="TRequestBody">The type of the request body.</typeparam>
- </member>
- <member name="M:SuperSocket.SocketBase.Protocol.RequestInfo`2.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Protocol.RequestInfo`2"/> class.
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.Protocol.RequestInfo`2.#ctor(System.String,`0,`1)">
- <summary>
- Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Protocol.RequestInfo`2"/> class.
- </summary>
- <param name="key">The key.</param>
- <param name="header">The header.</param>
- <param name="body">The body.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Protocol.RequestInfo`2.Initialize(System.String,`0,`1)">
- <summary>
- Initializes the specified key.
- </summary>
- <param name="key">The key.</param>
- <param name="header">The header.</param>
- <param name="body">The body.</param>
- </member>
- <member name="P:SuperSocket.SocketBase.Protocol.RequestInfo`2.Header">
- <summary>
- Gets the header.
- </summary>
- </member>
- <member name="T:SuperSocket.SocketBase.Protocol.StringRequestInfo">
- <summary>
- String type request information
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.Protocol.StringRequestInfo.#ctor(System.String,System.String,System.String[])">
- <summary>
- Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Protocol.StringRequestInfo"/> class.
- </summary>
- <param name="key">The key.</param>
- <param name="body">The body.</param>
- <param name="parameters">The parameters.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Protocol.StringRequestInfo.GetFirstParam">
- <summary>
- Gets the first param.
- </summary>
- <returns></returns>
- </member>
- <member name="P:SuperSocket.SocketBase.Protocol.StringRequestInfo.Parameters">
- <summary>
- Gets the parameters.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Protocol.StringRequestInfo.Item(System.Int32)">
- <summary>
- Gets the <see cref="T:System.String"/> at the specified index.
- </summary>
- </member>
- <member name="T:SuperSocket.SocketBase.Command.ReflectCommandLoader`1">
- <summary>
- A command loader which loads commands from assembly by reflection
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.Command.ReflectCommandLoader`1.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Command.ReflectCommandLoader`1"/> class.
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.Command.ReflectCommandLoader`1.Initialize(SuperSocket.SocketBase.Config.IRootConfig,SuperSocket.SocketBase.IAppServer)">
- <summary>
- Initializes the command loader by the root config and the server instance.
- </summary>
- <param name="rootConfig">The root config.</param>
- <param name="appServer">The app server.</param>
- <returns></returns>
- </member>
- <member name="M:SuperSocket.SocketBase.Command.ReflectCommandLoader`1.TryLoadCommands(System.Collections.Generic.IEnumerable{`0}@)">
- <summary>
- Tries to load commands.
- </summary>
- <param name="commands">The commands.</param>
- <returns></returns>
- </member>
- <member name="T:SuperSocket.SocketBase.Protocol.TerminatorReceiveFilter`1">
- <summary>
- Terminator Receive filter
- </summary>
- <typeparam name="TRequestInfo">The type of the request info.</typeparam>
- </member>
- <member name="F:SuperSocket.SocketBase.Protocol.TerminatorReceiveFilter`1.NullRequestInfo">
- <summary>
- Null RequestInfo
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.Protocol.TerminatorReceiveFilter`1.#ctor(System.Byte[])">
- <summary>
- Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Protocol.TerminatorReceiveFilter`1"/> class.
- </summary>
- <param name="terminator">The terminator.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Protocol.TerminatorReceiveFilter`1.Filter(System.Byte[],System.Int32,System.Int32,System.Boolean,System.Int32@)">
- <summary>
- Filters received data of the specific session into request info.
- </summary>
- <param name="readBuffer">The read buffer.</param>
- <param name="offset">The offset of the current received data in this read buffer.</param>
- <param name="length">The length of the current received data.</param>
- <param name="toBeCopied">if set to <c>true</c> [to be copied].</param>
- <param name="rest">The rest, the length of the data which hasn't been parsed.</param>
- <returns>return the parsed TRequestInfo</returns>
- </member>
- <member name="M:SuperSocket.SocketBase.Protocol.TerminatorReceiveFilter`1.Reset">
- <summary>
- Resets this instance.
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.Protocol.TerminatorReceiveFilter`1.ProcessMatchedRequest(System.Byte[],System.Int32,System.Int32)">
- <summary>
- Resolves the specified data to TRequestInfo.
- </summary>
- <param name="data">The data.</param>
- <param name="offset">The offset.</param>
- <param name="length">The length.</param>
- <returns></returns>
- </member>
- <member name="P:SuperSocket.SocketBase.Protocol.TerminatorReceiveFilter`1.Session">
- <summary>
- Gets the session assosiated with the Receive filter.
- </summary>
- </member>
- <member name="T:SuperSocket.SocketBase.Protocol.TerminatorReceiveFilter">
- <summary>
- TerminatorRequestFilter
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.Protocol.TerminatorReceiveFilter.#ctor(System.Byte[],System.Text.Encoding)">
- <summary>
- Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Protocol.TerminatorReceiveFilter"/> class.
- </summary>
- <param name="terminator">The terminator.</param>
- <param name="encoding">The encoding.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Protocol.TerminatorReceiveFilter.#ctor(System.Byte[],System.Text.Encoding,SuperSocket.SocketBase.Protocol.IRequestInfoParser{SuperSocket.SocketBase.Protocol.StringRequestInfo})">
- <summary>
- Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Protocol.TerminatorReceiveFilter"/> class.
- </summary>
- <param name="terminator">The terminator.</param>
- <param name="encoding">The encoding.</param>
- <param name="requestParser">The request parser.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Protocol.TerminatorReceiveFilter.ProcessMatchedRequest(System.Byte[],System.Int32,System.Int32)">
- <summary>
- Resolves the specified data to StringRequestInfo.
- </summary>
- <param name="data">The data.</param>
- <param name="offset">The offset.</param>
- <param name="length">The length.</param>
- <returns></returns>
- </member>
- <member name="T:SuperSocket.SocketBase.Protocol.UdpRequestInfo">
- <summary>
- UdpRequestInfo, it is designed for passing in business session ID to udp request info
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.Protocol.UdpRequestInfo.#ctor(System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Protocol.UdpRequestInfo"/> class.
- </summary>
- <param name="key">The key.</param>
- <param name="sessionID">The session ID.</param>
- </member>
- <member name="P:SuperSocket.SocketBase.Protocol.UdpRequestInfo.Key">
- <summary>
- Gets the key of this request.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Protocol.UdpRequestInfo.SessionID">
- <summary>
- Gets the session ID.
- </summary>
- </member>
- <member name="T:SuperSocket.SocketBase.Config.CertificateConfig">
- <summary>
- Certificate config model class
- </summary>
- </member>
- <member name="T:SuperSocket.SocketBase.Config.ICertificateConfig">
- <summary>
- Certificate configuration interface
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.ICertificateConfig.FilePath">
- <summary>
- Gets the file path.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.ICertificateConfig.Password">
- <summary>
- Gets the password.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.ICertificateConfig.StoreName">
- <summary>
- Gets the the store where certificate locates.
- </summary>
- <value>
- The name of the store.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.ICertificateConfig.Thumbprint">
- <summary>
- Gets the thumbprint.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.ICertificateConfig.StoreLocation">
- <summary>
- Gets the store location of the certificate.
- </summary>
- <value>
- The store location.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.ICertificateConfig.ClientCertificateRequired">
- <summary>
- Gets a value indicating whether [client certificate required].
- </summary>
- <value>
- <c>true</c> if [client certificate required]; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.ICertificateConfig.KeyStorageFlags">
- <summary>
- Gets a value that will be used to instantiate the X509Certificate2 object in the CertificateManager
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.CertificateConfig.FilePath">
- <summary>
- Gets/sets the file path.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.CertificateConfig.Password">
- <summary>
- Gets/sets the password.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.CertificateConfig.StoreName">
- <summary>
- Gets/sets the the store where certificate locates.
- </summary>
- <value>
- The name of the store.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.CertificateConfig.StoreLocation">
- <summary>
- Gets/sets the store location of the certificate.
- </summary>
- <value>
- The store location.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.CertificateConfig.Thumbprint">
- <summary>
- Gets/sets the thumbprint.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.CertificateConfig.ClientCertificateRequired">
- <summary>
- Gets/sets a value indicating whether [client certificate required].
- </summary>
- <value>
- <c>true</c> if [client certificate required]; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.CertificateConfig.KeyStorageFlags">
- <summary>
- Gets/sets a value that will be used to instantiate the X509Certificate2 object in the CertificateManager
- </summary>
- </member>
- <member name="T:SuperSocket.SocketBase.Config.IServerConfig">
- <summary>
- Server instance configuation interface
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.Config.IServerConfig.GetChildConfig``1(System.String)">
- <summary>
- Gets the child config.
- </summary>
- <typeparam name="TConfig">The type of the config.</typeparam>
- <param name="childConfigName">Name of the child config.</param>
- <returns></returns>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.IServerConfig.ServerTypeName">
- <summary>
- Gets the name of the server type this appServer want to use.
- </summary>
- <value>
- The name of the server type.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.IServerConfig.ServerType">
- <summary>
- Gets the type definition of the appserver.
- </summary>
- <value>
- The type of the server.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.IServerConfig.ReceiveFilterFactory">
- <summary>
- Gets the Receive filter factory.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.IServerConfig.Ip">
- <summary>
- Gets the ip.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.IServerConfig.Port">
- <summary>
- Gets the port.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.IServerConfig.Options">
- <summary>
- Gets the options.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.IServerConfig.OptionElements">
- <summary>
- Gets the option elements.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.IServerConfig.Disabled">
- <summary>
- Gets a value indicating whether this <see cref="T:SuperSocket.SocketBase.Config.IServerConfig"/> is disabled.
- </summary>
- <value>
- <c>true</c> if disabled; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.IServerConfig.Name">
- <summary>
- Gets the name.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.IServerConfig.Mode">
- <summary>
- Gets the mode.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.IServerConfig.SendTimeOut">
- <summary>
- Gets the send time out.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.IServerConfig.MaxConnectionNumber">
- <summary>
- Gets the max connection number.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.IServerConfig.ReceiveBufferSize">
- <summary>
- Gets the size of the receive buffer.
- </summary>
- <value>
- The size of the receive buffer.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.IServerConfig.SendBufferSize">
- <summary>
- Gets the size of the send buffer.
- </summary>
- <value>
- The size of the send buffer.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.IServerConfig.SyncSend">
- <summary>
- Gets a value indicating whether sending is in synchronous mode.
- </summary>
- <value>
- <c>true</c> if [sync send]; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.IServerConfig.LogCommand">
- <summary>
- Gets a value indicating whether log command in log file.
- </summary>
- <value><c>true</c> if log command; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.IServerConfig.ClearIdleSession">
- <summary>
- Gets a value indicating whether clear idle session.
- </summary>
- <value><c>true</c> if clear idle session; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.IServerConfig.ClearIdleSessionInterval">
- <summary>
- Gets the clear idle session interval, in seconds.
- </summary>
- <value>The clear idle session interval.</value>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.IServerConfig.IdleSessionTimeOut">
- <summary>
- Gets the idle session timeout time length, in seconds.
- </summary>
- <value>The idle session time out.</value>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.IServerConfig.Certificate">
- <summary>
- Gets X509Certificate configuration.
- </summary>
- <value>X509Certificate configuration.</value>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.IServerConfig.Security">
- <summary>
- Gets the security protocol, X509 certificate.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.IServerConfig.MaxRequestLength">
- <summary>
- Gets the length of the max request.
- </summary>
- <value>
- The length of the max request.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.IServerConfig.DisableSessionSnapshot">
- <summary>
- Gets a value indicating whether [disable session snapshot].
- </summary>
- <value>
- <c>true</c> if [disable session snapshot]; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.IServerConfig.SessionSnapshotInterval">
- <summary>
- Gets the interval to taking snapshot for all live sessions.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.IServerConfig.ConnectionFilter">
- <summary>
- Gets the connection filters used by this server instance.
- </summary>
- <value>
- The connection filter's name list, seperated by comma
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.IServerConfig.CommandLoader">
- <summary>
- Gets the command loader, multiple values should be separated by comma.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.IServerConfig.KeepAliveTime">
- <summary>
- Gets the start keep alive time, in seconds
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.IServerConfig.KeepAliveInterval">
- <summary>
- Gets the keep alive interval, in seconds.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.IServerConfig.ListenBacklog">
- <summary>
- Gets the backlog size of socket listening.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.IServerConfig.StartupOrder">
- <summary>
- Gets the startup order of the server instance.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.IServerConfig.Listeners">
- <summary>
- Gets the listeners' configuration.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.IServerConfig.LogFactory">
- <summary>
- Gets the log factory name.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.IServerConfig.SendingQueueSize">
- <summary>
- Gets the size of the sending queue.
- </summary>
- <value>
- The size of the sending queue.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.IServerConfig.LogBasicSessionActivity">
- <summary>
- Gets a value indicating whether [log basic session activity like connected and disconnected].
- </summary>
- <value>
- <c>true</c> if [log basic session activity]; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.IServerConfig.LogAllSocketException">
- <summary>
- Gets a value indicating whether [log all socket exception].
- </summary>
- <value>
- <c>true</c> if [log all socket exception]; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.IServerConfig.TextEncoding">
- <summary>
- Gets the default text encoding.
- </summary>
- <value>
- The text encoding.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.IServerConfig.CommandAssemblies">
- <summary>
- Gets the command assemblies configuration.
- </summary>
- <value>
- The command assemblies.
- </value>
- </member>
- <member name="T:SuperSocket.SocketBase.Config.ServerConfig">
- <summary>
- Server configruation model
- </summary>
- </member>
- <member name="F:SuperSocket.SocketBase.Config.ServerConfig.DefaultReceiveBufferSize">
- <summary>
- Default ReceiveBufferSize
- </summary>
- </member>
- <member name="F:SuperSocket.SocketBase.Config.ServerConfig.DefaultMaxConnectionNumber">
- <summary>
- Default MaxConnectionNumber
- </summary>
- </member>
- <member name="F:SuperSocket.SocketBase.Config.ServerConfig.DefaultSendingQueueSize">
- <summary>
- Default sending queue size
- </summary>
- </member>
- <member name="F:SuperSocket.SocketBase.Config.ServerConfig.DefaultMaxRequestLength">
- <summary>
- Default MaxRequestLength
- </summary>
- </member>
- <member name="F:SuperSocket.SocketBase.Config.ServerConfig.DefaultSendTimeout">
- <summary>
- Default send timeout value, in milliseconds
- </summary>
- </member>
- <member name="F:SuperSocket.SocketBase.Config.ServerConfig.DefaultClearIdleSessionInterval">
- <summary>
- Default clear idle session interval
- </summary>
- </member>
- <member name="F:SuperSocket.SocketBase.Config.ServerConfig.DefaultIdleSessionTimeOut">
- <summary>
- Default idle session timeout
- </summary>
- </member>
- <member name="F:SuperSocket.SocketBase.Config.ServerConfig.DefaultSendBufferSize">
- <summary>
- The default send buffer size
- </summary>
- </member>
- <member name="F:SuperSocket.SocketBase.Config.ServerConfig.DefaultSessionSnapshotInterval">
- <summary>
- The default session snapshot interval
- </summary>
- </member>
- <member name="F:SuperSocket.SocketBase.Config.ServerConfig.DefaultKeepAliveTime">
- <summary>
- The default keep alive time
- </summary>
- </member>
- <member name="F:SuperSocket.SocketBase.Config.ServerConfig.DefaultKeepAliveInterval">
- <summary>
- The default keep alive interval
- </summary>
- </member>
- <member name="F:SuperSocket.SocketBase.Config.ServerConfig.DefaultListenBacklog">
- <summary>
- The default listen backlog
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.Config.ServerConfig.#ctor(SuperSocket.SocketBase.Config.IServerConfig)">
- <summary>
- Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Config.ServerConfig"/> class.
- </summary>
- <param name="serverConfig">The server config.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Config.ServerConfig.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Config.ServerConfig"/> class.
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.Config.ServerConfig.GetChildConfig``1(System.String)">
- <summary>
- Gets the child config.
- </summary>
- <typeparam name="TConfig">The type of the config.</typeparam>
- <param name="childConfigName">Name of the child config.</param>
- <returns></returns>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.ServerConfig.ServerTypeName">
- <summary>
- Gets/sets the name of the server type of this appServer want to use.
- </summary>
- <value>
- The name of the server type.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.ServerConfig.ServerType">
- <summary>
- Gets/sets the type definition of the appserver.
- </summary>
- <value>
- The type of the server.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.ServerConfig.ReceiveFilterFactory">
- <summary>
- Gets/sets the Receive filter factory.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.ServerConfig.Ip">
- <summary>
- Gets/sets the ip.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.ServerConfig.Port">
- <summary>
- Gets/sets the port.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.ServerConfig.Options">
- <summary>
- Gets/sets the options.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.ServerConfig.OptionElements">
- <summary>
- Gets the option elements.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.ServerConfig.Disabled">
- <summary>
- Gets/sets a value indicating whether this <see cref="T:SuperSocket.SocketBase.Config.IServerConfig"/> is disabled.
- </summary>
- <value>
- <c>true</c> if disabled; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.ServerConfig.Name">
- <summary>
- Gets the name.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.ServerConfig.Mode">
- <summary>
- Gets/sets the mode.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.ServerConfig.SendTimeOut">
- <summary>
- Gets/sets the send time out.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.ServerConfig.MaxConnectionNumber">
- <summary>
- Gets the max connection number.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.ServerConfig.ReceiveBufferSize">
- <summary>
- Gets the size of the receive buffer.
- </summary>
- <value>
- The size of the receive buffer.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.ServerConfig.SendBufferSize">
- <summary>
- Gets the size of the send buffer.
- </summary>
- <value>
- The size of the send buffer.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.ServerConfig.SyncSend">
- <summary>
- Gets a value indicating whether sending is in synchronous mode.
- </summary>
- <value>
- <c>true</c> if [sync send]; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.ServerConfig.LogCommand">
- <summary>
- Gets/sets a value indicating whether log command in log file.
- </summary>
- <value>
- <c>true</c> if log command; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.ServerConfig.ClearIdleSession">
- <summary>
- Gets/sets a value indicating whether clear idle session.
- </summary>
- <value>
- <c>true</c> if clear idle session; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.ServerConfig.ClearIdleSessionInterval">
- <summary>
- Gets/sets the clear idle session interval, in seconds.
- </summary>
- <value>
- The clear idle session interval.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.ServerConfig.IdleSessionTimeOut">
- <summary>
- Gets/sets the idle session timeout time length, in seconds.
- </summary>
- <value>
- The idle session time out.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.ServerConfig.Certificate">
- <summary>
- Gets/sets X509Certificate configuration.
- </summary>
- <value>
- X509Certificate configuration.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.ServerConfig.Security">
- <summary>
- Gets/sets the security protocol, X509 certificate.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.ServerConfig.MaxRequestLength">
- <summary>
- Gets/sets the length of the max request.
- </summary>
- <value>
- The length of the max request.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.ServerConfig.DisableSessionSnapshot">
- <summary>
- Gets/sets a value indicating whether [disable session snapshot].
- </summary>
- <value>
- <c>true</c> if [disable session snapshot]; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.ServerConfig.SessionSnapshotInterval">
- <summary>
- Gets/sets the interval to taking snapshot for all live sessions.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.ServerConfig.ConnectionFilter">
- <summary>
- Gets/sets the connection filters used by this server instance.
- </summary>
- <value>
- The connection filter's name list, seperated by comma
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.ServerConfig.CommandLoader">
- <summary>
- Gets the command loader, multiple values should be separated by comma.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.ServerConfig.KeepAliveTime">
- <summary>
- Gets/sets the start keep alive time, in seconds
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.ServerConfig.KeepAliveInterval">
- <summary>
- Gets/sets the keep alive interval, in seconds.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.ServerConfig.ListenBacklog">
- <summary>
- Gets the backlog size of socket listening.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.ServerConfig.StartupOrder">
- <summary>
- Gets/sets the startup order of the server instance.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.ServerConfig.Listeners">
- <summary>
- Gets and sets the listeners' configuration.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.ServerConfig.LogFactory">
- <summary>
- Gets/sets the log factory name.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.ServerConfig.SendingQueueSize">
- <summary>
- Gets/sets the size of the sending queue.
- </summary>
- <value>
- The size of the sending queue.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.ServerConfig.LogBasicSessionActivity">
- <summary>
- Gets a value indicating whether [log basic session activity like connected and disconnected].
- </summary>
- <value>
- <c>true</c> if [log basic session activity]; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.ServerConfig.LogAllSocketException">
- <summary>
- Gets/sets a value indicating whether [log all socket exception].
- </summary>
- <value>
- <c>true</c> if [log all socket exception]; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.ServerConfig.TextEncoding">
- <summary>
- Gets/sets the default text encoding.
- </summary>
- <value>
- The text encoding.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.Config.ServerConfig.CommandAssemblies">
- <summary>
- Gets the command assemblies configuration.
- </summary>
- <value>
- The command assemblies.
- </value>
- </member>
- <member name="T:SuperSocket.SocketBase.IAppSession">
- <summary>
- The basic interface for appSession
- </summary>
- </member>
- <member name="T:SuperSocket.SocketBase.ISessionBase">
- <summary>
- The basic session interface
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.ISessionBase.SessionID">
- <summary>
- Gets the session ID.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.ISessionBase.RemoteEndPoint">
- <summary>
- Gets the remote endpoint.
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.IAppSession.Close">
- <summary>
- Closes this session.
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.IAppSession.Close(SuperSocket.SocketBase.CloseReason)">
- <summary>
- Closes the session by the specified reason.
- </summary>
- <param name="reason">The close reason.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.IAppSession.ProcessRequest(System.Byte[],System.Int32,System.Int32,System.Boolean)">
- <summary>
- Processes the request.
- </summary>
- <param name="readBuffer">The read buffer.</param>
- <param name="offset">The offset.</param>
- <param name="length">The length.</param>
- <param name="toBeCopied">if set to <c>true</c> [to be copied].</param>
- <returns>return offset delta of next receiving buffer</returns>
- </member>
- <member name="M:SuperSocket.SocketBase.IAppSession.StartSession">
- <summary>
- Starts the session.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.IAppSession.AppServer">
- <summary>
- Gets the app server.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.IAppSession.SocketSession">
- <summary>
- Gets the socket session of the AppSession.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.IAppSession.Items">
- <summary>
- Gets the items.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.IAppSession.Config">
- <summary>
- Gets the config of the server.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.IAppSession.LocalEndPoint">
- <summary>
- Gets the local listening endpoint.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.IAppSession.LastActiveTime">
- <summary>
- Gets or sets the last active time of the session.
- </summary>
- <value>
- The last active time.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.IAppSession.StartTime">
- <summary>
- Gets the start time of the session.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.IAppSession.Connected">
- <summary>
- Gets a value indicating whether this <see cref="T:SuperSocket.SocketBase.IAppSession"/> is connected.
- </summary>
- <value>
- <c>true</c> if connected; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.IAppSession.Charset">
- <summary>
- Gets or sets the charset which is used for transfering text message.
- </summary>
- <value>The charset.</value>
- </member>
- <member name="P:SuperSocket.SocketBase.IAppSession.PrevCommand">
- <summary>
- Gets or sets the previous command.
- </summary>
- <value>
- The prev command.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.IAppSession.CurrentCommand">
- <summary>
- Gets or sets the current executing command.
- </summary>
- <value>
- The current command.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.IAppSession.Logger">
- <summary>
- Gets the logger assosiated with this session.
- </summary>
- </member>
- <member name="T:SuperSocket.SocketBase.IAppSession`2">
- <summary>
- The interface for appSession
- </summary>
- <typeparam name="TAppSession">The type of the app session.</typeparam>
- <typeparam name="TRequestInfo">The type of the request info.</typeparam>
- </member>
- <member name="M:SuperSocket.SocketBase.IAppSession`2.Initialize(SuperSocket.SocketBase.IAppServer{`0,`1},SuperSocket.SocketBase.ISocketSession)">
- <summary>
- Initializes the specified session.
- </summary>
- <param name="server">The server.</param>
- <param name="socketSession">The socket session.</param>
- </member>
- <member name="T:SuperSocket.SocketBase.IConnectionFilter">
- <summary>
- The basic interface of connection filter
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.IConnectionFilter.Initialize(System.String,SuperSocket.SocketBase.IAppServer)">
- <summary>
- Initializes the connection filter
- </summary>
- <param name="name">The name.</param>
- <param name="appServer">The app server.</param>
- <returns></returns>
- </member>
- <member name="M:SuperSocket.SocketBase.IConnectionFilter.AllowConnect(System.Net.IPEndPoint)">
- <summary>
- Whether allows the connect according the remote endpoint
- </summary>
- <param name="remoteAddress">The remote address.</param>
- <returns></returns>
- </member>
- <member name="P:SuperSocket.SocketBase.IConnectionFilter.Name">
- <summary>
- Gets the name of the filter.
- </summary>
- </member>
- <member name="T:SuperSocket.SocketBase.ISocketServer">
- <summary>
- It is the basic interface of SocketServer,
- SocketServer is the abstract server who really listen the comming sockets directly.
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.ISocketServer.Start">
- <summary>
- Starts this instance.
- </summary>
- <returns></returns>
- </member>
- <member name="M:SuperSocket.SocketBase.ISocketServer.ResetSessionSecurity(SuperSocket.SocketBase.IAppSession,System.Security.Authentication.SslProtocols)">
- <summary>
- Resets the session's security protocol.
- </summary>
- <param name="session">The session.</param>
- <param name="security">The security protocol.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.ISocketServer.Stop">
- <summary>
- Stops this instance.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.ISocketServer.IsRunning">
- <summary>
- Gets a value indicating whether this instance is running.
- </summary>
- <value>
- <c>true</c> if this instance is running; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.ISocketServer.SendingQueuePool">
- <summary>
- Gets the information of the sending queue pool.
- </summary>
- <value>
- The sending queue pool.
- </value>
- </member>
- <member name="T:SuperSocket.SocketBase.ISocketServerFactory">
- <summary>
- The interface for socket server factory
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.ISocketServerFactory.CreateSocketServer``1(SuperSocket.SocketBase.IAppServer,SuperSocket.SocketBase.ListenerInfo[],SuperSocket.SocketBase.Config.IServerConfig)">
- <summary>
- Creates the socket server instance.
- </summary>
- <typeparam name="TRequestInfo">The type of the request info.</typeparam>
- <param name="appServer">The app server.</param>
- <param name="listeners">The listeners.</param>
- <param name="config">The config.</param>
- <returns></returns>
- </member>
- <member name="T:SuperSocket.SocketBase.CloseReason">
- <summary>
- CloseReason enum
- </summary>
- </member>
- <member name="F:SuperSocket.SocketBase.CloseReason.Unknown">
- <summary>
- The socket is closed for unknown reason
- </summary>
- </member>
- <member name="F:SuperSocket.SocketBase.CloseReason.ServerShutdown">
- <summary>
- Close for server shutdown
- </summary>
- </member>
- <member name="F:SuperSocket.SocketBase.CloseReason.ClientClosing">
- <summary>
- The client close the socket
- </summary>
- </member>
- <member name="F:SuperSocket.SocketBase.CloseReason.ServerClosing">
- <summary>
- The server side close the socket
- </summary>
- </member>
- <member name="F:SuperSocket.SocketBase.CloseReason.ApplicationError">
- <summary>
- Application error
- </summary>
- </member>
- <member name="F:SuperSocket.SocketBase.CloseReason.SocketError">
- <summary>
- The socket is closed for a socket error
- </summary>
- </member>
- <member name="F:SuperSocket.SocketBase.CloseReason.TimeOut">
- <summary>
- The socket is closed by server for timeout
- </summary>
- </member>
- <member name="F:SuperSocket.SocketBase.CloseReason.ProtocolError">
- <summary>
- Protocol error
- </summary>
- </member>
- <member name="F:SuperSocket.SocketBase.CloseReason.InternalError">
- <summary>
- SuperSocket internal error
- </summary>
- </member>
- <member name="T:SuperSocket.SocketBase.ISocketSession">
- <summary>
- The interface for socket session
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.ISocketSession.Initialize(SuperSocket.SocketBase.IAppSession)">
- <summary>
- Initializes the specified app session.
- </summary>
- <param name="appSession">The app session.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.ISocketSession.Start">
- <summary>
- Starts this instance.
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.ISocketSession.Close(SuperSocket.SocketBase.CloseReason)">
- <summary>
- Closes the socket session for the specified reason.
- </summary>
- <param name="reason">The reason.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.ISocketSession.TrySend(System.Collections.Generic.IList{System.ArraySegment{System.Byte}})">
- <summary>
- Tries to send array segment.
- </summary>
- <param name="segments">The segments.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.ISocketSession.TrySend(System.ArraySegment{System.Byte})">
- <summary>
- Tries to send array segment.
- </summary>
- <param name="segment">The segment.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.ISocketSession.ApplySecureProtocol">
- <summary>
- Applies the secure protocol.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.ISocketSession.Client">
- <summary>
- Gets the client socket.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.ISocketSession.LocalEndPoint">
- <summary>
- Gets the local listening endpoint.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.ISocketSession.SecureProtocol">
- <summary>
- Gets or sets the secure protocol.
- </summary>
- <value>
- The secure protocol.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.ISocketSession.Closed">
- <summary>
- Occurs when [closed].
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.ISocketSession.AppSession">
- <summary>
- Gets the app session assosiated with this socket session.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.ISocketSession.OrigReceiveOffset">
- <summary>
- Gets the original receive buffer offset.
- </summary>
- <value>
- The original receive buffer offset.
- </value>
- </member>
- <member name="T:SuperSocket.SocketBase.LoggerExtension">
- <summary>
- Logger extension class
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.LoggerExtension.Error(SuperSocket.SocketBase.Logging.ILog,SuperSocket.SocketBase.ISessionBase,System.String,System.Exception)">
- <summary>
- Logs the error
- </summary>
- <param name="logger">The logger.</param>
- <param name="session">The session.</param>
- <param name="title">The title.</param>
- <param name="e">The e.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.LoggerExtension.Error(SuperSocket.SocketBase.Logging.ILog,SuperSocket.SocketBase.ISessionBase,System.String)">
- <summary>
- Logs the error
- </summary>
- <param name="logger">The logger.</param>
- <param name="session">The session.</param>
- <param name="message">The message.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.LoggerExtension.Info(SuperSocket.SocketBase.Logging.ILog,SuperSocket.SocketBase.ISessionBase,System.String)">
- <summary>
- Logs the information
- </summary>
- <param name="logger">The logger.</param>
- <param name="session">The session.</param>
- <param name="message">The message.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.LoggerExtension.Debug(SuperSocket.SocketBase.Logging.ILog,SuperSocket.SocketBase.ISessionBase,System.String)">
- <summary>
- Logs the debug message
- </summary>
- <param name="logger">The logger.</param>
- <param name="session">The session.</param>
- <param name="message">The message.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.LoggerExtension.LogPerf(SuperSocket.SocketBase.IAppServer,System.String)">
- <summary>
- Logs the performance message
- </summary>
- <param name="appServer">The app server.</param>
- <param name="message">The message.</param>
- </member>
- <member name="T:SuperSocket.SocketBase.Protocol.BasicRequestInfoParser">
- <summary>
- Basic request info parser, which parse request info by separating
- </summary>
- </member>
- <member name="T:SuperSocket.SocketBase.Protocol.IRequestInfoParser`1">
- <summary>
- The interface for request info parser
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.Protocol.IRequestInfoParser`1.ParseRequestInfo(System.String)">
- <summary>
- Parses the request info from the source string.
- </summary>
- <param name="source">The source.</param>
- <returns></returns>
- </member>
- <member name="F:SuperSocket.SocketBase.Protocol.BasicRequestInfoParser.DefaultInstance">
- <summary>
- The default singlegton instance
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.Protocol.BasicRequestInfoParser.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Protocol.BasicRequestInfoParser"/> class.
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.Protocol.BasicRequestInfoParser.#ctor(System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.Protocol.BasicRequestInfoParser"/> class.
- </summary>
- <param name="spliter">The spliter between command name and command parameters.</param>
- <param name="parameterSpliter">The parameter spliter.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.Protocol.BasicRequestInfoParser.ParseRequestInfo(System.String)">
- <summary>
- Parses the request info.
- </summary>
- <param name="source">The source.</param>
- <returns></returns>
- </member>
- <member name="T:SuperSocket.SocketBase.ServerState">
- <summary>
- Server's state enum class
- </summary>
- </member>
- <member name="F:SuperSocket.SocketBase.ServerState.NotInitialized">
- <summary>
- Not initialized
- </summary>
- </member>
- <member name="F:SuperSocket.SocketBase.ServerState.Initializing">
- <summary>
- In initializing
- </summary>
- </member>
- <member name="F:SuperSocket.SocketBase.ServerState.NotStarted">
- <summary>
- Has been initialized, but not started
- </summary>
- </member>
- <member name="F:SuperSocket.SocketBase.ServerState.Starting">
- <summary>
- In starting
- </summary>
- </member>
- <member name="F:SuperSocket.SocketBase.ServerState.Running">
- <summary>
- In running
- </summary>
- </member>
- <member name="F:SuperSocket.SocketBase.ServerState.Stopping">
- <summary>
- In stopping
- </summary>
- </member>
- <member name="T:SuperSocket.SocketBase.Metadata.StatusInfoKeys">
- <summary>
- Server StatusInfo Metadata
- </summary>
- </member>
- <member name="F:SuperSocket.SocketBase.Metadata.StatusInfoKeys.CpuUsage">
- <summary>
- The cpu usage
- </summary>
- </member>
- <member name="F:SuperSocket.SocketBase.Metadata.StatusInfoKeys.MemoryUsage">
- <summary>
- The memory usage
- </summary>
- </member>
- <member name="F:SuperSocket.SocketBase.Metadata.StatusInfoKeys.TotalThreadCount">
- <summary>
- The total thread count
- </summary>
- </member>
- <member name="F:SuperSocket.SocketBase.Metadata.StatusInfoKeys.AvailableWorkingThreads">
- <summary>
- The available working threads count
- </summary>
- </member>
- <member name="F:SuperSocket.SocketBase.Metadata.StatusInfoKeys.AvailableCompletionPortThreads">
- <summary>
- The available completion port threads count
- </summary>
- </member>
- <member name="F:SuperSocket.SocketBase.Metadata.StatusInfoKeys.MaxWorkingThreads">
- <summary>
- The max working threads count
- </summary>
- </member>
- <member name="F:SuperSocket.SocketBase.Metadata.StatusInfoKeys.MaxCompletionPortThreads">
- <summary>
- The max completion port threads count
- </summary>
- </member>
- <member name="F:SuperSocket.SocketBase.Metadata.StatusInfoKeys.StartedTime">
- <summary>
- The started time.
- </summary>
- </member>
- <member name="F:SuperSocket.SocketBase.Metadata.StatusInfoKeys.IsRunning">
- <summary>
- <c>true</c> if this instance is running; otherwise, <c>false</c>.
- </summary>
- </member>
- <member name="F:SuperSocket.SocketBase.Metadata.StatusInfoKeys.TotalConnections">
- <summary>
- The total count of the connections.
- </summary>
- </member>
- <member name="F:SuperSocket.SocketBase.Metadata.StatusInfoKeys.MaxConnectionNumber">
- <summary>
- The max connection number.
- </summary>
- </member>
- <member name="F:SuperSocket.SocketBase.Metadata.StatusInfoKeys.TotalHandledRequests">
- <summary>
- The total handled requests count.
- </summary>
- </member>
- <member name="F:SuperSocket.SocketBase.Metadata.StatusInfoKeys.RequestHandlingSpeed">
- <summary>
- Gets or sets the request handling speed, per second.
- </summary>
- <value>
- The request handling speed.
- </value>
- </member>
- <member name="F:SuperSocket.SocketBase.Metadata.StatusInfoKeys.Listeners">
- <summary>
- Gets or sets the listeners.
- </summary>
- </member>
- <member name="F:SuperSocket.SocketBase.Metadata.StatusInfoKeys.AvialableSendingQueueItems">
- <summary>
- The avialable sending queue items.
- </summary>
- </member>
- <member name="F:SuperSocket.SocketBase.Metadata.StatusInfoKeys.TotalSendingQueueItems">
- <summary>
- The total sending queue items.
- </summary>
- </member>
- <member name="T:SuperSocket.SocketBase.SessionHandler`1">
- <summary>
- Used for session level event handler
- </summary>
- <typeparam name="TAppSession">the type of the target session</typeparam>
- <param name="session">the target session</param>
- </member>
- <member name="T:SuperSocket.SocketBase.SessionHandler`2">
- <summary>
- Used for session level event handler
- </summary>
- <typeparam name="TAppSession">the type of the target session</typeparam>
- <typeparam name="TParam">the target session</typeparam>
- <param name="session">the target session</param>
- <param name="value">the event parameter</param>
- </member>
- <member name="T:SuperSocket.SocketBase.SocketMode">
- <summary>
- Socket server running mode
- </summary>
- </member>
- <member name="F:SuperSocket.SocketBase.SocketMode.Tcp">
- <summary>
- Tcp mode
- </summary>
- </member>
- <member name="F:SuperSocket.SocketBase.SocketMode.Udp">
- <summary>
- Udp mode
- </summary>
- </member>
- <member name="T:SuperSocket.SocketBase.AppServer">
- <summary>
- AppServer class
- </summary>
- </member>
- <member name="T:SuperSocket.SocketBase.AppServer`1">
- <summary>
- AppServer class
- </summary>
- <typeparam name="TAppSession">The type of the app session.</typeparam>
- </member>
- <member name="T:SuperSocket.SocketBase.AppServer`2">
- <summary>
- AppServer basic class
- </summary>
- <typeparam name="TAppSession">The type of the app session.</typeparam>
- <typeparam name="TRequestInfo">The type of the request info.</typeparam>
- </member>
- <member name="M:SuperSocket.SocketBase.AppServer`2.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.AppServer`2"/> class.
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.AppServer`2.#ctor(SuperSocket.SocketBase.Protocol.IReceiveFilterFactory{`1})">
- <summary>
- Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.AppServer`2"/> class.
- </summary>
- <param name="protocol">The protocol.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.AppServer`2.Start">
- <summary>
- Starts this AppServer instance.
- </summary>
- <returns></returns>
- </member>
- <member name="M:SuperSocket.SocketBase.AppServer`2.RegisterSession(System.String,`0)">
- <summary>
- Registers the session into the session container.
- </summary>
- <param name="sessionID">The session ID.</param>
- <param name="appSession">The app session.</param>
- <returns></returns>
- </member>
- <member name="M:SuperSocket.SocketBase.AppServer`2.GetAppSessionByID(System.String)">
- <summary>
- Gets the app session by ID.
- </summary>
- <param name="sessionID">The session ID.</param>
- <returns></returns>
- </member>
- <member name="M:SuperSocket.SocketBase.AppServer`2.GetSessionByID(System.String)">
- <summary>
- Gets the app session by ID.
- </summary>
- <param name="sessionID">The session ID.</param>
- <returns></returns>
- </member>
- <member name="M:SuperSocket.SocketBase.AppServer`2.OnSessionClosed(`0,SuperSocket.SocketBase.CloseReason)">
- <summary>
- Called when [socket session closed].
- </summary>
- <param name="session">The session.</param>
- <param name="reason">The reason.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.AppServer`2.ClearIdleSession(System.Object)">
- <summary>
- Clears the idle session.
- </summary>
- <param name="state">The state.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.AppServer`2.GetSessions(System.Func{`0,System.Boolean})">
- <summary>
- Gets the matched sessions from sessions snapshot.
- </summary>
- <param name="critera">The prediction critera.</param>
- <returns></returns>
- </member>
- <member name="M:SuperSocket.SocketBase.AppServer`2.GetAllSessions">
- <summary>
- Gets all sessions in sessions snapshot.
- </summary>
- <returns></returns>
- </member>
- <member name="M:SuperSocket.SocketBase.AppServer`2.Stop">
- <summary>
- Stops this instance.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.AppServer`2.SessionCount">
- <summary>
- Gets the total session count.
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.AppServer`1.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.AppServer`1"/> class.
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.AppServer`1.#ctor(SuperSocket.SocketBase.Protocol.IReceiveFilterFactory{SuperSocket.SocketBase.Protocol.StringRequestInfo})">
- <summary>
- Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.AppServer`1"/> class.
- </summary>
- <param name="receiveFilterFactory">The Receive filter factory.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.AppServer.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.AppServer"/> class.
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.AppServer.#ctor(SuperSocket.SocketBase.Protocol.IReceiveFilterFactory{SuperSocket.SocketBase.Protocol.StringRequestInfo})">
- <summary>
- Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.AppServer"/> class.
- </summary>
- <param name="receiveFilterFactory">The Receive filter factory.</param>
- </member>
- <member name="T:SuperSocket.SocketBase.AppSession`2">
- <summary>
- AppSession base class
- </summary>
- <typeparam name="TAppSession">The type of the app session.</typeparam>
- <typeparam name="TRequestInfo">The type of the request info.</typeparam>
- </member>
- <member name="M:SuperSocket.SocketBase.AppSession`2.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.AppSession`2"/> class.
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.AppSession`2.Initialize(SuperSocket.SocketBase.IAppServer{`0,`1},SuperSocket.SocketBase.ISocketSession)">
- <summary>
- Initializes the specified app session by AppServer and SocketSession.
- </summary>
- <param name="appServer">The app server.</param>
- <param name="socketSession">The socket session.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.AppSession`2.SuperSocket#SocketBase#IAppSession#StartSession">
- <summary>
- Starts the session.
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.AppSession`2.OnInit">
- <summary>
- Called when [init].
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.AppSession`2.OnSessionStarted">
- <summary>
- Called when [session started].
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.AppSession`2.OnSessionClosed(SuperSocket.SocketBase.CloseReason)">
- <summary>
- Called when [session closed].
- </summary>
- <param name="reason">The reason.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.AppSession`2.HandleException(System.Exception)">
- <summary>
- Handles the exceptional error, it only handles application error.
- </summary>
- <param name="e">The exception.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.AppSession`2.HandleUnknownRequest(`1)">
- <summary>
- Handles the unknown request.
- </summary>
- <param name="requestInfo">The request info.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.AppSession`2.Close(SuperSocket.SocketBase.CloseReason)">
- <summary>
- Closes the session by the specified reason.
- </summary>
- <param name="reason">The close reason.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.AppSession`2.Close">
- <summary>
- Closes this session.
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.AppSession`2.TrySend(System.String)">
- <summary>
- Try to send the message to client.
- </summary>
- <param name="message">The message which will be sent.</param>
- <returns>Indicate whether the message was pushed into the sending queue</returns>
- </member>
- <member name="M:SuperSocket.SocketBase.AppSession`2.Send(System.String)">
- <summary>
- Sends the message to client.
- </summary>
- <param name="message">The message which will be sent.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.AppSession`2.TrySend(System.Byte[],System.Int32,System.Int32)">
- <summary>
- Try to send the data to client.
- </summary>
- <param name="data">The data which will be sent.</param>
- <param name="offset">The offset.</param>
- <param name="length">The length.</param>
- <returns>Indicate whether the message was pushed into the sending queue</returns>
- </member>
- <member name="M:SuperSocket.SocketBase.AppSession`2.Send(System.Byte[],System.Int32,System.Int32)">
- <summary>
- Sends the data to client.
- </summary>
- <param name="data">The data which will be sent.</param>
- <param name="offset">The offset.</param>
- <param name="length">The length.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.AppSession`2.TrySend(System.ArraySegment{System.Byte})">
- <summary>
- Try to send the data segment to client.
- </summary>
- <param name="segment">The segment which will be sent.</param>
- <returns>Indicate whether the message was pushed into the sending queue</returns>
- </member>
- <member name="M:SuperSocket.SocketBase.AppSession`2.Send(System.ArraySegment{System.Byte})">
- <summary>
- Sends the data segment to client.
- </summary>
- <param name="segment">The segment which will be sent.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.AppSession`2.TrySend(System.Collections.Generic.IList{System.ArraySegment{System.Byte}})">
- <summary>
- Try to send the data segments to client.
- </summary>
- <param name="segments">The segments.</param>
- <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>
- </member>
- <member name="M:SuperSocket.SocketBase.AppSession`2.Send(System.Collections.Generic.IList{System.ArraySegment{System.Byte}})">
- <summary>
- Sends the data segments to client.
- </summary>
- <param name="segments">The segments.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.AppSession`2.Send(System.String,System.Object[])">
- <summary>
- Sends the response.
- </summary>
- <param name="message">The message which will be sent.</param>
- <param name="paramValues">The parameter values.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.AppSession`2.SetNextReceiveFilter(SuperSocket.SocketBase.Protocol.IReceiveFilter{`1})">
- <summary>
- Sets the next Receive filter which will be used when next data block received
- </summary>
- <param name="nextReceiveFilter">The next receive filter.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.AppSession`2.GetMaxRequestLength">
- <summary>
- Gets the maximum allowed length of the request.
- </summary>
- <returns></returns>
- </member>
- <member name="M:SuperSocket.SocketBase.AppSession`2.FilterRequest(System.Byte[],System.Int32,System.Int32,System.Boolean,System.Int32@,System.Int32@)">
- <summary>
- Filters the request.
- </summary>
- <param name="readBuffer">The read buffer.</param>
- <param name="offset">The offset.</param>
- <param name="length">The length.</param>
- <param name="toBeCopied">if set to <c>true</c> [to be copied].</param>
- <param name="rest">The rest, the size of the data which has not been processed</param>
- <param name="offsetDelta">return offset delta of next receiving buffer.</param>
- <returns></returns>
- </member>
- <member name="M:SuperSocket.SocketBase.AppSession`2.SuperSocket#SocketBase#IAppSession#ProcessRequest(System.Byte[],System.Int32,System.Int32,System.Boolean)">
- <summary>
- Processes the request data.
- </summary>
- <param name="readBuffer">The read buffer.</param>
- <param name="offset">The offset.</param>
- <param name="length">The length.</param>
- <param name="toBeCopied">if set to <c>true</c> [to be copied].</param>
- <returns>
- return offset delta of next receiving buffer
- </returns>
- </member>
- <member name="P:SuperSocket.SocketBase.AppSession`2.AppServer">
- <summary>
- Gets the app server instance assosiated with the session.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.AppSession`2.SuperSocket#SocketBase#IAppSession#AppServer">
- <summary>
- Gets the app server instance assosiated with the session.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.AppSession`2.Charset">
- <summary>
- Gets or sets the charset which is used for transfering text message.
- </summary>
- <value>
- The charset.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.AppSession`2.Items">
- <summary>
- Gets the items dictionary, only support 10 items maximum
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.AppSession`2.Connected">
- <summary>
- Gets a value indicating whether this <see cref="T:SuperSocket.SocketBase.IAppSession"/> is connected.
- </summary>
- <value>
- <c>true</c> if connected; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.AppSession`2.PrevCommand">
- <summary>
- Gets or sets the previous command.
- </summary>
- <value>
- The prev command.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.AppSession`2.CurrentCommand">
- <summary>
- Gets or sets the current executing command.
- </summary>
- <value>
- The current command.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.AppSession`2.SecureProtocol">
- <summary>
- Gets or sets the secure protocol of transportation layer.
- </summary>
- <value>
- The secure protocol.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.AppSession`2.LocalEndPoint">
- <summary>
- Gets the local listening endpoint.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.AppSession`2.RemoteEndPoint">
- <summary>
- Gets the remote endpoint of client.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.AppSession`2.Logger">
- <summary>
- Gets the logger.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.AppSession`2.LastActiveTime">
- <summary>
- Gets or sets the last active time of the session.
- </summary>
- <value>
- The last active time.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.AppSession`2.StartTime">
- <summary>
- Gets the start time of the session.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.AppSession`2.SessionID">
- <summary>
- Gets the session ID.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.AppSession`2.SocketSession">
- <summary>
- Gets the socket session of the AppSession.
- </summary>
- </member>
- <member name="P:SuperSocket.SocketBase.AppSession`2.Config">
- <summary>
- Gets the config of the server.
- </summary>
- </member>
- <member name="T:SuperSocket.SocketBase.AppSession`1">
- <summary>
- AppServer basic class for whose request infoe type is StringRequestInfo
- </summary>
- <typeparam name="TAppSession">The type of the app session.</typeparam>
- </member>
- <member name="M:SuperSocket.SocketBase.AppSession`1.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.AppSession`1"/> class.
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.AppSession`1.#ctor(System.Boolean)">
- <summary>
- Initializes a new instance of the <see cref="T:SuperSocket.SocketBase.AppSession`1"/> class.
- </summary>
- <param name="appendNewLineForResponse">if set to <c>true</c> [append new line for response].</param>
- </member>
- <member name="M:SuperSocket.SocketBase.AppSession`1.HandleUnknownRequest(SuperSocket.SocketBase.Protocol.StringRequestInfo)">
- <summary>
- Handles the unknown request.
- </summary>
- <param name="requestInfo">The request info.</param>
- </member>
- <member name="M:SuperSocket.SocketBase.AppSession`1.ProcessSendingMessage(System.String)">
- <summary>
- Processes the sending message.
- </summary>
- <param name="rawMessage">The raw message.</param>
- <returns></returns>
- </member>
- <member name="M:SuperSocket.SocketBase.AppSession`1.Send(System.String)">
- <summary>
- Sends the specified message.
- </summary>
- <param name="message">The message.</param>
- <returns></returns>
- </member>
- <member name="M:SuperSocket.SocketBase.AppSession`1.Send(System.String,System.Object[])">
- <summary>
- Sends the response.
- </summary>
- <param name="message">The message.</param>
- <param name="paramValues">The param values.</param>
- <returns>Indicate whether the message was pushed into the sending queue</returns>
- </member>
- <member name="T:SuperSocket.SocketBase.AppSession">
- <summary>
- AppServer basic class for whose request infoe type is StringRequestInfo
- </summary>
- </member>
- <member name="T:SuperSocket.SocketBase.Command.StringCommandBase`1">
- <summary>
- A command type for whose request info type is StringRequestInfo
- </summary>
- <typeparam name="TAppSession">The type of the app session.</typeparam>
- </member>
- <member name="T:SuperSocket.SocketBase.Command.StringCommandBase">
- <summary>
- A command type for whose request info type is StringRequestInfo
- </summary>
- </member>
- <member name="T:SuperSocket.SocketBase.StatusInfoCollection">
- <summary>
- Status information collection
- </summary>
- </member>
- <member name="M:SuperSocket.SocketBase.StatusInfoCollection.GetValue``1(System.String,``0)">
- <summary>
- Gets the value.
- </summary>
- <typeparam name="T"></typeparam>
- <param name="name">The name.</param>
- <param name="defaultValue">The default value.</param>
- <returns></returns>
- </member>
- <member name="P:SuperSocket.SocketBase.StatusInfoCollection.Values">
- <summary>
- Gets the values.
- </summary>
- <value>
- The values.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.StatusInfoCollection.Name">
- <summary>
- Gets or sets the name.
- </summary>
- <value>
- The name.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.StatusInfoCollection.Tag">
- <summary>
- Gets or sets the tag.
- </summary>
- <value>
- The tag.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.StatusInfoCollection.CollectedTime">
- <summary>
- Gets or sets the collected time.
- </summary>
- <value>
- The collected time.
- </value>
- </member>
- <member name="P:SuperSocket.SocketBase.StatusInfoCollection.Item(System.String)">
- <summary>
- Gets or sets the <see cref="T:System.Object"/> with the specified name.
- </summary>
- <value>
- The <see cref="T:System.Object"/>.
- </value>
- <param name="name">The name.</param>
- <returns></returns>
- </member>
- </members>
- </doc>
|