NetCoreServer.xml 276 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>NetCoreServer</name>
  5. </assembly>
  6. <members>
  7. <member name="T:NetCoreServer.Buffer">
  8. <summary>
  9. Dynamic byte buffer
  10. </summary>
  11. </member>
  12. <member name="P:NetCoreServer.Buffer.IsEmpty">
  13. <summary>
  14. Is the buffer empty?
  15. </summary>
  16. </member>
  17. <member name="P:NetCoreServer.Buffer.Data">
  18. <summary>
  19. Bytes memory buffer
  20. </summary>
  21. </member>
  22. <member name="P:NetCoreServer.Buffer.Capacity">
  23. <summary>
  24. Bytes memory buffer capacity
  25. </summary>
  26. </member>
  27. <member name="P:NetCoreServer.Buffer.Size">
  28. <summary>
  29. Bytes memory buffer size
  30. </summary>
  31. </member>
  32. <member name="P:NetCoreServer.Buffer.Offset">
  33. <summary>
  34. Bytes memory buffer offset
  35. </summary>
  36. </member>
  37. <member name="P:NetCoreServer.Buffer.Item(System.Int64)">
  38. <summary>
  39. Buffer indexer operator
  40. </summary>
  41. </member>
  42. <member name="M:NetCoreServer.Buffer.#ctor">
  43. <summary>
  44. Initialize a new expandable buffer with zero capacity
  45. </summary>
  46. </member>
  47. <member name="M:NetCoreServer.Buffer.#ctor(System.Int64)">
  48. <summary>
  49. Initialize a new expandable buffer with the given capacity
  50. </summary>
  51. </member>
  52. <member name="M:NetCoreServer.Buffer.#ctor(System.Byte[])">
  53. <summary>
  54. Initialize a new expandable buffer with the given data
  55. </summary>
  56. </member>
  57. <member name="M:NetCoreServer.Buffer.AsSpan">
  58. <summary>
  59. Get a span of bytes from the current buffer
  60. </summary>
  61. </member>
  62. <member name="M:NetCoreServer.Buffer.ToString">
  63. <summary>
  64. Get a string from the current buffer
  65. </summary>
  66. </member>
  67. <member name="M:NetCoreServer.Buffer.Clear">
  68. <summary>
  69. Clear the current buffer and its offset
  70. </summary>
  71. </member>
  72. <member name="M:NetCoreServer.Buffer.ExtractString(System.Int64,System.Int64)">
  73. <summary>
  74. Extract the string from buffer of the given offset and size
  75. </summary>
  76. </member>
  77. <member name="M:NetCoreServer.Buffer.Remove(System.Int64,System.Int64)">
  78. <summary>
  79. Remove the buffer of the given offset and size
  80. </summary>
  81. </member>
  82. <member name="M:NetCoreServer.Buffer.Reserve(System.Int64)">
  83. <summary>
  84. Reserve the buffer of the given capacity
  85. </summary>
  86. </member>
  87. <member name="M:NetCoreServer.Buffer.Resize(System.Int64)">
  88. <summary>
  89. Resize the current buffer
  90. </summary>
  91. </member>
  92. <member name="M:NetCoreServer.Buffer.Shift(System.Int64)">
  93. <summary>
  94. Shift the current buffer offset
  95. </summary>
  96. </member>
  97. <member name="M:NetCoreServer.Buffer.Unshift(System.Int64)">
  98. <summary>
  99. Unshift the current buffer offset
  100. </summary>
  101. </member>
  102. <member name="M:NetCoreServer.Buffer.Append(System.Byte)">
  103. <summary>
  104. Append the single byte
  105. </summary>
  106. <param name="value">Byte value to append</param>
  107. <returns>Count of append bytes</returns>
  108. </member>
  109. <member name="M:NetCoreServer.Buffer.Append(System.Byte[])">
  110. <summary>
  111. Append the given buffer
  112. </summary>
  113. <param name="buffer">Buffer to append</param>
  114. <returns>Count of append bytes</returns>
  115. </member>
  116. <member name="M:NetCoreServer.Buffer.Append(System.Byte[],System.Int64,System.Int64)">
  117. <summary>
  118. Append the given buffer fragment
  119. </summary>
  120. <param name="buffer">Buffer to append</param>
  121. <param name="offset">Buffer offset</param>
  122. <param name="size">Buffer size</param>
  123. <returns>Count of append bytes</returns>
  124. </member>
  125. <member name="M:NetCoreServer.Buffer.Append(System.ReadOnlySpan{System.Byte})">
  126. <summary>
  127. Append the given span of bytes
  128. </summary>
  129. <param name="buffer">Buffer to append as a span of bytes</param>
  130. <returns>Count of append bytes</returns>
  131. </member>
  132. <member name="M:NetCoreServer.Buffer.Append(NetCoreServer.Buffer)">
  133. <summary>
  134. Append the given buffer
  135. </summary>
  136. <param name="buffer">Buffer to append</param>
  137. <returns>Count of append bytes</returns>
  138. </member>
  139. <member name="M:NetCoreServer.Buffer.Append(System.String)">
  140. <summary>
  141. Append the given text in UTF-8 encoding
  142. </summary>
  143. <param name="text">Text to append</param>
  144. <returns>Count of append bytes</returns>
  145. </member>
  146. <member name="M:NetCoreServer.Buffer.Append(System.ReadOnlySpan{System.Char})">
  147. <summary>
  148. Append the given text in UTF-8 encoding
  149. </summary>
  150. <param name="text">Text to append as a span of characters</param>
  151. <returns>Count of append bytes</returns>
  152. </member>
  153. <member name="T:NetCoreServer.FileCache">
  154. <summary>
  155. File cache is used to cache files in memory with optional timeouts.
  156. FileSystemWatcher is used to monitor file system changes in cached
  157. directories.
  158. </summary>
  159. <remarks>Thread-safe.</remarks>
  160. </member>
  161. <member name="P:NetCoreServer.FileCache.Empty">
  162. <summary>
  163. Is the file cache empty?
  164. </summary>
  165. </member>
  166. <member name="P:NetCoreServer.FileCache.Size">
  167. <summary>
  168. Get the file cache size
  169. </summary>
  170. </member>
  171. <member name="M:NetCoreServer.FileCache.Add(System.String,System.Byte[],System.TimeSpan)">
  172. <summary>
  173. Add a new cache value with the given timeout into the file cache
  174. </summary>
  175. <param name="key">Key to add</param>
  176. <param name="value">Value to add</param>
  177. <param name="timeout">Cache timeout (default is 0 - no timeout)</param>
  178. <returns>'true' if the cache value was added, 'false' if the given key was not added</returns>
  179. </member>
  180. <member name="M:NetCoreServer.FileCache.Find(System.String)">
  181. <summary>
  182. Try to find the cache value by the given key
  183. </summary>
  184. <param name="key">Key to find</param>
  185. <returns>'true' and cache value if the cache value was found, 'false' if the given key was not found</returns>
  186. </member>
  187. <member name="M:NetCoreServer.FileCache.Remove(System.String)">
  188. <summary>
  189. Remove the cache value with the given key from the file cache
  190. </summary>
  191. <param name="key">Key to remove</param>
  192. <returns>'true' if the cache value was removed, 'false' if the given key was not found</returns>
  193. </member>
  194. <member name="M:NetCoreServer.FileCache.InsertPath(System.String,System.String,System.String,System.TimeSpan,NetCoreServer.FileCache.InsertHandler)">
  195. <summary>
  196. Insert a new cache path with the given timeout into the file cache
  197. </summary>
  198. <param name="path">Path to insert</param>
  199. <param name="prefix">Cache prefix (default is "/")</param>
  200. <param name="filter">Cache filter (default is "*.*")</param>
  201. <param name="timeout">Cache timeout (default is 0 - no timeout)</param>
  202. <param name="handler">Cache insert handler (default is 'return cache.Add(key, value, timeout)')</param>
  203. <returns>'true' if the cache path was setup, 'false' if failed to setup the cache path</returns>
  204. </member>
  205. <member name="M:NetCoreServer.FileCache.FindPath(System.String)">
  206. <summary>
  207. Try to find the cache path
  208. </summary>
  209. <param name="path">Path to find</param>
  210. <returns>'true' if the cache path was found, 'false' if the given path was not found</returns>
  211. </member>
  212. <member name="M:NetCoreServer.FileCache.RemovePath(System.String)">
  213. <summary>
  214. Remove the cache path from the file cache
  215. </summary>
  216. <param name="path">Path to remove</param>
  217. <returns>'true' if the cache path was removed, 'false' if the given path was not found</returns>
  218. </member>
  219. <member name="M:NetCoreServer.FileCache.Clear">
  220. <summary>
  221. Clear the memory cache
  222. </summary>
  223. </member>
  224. <member name="T:NetCoreServer.DisposableLock">
  225. <summary>
  226. Disposable lock class performs exit action on dispose operation.
  227. </summary>
  228. </member>
  229. <member name="T:NetCoreServer.ReadLock">
  230. <summary>
  231. Read lock class enters read lock on construction and performs exit read lock on dispose.
  232. </summary>
  233. </member>
  234. <member name="T:NetCoreServer.WriteLock">
  235. <summary>
  236. Write lock class enters write lock on construction and performs exit write lock on dispose.
  237. </summary>
  238. </member>
  239. <member name="T:NetCoreServer.StringExtensions">
  240. <summary>
  241. String extensions utility class.
  242. </summary>
  243. </member>
  244. <member name="T:NetCoreServer.HttpClient">
  245. <summary>
  246. HTTP client is used to communicate with HTTP Web server. It allows to send GET, POST, PUT, DELETE requests and receive HTTP result.
  247. </summary>
  248. <remarks>Thread-safe.</remarks>
  249. </member>
  250. <member name="M:NetCoreServer.HttpClient.#ctor(System.Net.IPAddress,System.Int32)">
  251. <summary>
  252. Initialize HTTP client with a given IP address and port number
  253. </summary>
  254. <param name="address">IP address</param>
  255. <param name="port">Port number</param>
  256. </member>
  257. <member name="M:NetCoreServer.HttpClient.#ctor(System.String,System.Int32)">
  258. <summary>
  259. Initialize HTTP client with a given IP address and port number
  260. </summary>
  261. <param name="address">IP address</param>
  262. <param name="port">Port number</param>
  263. </member>
  264. <member name="M:NetCoreServer.HttpClient.#ctor(System.Net.DnsEndPoint)">
  265. <summary>
  266. Initialize HTTP client with a given DNS endpoint
  267. </summary>
  268. <param name="endpoint">DNS endpoint</param>
  269. </member>
  270. <member name="M:NetCoreServer.HttpClient.#ctor(System.Net.IPEndPoint)">
  271. <summary>
  272. Initialize HTTP client with a given IP endpoint
  273. </summary>
  274. <param name="endpoint">IP endpoint</param>
  275. </member>
  276. <member name="P:NetCoreServer.HttpClient.Request">
  277. <summary>
  278. Get the HTTP request
  279. </summary>
  280. </member>
  281. <member name="P:NetCoreServer.HttpClient.Response">
  282. <summary>
  283. Get the HTTP response
  284. </summary>
  285. </member>
  286. <member name="M:NetCoreServer.HttpClient.SendRequest">
  287. <summary>
  288. Send the current HTTP request (synchronous)
  289. </summary>
  290. <returns>Size of sent data</returns>
  291. </member>
  292. <member name="M:NetCoreServer.HttpClient.SendRequest(NetCoreServer.HttpRequest)">
  293. <summary>
  294. Send the HTTP request (synchronous)
  295. </summary>
  296. <param name="request">HTTP request</param>
  297. <returns>Size of sent data</returns>
  298. </member>
  299. <member name="M:NetCoreServer.HttpClient.SendRequestBody(System.String)">
  300. <summary>
  301. Send the HTTP request body (synchronous)
  302. </summary>
  303. <param name="body">HTTP request body</param>
  304. <returns>Size of sent data</returns>
  305. </member>
  306. <member name="M:NetCoreServer.HttpClient.SendRequestBody(System.ReadOnlySpan{System.Char})">
  307. <summary>
  308. Send the HTTP request body (synchronous)
  309. </summary>
  310. <param name="body">HTTP request body as a span of characters</param>
  311. <returns>Size of sent data</returns>
  312. </member>
  313. <member name="M:NetCoreServer.HttpClient.SendRequestBody(System.Byte[])">
  314. <summary>
  315. Send the HTTP request body (synchronous)
  316. </summary>
  317. <param name="buffer">HTTP request body buffer</param>
  318. <returns>Size of sent data</returns>
  319. </member>
  320. <member name="M:NetCoreServer.HttpClient.SendRequestBody(System.Byte[],System.Int64,System.Int64)">
  321. <summary>
  322. Send the HTTP request body (synchronous)
  323. </summary>
  324. <param name="buffer">HTTP request body buffer</param>
  325. <param name="offset">HTTP request body buffer offset</param>
  326. <param name="size">HTTP request body size</param>
  327. <returns>Size of sent data</returns>
  328. </member>
  329. <member name="M:NetCoreServer.HttpClient.SendRequestBody(System.ReadOnlySpan{System.Byte})">
  330. <summary>
  331. Send the HTTP request body (synchronous)
  332. </summary>
  333. <param name="buffer">HTTP request body buffer as a span of bytes</param>
  334. <returns>Size of sent data</returns>
  335. </member>
  336. <member name="M:NetCoreServer.HttpClient.SendRequestAsync">
  337. <summary>
  338. Send the current HTTP request (asynchronous)
  339. </summary>
  340. <returns>'true' if the current HTTP request was successfully sent, 'false' if the session is not connected</returns>
  341. </member>
  342. <member name="M:NetCoreServer.HttpClient.SendRequestAsync(NetCoreServer.HttpRequest)">
  343. <summary>
  344. Send the HTTP request (asynchronous)
  345. </summary>
  346. <param name="request">HTTP request</param>
  347. <returns>'true' if the current HTTP request was successfully sent, 'false' if the session is not connected</returns>
  348. </member>
  349. <member name="M:NetCoreServer.HttpClient.SendRequestBodyAsync(System.String)">
  350. <summary>
  351. Send the HTTP request body (asynchronous)
  352. </summary>
  353. <param name="body">HTTP request body</param>
  354. <returns>'true' if the HTTP request body was successfully sent, 'false' if the session is not connected</returns>
  355. </member>
  356. <member name="M:NetCoreServer.HttpClient.SendRequestBodyAsync(System.ReadOnlySpan{System.Char})">
  357. <summary>
  358. Send the HTTP request body (asynchronous)
  359. </summary>
  360. <param name="body">HTTP request body as a span of characters</param>
  361. <returns>'true' if the HTTP request body was successfully sent, 'false' if the session is not connected</returns>
  362. </member>
  363. <member name="M:NetCoreServer.HttpClient.SendRequestBodyAsync(System.Byte[])">
  364. <summary>
  365. Send the HTTP request body (asynchronous)
  366. </summary>
  367. <param name="buffer">HTTP request body buffer</param>
  368. <returns>'true' if the HTTP request body was successfully sent, 'false' if the session is not connected</returns>
  369. </member>
  370. <member name="M:NetCoreServer.HttpClient.SendRequestBodyAsync(System.Byte[],System.Int64,System.Int64)">
  371. <summary>
  372. Send the HTTP request body (asynchronous)
  373. </summary>
  374. <param name="buffer">HTTP request body buffer</param>
  375. <param name="offset">HTTP request body buffer offset</param>
  376. <param name="size">HTTP request body size</param>
  377. <returns>'true' if the HTTP request body was successfully sent, 'false' if the session is not connected</returns>
  378. </member>
  379. <member name="M:NetCoreServer.HttpClient.SendRequestBodyAsync(System.ReadOnlySpan{System.Byte})">
  380. <summary>
  381. Send the HTTP request body (asynchronous)
  382. </summary>
  383. <param name="buffer">HTTP request body buffer as a span of bytes</param>
  384. <returns>'true' if the HTTP request body was successfully sent, 'false' if the session is not connected</returns>
  385. </member>
  386. <member name="M:NetCoreServer.HttpClient.OnReceivedResponseHeader(NetCoreServer.HttpResponse)">
  387. <summary>
  388. Handle HTTP response header received notification
  389. </summary>
  390. <remarks>Notification is called when HTTP response header was received from the server.</remarks>
  391. <param name="response">HTTP request</param>
  392. </member>
  393. <member name="M:NetCoreServer.HttpClient.OnReceivedResponse(NetCoreServer.HttpResponse)">
  394. <summary>
  395. Handle HTTP response received notification
  396. </summary>
  397. <remarks>Notification is called when HTTP response was received from the server.</remarks>
  398. <param name="response">HTTP response</param>
  399. </member>
  400. <member name="M:NetCoreServer.HttpClient.OnReceivedResponseError(NetCoreServer.HttpResponse,System.String)">
  401. <summary>
  402. Handle HTTP response error notification
  403. </summary>
  404. <remarks>Notification is called when HTTP response error was received from the server.</remarks>
  405. <param name="response">HTTP response</param>
  406. <param name="error">HTTP response error</param>
  407. </member>
  408. <member name="T:NetCoreServer.HttpClientEx">
  409. <summary>
  410. HTTP extended client make requests to HTTP Web server with returning Task as a synchronization primitive.
  411. </summary>
  412. <remarks>Thread-safe.</remarks>
  413. </member>
  414. <member name="M:NetCoreServer.HttpClientEx.#ctor(System.Net.IPAddress,System.Int32)">
  415. <summary>
  416. Initialize HTTP client with a given IP address and port number
  417. </summary>
  418. <param name="address">IP address</param>
  419. <param name="port">Port number</param>
  420. </member>
  421. <member name="M:NetCoreServer.HttpClientEx.#ctor(System.String,System.Int32)">
  422. <summary>
  423. Initialize HTTP client with a given IP address and port number
  424. </summary>
  425. <param name="address">IP address</param>
  426. <param name="port">Port number</param>
  427. </member>
  428. <member name="M:NetCoreServer.HttpClientEx.#ctor(System.Net.DnsEndPoint)">
  429. <summary>
  430. Initialize HTTP client with a given DNS endpoint
  431. </summary>
  432. <param name="endpoint">DNS endpoint</param>
  433. </member>
  434. <member name="M:NetCoreServer.HttpClientEx.#ctor(System.Net.IPEndPoint)">
  435. <summary>
  436. Initialize HTTP client with a given IP endpoint
  437. </summary>
  438. <param name="endpoint">IP endpoint</param>
  439. </member>
  440. <member name="M:NetCoreServer.HttpClientEx.SendRequest(System.Nullable{System.TimeSpan})">
  441. <summary>
  442. Send current HTTP request
  443. </summary>
  444. <param name="timeout">Current HTTP request timeout (default is 1 minute)</param>
  445. <returns>HTTP request Task</returns>
  446. </member>
  447. <member name="M:NetCoreServer.HttpClientEx.SendRequest(NetCoreServer.HttpRequest,System.Nullable{System.TimeSpan})">
  448. <summary>
  449. Send HTTP request
  450. </summary>
  451. <param name="request">HTTP request</param>
  452. <param name="timeout">HTTP request timeout (default is 1 minute)</param>
  453. <returns>HTTP request Task</returns>
  454. </member>
  455. <member name="M:NetCoreServer.HttpClientEx.SendHeadRequest(System.String,System.Nullable{System.TimeSpan})">
  456. <summary>
  457. Send HEAD request
  458. </summary>
  459. <param name="url">URL to request</param>
  460. <param name="timeout">Current HTTP request timeout (default is 1 minute)</param>
  461. <returns>HTTP request Task</returns>
  462. </member>
  463. <member name="M:NetCoreServer.HttpClientEx.SendGetRequest(System.String,System.Nullable{System.TimeSpan})">
  464. <summary>
  465. Send GET request
  466. </summary>
  467. <param name="url">URL to request</param>
  468. <param name="timeout">Current HTTP request timeout (default is 1 minute)</param>
  469. <returns>HTTP request Task</returns>
  470. </member>
  471. <member name="M:NetCoreServer.HttpClientEx.SendPostRequest(System.String,System.String,System.Nullable{System.TimeSpan})">
  472. <summary>
  473. Send POST request
  474. </summary>
  475. <param name="url">URL to request</param>
  476. <param name="content">Content</param>
  477. <param name="timeout">Current HTTP request timeout (default is 1 minute)</param>
  478. <returns>HTTP request Task</returns>
  479. </member>
  480. <member name="M:NetCoreServer.HttpClientEx.SendPutRequest(System.String,System.String,System.Nullable{System.TimeSpan})">
  481. <summary>
  482. Send PUT request
  483. </summary>
  484. <param name="url">URL to request</param>
  485. <param name="content">Content</param>
  486. <param name="timeout">Current HTTP request timeout (default is 1 minute)</param>
  487. <returns>HTTP request Task</returns>
  488. </member>
  489. <member name="M:NetCoreServer.HttpClientEx.SendDeleteRequest(System.String,System.Nullable{System.TimeSpan})">
  490. <summary>
  491. Send DELETE request
  492. </summary>
  493. <param name="url">URL to request</param>
  494. <param name="timeout">Current HTTP request timeout (default is 1 minute)</param>
  495. <returns>HTTP request Task</returns>
  496. </member>
  497. <member name="M:NetCoreServer.HttpClientEx.SendOptionsRequest(System.String,System.Nullable{System.TimeSpan})">
  498. <summary>
  499. Send OPTIONS request
  500. </summary>
  501. <param name="url">URL to request</param>
  502. <param name="timeout">Current HTTP request timeout (default is 1 minute)</param>
  503. <returns>HTTP request Task</returns>
  504. </member>
  505. <member name="M:NetCoreServer.HttpClientEx.SendTraceRequest(System.String,System.Nullable{System.TimeSpan})">
  506. <summary>
  507. Send TRACE request
  508. </summary>
  509. <param name="url">URL to request</param>
  510. <param name="timeout">Current HTTP request timeout (default is 1 minute)</param>
  511. <returns>HTTP request Task</returns>
  512. </member>
  513. <member name="T:NetCoreServer.HttpRequest">
  514. <summary>
  515. HTTP request is used to create or process parameters of HTTP protocol request(method, URL, headers, etc).
  516. </summary>
  517. <remarks>Not thread-safe.</remarks>
  518. </member>
  519. <member name="M:NetCoreServer.HttpRequest.#ctor">
  520. <summary>
  521. Initialize an empty HTTP request
  522. </summary>
  523. </member>
  524. <member name="M:NetCoreServer.HttpRequest.#ctor(System.String,System.String,System.String)">
  525. <summary>
  526. Initialize a new HTTP request with a given method, URL and protocol
  527. </summary>
  528. <param name="method">HTTP method</param>
  529. <param name="url">Requested URL</param>
  530. <param name="protocol">Protocol version (default is "HTTP/1.1")</param>
  531. </member>
  532. <member name="P:NetCoreServer.HttpRequest.IsEmpty">
  533. <summary>
  534. Is the HTTP request empty?
  535. </summary>
  536. </member>
  537. <member name="P:NetCoreServer.HttpRequest.IsErrorSet">
  538. <summary>
  539. Is the HTTP request error flag set?
  540. </summary>
  541. </member>
  542. <member name="P:NetCoreServer.HttpRequest.Method">
  543. <summary>
  544. Get the HTTP request method
  545. </summary>
  546. </member>
  547. <member name="P:NetCoreServer.HttpRequest.Url">
  548. <summary>
  549. Get the HTTP request URL
  550. </summary>
  551. </member>
  552. <member name="P:NetCoreServer.HttpRequest.Protocol">
  553. <summary>
  554. Get the HTTP request protocol version
  555. </summary>
  556. </member>
  557. <member name="P:NetCoreServer.HttpRequest.Headers">
  558. <summary>
  559. Get the HTTP request headers count
  560. </summary>
  561. </member>
  562. <member name="M:NetCoreServer.HttpRequest.Header(System.Int32)">
  563. <summary>
  564. Get the HTTP request header by index
  565. </summary>
  566. </member>
  567. <member name="P:NetCoreServer.HttpRequest.Cookies">
  568. <summary>
  569. Get the HTTP request cookies count
  570. </summary>
  571. </member>
  572. <member name="M:NetCoreServer.HttpRequest.Cookie(System.Int32)">
  573. <summary>
  574. Get the HTTP request cookie by index
  575. </summary>
  576. </member>
  577. <member name="P:NetCoreServer.HttpRequest.Body">
  578. <summary>
  579. Get the HTTP request body as string
  580. </summary>
  581. </member>
  582. <member name="P:NetCoreServer.HttpRequest.BodyBytes">
  583. <summary>
  584. Get the HTTP request body as byte array
  585. </summary>
  586. </member>
  587. <member name="P:NetCoreServer.HttpRequest.BodySpan">
  588. <summary>
  589. Get the HTTP request body as byte span
  590. </summary>
  591. </member>
  592. <member name="P:NetCoreServer.HttpRequest.BodyLength">
  593. <summary>
  594. Get the HTTP request body length
  595. </summary>
  596. </member>
  597. <member name="P:NetCoreServer.HttpRequest.Cache">
  598. <summary>
  599. Get the HTTP request cache content
  600. </summary>
  601. </member>
  602. <member name="M:NetCoreServer.HttpRequest.ToString">
  603. <summary>
  604. Get string from the current HTTP request
  605. </summary>
  606. </member>
  607. <member name="M:NetCoreServer.HttpRequest.Clear">
  608. <summary>
  609. Clear the HTTP request cache
  610. </summary>
  611. </member>
  612. <member name="M:NetCoreServer.HttpRequest.SetBegin(System.String,System.String,System.String)">
  613. <summary>
  614. Set the HTTP request begin with a given method, URL and protocol
  615. </summary>
  616. <param name="method">HTTP method</param>
  617. <param name="url">Requested URL</param>
  618. <param name="protocol">Protocol version (default is "HTTP/1.1")</param>
  619. </member>
  620. <member name="M:NetCoreServer.HttpRequest.SetHeader(System.String,System.String)">
  621. <summary>
  622. Set the HTTP request header
  623. </summary>
  624. <param name="key">Header key</param>
  625. <param name="value">Header value</param>
  626. </member>
  627. <member name="M:NetCoreServer.HttpRequest.SetCookie(System.String,System.String)">
  628. <summary>
  629. Set the HTTP request cookie
  630. </summary>
  631. <param name="name">Cookie name</param>
  632. <param name="value">Cookie value</param>
  633. </member>
  634. <member name="M:NetCoreServer.HttpRequest.AddCookie(System.String,System.String)">
  635. <summary>
  636. Add the HTTP request cookie
  637. </summary>
  638. <param name="name">Cookie name</param>
  639. <param name="value">Cookie value</param>
  640. </member>
  641. <member name="M:NetCoreServer.HttpRequest.SetBody(System.String)">
  642. <summary>
  643. Set the HTTP request body
  644. </summary>
  645. <param name="body">Body string content (default is "")</param>
  646. </member>
  647. <member name="M:NetCoreServer.HttpRequest.SetBody(System.ReadOnlySpan{System.Char})">
  648. <summary>
  649. Set the HTTP request body
  650. </summary>
  651. <param name="body">Body string content as a span of characters</param>
  652. </member>
  653. <member name="M:NetCoreServer.HttpRequest.SetBody(System.Byte[])">
  654. <summary>
  655. Set the HTTP request body
  656. </summary>
  657. <param name="body">Body binary content</param>
  658. </member>
  659. <member name="M:NetCoreServer.HttpRequest.SetBody(System.ReadOnlySpan{System.Byte})">
  660. <summary>
  661. Set the HTTP request body
  662. </summary>
  663. <param name="body">Body binary content as a span of bytes</param>
  664. </member>
  665. <member name="M:NetCoreServer.HttpRequest.SetBodyLength(System.Int32)">
  666. <summary>
  667. Set the HTTP request body length
  668. </summary>
  669. <param name="length">Body length</param>
  670. </member>
  671. <member name="M:NetCoreServer.HttpRequest.MakeHeadRequest(System.String)">
  672. <summary>
  673. Make HEAD request
  674. </summary>
  675. <param name="url">URL to request</param>
  676. </member>
  677. <member name="M:NetCoreServer.HttpRequest.MakeGetRequest(System.String)">
  678. <summary>
  679. Make GET request
  680. </summary>
  681. <param name="url">URL to request</param>
  682. </member>
  683. <member name="M:NetCoreServer.HttpRequest.MakePostRequest(System.String,System.String,System.String)">
  684. <summary>
  685. Make POST request
  686. </summary>
  687. <param name="url">URL to request</param>
  688. <param name="content">String content</param>
  689. <param name="contentType">Content type (default is "text/plain; charset=UTF-8")</param>
  690. </member>
  691. <member name="M:NetCoreServer.HttpRequest.MakePostRequest(System.String,System.ReadOnlySpan{System.Char},System.String)">
  692. <summary>
  693. Make POST request
  694. </summary>
  695. <param name="url">URL to request</param>
  696. <param name="content">String content as a span of characters</param>
  697. <param name="contentType">Content type (default is "text/plain; charset=UTF-8")</param>
  698. </member>
  699. <member name="M:NetCoreServer.HttpRequest.MakePostRequest(System.String,System.Byte[],System.String)">
  700. <summary>
  701. Make POST request
  702. </summary>
  703. <param name="url">URL to request</param>
  704. <param name="content">Binary content</param>
  705. <param name="contentType">Content type (default is "")</param>
  706. </member>
  707. <member name="M:NetCoreServer.HttpRequest.MakePostRequest(System.String,System.ReadOnlySpan{System.Byte},System.String)">
  708. <summary>
  709. Make POST request
  710. </summary>
  711. <param name="url">URL to request</param>
  712. <param name="content">Binary content as a span of bytes</param>
  713. <param name="contentType">Content type (default is "")</param>
  714. </member>
  715. <member name="M:NetCoreServer.HttpRequest.MakePutRequest(System.String,System.String,System.String)">
  716. <summary>
  717. Make PUT request
  718. </summary>
  719. <param name="url">URL to request</param>
  720. <param name="content">String content</param>
  721. <param name="contentType">Content type (default is "text/plain; charset=UTF-8")</param>
  722. </member>
  723. <member name="M:NetCoreServer.HttpRequest.MakePutRequest(System.String,System.ReadOnlySpan{System.Char},System.String)">
  724. <summary>
  725. Make PUT request
  726. </summary>
  727. <param name="url">URL to request</param>
  728. <param name="content">String content as a span of characters</param>
  729. <param name="contentType">Content type (default is "text/plain; charset=UTF-8")</param>
  730. </member>
  731. <member name="M:NetCoreServer.HttpRequest.MakePutRequest(System.String,System.Byte[],System.String)">
  732. <summary>
  733. Make PUT request
  734. </summary>
  735. <param name="url">URL to request</param>
  736. <param name="content">Binary content</param>
  737. <param name="contentType">Content type (default is "")</param>
  738. </member>
  739. <member name="M:NetCoreServer.HttpRequest.MakePutRequest(System.String,System.ReadOnlySpan{System.Byte},System.String)">
  740. <summary>
  741. Make PUT request
  742. </summary>
  743. <param name="url">URL to request</param>
  744. <param name="content">Binary content as a span of bytes</param>
  745. <param name="contentType">Content type (default is "")</param>
  746. </member>
  747. <member name="M:NetCoreServer.HttpRequest.MakeDeleteRequest(System.String)">
  748. <summary>
  749. Make DELETE request
  750. </summary>
  751. <param name="url">URL to request</param>
  752. </member>
  753. <member name="M:NetCoreServer.HttpRequest.MakeOptionsRequest(System.String)">
  754. <summary>
  755. Make OPTIONS request
  756. </summary>
  757. <param name="url">URL to request</param>
  758. </member>
  759. <member name="M:NetCoreServer.HttpRequest.MakeTraceRequest(System.String)">
  760. <summary>
  761. Make TRACE request
  762. </summary>
  763. <param name="url">URL to request</param>
  764. </member>
  765. <member name="T:NetCoreServer.HttpResponse">
  766. <summary>
  767. HTTP response is used to create or process parameters of HTTP protocol response(status, headers, etc).
  768. </summary>
  769. <remarks>Not thread-safe.</remarks>
  770. </member>
  771. <member name="M:NetCoreServer.HttpResponse.#ctor">
  772. <summary>
  773. Initialize an empty HTTP response
  774. </summary>
  775. </member>
  776. <member name="M:NetCoreServer.HttpResponse.#ctor(System.Int32,System.String)">
  777. <summary>
  778. Initialize a new HTTP response with a given status and protocol
  779. </summary>
  780. <param name="status">HTTP status</param>
  781. <param name="protocol">Protocol version (default is "HTTP/1.1")</param>
  782. </member>
  783. <member name="M:NetCoreServer.HttpResponse.#ctor(System.Int32,System.String,System.String)">
  784. <summary>
  785. Initialize a new HTTP response with a given status, status phrase and protocol
  786. </summary>
  787. <param name="status">HTTP status</param>
  788. <param name="statusPhrase">HTTP status phrase</param>
  789. <param name="protocol">Protocol version</param>
  790. </member>
  791. <member name="P:NetCoreServer.HttpResponse.IsEmpty">
  792. <summary>
  793. Is the HTTP response empty?
  794. </summary>
  795. </member>
  796. <member name="P:NetCoreServer.HttpResponse.IsErrorSet">
  797. <summary>
  798. Is the HTTP response error flag set?
  799. </summary>
  800. </member>
  801. <member name="P:NetCoreServer.HttpResponse.Status">
  802. <summary>
  803. Get the HTTP response status
  804. </summary>
  805. </member>
  806. <member name="P:NetCoreServer.HttpResponse.StatusPhrase">
  807. <summary>
  808. Get the HTTP response status phrase
  809. </summary>
  810. </member>
  811. <member name="P:NetCoreServer.HttpResponse.Protocol">
  812. <summary>
  813. Get the HTTP response protocol version
  814. </summary>
  815. </member>
  816. <member name="P:NetCoreServer.HttpResponse.Headers">
  817. <summary>
  818. Get the HTTP response headers count
  819. </summary>
  820. </member>
  821. <member name="M:NetCoreServer.HttpResponse.Header(System.Int32)">
  822. <summary>
  823. Get the HTTP response header by index
  824. </summary>
  825. </member>
  826. <member name="P:NetCoreServer.HttpResponse.Body">
  827. <summary>
  828. Get the HTTP response body as string
  829. </summary>
  830. </member>
  831. <member name="P:NetCoreServer.HttpResponse.BodyBytes">
  832. <summary>
  833. Get the HTTP request body as byte array
  834. </summary>
  835. </member>
  836. <member name="P:NetCoreServer.HttpResponse.BodySpan">
  837. <summary>
  838. Get the HTTP request body as read-only byte span
  839. </summary>
  840. </member>
  841. <member name="P:NetCoreServer.HttpResponse.BodyLength">
  842. <summary>
  843. Get the HTTP response body length
  844. </summary>
  845. </member>
  846. <member name="P:NetCoreServer.HttpResponse.Cache">
  847. <summary>
  848. Get the HTTP response cache content
  849. </summary>
  850. </member>
  851. <member name="M:NetCoreServer.HttpResponse.ToString">
  852. <summary>
  853. Get string from the current HTTP response
  854. </summary>
  855. </member>
  856. <member name="M:NetCoreServer.HttpResponse.Clear">
  857. <summary>
  858. Clear the HTTP response cache
  859. </summary>
  860. </member>
  861. <member name="M:NetCoreServer.HttpResponse.SetBegin(System.Int32,System.String)">
  862. <summary>
  863. Set the HTTP response begin with a given status and protocol
  864. </summary>
  865. <param name="status">HTTP status</param>
  866. <param name="protocol">Protocol version (default is "HTTP/1.1")</param>
  867. </member>
  868. <member name="M:NetCoreServer.HttpResponse.SetBegin(System.Int32,System.String,System.String)">
  869. <summary>
  870. Set the HTTP response begin with a given status, status phrase and protocol
  871. </summary>
  872. <param name="status">HTTP status</param>
  873. <param name="statusPhrase"> HTTP status phrase</param>
  874. <param name="protocol">Protocol version</param>
  875. </member>
  876. <member name="M:NetCoreServer.HttpResponse.SetContentType(System.String)">
  877. <summary>
  878. Set the HTTP response content type
  879. </summary>
  880. <param name="extension">Content extension</param>
  881. </member>
  882. <member name="M:NetCoreServer.HttpResponse.SetHeader(System.String,System.String)">
  883. <summary>
  884. Set the HTTP response header
  885. </summary>
  886. <param name="key">Header key</param>
  887. <param name="value">Header value</param>
  888. </member>
  889. <member name="M:NetCoreServer.HttpResponse.SetCookie(System.String,System.String,System.Int32,System.String,System.String,System.Boolean,System.Boolean,System.Boolean)">
  890. <summary>
  891. Set the HTTP response cookie
  892. </summary>
  893. <param name="name">Cookie name</param>
  894. <param name="value">Cookie value</param>
  895. <param name="maxAge">Cookie age in seconds until it expires (default is 86400)</param>
  896. <param name="path">Cookie path (default is "")</param>
  897. <param name="domain">Cookie domain (default is "")</param>
  898. <param name="secure">Cookie secure flag (default is true)</param>
  899. <param name="strict">Cookie strict flag (default is true)</param>
  900. <param name="httpOnly">Cookie HTTP-only flag (default is true)</param>
  901. </member>
  902. <member name="M:NetCoreServer.HttpResponse.SetBody(System.String)">
  903. <summary>
  904. Set the HTTP response body
  905. </summary>
  906. <param name="body">Body string content (default is "")</param>
  907. </member>
  908. <member name="M:NetCoreServer.HttpResponse.SetBody(System.ReadOnlySpan{System.Char})">
  909. <summary>
  910. Set the HTTP response body
  911. </summary>
  912. <param name="body">Body string content as a span of characters</param>
  913. </member>
  914. <member name="M:NetCoreServer.HttpResponse.SetBody(System.Byte[])">
  915. <summary>
  916. Set the HTTP response body
  917. </summary>
  918. <param name="body">Body binary content</param>
  919. </member>
  920. <member name="M:NetCoreServer.HttpResponse.SetBody(System.ReadOnlySpan{System.Byte})">
  921. <summary>
  922. Set the HTTP response body
  923. </summary>
  924. <param name="body">Body binary content as a span of bytes</param>
  925. </member>
  926. <member name="M:NetCoreServer.HttpResponse.SetBodyLength(System.Int32)">
  927. <summary>
  928. Set the HTTP response body length
  929. </summary>
  930. <param name="length">Body length</param>
  931. </member>
  932. <member name="M:NetCoreServer.HttpResponse.MakeOkResponse(System.Int32)">
  933. <summary>
  934. Make OK response
  935. </summary>
  936. <param name="status">OK status (default is 200 (OK))</param>
  937. </member>
  938. <member name="M:NetCoreServer.HttpResponse.MakeErrorResponse(System.String,System.String)">
  939. <summary>
  940. Make ERROR response
  941. </summary>
  942. <param name="content">Error content (default is "")</param>
  943. <param name="contentType">Error content type (default is "text/plain; charset=UTF-8")</param>
  944. </member>
  945. <member name="M:NetCoreServer.HttpResponse.MakeErrorResponse(System.Int32,System.String,System.String)">
  946. <summary>
  947. Make ERROR response
  948. </summary>
  949. <param name="status">Error status</param>
  950. <param name="content">Error content (default is "")</param>
  951. <param name="contentType">Error content type (default is "text/plain; charset=UTF-8")</param>
  952. </member>
  953. <member name="M:NetCoreServer.HttpResponse.MakeHeadResponse">
  954. <summary>
  955. Make HEAD response
  956. </summary>
  957. </member>
  958. <member name="M:NetCoreServer.HttpResponse.MakeGetResponse(System.String,System.String)">
  959. <summary>
  960. Make GET response
  961. </summary>
  962. <param name="content">String content (default is "")</param>
  963. <param name="contentType">Content type (default is "text/plain; charset=UTF-8")</param>
  964. </member>
  965. <member name="M:NetCoreServer.HttpResponse.MakeGetResponse(System.ReadOnlySpan{System.Char},System.String)">
  966. <summary>
  967. Make GET response
  968. </summary>
  969. <param name="content">String content as a span of characters</param>
  970. <param name="contentType">Content type (default is "text/plain; charset=UTF-8")</param>
  971. </member>
  972. <member name="M:NetCoreServer.HttpResponse.MakeGetResponse(System.Byte[],System.String)">
  973. <summary>
  974. Make GET response
  975. </summary>
  976. <param name="content">Binary content</param>
  977. <param name="contentType">Content type (default is "")</param>
  978. </member>
  979. <member name="M:NetCoreServer.HttpResponse.MakeGetResponse(System.ReadOnlySpan{System.Byte},System.String)">
  980. <summary>
  981. Make GET response
  982. </summary>
  983. <param name="content">Binary content as a span of bytes</param>
  984. <param name="contentType">Content type (default is "")</param>
  985. </member>
  986. <member name="M:NetCoreServer.HttpResponse.MakeOptionsResponse(System.String)">
  987. <summary>
  988. Make OPTIONS response
  989. </summary>
  990. <param name="allow">Allow methods (default is "HEAD,GET,POST,PUT,DELETE,OPTIONS,TRACE")</param>
  991. </member>
  992. <member name="M:NetCoreServer.HttpResponse.MakeTraceResponse(System.String)">
  993. <summary>
  994. Make TRACE response
  995. </summary>
  996. <param name="content">String content</param>
  997. </member>
  998. <member name="M:NetCoreServer.HttpResponse.MakeTraceResponse(System.ReadOnlySpan{System.Char})">
  999. <summary>
  1000. Make TRACE response
  1001. </summary>
  1002. <param name="content">String content as a span of characters</param>
  1003. </member>
  1004. <member name="M:NetCoreServer.HttpResponse.MakeTraceResponse(System.Byte[])">
  1005. <summary>
  1006. Make TRACE response
  1007. </summary>
  1008. <param name="content">Binary content</param>
  1009. </member>
  1010. <member name="M:NetCoreServer.HttpResponse.MakeTraceResponse(System.ReadOnlySpan{System.Byte})">
  1011. <summary>
  1012. Make TRACE response
  1013. </summary>
  1014. <param name="content">Binary content as a span of bytes</param>
  1015. </member>
  1016. <member name="M:NetCoreServer.HttpResponse.MakeTraceResponse(NetCoreServer.HttpRequest)">
  1017. <summary>
  1018. Make TRACE response
  1019. </summary>
  1020. <param name="request">HTTP request</param>
  1021. </member>
  1022. <member name="T:NetCoreServer.HttpsClient">
  1023. <summary>
  1024. HTTPS client is used to communicate with secured HTTPS Web server. It allows to send GET, POST, PUT, DELETE requests and receive HTTP result using secure transport.
  1025. </summary>
  1026. <remarks>Thread-safe.</remarks>
  1027. </member>
  1028. <member name="M:NetCoreServer.HttpsClient.#ctor(NetCoreServer.SslContext,System.Net.IPAddress,System.Int32)">
  1029. <summary>
  1030. Initialize HTTPS client with a given IP address and port number
  1031. </summary>
  1032. <param name="context">SSL context</param>
  1033. <param name="address">IP address</param>
  1034. <param name="port">Port number</param>
  1035. </member>
  1036. <member name="M:NetCoreServer.HttpsClient.#ctor(NetCoreServer.SslContext,System.String,System.Int32)">
  1037. <summary>
  1038. Initialize HTTPS client with a given IP address and port number
  1039. </summary>
  1040. <param name="context">SSL context</param>
  1041. <param name="address">IP address</param>
  1042. <param name="port">Port number</param>
  1043. </member>
  1044. <member name="M:NetCoreServer.HttpsClient.#ctor(NetCoreServer.SslContext,System.Net.DnsEndPoint)">
  1045. <summary>
  1046. Initialize HTTPS client with a given DNS endpoint
  1047. </summary>
  1048. <param name="context">SSL context</param>
  1049. <param name="endpoint">DNS endpoint</param>
  1050. </member>
  1051. <member name="M:NetCoreServer.HttpsClient.#ctor(NetCoreServer.SslContext,System.Net.IPEndPoint)">
  1052. <summary>
  1053. Initialize HTTPS client with a given IP endpoint
  1054. </summary>
  1055. <param name="context">SSL context</param>
  1056. <param name="endpoint">IP endpoint</param>
  1057. </member>
  1058. <member name="P:NetCoreServer.HttpsClient.Request">
  1059. <summary>
  1060. Get the HTTP request
  1061. </summary>
  1062. </member>
  1063. <member name="P:NetCoreServer.HttpsClient.Response">
  1064. <summary>
  1065. Get the HTTP response
  1066. </summary>
  1067. </member>
  1068. <member name="M:NetCoreServer.HttpsClient.SendRequest">
  1069. <summary>
  1070. Send the current HTTP request (synchronous)
  1071. </summary>
  1072. <returns>Size of sent data</returns>
  1073. </member>
  1074. <member name="M:NetCoreServer.HttpsClient.SendRequest(NetCoreServer.HttpRequest)">
  1075. <summary>
  1076. Send the HTTP request (synchronous)
  1077. </summary>
  1078. <param name="request">HTTP request</param>
  1079. <returns>Size of sent data</returns>
  1080. </member>
  1081. <member name="M:NetCoreServer.HttpsClient.SendRequestBody(System.String)">
  1082. <summary>
  1083. Send the HTTP request body (synchronous)
  1084. </summary>
  1085. <param name="body">HTTP request body</param>
  1086. <returns>Size of sent data</returns>
  1087. </member>
  1088. <member name="M:NetCoreServer.HttpsClient.SendRequestBody(System.ReadOnlySpan{System.Char})">
  1089. <summary>
  1090. Send the HTTP request body (synchronous)
  1091. </summary>
  1092. <param name="body">HTTP request body as a span of characters</param>
  1093. <returns>Size of sent data</returns>
  1094. </member>
  1095. <member name="M:NetCoreServer.HttpsClient.SendRequestBody(System.Byte[])">
  1096. <summary>
  1097. Send the HTTP request body (synchronous)
  1098. </summary>
  1099. <param name="buffer">HTTP request body buffer</param>
  1100. <returns>Size of sent data</returns>
  1101. </member>
  1102. <member name="M:NetCoreServer.HttpsClient.SendRequestBody(System.Byte[],System.Int64,System.Int64)">
  1103. <summary>
  1104. Send the HTTP request body (synchronous)
  1105. </summary>
  1106. <param name="buffer">HTTP request body buffer</param>
  1107. <param name="offset">HTTP request body buffer offset</param>
  1108. <param name="size">HTTP request body size</param>
  1109. <returns>Size of sent data</returns>
  1110. </member>
  1111. <member name="M:NetCoreServer.HttpsClient.SendRequestBody(System.ReadOnlySpan{System.Byte})">
  1112. <summary>
  1113. Send the HTTP request body (synchronous)
  1114. </summary>
  1115. <param name="buffer">HTTP request body buffer as a span of bytes</param>
  1116. <returns>Size of sent data</returns>
  1117. </member>
  1118. <member name="M:NetCoreServer.HttpsClient.SendRequestAsync">
  1119. <summary>
  1120. Send the current HTTP request (asynchronous)
  1121. </summary>
  1122. <returns>'true' if the current HTTP request was successfully sent, 'false' if the session is not connected</returns>
  1123. </member>
  1124. <member name="M:NetCoreServer.HttpsClient.SendRequestAsync(NetCoreServer.HttpRequest)">
  1125. <summary>
  1126. Send the HTTP request (asynchronous)
  1127. </summary>
  1128. <param name="request">HTTP request</param>
  1129. <returns>'true' if the current HTTP request was successfully sent, 'false' if the session is not connected</returns>
  1130. </member>
  1131. <member name="M:NetCoreServer.HttpsClient.SendRequestBodyAsync(System.String)">
  1132. <summary>
  1133. Send the HTTP request body (asynchronous)
  1134. </summary>
  1135. <param name="body">HTTP request body</param>
  1136. <returns>'true' if the HTTP request body was successfully sent, 'false' if the session is not connected</returns>
  1137. </member>
  1138. <member name="M:NetCoreServer.HttpsClient.SendRequestBodyAsync(System.ReadOnlySpan{System.Char})">
  1139. <summary>
  1140. Send the HTTP request body (asynchronous)
  1141. </summary>
  1142. <param name="body">HTTP request body as a span of characters</param>
  1143. <returns>'true' if the HTTP request body was successfully sent, 'false' if the session is not connected</returns>
  1144. </member>
  1145. <member name="M:NetCoreServer.HttpsClient.SendRequestBodyAsync(System.Byte[])">
  1146. <summary>
  1147. Send the HTTP request body (asynchronous)
  1148. </summary>
  1149. <param name="buffer">HTTP request body buffer</param>
  1150. <returns>'true' if the HTTP request body was successfully sent, 'false' if the session is not connected</returns>
  1151. </member>
  1152. <member name="M:NetCoreServer.HttpsClient.SendRequestBodyAsync(System.Byte[],System.Int64,System.Int64)">
  1153. <summary>
  1154. Send the HTTP request body (asynchronous)
  1155. </summary>
  1156. <param name="buffer">HTTP request body buffer</param>
  1157. <param name="offset">HTTP request body buffer offset</param>
  1158. <param name="size">HTTP request body size</param>
  1159. <returns>'true' if the HTTP request body was successfully sent, 'false' if the session is not connected</returns>
  1160. </member>
  1161. <member name="M:NetCoreServer.HttpsClient.SendRequestBodyAsync(System.ReadOnlySpan{System.Byte})">
  1162. <summary>
  1163. Send the HTTP request body (asynchronous)
  1164. </summary>
  1165. <param name="buffer">HTTP request body buffer as a span of bytes</param>
  1166. <returns>'true' if the HTTP request body was successfully sent, 'false' if the session is not connected</returns>
  1167. </member>
  1168. <member name="M:NetCoreServer.HttpsClient.OnReceivedResponseHeader(NetCoreServer.HttpResponse)">
  1169. <summary>
  1170. Handle HTTP response header received notification
  1171. </summary>
  1172. <remarks>Notification is called when HTTP response header was received from the server.</remarks>
  1173. <param name="response">HTTP request</param>
  1174. </member>
  1175. <member name="M:NetCoreServer.HttpsClient.OnReceivedResponse(NetCoreServer.HttpResponse)">
  1176. <summary>
  1177. Handle HTTP response received notification
  1178. </summary>
  1179. <remarks>Notification is called when HTTP response was received from the server.</remarks>
  1180. <param name="response">HTTP response</param>
  1181. </member>
  1182. <member name="M:NetCoreServer.HttpsClient.OnReceivedResponseError(NetCoreServer.HttpResponse,System.String)">
  1183. <summary>
  1184. Handle HTTP response error notification
  1185. </summary>
  1186. <remarks>Notification is called when HTTP response error was received from the server.</remarks>
  1187. <param name="response">HTTP response</param>
  1188. <param name="error">HTTP response error</param>
  1189. </member>
  1190. <member name="T:NetCoreServer.HttpsClientEx">
  1191. <summary>
  1192. HTTPS extended client make requests to HTTPS Web server with returning Task as a synchronization primitive.
  1193. </summary>
  1194. <remarks>Thread-safe.</remarks>
  1195. </member>
  1196. <member name="M:NetCoreServer.HttpsClientEx.#ctor(NetCoreServer.SslContext,System.Net.IPAddress,System.Int32)">
  1197. <summary>
  1198. Initialize HTTPS client with a given IP address and port number
  1199. </summary>
  1200. <param name="context">SSL context</param>
  1201. <param name="address">IP address</param>
  1202. <param name="port">Port number</param>
  1203. </member>
  1204. <member name="M:NetCoreServer.HttpsClientEx.#ctor(NetCoreServer.SslContext,System.String,System.Int32)">
  1205. <summary>
  1206. Initialize HTTPS client with a given IP address and port number
  1207. </summary>
  1208. <param name="context">SSL context</param>
  1209. <param name="address">IP address</param>
  1210. <param name="port">Port number</param>
  1211. </member>
  1212. <member name="M:NetCoreServer.HttpsClientEx.#ctor(NetCoreServer.SslContext,System.Net.DnsEndPoint)">
  1213. <summary>
  1214. Initialize HTTPS client with a given DNS endpoint
  1215. </summary>
  1216. <param name="context">SSL context</param>
  1217. <param name="endpoint">DNS endpoint</param>
  1218. </member>
  1219. <member name="M:NetCoreServer.HttpsClientEx.#ctor(NetCoreServer.SslContext,System.Net.IPEndPoint)">
  1220. <summary>
  1221. Initialize HTTPS client with a given IP endpoint
  1222. </summary>
  1223. <param name="context">SSL context</param>
  1224. <param name="endpoint">IP endpoint</param>
  1225. </member>
  1226. <member name="M:NetCoreServer.HttpsClientEx.SendRequest(System.Nullable{System.TimeSpan})">
  1227. <summary>
  1228. Send current HTTP request
  1229. </summary>
  1230. <param name="timeout">Current HTTP request timeout (default is 1 minute)</param>
  1231. <returns>HTTP request Task</returns>
  1232. </member>
  1233. <member name="M:NetCoreServer.HttpsClientEx.SendRequest(NetCoreServer.HttpRequest,System.Nullable{System.TimeSpan})">
  1234. <summary>
  1235. Send HTTP request
  1236. </summary>
  1237. <param name="request">HTTP request</param>
  1238. <param name="timeout">HTTP request timeout (default is 1 minute)</param>
  1239. <returns>HTTP request Task</returns>
  1240. </member>
  1241. <member name="M:NetCoreServer.HttpsClientEx.SendHeadRequest(System.String,System.Nullable{System.TimeSpan})">
  1242. <summary>
  1243. Send HEAD request
  1244. </summary>
  1245. <param name="url">URL to request</param>
  1246. <param name="timeout">Current HTTP request timeout (default is 1 minute)</param>
  1247. <returns>HTTP request Task</returns>
  1248. </member>
  1249. <member name="M:NetCoreServer.HttpsClientEx.SendGetRequest(System.String,System.Nullable{System.TimeSpan})">
  1250. <summary>
  1251. Send GET request
  1252. </summary>
  1253. <param name="url">URL to request</param>
  1254. <param name="timeout">Current HTTP request timeout (default is 1 minute)</param>
  1255. <returns>HTTP request Task</returns>
  1256. </member>
  1257. <member name="M:NetCoreServer.HttpsClientEx.SendPostRequest(System.String,System.String,System.Nullable{System.TimeSpan})">
  1258. <summary>
  1259. Send POST request
  1260. </summary>
  1261. <param name="url">URL to request</param>
  1262. <param name="content">Content</param>
  1263. <param name="timeout">Current HTTP request timeout (default is 1 minute)</param>
  1264. <returns>HTTP request Task</returns>
  1265. </member>
  1266. <member name="M:NetCoreServer.HttpsClientEx.SendPutRequest(System.String,System.String,System.Nullable{System.TimeSpan})">
  1267. <summary>
  1268. Send PUT request
  1269. </summary>
  1270. <param name="url">URL to request</param>
  1271. <param name="content">Content</param>
  1272. <param name="timeout">Current HTTP request timeout (default is 1 minute)</param>
  1273. <returns>HTTP request Task</returns>
  1274. </member>
  1275. <member name="M:NetCoreServer.HttpsClientEx.SendDeleteRequest(System.String,System.Nullable{System.TimeSpan})">
  1276. <summary>
  1277. Send DELETE request
  1278. </summary>
  1279. <param name="url">URL to request</param>
  1280. <param name="timeout">Current HTTP request timeout (default is 1 minute)</param>
  1281. <returns>HTTP request Task</returns>
  1282. </member>
  1283. <member name="M:NetCoreServer.HttpsClientEx.SendOptionsRequest(System.String,System.Nullable{System.TimeSpan})">
  1284. <summary>
  1285. Send OPTIONS request
  1286. </summary>
  1287. <param name="url">URL to request</param>
  1288. <param name="timeout">Current HTTP request timeout (default is 1 minute)</param>
  1289. <returns>HTTP request Task</returns>
  1290. </member>
  1291. <member name="M:NetCoreServer.HttpsClientEx.SendTraceRequest(System.String,System.Nullable{System.TimeSpan})">
  1292. <summary>
  1293. Send TRACE request
  1294. </summary>
  1295. <param name="url">URL to request</param>
  1296. <param name="timeout">Current HTTP request timeout (default is 1 minute)</param>
  1297. <returns>HTTP request Task</returns>
  1298. </member>
  1299. <member name="T:NetCoreServer.HttpServer">
  1300. <summary>
  1301. HTTP server is used to create HTTP Web server and communicate with clients using HTTP protocol. It allows to receive GET, POST, PUT, DELETE requests and send HTTP responses.
  1302. </summary>
  1303. <remarks>Thread-safe.</remarks>
  1304. </member>
  1305. <member name="M:NetCoreServer.HttpServer.#ctor(System.Net.IPAddress,System.Int32)">
  1306. <summary>
  1307. Initialize HTTP server with a given IP address and port number
  1308. </summary>
  1309. <param name="address">IP address</param>
  1310. <param name="port">Port number</param>
  1311. </member>
  1312. <member name="M:NetCoreServer.HttpServer.#ctor(System.String,System.Int32)">
  1313. <summary>
  1314. Initialize HTTP server with a given IP address and port number
  1315. </summary>
  1316. <param name="address">IP address</param>
  1317. <param name="port">Port number</param>
  1318. </member>
  1319. <member name="M:NetCoreServer.HttpServer.#ctor(System.Net.DnsEndPoint)">
  1320. <summary>
  1321. Initialize HTTP server with a given DNS endpoint
  1322. </summary>
  1323. <param name="endpoint">DNS endpoint</param>
  1324. </member>
  1325. <member name="M:NetCoreServer.HttpServer.#ctor(System.Net.IPEndPoint)">
  1326. <summary>
  1327. Initialize HTTP server with a given IP endpoint
  1328. </summary>
  1329. <param name="endpoint">IP endpoint</param>
  1330. </member>
  1331. <member name="P:NetCoreServer.HttpServer.Cache">
  1332. <summary>
  1333. Get the static content cache
  1334. </summary>
  1335. </member>
  1336. <member name="M:NetCoreServer.HttpServer.AddStaticContent(System.String,System.String,System.String,System.Nullable{System.TimeSpan})">
  1337. <summary>
  1338. Add static content cache
  1339. </summary>
  1340. <param name="path">Static content path</param>
  1341. <param name="prefix">Cache prefix (default is "/")</param>
  1342. <param name="filter">Cache filter (default is "*.*")</param>
  1343. <param name="timeout">Refresh cache timeout (default is 1 hour)</param>
  1344. </member>
  1345. <member name="M:NetCoreServer.HttpServer.RemoveStaticContent(System.String)">
  1346. <summary>
  1347. Remove static content cache
  1348. </summary>
  1349. <param name="path">Static content path</param>
  1350. </member>
  1351. <member name="M:NetCoreServer.HttpServer.ClearStaticContent">
  1352. <summary>
  1353. Clear static content cache
  1354. </summary>
  1355. </member>
  1356. <member name="T:NetCoreServer.HttpSession">
  1357. <summary>
  1358. HTTP session is used to receive/send HTTP requests/responses from the connected HTTP client.
  1359. </summary>
  1360. <remarks>Thread-safe.</remarks>
  1361. </member>
  1362. <member name="P:NetCoreServer.HttpSession.Cache">
  1363. <summary>
  1364. Get the static content cache
  1365. </summary>
  1366. </member>
  1367. <member name="P:NetCoreServer.HttpSession.Request">
  1368. <summary>
  1369. Get the HTTP request
  1370. </summary>
  1371. </member>
  1372. <member name="P:NetCoreServer.HttpSession.Response">
  1373. <summary>
  1374. Get the HTTP response
  1375. </summary>
  1376. </member>
  1377. <member name="M:NetCoreServer.HttpSession.SendResponse">
  1378. <summary>
  1379. Send the current HTTP response (synchronous)
  1380. </summary>
  1381. <returns>Size of sent data</returns>
  1382. </member>
  1383. <member name="M:NetCoreServer.HttpSession.SendResponse(NetCoreServer.HttpResponse)">
  1384. <summary>
  1385. Send the HTTP response (synchronous)
  1386. </summary>
  1387. <param name="response">HTTP response</param>
  1388. <returns>Size of sent data</returns>
  1389. </member>
  1390. <member name="M:NetCoreServer.HttpSession.SendResponseBody(System.String)">
  1391. <summary>
  1392. Send the HTTP response body (synchronous)
  1393. </summary>
  1394. <param name="body">HTTP response body</param>
  1395. <returns>Size of sent data</returns>
  1396. </member>
  1397. <member name="M:NetCoreServer.HttpSession.SendResponseBody(System.ReadOnlySpan{System.Char})">
  1398. <summary>
  1399. Send the HTTP response body (synchronous)
  1400. </summary>
  1401. <param name="body">HTTP response body as a span of characters</param>
  1402. <returns>Size of sent data</returns>
  1403. </member>
  1404. <member name="M:NetCoreServer.HttpSession.SendResponseBody(System.Byte[])">
  1405. <summary>
  1406. Send the HTTP response body (synchronous)
  1407. </summary>
  1408. <param name="buffer">HTTP response body buffer</param>
  1409. <returns>Size of sent data</returns>
  1410. </member>
  1411. <member name="M:NetCoreServer.HttpSession.SendResponseBody(System.Byte[],System.Int64,System.Int64)">
  1412. <summary>
  1413. Send the HTTP response body (synchronous)
  1414. </summary>
  1415. <param name="buffer">HTTP response body buffer</param>
  1416. <param name="offset">HTTP response body buffer offset</param>
  1417. <param name="size">HTTP response body size</param>
  1418. <returns>Size of sent data</returns>
  1419. </member>
  1420. <member name="M:NetCoreServer.HttpSession.SendResponseBody(System.ReadOnlySpan{System.Byte})">
  1421. <summary>
  1422. Send the HTTP response body (synchronous)
  1423. </summary>
  1424. <param name="buffer">HTTP response body buffer as a span of bytes</param>
  1425. <returns>Size of sent data</returns>
  1426. </member>
  1427. <member name="M:NetCoreServer.HttpSession.SendResponseAsync">
  1428. <summary>
  1429. Send the current HTTP response (asynchronous)
  1430. </summary>
  1431. <returns>'true' if the current HTTP response was successfully sent, 'false' if the session is not connected</returns>
  1432. </member>
  1433. <member name="M:NetCoreServer.HttpSession.SendResponseAsync(NetCoreServer.HttpResponse)">
  1434. <summary>
  1435. Send the HTTP response (asynchronous)
  1436. </summary>
  1437. <param name="response">HTTP response</param>
  1438. <returns>'true' if the current HTTP response was successfully sent, 'false' if the session is not connected</returns>
  1439. </member>
  1440. <member name="M:NetCoreServer.HttpSession.SendResponseBodyAsync(System.String)">
  1441. <summary>
  1442. Send the HTTP response body (asynchronous)
  1443. </summary>
  1444. <param name="body">HTTP response body</param>
  1445. <returns>'true' if the HTTP response body was successfully sent, 'false' if the session is not connected</returns>
  1446. </member>
  1447. <member name="M:NetCoreServer.HttpSession.SendResponseBodyAsync(System.ReadOnlySpan{System.Char})">
  1448. <summary>
  1449. Send the HTTP response body (asynchronous)
  1450. </summary>
  1451. <param name="body">HTTP response body as a span of characters</param>
  1452. <returns>'true' if the HTTP response body was successfully sent, 'false' if the session is not connected</returns>
  1453. </member>
  1454. <member name="M:NetCoreServer.HttpSession.SendResponseBodyAsync(System.Byte[])">
  1455. <summary>
  1456. Send the HTTP response body (asynchronous)
  1457. </summary>
  1458. <param name="buffer">HTTP response body buffer</param>
  1459. <returns>'true' if the HTTP response body was successfully sent, 'false' if the session is not connected</returns>
  1460. </member>
  1461. <member name="M:NetCoreServer.HttpSession.SendResponseBodyAsync(System.Byte[],System.Int64,System.Int64)">
  1462. <summary>
  1463. Send the HTTP response body (asynchronous)
  1464. </summary>
  1465. <param name="buffer">HTTP response body buffer</param>
  1466. <param name="offset">HTTP response body buffer offset</param>
  1467. <param name="size">HTTP response body size</param>
  1468. <returns>'true' if the HTTP response body was successfully sent, 'false' if the session is not connected</returns>
  1469. </member>
  1470. <member name="M:NetCoreServer.HttpSession.SendResponseBodyAsync(System.ReadOnlySpan{System.Byte})">
  1471. <summary>
  1472. Send the HTTP response body (asynchronous)
  1473. </summary>
  1474. <param name="buffer">HTTP response body buffer as a span of bytes</param>
  1475. <returns>'true' if the HTTP response body was successfully sent, 'false' if the session is not connected</returns>
  1476. </member>
  1477. <member name="M:NetCoreServer.HttpSession.OnReceivedRequestHeader(NetCoreServer.HttpRequest)">
  1478. <summary>
  1479. Handle HTTP request header received notification
  1480. </summary>
  1481. <remarks>Notification is called when HTTP request header was received from the client.</remarks>
  1482. <param name="request">HTTP request</param>
  1483. </member>
  1484. <member name="M:NetCoreServer.HttpSession.OnReceivedRequest(NetCoreServer.HttpRequest)">
  1485. <summary>
  1486. Handle HTTP request received notification
  1487. </summary>
  1488. <remarks>Notification is called when HTTP request was received from the client.</remarks>
  1489. <param name="request">HTTP request</param>
  1490. </member>
  1491. <member name="M:NetCoreServer.HttpSession.OnReceivedCachedRequest(NetCoreServer.HttpRequest,System.Byte[])">
  1492. <summary>
  1493. Handle HTTP cached request received notification
  1494. </summary>
  1495. <remarks>
  1496. Notification is called when HTTP request was received
  1497. from the client and the corresponding cached content
  1498. was found.
  1499. Default behavior is just send cached response content
  1500. to the client.
  1501. </remarks>
  1502. <param name="request">HTTP request</param>
  1503. <param name="content">Cached response content</param>
  1504. </member>
  1505. <member name="M:NetCoreServer.HttpSession.OnReceivedRequestError(NetCoreServer.HttpRequest,System.String)">
  1506. <summary>
  1507. Handle HTTP request error notification
  1508. </summary>
  1509. <remarks>Notification is called when HTTP request error was received from the client.</remarks>
  1510. <param name="request">HTTP request</param>
  1511. <param name="error">HTTP request error</param>
  1512. </member>
  1513. <member name="T:NetCoreServer.HttpsServer">
  1514. <summary>
  1515. HTTPS server is used to create secured HTTPS Web server and communicate with clients using secure HTTPS protocol. It allows to receive GET, POST, PUT, DELETE requests and send HTTP responses.
  1516. </summary>
  1517. <remarks>Thread-safe.</remarks>
  1518. </member>
  1519. <member name="M:NetCoreServer.HttpsServer.#ctor(NetCoreServer.SslContext,System.Net.IPAddress,System.Int32)">
  1520. <summary>
  1521. Initialize HTTPS server with a given IP address and port number
  1522. </summary>
  1523. <param name="context">SSL context</param>
  1524. <param name="address">IP address</param>
  1525. <param name="port">Port number</param>
  1526. </member>
  1527. <member name="M:NetCoreServer.HttpsServer.#ctor(NetCoreServer.SslContext,System.String,System.Int32)">
  1528. <summary>
  1529. Initialize HTTPS server with a given IP address and port number
  1530. </summary>
  1531. <param name="context">SSL context</param>
  1532. <param name="address">IP address</param>
  1533. <param name="port">Port number</param>
  1534. </member>
  1535. <member name="M:NetCoreServer.HttpsServer.#ctor(NetCoreServer.SslContext,System.Net.DnsEndPoint)">
  1536. <summary>
  1537. Initialize HTTPS server with a given DNS endpoint
  1538. </summary>
  1539. <param name="context">SSL context</param>
  1540. <param name="endpoint">DNS endpoint</param>
  1541. </member>
  1542. <member name="M:NetCoreServer.HttpsServer.#ctor(NetCoreServer.SslContext,System.Net.IPEndPoint)">
  1543. <summary>
  1544. Initialize HTTPS server with a given IP endpoint
  1545. </summary>
  1546. <param name="context">SSL context</param>
  1547. <param name="endpoint">IP endpoint</param>
  1548. </member>
  1549. <member name="P:NetCoreServer.HttpsServer.Cache">
  1550. <summary>
  1551. Get the static content cache
  1552. </summary>
  1553. </member>
  1554. <member name="M:NetCoreServer.HttpsServer.AddStaticContent(System.String,System.String,System.String,System.Nullable{System.TimeSpan})">
  1555. <summary>
  1556. Add static content cache
  1557. </summary>
  1558. <param name="path">Static content path</param>
  1559. <param name="prefix">Cache prefix (default is "/")</param>
  1560. <param name="filter">Cache filter (default is "*.*")</param>
  1561. <param name="timeout">Refresh cache timeout (default is 1 hour)</param>
  1562. </member>
  1563. <member name="M:NetCoreServer.HttpsServer.RemoveStaticContent(System.String)">
  1564. <summary>
  1565. Remove static content cache
  1566. </summary>
  1567. <param name="path">Static content path</param>
  1568. </member>
  1569. <member name="M:NetCoreServer.HttpsServer.ClearStaticContent">
  1570. <summary>
  1571. Clear static content cache
  1572. </summary>
  1573. </member>
  1574. <member name="T:NetCoreServer.HttpsSession">
  1575. <summary>
  1576. HTTPS session is used to receive/send HTTP requests/responses from the connected HTTPS client.
  1577. </summary>
  1578. <remarks>Thread-safe.</remarks>
  1579. </member>
  1580. <member name="P:NetCoreServer.HttpsSession.Cache">
  1581. <summary>
  1582. Get the static content cache
  1583. </summary>
  1584. </member>
  1585. <member name="P:NetCoreServer.HttpsSession.Request">
  1586. <summary>
  1587. Get the HTTP request
  1588. </summary>
  1589. </member>
  1590. <member name="P:NetCoreServer.HttpsSession.Response">
  1591. <summary>
  1592. Get the HTTP response
  1593. </summary>
  1594. </member>
  1595. <member name="M:NetCoreServer.HttpsSession.SendResponse">
  1596. <summary>
  1597. Send the current HTTP response (synchronous)
  1598. </summary>
  1599. <returns>Size of sent data</returns>
  1600. </member>
  1601. <member name="M:NetCoreServer.HttpsSession.SendResponse(NetCoreServer.HttpResponse)">
  1602. <summary>
  1603. Send the HTTP response (synchronous)
  1604. </summary>
  1605. <param name="response">HTTP response</param>
  1606. <returns>Size of sent data</returns>
  1607. </member>
  1608. <member name="M:NetCoreServer.HttpsSession.SendResponseBody(System.String)">
  1609. <summary>
  1610. Send the HTTP response body (synchronous)
  1611. </summary>
  1612. <param name="body">HTTP response body</param>
  1613. <returns>Size of sent data</returns>
  1614. </member>
  1615. <member name="M:NetCoreServer.HttpsSession.SendResponseBody(System.ReadOnlySpan{System.Char})">
  1616. <summary>
  1617. Send the HTTP response body (synchronous)
  1618. </summary>
  1619. <param name="body">HTTP response body as a span of characters</param>
  1620. <returns>Size of sent data</returns>
  1621. </member>
  1622. <member name="M:NetCoreServer.HttpsSession.SendResponseBody(System.Byte[])">
  1623. <summary>
  1624. Send the HTTP response body (synchronous)
  1625. </summary>
  1626. <param name="buffer">HTTP response body buffer</param>
  1627. <returns>Size of sent data</returns>
  1628. </member>
  1629. <member name="M:NetCoreServer.HttpsSession.SendResponseBody(System.Byte[],System.Int64,System.Int64)">
  1630. <summary>
  1631. Send the HTTP response body (synchronous)
  1632. </summary>
  1633. <param name="buffer">HTTP response body buffer</param>
  1634. <param name="offset">HTTP response body buffer offset</param>
  1635. <param name="size">HTTP response body size</param>
  1636. <returns>Size of sent data</returns>
  1637. </member>
  1638. <member name="M:NetCoreServer.HttpsSession.SendResponseBody(System.ReadOnlySpan{System.Byte})">
  1639. <summary>
  1640. Send the HTTP response body (synchronous)
  1641. </summary>
  1642. <param name="buffer">HTTP response body buffer as a span of bytes</param>
  1643. <returns>Size of sent data</returns>
  1644. </member>
  1645. <member name="M:NetCoreServer.HttpsSession.SendResponseAsync">
  1646. <summary>
  1647. Send the current HTTP response (asynchronous)
  1648. </summary>
  1649. <returns>'true' if the current HTTP response was successfully sent, 'false' if the session is not connected</returns>
  1650. </member>
  1651. <member name="M:NetCoreServer.HttpsSession.SendResponseAsync(NetCoreServer.HttpResponse)">
  1652. <summary>
  1653. Send the HTTP response (asynchronous)
  1654. </summary>
  1655. <param name="response">HTTP response</param>
  1656. <returns>'true' if the current HTTP response was successfully sent, 'false' if the session is not connected</returns>
  1657. </member>
  1658. <member name="M:NetCoreServer.HttpsSession.SendResponseBodyAsync(System.String)">
  1659. <summary>
  1660. Send the HTTP response body (asynchronous)
  1661. </summary>
  1662. <param name="body">HTTP response body</param>
  1663. <returns>'true' if the HTTP response body was successfully sent, 'false' if the session is not connected</returns>
  1664. </member>
  1665. <member name="M:NetCoreServer.HttpsSession.SendResponseBodyAsync(System.ReadOnlySpan{System.Char})">
  1666. <summary>
  1667. Send the HTTP response body (asynchronous)
  1668. </summary>
  1669. <param name="body">HTTP response body as a span of characters</param>
  1670. <returns>'true' if the HTTP response body was successfully sent, 'false' if the session is not connected</returns>
  1671. </member>
  1672. <member name="M:NetCoreServer.HttpsSession.SendResponseBodyAsync(System.Byte[])">
  1673. <summary>
  1674. Send the HTTP response body (asynchronous)
  1675. </summary>
  1676. <param name="buffer">HTTP response body buffer</param>
  1677. <returns>'true' if the HTTP response body was successfully sent, 'false' if the session is not connected</returns>
  1678. </member>
  1679. <member name="M:NetCoreServer.HttpsSession.SendResponseBodyAsync(System.Byte[],System.Int64,System.Int64)">
  1680. <summary>
  1681. Send the HTTP response body (asynchronous)
  1682. </summary>
  1683. <param name="buffer">HTTP response body buffer</param>
  1684. <param name="offset">HTTP response body buffer offset</param>
  1685. <param name="size">HTTP response body size</param>
  1686. <returns>'true' if the HTTP response body was successfully sent, 'false' if the session is not connected</returns>
  1687. </member>
  1688. <member name="M:NetCoreServer.HttpsSession.SendResponseBodyAsync(System.ReadOnlySpan{System.Byte})">
  1689. <summary>
  1690. Send the HTTP response body (asynchronous)
  1691. </summary>
  1692. <param name="buffer">HTTP response body buffer as a span of bytes</param>
  1693. <returns>'true' if the HTTP response body was successfully sent, 'false' if the session is not connected</returns>
  1694. </member>
  1695. <member name="M:NetCoreServer.HttpsSession.OnReceivedRequestHeader(NetCoreServer.HttpRequest)">
  1696. <summary>
  1697. Handle HTTP request header received notification
  1698. </summary>
  1699. <remarks>Notification is called when HTTP request header was received from the client.</remarks>
  1700. <param name="request">HTTP request</param>
  1701. </member>
  1702. <member name="M:NetCoreServer.HttpsSession.OnReceivedRequest(NetCoreServer.HttpRequest)">
  1703. <summary>
  1704. Handle HTTP request received notification
  1705. </summary>
  1706. <remarks>Notification is called when HTTP request was received from the client.</remarks>
  1707. <param name="request">HTTP request</param>
  1708. </member>
  1709. <member name="M:NetCoreServer.HttpsSession.OnReceivedCachedRequest(NetCoreServer.HttpRequest,System.Byte[])">
  1710. <summary>
  1711. Handle HTTP cached request received notification
  1712. </summary>
  1713. <remarks>
  1714. Notification is called when HTTP request was received
  1715. from the client and the corresponding cached content
  1716. was found.
  1717. Default behavior is just send cached response content
  1718. to the client.
  1719. </remarks>
  1720. <param name="request">HTTP request</param>
  1721. <param name="content">Cached response content</param>
  1722. </member>
  1723. <member name="M:NetCoreServer.HttpsSession.OnReceivedRequestError(NetCoreServer.HttpRequest,System.String)">
  1724. <summary>
  1725. Handle HTTP request error notification
  1726. </summary>
  1727. <remarks>Notification is called when HTTP request error was received from the client.</remarks>
  1728. <param name="request">HTTP request</param>
  1729. <param name="error">HTTP request error</param>
  1730. </member>
  1731. <member name="T:NetCoreServer.IWebSocket">
  1732. <summary>
  1733. WebSocket interface
  1734. </summary>
  1735. </member>
  1736. <member name="M:NetCoreServer.IWebSocket.OnWsConnecting(NetCoreServer.HttpRequest)">
  1737. <summary>
  1738. Handle WebSocket client connecting notification
  1739. </summary>
  1740. <remarks>Notification is called when WebSocket client is connecting to the server. You can handle the connection and change WebSocket upgrade HTTP request by providing your own headers.</remarks>
  1741. <param name="request">WebSocket upgrade HTTP request</param>
  1742. </member>
  1743. <member name="M:NetCoreServer.IWebSocket.OnWsConnected(NetCoreServer.HttpResponse)">
  1744. <summary>
  1745. Handle WebSocket client connected notification
  1746. </summary>
  1747. <param name="response">WebSocket upgrade HTTP response</param>
  1748. </member>
  1749. <member name="M:NetCoreServer.IWebSocket.OnWsConnecting(NetCoreServer.HttpRequest,NetCoreServer.HttpResponse)">
  1750. <summary>
  1751. Handle WebSocket server session validating notification
  1752. </summary>
  1753. <remarks>Notification is called when WebSocket client is connecting to the server. You can handle the connection and validate WebSocket upgrade HTTP request.</remarks>
  1754. <param name="request">WebSocket upgrade HTTP request</param>
  1755. <param name="response">WebSocket upgrade HTTP response</param>
  1756. <returns>return 'true' if the WebSocket update request is valid, 'false' if the WebSocket update request is not valid</returns>
  1757. </member>
  1758. <member name="M:NetCoreServer.IWebSocket.OnWsConnected(NetCoreServer.HttpRequest)">
  1759. <summary>
  1760. Handle WebSocket server session connected notification
  1761. </summary>
  1762. <param name="request">WebSocket upgrade HTTP request</param>
  1763. </member>
  1764. <member name="M:NetCoreServer.IWebSocket.OnWsDisconnecting">
  1765. <summary>
  1766. Handle WebSocket client disconnecting notification
  1767. </summary>
  1768. </member>
  1769. <member name="M:NetCoreServer.IWebSocket.OnWsDisconnected">
  1770. <summary>
  1771. Handle WebSocket client disconnected notification
  1772. </summary>
  1773. </member>
  1774. <member name="M:NetCoreServer.IWebSocket.OnWsReceived(System.Byte[],System.Int64,System.Int64)">
  1775. <summary>
  1776. Handle WebSocket received notification
  1777. </summary>
  1778. <param name="buffer">Received buffer</param>
  1779. <param name="offset">Received buffer offset</param>
  1780. <param name="size">Received buffer size</param>
  1781. </member>
  1782. <member name="M:NetCoreServer.IWebSocket.OnWsClose(System.Byte[],System.Int64,System.Int64,System.Int32)">
  1783. <summary>
  1784. Handle WebSocket client close notification
  1785. </summary>
  1786. <param name="buffer">Received buffer</param>
  1787. <param name="offset">Received buffer offset</param>
  1788. <param name="size">Received buffer size</param>
  1789. <param name="status">WebSocket close status (default is 1000)</param>
  1790. </member>
  1791. <member name="M:NetCoreServer.IWebSocket.OnWsPing(System.Byte[],System.Int64,System.Int64)">
  1792. <summary>
  1793. Handle WebSocket ping notification
  1794. </summary>
  1795. <param name="buffer">Received buffer</param>
  1796. <param name="offset">Received buffer offset</param>
  1797. <param name="size">Received buffer size</param>
  1798. </member>
  1799. <member name="M:NetCoreServer.IWebSocket.OnWsPong(System.Byte[],System.Int64,System.Int64)">
  1800. <summary>
  1801. Handle WebSocket pong notification
  1802. </summary>
  1803. <param name="buffer">Received buffer</param>
  1804. <param name="offset">Received buffer offset</param>
  1805. <param name="size">Received buffer size</param>
  1806. </member>
  1807. <member name="M:NetCoreServer.IWebSocket.OnWsError(System.String)">
  1808. <summary>
  1809. Handle WebSocket error notification
  1810. </summary>
  1811. <param name="error">Error message</param>
  1812. </member>
  1813. <member name="M:NetCoreServer.IWebSocket.OnWsError(System.Net.Sockets.SocketError)">
  1814. <summary>
  1815. Handle socket error notification
  1816. </summary>
  1817. <param name="error">Socket error</param>
  1818. </member>
  1819. <member name="M:NetCoreServer.IWebSocket.SendUpgrade(NetCoreServer.HttpResponse)">
  1820. <summary>
  1821. Send WebSocket server upgrade response
  1822. </summary>
  1823. <param name="response">WebSocket upgrade HTTP response</param>
  1824. </member>
  1825. <member name="T:NetCoreServer.SslClient">
  1826. <summary>
  1827. SSL client is used to read/write data from/into the connected SSL server
  1828. </summary>
  1829. <remarks>Thread-safe</remarks>
  1830. </member>
  1831. <member name="M:NetCoreServer.SslClient.#ctor(NetCoreServer.SslContext,System.Net.IPAddress,System.Int32)">
  1832. <summary>
  1833. Initialize SSL client with a given server IP address and port number
  1834. </summary>
  1835. <param name="context">SSL context</param>
  1836. <param name="address">IP address</param>
  1837. <param name="port">Port number</param>
  1838. </member>
  1839. <member name="M:NetCoreServer.SslClient.#ctor(NetCoreServer.SslContext,System.String,System.Int32)">
  1840. <summary>
  1841. Initialize SSL client with a given server IP address and port number
  1842. </summary>
  1843. <param name="context">SSL context</param>
  1844. <param name="address">IP address</param>
  1845. <param name="port">Port number</param>
  1846. </member>
  1847. <member name="M:NetCoreServer.SslClient.#ctor(NetCoreServer.SslContext,System.Net.DnsEndPoint)">
  1848. <summary>
  1849. Initialize SSL client with a given DNS endpoint
  1850. </summary>
  1851. <param name="context">SSL context</param>
  1852. <param name="endpoint">DNS endpoint</param>
  1853. </member>
  1854. <member name="M:NetCoreServer.SslClient.#ctor(NetCoreServer.SslContext,System.Net.IPEndPoint)">
  1855. <summary>
  1856. Initialize SSL client with a given IP endpoint
  1857. </summary>
  1858. <param name="context">SSL context</param>
  1859. <param name="endpoint">IP endpoint</param>
  1860. </member>
  1861. <member name="M:NetCoreServer.SslClient.#ctor(NetCoreServer.SslContext,System.Net.EndPoint,System.String,System.Int32)">
  1862. <summary>
  1863. Initialize SSL client with a given SSL context, endpoint, address and port
  1864. </summary>
  1865. <param name="context">SSL context</param>
  1866. <param name="endpoint">Endpoint</param>
  1867. <param name="address">Server address</param>
  1868. <param name="port">Server port</param>
  1869. </member>
  1870. <member name="P:NetCoreServer.SslClient.Id">
  1871. <summary>
  1872. Client Id
  1873. </summary>
  1874. </member>
  1875. <member name="P:NetCoreServer.SslClient.Address">
  1876. <summary>
  1877. SSL server address
  1878. </summary>
  1879. </member>
  1880. <member name="P:NetCoreServer.SslClient.Port">
  1881. <summary>
  1882. SSL server port
  1883. </summary>
  1884. </member>
  1885. <member name="P:NetCoreServer.SslClient.Context">
  1886. <summary>
  1887. SSL context
  1888. </summary>
  1889. </member>
  1890. <member name="P:NetCoreServer.SslClient.Endpoint">
  1891. <summary>
  1892. Endpoint
  1893. </summary>
  1894. </member>
  1895. <member name="P:NetCoreServer.SslClient.Socket">
  1896. <summary>
  1897. Socket
  1898. </summary>
  1899. </member>
  1900. <member name="P:NetCoreServer.SslClient.BytesPending">
  1901. <summary>
  1902. Number of bytes pending sent by the client
  1903. </summary>
  1904. </member>
  1905. <member name="P:NetCoreServer.SslClient.BytesSending">
  1906. <summary>
  1907. Number of bytes sending by the client
  1908. </summary>
  1909. </member>
  1910. <member name="P:NetCoreServer.SslClient.BytesSent">
  1911. <summary>
  1912. Number of bytes sent by the client
  1913. </summary>
  1914. </member>
  1915. <member name="P:NetCoreServer.SslClient.BytesReceived">
  1916. <summary>
  1917. Number of bytes received by the client
  1918. </summary>
  1919. </member>
  1920. <member name="P:NetCoreServer.SslClient.OptionDualMode">
  1921. <summary>
  1922. Option: dual mode socket
  1923. </summary>
  1924. <remarks>
  1925. Specifies whether the Socket is a dual-mode socket used for both IPv4 and IPv6.
  1926. Will work only if socket is bound on IPv6 address.
  1927. </remarks>
  1928. </member>
  1929. <member name="P:NetCoreServer.SslClient.OptionKeepAlive">
  1930. <summary>
  1931. Option: keep alive
  1932. </summary>
  1933. <remarks>
  1934. This option will setup SO_KEEPALIVE if the OS support this feature
  1935. </remarks>
  1936. </member>
  1937. <member name="P:NetCoreServer.SslClient.OptionTcpKeepAliveTime">
  1938. <summary>
  1939. Option: TCP keep alive time
  1940. </summary>
  1941. <remarks>
  1942. The number of seconds a TCP connection will remain alive/idle before keepalive probes are sent to the remote
  1943. </remarks>
  1944. </member>
  1945. <member name="P:NetCoreServer.SslClient.OptionTcpKeepAliveInterval">
  1946. <summary>
  1947. Option: TCP keep alive interval
  1948. </summary>
  1949. <remarks>
  1950. The number of seconds a TCP connection will wait for a keepalive response before sending another keepalive probe
  1951. </remarks>
  1952. </member>
  1953. <member name="P:NetCoreServer.SslClient.OptionTcpKeepAliveRetryCount">
  1954. <summary>
  1955. Option: TCP keep alive retry count
  1956. </summary>
  1957. <remarks>
  1958. The number of TCP keep alive probes that will be sent before the connection is terminated
  1959. </remarks>
  1960. </member>
  1961. <member name="P:NetCoreServer.SslClient.OptionNoDelay">
  1962. <summary>
  1963. Option: no delay
  1964. </summary>
  1965. <remarks>
  1966. This option will enable/disable Nagle's algorithm for SSL protocol
  1967. </remarks>
  1968. </member>
  1969. <member name="P:NetCoreServer.SslClient.OptionReceiveBufferLimit">
  1970. <summary>
  1971. Option: receive buffer limit
  1972. </summary>
  1973. </member>
  1974. <member name="P:NetCoreServer.SslClient.OptionReceiveBufferSize">
  1975. <summary>
  1976. Option: receive buffer size
  1977. </summary>
  1978. </member>
  1979. <member name="P:NetCoreServer.SslClient.OptionSendBufferLimit">
  1980. <summary>
  1981. Option: send buffer limit
  1982. </summary>
  1983. </member>
  1984. <member name="P:NetCoreServer.SslClient.OptionSendBufferSize">
  1985. <summary>
  1986. Option: send buffer size
  1987. </summary>
  1988. </member>
  1989. <member name="P:NetCoreServer.SslClient.IsConnecting">
  1990. <summary>
  1991. Is the client connecting?
  1992. </summary>
  1993. </member>
  1994. <member name="P:NetCoreServer.SslClient.IsConnected">
  1995. <summary>
  1996. Is the client connected?
  1997. </summary>
  1998. </member>
  1999. <member name="P:NetCoreServer.SslClient.IsHandshaking">
  2000. <summary>
  2001. Is the client handshaking?
  2002. </summary>
  2003. </member>
  2004. <member name="P:NetCoreServer.SslClient.IsHandshaked">
  2005. <summary>
  2006. Is the client handshaked?
  2007. </summary>
  2008. </member>
  2009. <member name="M:NetCoreServer.SslClient.CreateSocket">
  2010. <summary>
  2011. Create a new socket object
  2012. </summary>
  2013. <remarks>
  2014. Method may be override if you need to prepare some specific socket object in your implementation.
  2015. </remarks>
  2016. <returns>Socket object</returns>
  2017. </member>
  2018. <member name="M:NetCoreServer.SslClient.Connect">
  2019. <summary>
  2020. Connect the client (synchronous)
  2021. </summary>
  2022. <remarks>
  2023. Please note that synchronous connect will not receive data automatically!
  2024. You should use Receive() or ReceiveAsync() method manually after successful connection.
  2025. </remarks>
  2026. <returns>'true' if the client was successfully connected, 'false' if the client failed to connect</returns>
  2027. </member>
  2028. <member name="M:NetCoreServer.SslClient.Disconnect">
  2029. <summary>
  2030. Disconnect the client (synchronous)
  2031. </summary>
  2032. <returns>'true' if the client was successfully disconnected, 'false' if the client is already disconnected</returns>
  2033. </member>
  2034. <member name="M:NetCoreServer.SslClient.Reconnect">
  2035. <summary>
  2036. Reconnect the client (synchronous)
  2037. </summary>
  2038. <returns>'true' if the client was successfully reconnected, 'false' if the client is already reconnected</returns>
  2039. </member>
  2040. <member name="M:NetCoreServer.SslClient.ConnectAsync">
  2041. <summary>
  2042. Connect the client (asynchronous)
  2043. </summary>
  2044. <returns>'true' if the client was successfully connected, 'false' if the client failed to connect</returns>
  2045. </member>
  2046. <member name="M:NetCoreServer.SslClient.DisconnectAsync">
  2047. <summary>
  2048. Disconnect the client (asynchronous)
  2049. </summary>
  2050. <returns>'true' if the client was successfully disconnected, 'false' if the client is already disconnected</returns>
  2051. </member>
  2052. <member name="M:NetCoreServer.SslClient.ReconnectAsync">
  2053. <summary>
  2054. Reconnect the client (asynchronous)
  2055. </summary>
  2056. <returns>'true' if the client was successfully reconnected, 'false' if the client is already reconnected</returns>
  2057. </member>
  2058. <member name="M:NetCoreServer.SslClient.Send(System.Byte[])">
  2059. <summary>
  2060. Send data to the server (synchronous)
  2061. </summary>
  2062. <param name="buffer">Buffer to send</param>
  2063. <returns>Size of sent data</returns>
  2064. </member>
  2065. <member name="M:NetCoreServer.SslClient.Send(System.Byte[],System.Int64,System.Int64)">
  2066. <summary>
  2067. Send data to the server (synchronous)
  2068. </summary>
  2069. <param name="buffer">Buffer to send</param>
  2070. <param name="offset">Buffer offset</param>
  2071. <param name="size">Buffer size</param>
  2072. <returns>Size of sent data</returns>
  2073. </member>
  2074. <member name="M:NetCoreServer.SslClient.Send(System.ReadOnlySpan{System.Byte})">
  2075. <summary>
  2076. Send data to the server (synchronous)
  2077. </summary>
  2078. <param name="buffer">Buffer to send as a span of bytes</param>
  2079. <returns>Size of sent data</returns>
  2080. </member>
  2081. <member name="M:NetCoreServer.SslClient.Send(System.String)">
  2082. <summary>
  2083. Send text to the server (synchronous)
  2084. </summary>
  2085. <param name="text">Text string to send</param>
  2086. <returns>Size of sent text</returns>
  2087. </member>
  2088. <member name="M:NetCoreServer.SslClient.Send(System.ReadOnlySpan{System.Char})">
  2089. <summary>
  2090. Send text to the server (synchronous)
  2091. </summary>
  2092. <param name="text">Text to send as a span of characters</param>
  2093. <returns>Size of sent text</returns>
  2094. </member>
  2095. <member name="M:NetCoreServer.SslClient.SendAsync(System.Byte[])">
  2096. <summary>
  2097. Send data to the server (asynchronous)
  2098. </summary>
  2099. <param name="buffer">Buffer to send</param>
  2100. <returns>'true' if the data was successfully sent, 'false' if the client is not connected</returns>
  2101. </member>
  2102. <member name="M:NetCoreServer.SslClient.SendAsync(System.Byte[],System.Int64,System.Int64)">
  2103. <summary>
  2104. Send data to the server (asynchronous)
  2105. </summary>
  2106. <param name="buffer">Buffer to send</param>
  2107. <param name="offset">Buffer offset</param>
  2108. <param name="size">Buffer size</param>
  2109. <returns>'true' if the data was successfully sent, 'false' if the client is not connected</returns>
  2110. </member>
  2111. <member name="M:NetCoreServer.SslClient.SendAsync(System.ReadOnlySpan{System.Byte})">
  2112. <summary>
  2113. Send data to the server (asynchronous)
  2114. </summary>
  2115. <param name="buffer">Buffer to send as a span of bytes</param>
  2116. <returns>'true' if the data was successfully sent, 'false' if the client is not connected</returns>
  2117. </member>
  2118. <member name="M:NetCoreServer.SslClient.SendAsync(System.String)">
  2119. <summary>
  2120. Send text to the server (asynchronous)
  2121. </summary>
  2122. <param name="text">Text string to send</param>
  2123. <returns>'true' if the text was successfully sent, 'false' if the client is not connected</returns>
  2124. </member>
  2125. <member name="M:NetCoreServer.SslClient.SendAsync(System.ReadOnlySpan{System.Char})">
  2126. <summary>
  2127. Send text to the server (asynchronous)
  2128. </summary>
  2129. <param name="text">Text to send as a span of characters</param>
  2130. <returns>'true' if the text was successfully sent, 'false' if the client is not connected</returns>
  2131. </member>
  2132. <member name="M:NetCoreServer.SslClient.Receive(System.Byte[])">
  2133. <summary>
  2134. Receive data from the server (synchronous)
  2135. </summary>
  2136. <param name="buffer">Buffer to receive</param>
  2137. <returns>Size of received data</returns>
  2138. </member>
  2139. <member name="M:NetCoreServer.SslClient.Receive(System.Byte[],System.Int64,System.Int64)">
  2140. <summary>
  2141. Receive data from the server (synchronous)
  2142. </summary>
  2143. <param name="buffer">Buffer to receive</param>
  2144. <param name="offset">Buffer offset</param>
  2145. <param name="size">Buffer size</param>
  2146. <returns>Size of received data</returns>
  2147. </member>
  2148. <member name="M:NetCoreServer.SslClient.Receive(System.Int64)">
  2149. <summary>
  2150. Receive text from the server (synchronous)
  2151. </summary>
  2152. <param name="size">Text size to receive</param>
  2153. <returns>Received text</returns>
  2154. </member>
  2155. <member name="M:NetCoreServer.SslClient.ReceiveAsync">
  2156. <summary>
  2157. Receive data from the server (asynchronous)
  2158. </summary>
  2159. </member>
  2160. <member name="M:NetCoreServer.SslClient.TryReceive">
  2161. <summary>
  2162. Try to receive new data
  2163. </summary>
  2164. </member>
  2165. <member name="M:NetCoreServer.SslClient.TrySend">
  2166. <summary>
  2167. Try to send pending data
  2168. </summary>
  2169. </member>
  2170. <member name="M:NetCoreServer.SslClient.ClearBuffers">
  2171. <summary>
  2172. Clear send/receive buffers
  2173. </summary>
  2174. </member>
  2175. <member name="M:NetCoreServer.SslClient.OnAsyncCompleted(System.Object,System.Net.Sockets.SocketAsyncEventArgs)">
  2176. <summary>
  2177. This method is called whenever a receive or send operation is completed on a socket
  2178. </summary>
  2179. </member>
  2180. <member name="M:NetCoreServer.SslClient.ProcessConnect(System.Net.Sockets.SocketAsyncEventArgs)">
  2181. <summary>
  2182. This method is invoked when an asynchronous connect operation completes
  2183. </summary>
  2184. </member>
  2185. <member name="M:NetCoreServer.SslClient.ProcessHandshake(System.IAsyncResult)">
  2186. <summary>
  2187. This method is invoked when an asynchronous handshake operation completes
  2188. </summary>
  2189. </member>
  2190. <member name="M:NetCoreServer.SslClient.ProcessReceive(System.IAsyncResult)">
  2191. <summary>
  2192. This method is invoked when an asynchronous receive operation completes
  2193. </summary>
  2194. </member>
  2195. <member name="M:NetCoreServer.SslClient.ProcessSend(System.IAsyncResult)">
  2196. <summary>
  2197. This method is invoked when an asynchronous send operation completes
  2198. </summary>
  2199. </member>
  2200. <member name="M:NetCoreServer.SslClient.OnConnecting">
  2201. <summary>
  2202. Handle client connecting notification
  2203. </summary>
  2204. </member>
  2205. <member name="M:NetCoreServer.SslClient.OnConnected">
  2206. <summary>
  2207. Handle client connected notification
  2208. </summary>
  2209. </member>
  2210. <member name="M:NetCoreServer.SslClient.OnHandshaking">
  2211. <summary>
  2212. Handle client handshaking notification
  2213. </summary>
  2214. </member>
  2215. <member name="M:NetCoreServer.SslClient.OnHandshaked">
  2216. <summary>
  2217. Handle client handshaked notification
  2218. </summary>
  2219. </member>
  2220. <member name="M:NetCoreServer.SslClient.OnDisconnecting">
  2221. <summary>
  2222. Handle client disconnecting notification
  2223. </summary>
  2224. </member>
  2225. <member name="M:NetCoreServer.SslClient.OnDisconnected">
  2226. <summary>
  2227. Handle client disconnected notification
  2228. </summary>
  2229. </member>
  2230. <member name="M:NetCoreServer.SslClient.OnReceived(System.Byte[],System.Int64,System.Int64)">
  2231. <summary>
  2232. Handle buffer received notification
  2233. </summary>
  2234. <param name="buffer">Received buffer</param>
  2235. <param name="offset">Received buffer offset</param>
  2236. <param name="size">Received buffer size</param>
  2237. <remarks>
  2238. Notification is called when another part of buffer was received from the server
  2239. </remarks>
  2240. </member>
  2241. <member name="M:NetCoreServer.SslClient.OnSent(System.Int64,System.Int64)">
  2242. <summary>
  2243. Handle buffer sent notification
  2244. </summary>
  2245. <param name="sent">Size of sent buffer</param>
  2246. <param name="pending">Size of pending buffer</param>
  2247. <remarks>
  2248. Notification is called when another part of buffer was sent to the server.
  2249. This handler could be used to send another buffer to the server for instance when the pending size is zero.
  2250. </remarks>
  2251. </member>
  2252. <member name="M:NetCoreServer.SslClient.OnEmpty">
  2253. <summary>
  2254. Handle empty send buffer notification
  2255. </summary>
  2256. <remarks>
  2257. Notification is called when the send buffer is empty and ready for a new data to send.
  2258. This handler could be used to send another buffer to the server.
  2259. </remarks>
  2260. </member>
  2261. <member name="M:NetCoreServer.SslClient.OnError(System.Net.Sockets.SocketError)">
  2262. <summary>
  2263. Handle error notification
  2264. </summary>
  2265. <param name="error">Socket error code</param>
  2266. </member>
  2267. <member name="M:NetCoreServer.SslClient.SendError(System.Net.Sockets.SocketError)">
  2268. <summary>
  2269. Send error notification
  2270. </summary>
  2271. <param name="error">Socket error code</param>
  2272. </member>
  2273. <member name="P:NetCoreServer.SslClient.IsDisposed">
  2274. <summary>
  2275. Disposed flag
  2276. </summary>
  2277. </member>
  2278. <member name="P:NetCoreServer.SslClient.IsSocketDisposed">
  2279. <summary>
  2280. Client socket disposed flag
  2281. </summary>
  2282. </member>
  2283. <member name="T:NetCoreServer.SslContext">
  2284. <summary>
  2285. SSL context
  2286. </summary>
  2287. </member>
  2288. <member name="M:NetCoreServer.SslContext.#ctor">
  2289. <summary>
  2290. Initialize SSL context with default protocols
  2291. </summary>
  2292. </member>
  2293. <member name="M:NetCoreServer.SslContext.#ctor(System.Security.Authentication.SslProtocols)">
  2294. <summary>
  2295. Initialize SSL context with given protocols
  2296. </summary>
  2297. <param name="protocols">SSL protocols</param>
  2298. </member>
  2299. <member name="M:NetCoreServer.SslContext.#ctor(System.Security.Authentication.SslProtocols,System.Net.Security.RemoteCertificateValidationCallback)">
  2300. <summary>
  2301. Initialize SSL context with given protocols and validation callback
  2302. </summary>
  2303. <param name="protocols">SSL protocols</param>
  2304. <param name="certificateValidationCallback">SSL certificate</param>
  2305. </member>
  2306. <member name="M:NetCoreServer.SslContext.#ctor(System.Security.Authentication.SslProtocols,System.Security.Cryptography.X509Certificates.X509Certificate)">
  2307. <summary>
  2308. Initialize SSL context with given protocols and certificate
  2309. </summary>
  2310. <param name="protocols">SSL protocols</param>
  2311. <param name="certificate">SSL certificate</param>
  2312. </member>
  2313. <member name="M:NetCoreServer.SslContext.#ctor(System.Security.Authentication.SslProtocols,System.Security.Cryptography.X509Certificates.X509Certificate,System.Net.Security.RemoteCertificateValidationCallback)">
  2314. <summary>
  2315. Initialize SSL context with given protocols, certificate and validation callback
  2316. </summary>
  2317. <param name="protocols">SSL protocols</param>
  2318. <param name="certificate">SSL certificate</param>
  2319. <param name="certificateValidationCallback">SSL certificate</param>
  2320. </member>
  2321. <member name="M:NetCoreServer.SslContext.#ctor(System.Security.Authentication.SslProtocols,System.Security.Cryptography.X509Certificates.X509Certificate2Collection)">
  2322. <summary>
  2323. Initialize SSL context with given protocols and certificates collection
  2324. </summary>
  2325. <param name="protocols">SSL protocols</param>
  2326. <param name="certificates">SSL certificates collection</param>
  2327. </member>
  2328. <member name="M:NetCoreServer.SslContext.#ctor(System.Security.Authentication.SslProtocols,System.Security.Cryptography.X509Certificates.X509Certificate2Collection,System.Net.Security.RemoteCertificateValidationCallback)">
  2329. <summary>
  2330. Initialize SSL context with given protocols, certificates collection and validation callback
  2331. </summary>
  2332. <param name="protocols">SSL protocols</param>
  2333. <param name="certificates">SSL certificates collection</param>
  2334. <param name="certificateValidationCallback">SSL certificate</param>
  2335. </member>
  2336. <member name="P:NetCoreServer.SslContext.Protocols">
  2337. <summary>
  2338. SSL protocols
  2339. </summary>
  2340. </member>
  2341. <member name="P:NetCoreServer.SslContext.Certificate">
  2342. <summary>
  2343. SSL certificate
  2344. </summary>
  2345. </member>
  2346. <member name="P:NetCoreServer.SslContext.Certificates">
  2347. <summary>
  2348. SSL certificates collection
  2349. </summary>
  2350. </member>
  2351. <member name="P:NetCoreServer.SslContext.CertificateValidationCallback">
  2352. <summary>
  2353. SSL certificate validation callback
  2354. </summary>
  2355. </member>
  2356. <member name="P:NetCoreServer.SslContext.ClientCertificateRequired">
  2357. <summary>
  2358. Is the client is asked for a certificate for authentication.
  2359. Note that this is only a request - if no certificate is provided, the server still accepts the connection request.
  2360. </summary>
  2361. </member>
  2362. <member name="T:NetCoreServer.SslServer">
  2363. <summary>
  2364. SSL server is used to connect, disconnect and manage SSL sessions
  2365. </summary>
  2366. <remarks>Thread-safe</remarks>
  2367. </member>
  2368. <member name="M:NetCoreServer.SslServer.#ctor(NetCoreServer.SslContext,System.Net.IPAddress,System.Int32)">
  2369. <summary>
  2370. Initialize SSL server with a given IP address and port number
  2371. </summary>
  2372. <param name="context">SSL context</param>
  2373. <param name="address">IP address</param>
  2374. <param name="port">Port number</param>
  2375. </member>
  2376. <member name="M:NetCoreServer.SslServer.#ctor(NetCoreServer.SslContext,System.String,System.Int32)">
  2377. <summary>
  2378. Initialize SSL server with a given IP address and port number
  2379. </summary>
  2380. <param name="context">SSL context</param>
  2381. <param name="address">IP address</param>
  2382. <param name="port">Port number</param>
  2383. </member>
  2384. <member name="M:NetCoreServer.SslServer.#ctor(NetCoreServer.SslContext,System.Net.DnsEndPoint)">
  2385. <summary>
  2386. Initialize SSL server with a given DNS endpoint
  2387. </summary>
  2388. <param name="context">SSL context</param>
  2389. <param name="endpoint">DNS endpoint</param>
  2390. </member>
  2391. <member name="M:NetCoreServer.SslServer.#ctor(NetCoreServer.SslContext,System.Net.IPEndPoint)">
  2392. <summary>
  2393. Initialize SSL server with a given IP endpoint
  2394. </summary>
  2395. <param name="context">SSL context</param>
  2396. <param name="endpoint">IP endpoint</param>
  2397. </member>
  2398. <member name="M:NetCoreServer.SslServer.#ctor(NetCoreServer.SslContext,System.Net.EndPoint,System.String,System.Int32)">
  2399. <summary>
  2400. Initialize SSL server with a given SSL context, endpoint, address and port
  2401. </summary>
  2402. <param name="context">SSL context</param>
  2403. <param name="endpoint">Endpoint</param>
  2404. <param name="address">Server address</param>
  2405. <param name="port">Server port</param>
  2406. </member>
  2407. <member name="P:NetCoreServer.SslServer.Id">
  2408. <summary>
  2409. Server Id
  2410. </summary>
  2411. </member>
  2412. <member name="P:NetCoreServer.SslServer.Address">
  2413. <summary>
  2414. SSL server address
  2415. </summary>
  2416. </member>
  2417. <member name="P:NetCoreServer.SslServer.Port">
  2418. <summary>
  2419. SSL server port
  2420. </summary>
  2421. </member>
  2422. <member name="P:NetCoreServer.SslServer.Context">
  2423. <summary>
  2424. SSL context
  2425. </summary>
  2426. </member>
  2427. <member name="P:NetCoreServer.SslServer.Endpoint">
  2428. <summary>
  2429. Endpoint
  2430. </summary>
  2431. </member>
  2432. <member name="P:NetCoreServer.SslServer.ConnectedSessions">
  2433. <summary>
  2434. Number of sessions connected to the server
  2435. </summary>
  2436. </member>
  2437. <member name="P:NetCoreServer.SslServer.BytesPending">
  2438. <summary>
  2439. Number of bytes pending sent by the server
  2440. </summary>
  2441. </member>
  2442. <member name="P:NetCoreServer.SslServer.BytesSent">
  2443. <summary>
  2444. Number of bytes sent by the server
  2445. </summary>
  2446. </member>
  2447. <member name="P:NetCoreServer.SslServer.BytesReceived">
  2448. <summary>
  2449. Number of bytes received by the server
  2450. </summary>
  2451. </member>
  2452. <member name="P:NetCoreServer.SslServer.OptionAcceptorBacklog">
  2453. <summary>
  2454. Option: acceptor backlog size
  2455. </summary>
  2456. <remarks>
  2457. This option will set the listening socket's backlog size
  2458. </remarks>
  2459. </member>
  2460. <member name="P:NetCoreServer.SslServer.OptionDualMode">
  2461. <summary>
  2462. Option: dual mode socket
  2463. </summary>
  2464. <remarks>
  2465. Specifies whether the Socket is a dual-mode socket used for both IPv4 and IPv6.
  2466. Will work only if socket is bound on IPv6 address.
  2467. </remarks>
  2468. </member>
  2469. <member name="P:NetCoreServer.SslServer.OptionKeepAlive">
  2470. <summary>
  2471. Option: keep alive
  2472. </summary>
  2473. <remarks>
  2474. This option will setup SO_KEEPALIVE if the OS support this feature
  2475. </remarks>
  2476. </member>
  2477. <member name="P:NetCoreServer.SslServer.OptionTcpKeepAliveTime">
  2478. <summary>
  2479. Option: TCP keep alive time
  2480. </summary>
  2481. <remarks>
  2482. The number of seconds a TCP connection will remain alive/idle before keepalive probes are sent to the remote
  2483. </remarks>
  2484. </member>
  2485. <member name="P:NetCoreServer.SslServer.OptionTcpKeepAliveInterval">
  2486. <summary>
  2487. Option: TCP keep alive interval
  2488. </summary>
  2489. <remarks>
  2490. The number of seconds a TCP connection will wait for a keepalive response before sending another keepalive probe
  2491. </remarks>
  2492. </member>
  2493. <member name="P:NetCoreServer.SslServer.OptionTcpKeepAliveRetryCount">
  2494. <summary>
  2495. Option: TCP keep alive retry count
  2496. </summary>
  2497. <remarks>
  2498. The number of TCP keep alive probes that will be sent before the connection is terminated
  2499. </remarks>
  2500. </member>
  2501. <member name="P:NetCoreServer.SslServer.OptionNoDelay">
  2502. <summary>
  2503. Option: no delay
  2504. </summary>
  2505. <remarks>
  2506. This option will enable/disable Nagle's algorithm for SSL protocol
  2507. </remarks>
  2508. </member>
  2509. <member name="P:NetCoreServer.SslServer.OptionReuseAddress">
  2510. <summary>
  2511. Option: reuse address
  2512. </summary>
  2513. <remarks>
  2514. This option will enable/disable SO_REUSEADDR if the OS support this feature
  2515. </remarks>
  2516. </member>
  2517. <member name="P:NetCoreServer.SslServer.OptionExclusiveAddressUse">
  2518. <summary>
  2519. Option: enables a socket to be bound for exclusive access
  2520. </summary>
  2521. <remarks>
  2522. This option will enable/disable SO_EXCLUSIVEADDRUSE if the OS support this feature
  2523. </remarks>
  2524. </member>
  2525. <member name="P:NetCoreServer.SslServer.OptionReceiveBufferSize">
  2526. <summary>
  2527. Option: receive buffer size
  2528. </summary>
  2529. </member>
  2530. <member name="P:NetCoreServer.SslServer.OptionSendBufferSize">
  2531. <summary>
  2532. Option: send buffer size
  2533. </summary>
  2534. </member>
  2535. <member name="P:NetCoreServer.SslServer.IsStarted">
  2536. <summary>
  2537. Is the server started?
  2538. </summary>
  2539. </member>
  2540. <member name="P:NetCoreServer.SslServer.IsAccepting">
  2541. <summary>
  2542. Is the server accepting new clients?
  2543. </summary>
  2544. </member>
  2545. <member name="M:NetCoreServer.SslServer.CreateSocket">
  2546. <summary>
  2547. Create a new socket object
  2548. </summary>
  2549. <remarks>
  2550. Method may be override if you need to prepare some specific socket object in your implementation.
  2551. </remarks>
  2552. <returns>Socket object</returns>
  2553. </member>
  2554. <member name="M:NetCoreServer.SslServer.Start">
  2555. <summary>
  2556. Start the server
  2557. </summary>
  2558. <returns>'true' if the server was successfully started, 'false' if the server failed to start</returns>
  2559. </member>
  2560. <member name="M:NetCoreServer.SslServer.Stop">
  2561. <summary>
  2562. Stop the server
  2563. </summary>
  2564. <returns>'true' if the server was successfully stopped, 'false' if the server is already stopped</returns>
  2565. </member>
  2566. <member name="M:NetCoreServer.SslServer.Restart">
  2567. <summary>
  2568. Restart the server
  2569. </summary>
  2570. <returns>'true' if the server was successfully restarted, 'false' if the server failed to restart</returns>
  2571. </member>
  2572. <member name="M:NetCoreServer.SslServer.StartAccept(System.Net.Sockets.SocketAsyncEventArgs)">
  2573. <summary>
  2574. Start accept a new client connection
  2575. </summary>
  2576. </member>
  2577. <member name="M:NetCoreServer.SslServer.ProcessAccept(System.Net.Sockets.SocketAsyncEventArgs)">
  2578. <summary>
  2579. Process accepted client connection
  2580. </summary>
  2581. </member>
  2582. <member name="M:NetCoreServer.SslServer.OnAsyncCompleted(System.Object,System.Net.Sockets.SocketAsyncEventArgs)">
  2583. <summary>
  2584. This method is the callback method associated with Socket.AcceptAsync()
  2585. operations and is invoked when an accept operation is complete
  2586. </summary>
  2587. </member>
  2588. <member name="M:NetCoreServer.SslServer.CreateSession">
  2589. <summary>
  2590. Create SSL session factory method
  2591. </summary>
  2592. <returns>SSL session</returns>
  2593. </member>
  2594. <member name="F:NetCoreServer.SslServer.Sessions">
  2595. <summary>
  2596. Server sessions
  2597. </summary>
  2598. </member>
  2599. <member name="M:NetCoreServer.SslServer.DisconnectAll">
  2600. <summary>
  2601. Disconnect all connected sessions
  2602. </summary>
  2603. <returns>'true' if all sessions were successfully disconnected, 'false' if the server is not started</returns>
  2604. </member>
  2605. <member name="M:NetCoreServer.SslServer.FindSession(System.Guid)">
  2606. <summary>
  2607. Find a session with a given Id
  2608. </summary>
  2609. <param name="id">Session Id</param>
  2610. <returns>Session with a given Id or null if the session it not connected</returns>
  2611. </member>
  2612. <member name="M:NetCoreServer.SslServer.RegisterSession(NetCoreServer.SslSession)">
  2613. <summary>
  2614. Register a new session
  2615. </summary>
  2616. <param name="session">Session to register</param>
  2617. </member>
  2618. <member name="M:NetCoreServer.SslServer.UnregisterSession(System.Guid)">
  2619. <summary>
  2620. Unregister session by Id
  2621. </summary>
  2622. <param name="id">Session Id</param>
  2623. </member>
  2624. <member name="M:NetCoreServer.SslServer.Multicast(System.Byte[])">
  2625. <summary>
  2626. Multicast data to all connected sessions
  2627. </summary>
  2628. <param name="buffer">Buffer to multicast</param>
  2629. <returns>'true' if the data was successfully multicasted, 'false' if the data was not multicasted</returns>
  2630. </member>
  2631. <member name="M:NetCoreServer.SslServer.Multicast(System.Byte[],System.Int64,System.Int64)">
  2632. <summary>
  2633. Multicast data to all connected clients
  2634. </summary>
  2635. <param name="buffer">Buffer to multicast</param>
  2636. <param name="offset">Buffer offset</param>
  2637. <param name="size">Buffer size</param>
  2638. <returns>'true' if the data was successfully multicasted, 'false' if the data was not multicasted</returns>
  2639. </member>
  2640. <member name="M:NetCoreServer.SslServer.Multicast(System.ReadOnlySpan{System.Byte})">
  2641. <summary>
  2642. Multicast data to all connected clients
  2643. </summary>
  2644. <param name="buffer">Buffer to send as a span of bytes</param>
  2645. <returns>'true' if the data was successfully multicasted, 'false' if the data was not multicasted</returns>
  2646. </member>
  2647. <member name="M:NetCoreServer.SslServer.Multicast(System.String)">
  2648. <summary>
  2649. Multicast text to all connected clients
  2650. </summary>
  2651. <param name="text">Text string to multicast</param>
  2652. <returns>'true' if the text was successfully multicasted, 'false' if the text was not multicasted</returns>
  2653. </member>
  2654. <member name="M:NetCoreServer.SslServer.Multicast(System.ReadOnlySpan{System.Char})">
  2655. <summary>
  2656. Multicast text to all connected clients
  2657. </summary>
  2658. <param name="text">Text to multicast as a span of characters</param>
  2659. <returns>'true' if the text was successfully multicasted, 'false' if the text was not multicasted</returns>
  2660. </member>
  2661. <member name="M:NetCoreServer.SslServer.OnStarting">
  2662. <summary>
  2663. Handle server starting notification
  2664. </summary>
  2665. </member>
  2666. <member name="M:NetCoreServer.SslServer.OnStarted">
  2667. <summary>
  2668. Handle server started notification
  2669. </summary>
  2670. </member>
  2671. <member name="M:NetCoreServer.SslServer.OnStopping">
  2672. <summary>
  2673. Handle server stopping notification
  2674. </summary>
  2675. </member>
  2676. <member name="M:NetCoreServer.SslServer.OnStopped">
  2677. <summary>
  2678. Handle server stopped notification
  2679. </summary>
  2680. </member>
  2681. <member name="M:NetCoreServer.SslServer.OnConnecting(NetCoreServer.SslSession)">
  2682. <summary>
  2683. Handle session connecting notification
  2684. </summary>
  2685. <param name="session">Connecting session</param>
  2686. </member>
  2687. <member name="M:NetCoreServer.SslServer.OnConnected(NetCoreServer.SslSession)">
  2688. <summary>
  2689. Handle session connected notification
  2690. </summary>
  2691. <param name="session">Connected session</param>
  2692. </member>
  2693. <member name="M:NetCoreServer.SslServer.OnHandshaking(NetCoreServer.SslSession)">
  2694. <summary>
  2695. Handle session handshaking notification
  2696. </summary>
  2697. <param name="session">Handshaking session</param>
  2698. </member>
  2699. <member name="M:NetCoreServer.SslServer.OnHandshaked(NetCoreServer.SslSession)">
  2700. <summary>
  2701. Handle session handshaked notification
  2702. </summary>
  2703. <param name="session">Handshaked session</param>
  2704. </member>
  2705. <member name="M:NetCoreServer.SslServer.OnDisconnecting(NetCoreServer.SslSession)">
  2706. <summary>
  2707. Handle session disconnecting notification
  2708. </summary>
  2709. <param name="session">Disconnecting session</param>
  2710. </member>
  2711. <member name="M:NetCoreServer.SslServer.OnDisconnected(NetCoreServer.SslSession)">
  2712. <summary>
  2713. Handle session disconnected notification
  2714. </summary>
  2715. <param name="session">Disconnected session</param>
  2716. </member>
  2717. <member name="M:NetCoreServer.SslServer.OnError(System.Net.Sockets.SocketError)">
  2718. <summary>
  2719. Handle error notification
  2720. </summary>
  2721. <param name="error">Socket error code</param>
  2722. </member>
  2723. <member name="M:NetCoreServer.SslServer.SendError(System.Net.Sockets.SocketError)">
  2724. <summary>
  2725. Send error notification
  2726. </summary>
  2727. <param name="error">Socket error code</param>
  2728. </member>
  2729. <member name="P:NetCoreServer.SslServer.IsDisposed">
  2730. <summary>
  2731. Disposed flag
  2732. </summary>
  2733. </member>
  2734. <member name="P:NetCoreServer.SslServer.IsSocketDisposed">
  2735. <summary>
  2736. Acceptor socket disposed flag
  2737. </summary>
  2738. </member>
  2739. <member name="T:NetCoreServer.SslSession">
  2740. <summary>
  2741. SSL session is used to read and write data from the connected SSL client
  2742. </summary>
  2743. <remarks>Thread-safe</remarks>
  2744. </member>
  2745. <member name="M:NetCoreServer.SslSession.#ctor(NetCoreServer.SslServer)">
  2746. <summary>
  2747. Initialize the session with a given server
  2748. </summary>
  2749. <param name="server">SSL server</param>
  2750. </member>
  2751. <member name="P:NetCoreServer.SslSession.Id">
  2752. <summary>
  2753. Session Id
  2754. </summary>
  2755. </member>
  2756. <member name="P:NetCoreServer.SslSession.Server">
  2757. <summary>
  2758. Server
  2759. </summary>
  2760. </member>
  2761. <member name="P:NetCoreServer.SslSession.Socket">
  2762. <summary>
  2763. Socket
  2764. </summary>
  2765. </member>
  2766. <member name="P:NetCoreServer.SslSession.BytesPending">
  2767. <summary>
  2768. Number of bytes pending sent by the session
  2769. </summary>
  2770. </member>
  2771. <member name="P:NetCoreServer.SslSession.BytesSending">
  2772. <summary>
  2773. Number of bytes sending by the session
  2774. </summary>
  2775. </member>
  2776. <member name="P:NetCoreServer.SslSession.BytesSent">
  2777. <summary>
  2778. Number of bytes sent by the session
  2779. </summary>
  2780. </member>
  2781. <member name="P:NetCoreServer.SslSession.BytesReceived">
  2782. <summary>
  2783. Number of bytes received by the session
  2784. </summary>
  2785. </member>
  2786. <member name="P:NetCoreServer.SslSession.OptionReceiveBufferLimit">
  2787. <summary>
  2788. Option: receive buffer limit
  2789. </summary>
  2790. </member>
  2791. <member name="P:NetCoreServer.SslSession.OptionReceiveBufferSize">
  2792. <summary>
  2793. Option: receive buffer size
  2794. </summary>
  2795. </member>
  2796. <member name="P:NetCoreServer.SslSession.OptionSendBufferLimit">
  2797. <summary>
  2798. Option: send buffer limit
  2799. </summary>
  2800. </member>
  2801. <member name="P:NetCoreServer.SslSession.OptionSendBufferSize">
  2802. <summary>
  2803. Option: send buffer size
  2804. </summary>
  2805. </member>
  2806. <member name="P:NetCoreServer.SslSession.IsConnected">
  2807. <summary>
  2808. Is the session connected?
  2809. </summary>
  2810. </member>
  2811. <member name="P:NetCoreServer.SslSession.IsHandshaked">
  2812. <summary>
  2813. Is the session handshaked?
  2814. </summary>
  2815. </member>
  2816. <member name="M:NetCoreServer.SslSession.Connect(System.Net.Sockets.Socket)">
  2817. <summary>
  2818. Connect the session
  2819. </summary>
  2820. <param name="socket">Session socket</param>
  2821. </member>
  2822. <member name="M:NetCoreServer.SslSession.Disconnect">
  2823. <summary>
  2824. Disconnect the session
  2825. </summary>
  2826. <returns>'true' if the section was successfully disconnected, 'false' if the section is already disconnected</returns>
  2827. </member>
  2828. <member name="M:NetCoreServer.SslSession.Send(System.Byte[])">
  2829. <summary>
  2830. Send data to the client (synchronous)
  2831. </summary>
  2832. <param name="buffer">Buffer to send</param>
  2833. <returns>Size of sent data</returns>
  2834. </member>
  2835. <member name="M:NetCoreServer.SslSession.Send(System.Byte[],System.Int64,System.Int64)">
  2836. <summary>
  2837. Send data to the client (synchronous)
  2838. </summary>
  2839. <param name="buffer">Buffer to send</param>
  2840. <param name="offset">Buffer offset</param>
  2841. <param name="size">Buffer size</param>
  2842. <returns>Size of sent data</returns>
  2843. </member>
  2844. <member name="M:NetCoreServer.SslSession.Send(System.ReadOnlySpan{System.Byte})">
  2845. <summary>
  2846. Send data to the client (synchronous)
  2847. </summary>
  2848. <param name="buffer">Buffer to send as a span of bytes</param>
  2849. <returns>Size of sent data</returns>
  2850. </member>
  2851. <member name="M:NetCoreServer.SslSession.Send(System.String)">
  2852. <summary>
  2853. Send text to the client (synchronous)
  2854. </summary>
  2855. <param name="text">Text string to send</param>
  2856. <returns>Size of sent text</returns>
  2857. </member>
  2858. <member name="M:NetCoreServer.SslSession.Send(System.ReadOnlySpan{System.Char})">
  2859. <summary>
  2860. Send text to the client (synchronous)
  2861. </summary>
  2862. <param name="text">Text to send as a span of characters</param>
  2863. <returns>Size of sent text</returns>
  2864. </member>
  2865. <member name="M:NetCoreServer.SslSession.SendAsync(System.Byte[])">
  2866. <summary>
  2867. Send data to the client (asynchronous)
  2868. </summary>
  2869. <param name="buffer">Buffer to send</param>
  2870. <returns>'true' if the data was successfully sent, 'false' if the session is not connected</returns>
  2871. </member>
  2872. <member name="M:NetCoreServer.SslSession.SendAsync(System.Byte[],System.Int64,System.Int64)">
  2873. <summary>
  2874. Send data to the client (asynchronous)
  2875. </summary>
  2876. <param name="buffer">Buffer to send</param>
  2877. <param name="offset">Buffer offset</param>
  2878. <param name="size">Buffer size</param>
  2879. <returns>'true' if the data was successfully sent, 'false' if the session is not connected</returns>
  2880. </member>
  2881. <member name="M:NetCoreServer.SslSession.SendAsync(System.ReadOnlySpan{System.Byte})">
  2882. <summary>
  2883. Send data to the client (asynchronous)
  2884. </summary>
  2885. <param name="buffer">Buffer to send as a span of bytes</param>
  2886. <returns>'true' if the data was successfully sent, 'false' if the session is not connected</returns>
  2887. </member>
  2888. <member name="M:NetCoreServer.SslSession.SendAsync(System.String)">
  2889. <summary>
  2890. Send text to the client (asynchronous)
  2891. </summary>
  2892. <param name="text">Text string to send</param>
  2893. <returns>'true' if the text was successfully sent, 'false' if the session is not connected</returns>
  2894. </member>
  2895. <member name="M:NetCoreServer.SslSession.SendAsync(System.ReadOnlySpan{System.Char})">
  2896. <summary>
  2897. Send text to the client (asynchronous)
  2898. </summary>
  2899. <param name="text">Text to send as a span of characters</param>
  2900. <returns>'true' if the text was successfully sent, 'false' if the session is not connected</returns>
  2901. </member>
  2902. <member name="M:NetCoreServer.SslSession.Receive(System.Byte[])">
  2903. <summary>
  2904. Receive data from the client (synchronous)
  2905. </summary>
  2906. <param name="buffer">Buffer to receive</param>
  2907. <returns>Size of received data</returns>
  2908. </member>
  2909. <member name="M:NetCoreServer.SslSession.Receive(System.Byte[],System.Int64,System.Int64)">
  2910. <summary>
  2911. Receive data from the client (synchronous)
  2912. </summary>
  2913. <param name="buffer">Buffer to receive</param>
  2914. <param name="offset">Buffer offset</param>
  2915. <param name="size">Buffer size</param>
  2916. <returns>Size of received data</returns>
  2917. </member>
  2918. <member name="M:NetCoreServer.SslSession.Receive(System.Int64)">
  2919. <summary>
  2920. Receive text from the client (synchronous)
  2921. </summary>
  2922. <param name="size">Text size to receive</param>
  2923. <returns>Received text</returns>
  2924. </member>
  2925. <member name="M:NetCoreServer.SslSession.ReceiveAsync">
  2926. <summary>
  2927. Receive data from the client (asynchronous)
  2928. </summary>
  2929. </member>
  2930. <member name="M:NetCoreServer.SslSession.TryReceive">
  2931. <summary>
  2932. Try to receive new data
  2933. </summary>
  2934. </member>
  2935. <member name="M:NetCoreServer.SslSession.TrySend">
  2936. <summary>
  2937. Try to send pending data
  2938. </summary>
  2939. </member>
  2940. <member name="M:NetCoreServer.SslSession.ClearBuffers">
  2941. <summary>
  2942. Clear send/receive buffers
  2943. </summary>
  2944. </member>
  2945. <member name="M:NetCoreServer.SslSession.ProcessHandshake(System.IAsyncResult)">
  2946. <summary>
  2947. This method is invoked when an asynchronous handshake operation completes
  2948. </summary>
  2949. </member>
  2950. <member name="M:NetCoreServer.SslSession.ProcessReceive(System.IAsyncResult)">
  2951. <summary>
  2952. This method is invoked when an asynchronous receive operation completes
  2953. </summary>
  2954. </member>
  2955. <member name="M:NetCoreServer.SslSession.ProcessSend(System.IAsyncResult)">
  2956. <summary>
  2957. This method is invoked when an asynchronous send operation completes
  2958. </summary>
  2959. </member>
  2960. <member name="M:NetCoreServer.SslSession.OnConnecting">
  2961. <summary>
  2962. Handle client connecting notification
  2963. </summary>
  2964. </member>
  2965. <member name="M:NetCoreServer.SslSession.OnConnected">
  2966. <summary>
  2967. Handle client connected notification
  2968. </summary>
  2969. </member>
  2970. <member name="M:NetCoreServer.SslSession.OnHandshaking">
  2971. <summary>
  2972. Handle client handshaking notification
  2973. </summary>
  2974. </member>
  2975. <member name="M:NetCoreServer.SslSession.OnHandshaked">
  2976. <summary>
  2977. Handle client handshaked notification
  2978. </summary>
  2979. </member>
  2980. <member name="M:NetCoreServer.SslSession.OnDisconnecting">
  2981. <summary>
  2982. Handle client disconnecting notification
  2983. </summary>
  2984. </member>
  2985. <member name="M:NetCoreServer.SslSession.OnDisconnected">
  2986. <summary>
  2987. Handle client disconnected notification
  2988. </summary>
  2989. </member>
  2990. <member name="M:NetCoreServer.SslSession.OnReceived(System.Byte[],System.Int64,System.Int64)">
  2991. <summary>
  2992. Handle buffer received notification
  2993. </summary>
  2994. <param name="buffer">Received buffer</param>
  2995. <param name="offset">Received buffer offset</param>
  2996. <param name="size">Received buffer size</param>
  2997. <remarks>
  2998. Notification is called when another part of buffer was received from the client
  2999. </remarks>
  3000. </member>
  3001. <member name="M:NetCoreServer.SslSession.OnSent(System.Int64,System.Int64)">
  3002. <summary>
  3003. Handle buffer sent notification
  3004. </summary>
  3005. <param name="sent">Size of sent buffer</param>
  3006. <param name="pending">Size of pending buffer</param>
  3007. <remarks>
  3008. Notification is called when another part of buffer was sent to the client.
  3009. This handler could be used to send another buffer to the client for instance when the pending size is zero.
  3010. </remarks>
  3011. </member>
  3012. <member name="M:NetCoreServer.SslSession.OnEmpty">
  3013. <summary>
  3014. Handle empty send buffer notification
  3015. </summary>
  3016. <remarks>
  3017. Notification is called when the send buffer is empty and ready for a new data to send.
  3018. This handler could be used to send another buffer to the client.
  3019. </remarks>
  3020. </member>
  3021. <member name="M:NetCoreServer.SslSession.OnError(System.Net.Sockets.SocketError)">
  3022. <summary>
  3023. Handle error notification
  3024. </summary>
  3025. <param name="error">Socket error code</param>
  3026. </member>
  3027. <member name="M:NetCoreServer.SslSession.SendError(System.Net.Sockets.SocketError)">
  3028. <summary>
  3029. Send error notification
  3030. </summary>
  3031. <param name="error">Socket error code</param>
  3032. </member>
  3033. <member name="P:NetCoreServer.SslSession.IsDisposed">
  3034. <summary>
  3035. Disposed flag
  3036. </summary>
  3037. </member>
  3038. <member name="P:NetCoreServer.SslSession.IsSocketDisposed">
  3039. <summary>
  3040. Session socket disposed flag
  3041. </summary>
  3042. </member>
  3043. <member name="T:NetCoreServer.TcpClient">
  3044. <summary>
  3045. TCP client is used to read/write data from/into the connected TCP server
  3046. </summary>
  3047. <remarks>Thread-safe</remarks>
  3048. </member>
  3049. <member name="M:NetCoreServer.TcpClient.#ctor(System.Net.IPAddress,System.Int32)">
  3050. <summary>
  3051. Initialize TCP client with a given server IP address and port number
  3052. </summary>
  3053. <param name="address">IP address</param>
  3054. <param name="port">Port number</param>
  3055. </member>
  3056. <member name="M:NetCoreServer.TcpClient.#ctor(System.String,System.Int32)">
  3057. <summary>
  3058. Initialize TCP client with a given server IP address and port number
  3059. </summary>
  3060. <param name="address">IP address</param>
  3061. <param name="port">Port number</param>
  3062. </member>
  3063. <member name="M:NetCoreServer.TcpClient.#ctor(System.Net.DnsEndPoint)">
  3064. <summary>
  3065. Initialize TCP client with a given DNS endpoint
  3066. </summary>
  3067. <param name="endpoint">DNS endpoint</param>
  3068. </member>
  3069. <member name="M:NetCoreServer.TcpClient.#ctor(System.Net.IPEndPoint)">
  3070. <summary>
  3071. Initialize TCP client with a given IP endpoint
  3072. </summary>
  3073. <param name="endpoint">IP endpoint</param>
  3074. </member>
  3075. <member name="M:NetCoreServer.TcpClient.#ctor(System.Net.EndPoint,System.String,System.Int32)">
  3076. <summary>
  3077. Initialize TCP client with a given endpoint, address and port
  3078. </summary>
  3079. <param name="endpoint">Endpoint</param>
  3080. <param name="address">Server address</param>
  3081. <param name="port">Server port</param>
  3082. </member>
  3083. <member name="P:NetCoreServer.TcpClient.Id">
  3084. <summary>
  3085. Client Id
  3086. </summary>
  3087. </member>
  3088. <member name="P:NetCoreServer.TcpClient.Address">
  3089. <summary>
  3090. TCP server address
  3091. </summary>
  3092. </member>
  3093. <member name="P:NetCoreServer.TcpClient.Port">
  3094. <summary>
  3095. TCP server port
  3096. </summary>
  3097. </member>
  3098. <member name="P:NetCoreServer.TcpClient.Endpoint">
  3099. <summary>
  3100. Endpoint
  3101. </summary>
  3102. </member>
  3103. <member name="P:NetCoreServer.TcpClient.Socket">
  3104. <summary>
  3105. Socket
  3106. </summary>
  3107. </member>
  3108. <member name="P:NetCoreServer.TcpClient.BytesPending">
  3109. <summary>
  3110. Number of bytes pending sent by the client
  3111. </summary>
  3112. </member>
  3113. <member name="P:NetCoreServer.TcpClient.BytesSending">
  3114. <summary>
  3115. Number of bytes sending by the client
  3116. </summary>
  3117. </member>
  3118. <member name="P:NetCoreServer.TcpClient.BytesSent">
  3119. <summary>
  3120. Number of bytes sent by the client
  3121. </summary>
  3122. </member>
  3123. <member name="P:NetCoreServer.TcpClient.BytesReceived">
  3124. <summary>
  3125. Number of bytes received by the client
  3126. </summary>
  3127. </member>
  3128. <member name="P:NetCoreServer.TcpClient.OptionDualMode">
  3129. <summary>
  3130. Option: dual mode socket
  3131. </summary>
  3132. <remarks>
  3133. Specifies whether the Socket is a dual-mode socket used for both IPv4 and IPv6.
  3134. Will work only if socket is bound on IPv6 address.
  3135. </remarks>
  3136. </member>
  3137. <member name="P:NetCoreServer.TcpClient.OptionKeepAlive">
  3138. <summary>
  3139. Option: keep alive
  3140. </summary>
  3141. <remarks>
  3142. This option will setup SO_KEEPALIVE if the OS support this feature
  3143. </remarks>
  3144. </member>
  3145. <member name="P:NetCoreServer.TcpClient.OptionTcpKeepAliveTime">
  3146. <summary>
  3147. Option: TCP keep alive time
  3148. </summary>
  3149. <remarks>
  3150. The number of seconds a TCP connection will remain alive/idle before keepalive probes are sent to the remote
  3151. </remarks>
  3152. </member>
  3153. <member name="P:NetCoreServer.TcpClient.OptionTcpKeepAliveInterval">
  3154. <summary>
  3155. Option: TCP keep alive interval
  3156. </summary>
  3157. <remarks>
  3158. The number of seconds a TCP connection will wait for a keepalive response before sending another keepalive probe
  3159. </remarks>
  3160. </member>
  3161. <member name="P:NetCoreServer.TcpClient.OptionTcpKeepAliveRetryCount">
  3162. <summary>
  3163. Option: TCP keep alive retry count
  3164. </summary>
  3165. <remarks>
  3166. The number of TCP keep alive probes that will be sent before the connection is terminated
  3167. </remarks>
  3168. </member>
  3169. <member name="P:NetCoreServer.TcpClient.OptionNoDelay">
  3170. <summary>
  3171. Option: no delay
  3172. </summary>
  3173. <remarks>
  3174. This option will enable/disable Nagle's algorithm for TCP protocol
  3175. </remarks>
  3176. </member>
  3177. <member name="P:NetCoreServer.TcpClient.OptionReceiveBufferLimit">
  3178. <summary>
  3179. Option: receive buffer limit
  3180. </summary>
  3181. </member>
  3182. <member name="P:NetCoreServer.TcpClient.OptionReceiveBufferSize">
  3183. <summary>
  3184. Option: receive buffer size
  3185. </summary>
  3186. </member>
  3187. <member name="P:NetCoreServer.TcpClient.OptionSendBufferLimit">
  3188. <summary>
  3189. Option: send buffer limit
  3190. </summary>
  3191. </member>
  3192. <member name="P:NetCoreServer.TcpClient.OptionSendBufferSize">
  3193. <summary>
  3194. Option: send buffer size
  3195. </summary>
  3196. </member>
  3197. <member name="P:NetCoreServer.TcpClient.IsConnecting">
  3198. <summary>
  3199. Is the client connecting?
  3200. </summary>
  3201. </member>
  3202. <member name="P:NetCoreServer.TcpClient.IsConnected">
  3203. <summary>
  3204. Is the client connected?
  3205. </summary>
  3206. </member>
  3207. <member name="M:NetCoreServer.TcpClient.CreateSocket">
  3208. <summary>
  3209. Create a new socket object
  3210. </summary>
  3211. <remarks>
  3212. Method may be override if you need to prepare some specific socket object in your implementation.
  3213. </remarks>
  3214. <returns>Socket object</returns>
  3215. </member>
  3216. <member name="M:NetCoreServer.TcpClient.Connect">
  3217. <summary>
  3218. Connect the client (synchronous)
  3219. </summary>
  3220. <remarks>
  3221. Please note that synchronous connect will not receive data automatically!
  3222. You should use Receive() or ReceiveAsync() method manually after successful connection.
  3223. </remarks>
  3224. <returns>'true' if the client was successfully connected, 'false' if the client failed to connect</returns>
  3225. </member>
  3226. <member name="M:NetCoreServer.TcpClient.Disconnect">
  3227. <summary>
  3228. Disconnect the client (synchronous)
  3229. </summary>
  3230. <returns>'true' if the client was successfully disconnected, 'false' if the client is already disconnected</returns>
  3231. </member>
  3232. <member name="M:NetCoreServer.TcpClient.Reconnect">
  3233. <summary>
  3234. Reconnect the client (synchronous)
  3235. </summary>
  3236. <returns>'true' if the client was successfully reconnected, 'false' if the client is already reconnected</returns>
  3237. </member>
  3238. <member name="M:NetCoreServer.TcpClient.ConnectAsync">
  3239. <summary>
  3240. Connect the client (asynchronous)
  3241. </summary>
  3242. <returns>'true' if the client was successfully connected, 'false' if the client failed to connect</returns>
  3243. </member>
  3244. <member name="M:NetCoreServer.TcpClient.DisconnectAsync">
  3245. <summary>
  3246. Disconnect the client (asynchronous)
  3247. </summary>
  3248. <returns>'true' if the client was successfully disconnected, 'false' if the client is already disconnected</returns>
  3249. </member>
  3250. <member name="M:NetCoreServer.TcpClient.ReconnectAsync">
  3251. <summary>
  3252. Reconnect the client (asynchronous)
  3253. </summary>
  3254. <returns>'true' if the client was successfully reconnected, 'false' if the client is already reconnected</returns>
  3255. </member>
  3256. <member name="M:NetCoreServer.TcpClient.Send(System.Byte[])">
  3257. <summary>
  3258. Send data to the server (synchronous)
  3259. </summary>
  3260. <param name="buffer">Buffer to send</param>
  3261. <returns>Size of sent data</returns>
  3262. </member>
  3263. <member name="M:NetCoreServer.TcpClient.Send(System.Byte[],System.Int64,System.Int64)">
  3264. <summary>
  3265. Send data to the server (synchronous)
  3266. </summary>
  3267. <param name="buffer">Buffer to send</param>
  3268. <param name="offset">Buffer offset</param>
  3269. <param name="size">Buffer size</param>
  3270. <returns>Size of sent data</returns>
  3271. </member>
  3272. <member name="M:NetCoreServer.TcpClient.Send(System.ReadOnlySpan{System.Byte})">
  3273. <summary>
  3274. Send data to the server (synchronous)
  3275. </summary>
  3276. <param name="buffer">Buffer to send as a span of bytes</param>
  3277. <returns>Size of sent data</returns>
  3278. </member>
  3279. <member name="M:NetCoreServer.TcpClient.Send(System.String)">
  3280. <summary>
  3281. Send text to the server (synchronous)
  3282. </summary>
  3283. <param name="text">Text string to send</param>
  3284. <returns>Size of sent text</returns>
  3285. </member>
  3286. <member name="M:NetCoreServer.TcpClient.Send(System.ReadOnlySpan{System.Char})">
  3287. <summary>
  3288. Send text to the server (synchronous)
  3289. </summary>
  3290. <param name="text">Text to send as a span of characters</param>
  3291. <returns>Size of sent text</returns>
  3292. </member>
  3293. <member name="M:NetCoreServer.TcpClient.SendAsync(System.Byte[])">
  3294. <summary>
  3295. Send data to the server (asynchronous)
  3296. </summary>
  3297. <param name="buffer">Buffer to send</param>
  3298. <returns>'true' if the data was successfully sent, 'false' if the client is not connected</returns>
  3299. </member>
  3300. <member name="M:NetCoreServer.TcpClient.SendAsync(System.Byte[],System.Int64,System.Int64)">
  3301. <summary>
  3302. Send data to the server (asynchronous)
  3303. </summary>
  3304. <param name="buffer">Buffer to send</param>
  3305. <param name="offset">Buffer offset</param>
  3306. <param name="size">Buffer size</param>
  3307. <returns>'true' if the data was successfully sent, 'false' if the client is not connected</returns>
  3308. </member>
  3309. <member name="M:NetCoreServer.TcpClient.SendAsync(System.ReadOnlySpan{System.Byte})">
  3310. <summary>
  3311. Send data to the server (asynchronous)
  3312. </summary>
  3313. <param name="buffer">Buffer to send as a span of bytes</param>
  3314. <returns>'true' if the data was successfully sent, 'false' if the client is not connected</returns>
  3315. </member>
  3316. <member name="M:NetCoreServer.TcpClient.SendAsync(System.String)">
  3317. <summary>
  3318. Send text to the server (asynchronous)
  3319. </summary>
  3320. <param name="text">Text string to send</param>
  3321. <returns>'true' if the text was successfully sent, 'false' if the client is not connected</returns>
  3322. </member>
  3323. <member name="M:NetCoreServer.TcpClient.SendAsync(System.ReadOnlySpan{System.Char})">
  3324. <summary>
  3325. Send text to the server (asynchronous)
  3326. </summary>
  3327. <param name="text">Text to send as a span of characters</param>
  3328. <returns>'true' if the text was successfully sent, 'false' if the client is not connected</returns>
  3329. </member>
  3330. <member name="M:NetCoreServer.TcpClient.Receive(System.Byte[])">
  3331. <summary>
  3332. Receive data from the server (synchronous)
  3333. </summary>
  3334. <param name="buffer">Buffer to receive</param>
  3335. <returns>Size of received data</returns>
  3336. </member>
  3337. <member name="M:NetCoreServer.TcpClient.Receive(System.Byte[],System.Int64,System.Int64)">
  3338. <summary>
  3339. Receive data from the server (synchronous)
  3340. </summary>
  3341. <param name="buffer">Buffer to receive</param>
  3342. <param name="offset">Buffer offset</param>
  3343. <param name="size">Buffer size</param>
  3344. <returns>Size of received data</returns>
  3345. </member>
  3346. <member name="M:NetCoreServer.TcpClient.Receive(System.Int64)">
  3347. <summary>
  3348. Receive text from the server (synchronous)
  3349. </summary>
  3350. <param name="size">Text size to receive</param>
  3351. <returns>Received text</returns>
  3352. </member>
  3353. <member name="M:NetCoreServer.TcpClient.ReceiveAsync">
  3354. <summary>
  3355. Receive data from the server (asynchronous)
  3356. </summary>
  3357. </member>
  3358. <member name="M:NetCoreServer.TcpClient.TryReceive">
  3359. <summary>
  3360. Try to receive new data
  3361. </summary>
  3362. </member>
  3363. <member name="M:NetCoreServer.TcpClient.TrySend">
  3364. <summary>
  3365. Try to send pending data
  3366. </summary>
  3367. </member>
  3368. <member name="M:NetCoreServer.TcpClient.ClearBuffers">
  3369. <summary>
  3370. Clear send/receive buffers
  3371. </summary>
  3372. </member>
  3373. <member name="M:NetCoreServer.TcpClient.OnAsyncCompleted(System.Object,System.Net.Sockets.SocketAsyncEventArgs)">
  3374. <summary>
  3375. This method is called whenever a receive or send operation is completed on a socket
  3376. </summary>
  3377. </member>
  3378. <member name="M:NetCoreServer.TcpClient.ProcessConnect(System.Net.Sockets.SocketAsyncEventArgs)">
  3379. <summary>
  3380. This method is invoked when an asynchronous connect operation completes
  3381. </summary>
  3382. </member>
  3383. <member name="M:NetCoreServer.TcpClient.ProcessReceive(System.Net.Sockets.SocketAsyncEventArgs)">
  3384. <summary>
  3385. This method is invoked when an asynchronous receive operation completes
  3386. </summary>
  3387. </member>
  3388. <member name="M:NetCoreServer.TcpClient.ProcessSend(System.Net.Sockets.SocketAsyncEventArgs)">
  3389. <summary>
  3390. This method is invoked when an asynchronous send operation completes
  3391. </summary>
  3392. </member>
  3393. <member name="M:NetCoreServer.TcpClient.OnConnecting">
  3394. <summary>
  3395. Handle client connecting notification
  3396. </summary>
  3397. </member>
  3398. <member name="M:NetCoreServer.TcpClient.OnConnected">
  3399. <summary>
  3400. Handle client connected notification
  3401. </summary>
  3402. </member>
  3403. <member name="M:NetCoreServer.TcpClient.OnDisconnecting">
  3404. <summary>
  3405. Handle client disconnecting notification
  3406. </summary>
  3407. </member>
  3408. <member name="M:NetCoreServer.TcpClient.OnDisconnected">
  3409. <summary>
  3410. Handle client disconnected notification
  3411. </summary>
  3412. </member>
  3413. <member name="M:NetCoreServer.TcpClient.OnReceived(System.Byte[],System.Int64,System.Int64)">
  3414. <summary>
  3415. Handle buffer received notification
  3416. </summary>
  3417. <param name="buffer">Received buffer</param>
  3418. <param name="offset">Received buffer offset</param>
  3419. <param name="size">Received buffer size</param>
  3420. <remarks>
  3421. Notification is called when another part of buffer was received from the server
  3422. </remarks>
  3423. </member>
  3424. <member name="M:NetCoreServer.TcpClient.OnSent(System.Int64,System.Int64)">
  3425. <summary>
  3426. Handle buffer sent notification
  3427. </summary>
  3428. <param name="sent">Size of sent buffer</param>
  3429. <param name="pending">Size of pending buffer</param>
  3430. <remarks>
  3431. Notification is called when another part of buffer was sent to the server.
  3432. This handler could be used to send another buffer to the server for instance when the pending size is zero.
  3433. </remarks>
  3434. </member>
  3435. <member name="M:NetCoreServer.TcpClient.OnEmpty">
  3436. <summary>
  3437. Handle empty send buffer notification
  3438. </summary>
  3439. <remarks>
  3440. Notification is called when the send buffer is empty and ready for a new data to send.
  3441. This handler could be used to send another buffer to the server.
  3442. </remarks>
  3443. </member>
  3444. <member name="M:NetCoreServer.TcpClient.OnError(System.Net.Sockets.SocketError)">
  3445. <summary>
  3446. Handle error notification
  3447. </summary>
  3448. <param name="error">Socket error code</param>
  3449. </member>
  3450. <member name="M:NetCoreServer.TcpClient.SendError(System.Net.Sockets.SocketError)">
  3451. <summary>
  3452. Send error notification
  3453. </summary>
  3454. <param name="error">Socket error code</param>
  3455. </member>
  3456. <member name="P:NetCoreServer.TcpClient.IsDisposed">
  3457. <summary>
  3458. Disposed flag
  3459. </summary>
  3460. </member>
  3461. <member name="P:NetCoreServer.TcpClient.IsSocketDisposed">
  3462. <summary>
  3463. Client socket disposed flag
  3464. </summary>
  3465. </member>
  3466. <member name="T:NetCoreServer.TcpServer">
  3467. <summary>
  3468. TCP server is used to connect, disconnect and manage TCP sessions
  3469. </summary>
  3470. <remarks>Thread-safe</remarks>
  3471. </member>
  3472. <member name="M:NetCoreServer.TcpServer.#ctor(System.Net.IPAddress,System.Int32)">
  3473. <summary>
  3474. Initialize TCP server with a given IP address and port number
  3475. </summary>
  3476. <param name="address">IP address</param>
  3477. <param name="port">Port number</param>
  3478. </member>
  3479. <member name="M:NetCoreServer.TcpServer.#ctor(System.String,System.Int32)">
  3480. <summary>
  3481. Initialize TCP server with a given IP address and port number
  3482. </summary>
  3483. <param name="address">IP address</param>
  3484. <param name="port">Port number</param>
  3485. </member>
  3486. <member name="M:NetCoreServer.TcpServer.#ctor(System.Net.DnsEndPoint)">
  3487. <summary>
  3488. Initialize TCP server with a given DNS endpoint
  3489. </summary>
  3490. <param name="endpoint">DNS endpoint</param>
  3491. </member>
  3492. <member name="M:NetCoreServer.TcpServer.#ctor(System.Net.IPEndPoint)">
  3493. <summary>
  3494. Initialize TCP server with a given IP endpoint
  3495. </summary>
  3496. <param name="endpoint">IP endpoint</param>
  3497. </member>
  3498. <member name="M:NetCoreServer.TcpServer.#ctor(System.Net.EndPoint,System.String,System.Int32)">
  3499. <summary>
  3500. Initialize TCP server with a given endpoint, address and port
  3501. </summary>
  3502. <param name="endpoint">Endpoint</param>
  3503. <param name="address">Server address</param>
  3504. <param name="port">Server port</param>
  3505. </member>
  3506. <member name="P:NetCoreServer.TcpServer.Id">
  3507. <summary>
  3508. Server Id
  3509. </summary>
  3510. </member>
  3511. <member name="P:NetCoreServer.TcpServer.Address">
  3512. <summary>
  3513. TCP server address
  3514. </summary>
  3515. </member>
  3516. <member name="P:NetCoreServer.TcpServer.Port">
  3517. <summary>
  3518. TCP server port
  3519. </summary>
  3520. </member>
  3521. <member name="P:NetCoreServer.TcpServer.Endpoint">
  3522. <summary>
  3523. Endpoint
  3524. </summary>
  3525. </member>
  3526. <member name="P:NetCoreServer.TcpServer.ConnectedSessions">
  3527. <summary>
  3528. Number of sessions connected to the server
  3529. </summary>
  3530. </member>
  3531. <member name="P:NetCoreServer.TcpServer.BytesPending">
  3532. <summary>
  3533. Number of bytes pending sent by the server
  3534. </summary>
  3535. </member>
  3536. <member name="P:NetCoreServer.TcpServer.BytesSent">
  3537. <summary>
  3538. Number of bytes sent by the server
  3539. </summary>
  3540. </member>
  3541. <member name="P:NetCoreServer.TcpServer.BytesReceived">
  3542. <summary>
  3543. Number of bytes received by the server
  3544. </summary>
  3545. </member>
  3546. <member name="P:NetCoreServer.TcpServer.OptionAcceptorBacklog">
  3547. <summary>
  3548. Option: acceptor backlog size
  3549. </summary>
  3550. <remarks>
  3551. This option will set the listening socket's backlog size
  3552. </remarks>
  3553. </member>
  3554. <member name="P:NetCoreServer.TcpServer.OptionDualMode">
  3555. <summary>
  3556. Option: dual mode socket
  3557. </summary>
  3558. <remarks>
  3559. Specifies whether the Socket is a dual-mode socket used for both IPv4 and IPv6.
  3560. Will work only if socket is bound on IPv6 address.
  3561. </remarks>
  3562. </member>
  3563. <member name="P:NetCoreServer.TcpServer.OptionKeepAlive">
  3564. <summary>
  3565. Option: keep alive
  3566. </summary>
  3567. <remarks>
  3568. This option will setup SO_KEEPALIVE if the OS support this feature
  3569. </remarks>
  3570. </member>
  3571. <member name="P:NetCoreServer.TcpServer.OptionTcpKeepAliveTime">
  3572. <summary>
  3573. Option: TCP keep alive time
  3574. </summary>
  3575. <remarks>
  3576. The number of seconds a TCP connection will remain alive/idle before keepalive probes are sent to the remote
  3577. </remarks>
  3578. </member>
  3579. <member name="P:NetCoreServer.TcpServer.OptionTcpKeepAliveInterval">
  3580. <summary>
  3581. Option: TCP keep alive interval
  3582. </summary>
  3583. <remarks>
  3584. The number of seconds a TCP connection will wait for a keepalive response before sending another keepalive probe
  3585. </remarks>
  3586. </member>
  3587. <member name="P:NetCoreServer.TcpServer.OptionTcpKeepAliveRetryCount">
  3588. <summary>
  3589. Option: TCP keep alive retry count
  3590. </summary>
  3591. <remarks>
  3592. The number of TCP keep alive probes that will be sent before the connection is terminated
  3593. </remarks>
  3594. </member>
  3595. <member name="P:NetCoreServer.TcpServer.OptionNoDelay">
  3596. <summary>
  3597. Option: no delay
  3598. </summary>
  3599. <remarks>
  3600. This option will enable/disable Nagle's algorithm for TCP protocol
  3601. </remarks>
  3602. </member>
  3603. <member name="P:NetCoreServer.TcpServer.OptionReuseAddress">
  3604. <summary>
  3605. Option: reuse address
  3606. </summary>
  3607. <remarks>
  3608. This option will enable/disable SO_REUSEADDR if the OS support this feature
  3609. </remarks>
  3610. </member>
  3611. <member name="P:NetCoreServer.TcpServer.OptionExclusiveAddressUse">
  3612. <summary>
  3613. Option: enables a socket to be bound for exclusive access
  3614. </summary>
  3615. <remarks>
  3616. This option will enable/disable SO_EXCLUSIVEADDRUSE if the OS support this feature
  3617. </remarks>
  3618. </member>
  3619. <member name="P:NetCoreServer.TcpServer.OptionReceiveBufferSize">
  3620. <summary>
  3621. Option: receive buffer size
  3622. </summary>
  3623. </member>
  3624. <member name="P:NetCoreServer.TcpServer.OptionSendBufferSize">
  3625. <summary>
  3626. Option: send buffer size
  3627. </summary>
  3628. </member>
  3629. <member name="P:NetCoreServer.TcpServer.IsStarted">
  3630. <summary>
  3631. Is the server started?
  3632. </summary>
  3633. </member>
  3634. <member name="P:NetCoreServer.TcpServer.IsAccepting">
  3635. <summary>
  3636. Is the server accepting new clients?
  3637. </summary>
  3638. </member>
  3639. <member name="M:NetCoreServer.TcpServer.CreateSocket">
  3640. <summary>
  3641. Create a new socket object
  3642. </summary>
  3643. <remarks>
  3644. Method may be override if you need to prepare some specific socket object in your implementation.
  3645. </remarks>
  3646. <returns>Socket object</returns>
  3647. </member>
  3648. <member name="M:NetCoreServer.TcpServer.Start">
  3649. <summary>
  3650. Start the server
  3651. </summary>
  3652. <returns>'true' if the server was successfully started, 'false' if the server failed to start</returns>
  3653. </member>
  3654. <member name="M:NetCoreServer.TcpServer.Stop">
  3655. <summary>
  3656. Stop the server
  3657. </summary>
  3658. <returns>'true' if the server was successfully stopped, 'false' if the server is already stopped</returns>
  3659. </member>
  3660. <member name="M:NetCoreServer.TcpServer.Restart">
  3661. <summary>
  3662. Restart the server
  3663. </summary>
  3664. <returns>'true' if the server was successfully restarted, 'false' if the server failed to restart</returns>
  3665. </member>
  3666. <member name="M:NetCoreServer.TcpServer.StartAccept(System.Net.Sockets.SocketAsyncEventArgs)">
  3667. <summary>
  3668. Start accept a new client connection
  3669. </summary>
  3670. </member>
  3671. <member name="M:NetCoreServer.TcpServer.ProcessAccept(System.Net.Sockets.SocketAsyncEventArgs)">
  3672. <summary>
  3673. Process accepted client connection
  3674. </summary>
  3675. </member>
  3676. <member name="M:NetCoreServer.TcpServer.OnAsyncCompleted(System.Object,System.Net.Sockets.SocketAsyncEventArgs)">
  3677. <summary>
  3678. This method is the callback method associated with Socket.AcceptAsync()
  3679. operations and is invoked when an accept operation is complete
  3680. </summary>
  3681. </member>
  3682. <member name="M:NetCoreServer.TcpServer.CreateSession">
  3683. <summary>
  3684. Create TCP session factory method
  3685. </summary>
  3686. <returns>TCP session</returns>
  3687. </member>
  3688. <member name="F:NetCoreServer.TcpServer.Sessions">
  3689. <summary>
  3690. Server sessions
  3691. </summary>
  3692. </member>
  3693. <member name="M:NetCoreServer.TcpServer.DisconnectAll">
  3694. <summary>
  3695. Disconnect all connected sessions
  3696. </summary>
  3697. <returns>'true' if all sessions were successfully disconnected, 'false' if the server is not started</returns>
  3698. </member>
  3699. <member name="M:NetCoreServer.TcpServer.FindSession(System.Guid)">
  3700. <summary>
  3701. Find a session with a given Id
  3702. </summary>
  3703. <param name="id">Session Id</param>
  3704. <returns>Session with a given Id or null if the session it not connected</returns>
  3705. </member>
  3706. <member name="M:NetCoreServer.TcpServer.RegisterSession(NetCoreServer.TcpSession)">
  3707. <summary>
  3708. Register a new session
  3709. </summary>
  3710. <param name="session">Session to register</param>
  3711. </member>
  3712. <member name="M:NetCoreServer.TcpServer.UnregisterSession(System.Guid)">
  3713. <summary>
  3714. Unregister session by Id
  3715. </summary>
  3716. <param name="id">Session Id</param>
  3717. </member>
  3718. <member name="M:NetCoreServer.TcpServer.Multicast(System.Byte[])">
  3719. <summary>
  3720. Multicast data to all connected sessions
  3721. </summary>
  3722. <param name="buffer">Buffer to multicast</param>
  3723. <returns>'true' if the data was successfully multicasted, 'false' if the data was not multicasted</returns>
  3724. </member>
  3725. <member name="M:NetCoreServer.TcpServer.Multicast(System.Byte[],System.Int64,System.Int64)">
  3726. <summary>
  3727. Multicast data to all connected clients
  3728. </summary>
  3729. <param name="buffer">Buffer to multicast</param>
  3730. <param name="offset">Buffer offset</param>
  3731. <param name="size">Buffer size</param>
  3732. <returns>'true' if the data was successfully multicasted, 'false' if the data was not multicasted</returns>
  3733. </member>
  3734. <member name="M:NetCoreServer.TcpServer.Multicast(System.ReadOnlySpan{System.Byte})">
  3735. <summary>
  3736. Multicast data to all connected clients
  3737. </summary>
  3738. <param name="buffer">Buffer to send as a span of bytes</param>
  3739. <returns>'true' if the data was successfully multicasted, 'false' if the data was not multicasted</returns>
  3740. </member>
  3741. <member name="M:NetCoreServer.TcpServer.Multicast(System.String)">
  3742. <summary>
  3743. Multicast text to all connected clients
  3744. </summary>
  3745. <param name="text">Text string to multicast</param>
  3746. <returns>'true' if the text was successfully multicasted, 'false' if the text was not multicasted</returns>
  3747. </member>
  3748. <member name="M:NetCoreServer.TcpServer.Multicast(System.ReadOnlySpan{System.Char})">
  3749. <summary>
  3750. Multicast text to all connected clients
  3751. </summary>
  3752. <param name="text">Text to multicast as a span of characters</param>
  3753. <returns>'true' if the text was successfully multicasted, 'false' if the text was not multicasted</returns>
  3754. </member>
  3755. <member name="M:NetCoreServer.TcpServer.OnStarting">
  3756. <summary>
  3757. Handle server starting notification
  3758. </summary>
  3759. </member>
  3760. <member name="M:NetCoreServer.TcpServer.OnStarted">
  3761. <summary>
  3762. Handle server started notification
  3763. </summary>
  3764. </member>
  3765. <member name="M:NetCoreServer.TcpServer.OnStopping">
  3766. <summary>
  3767. Handle server stopping notification
  3768. </summary>
  3769. </member>
  3770. <member name="M:NetCoreServer.TcpServer.OnStopped">
  3771. <summary>
  3772. Handle server stopped notification
  3773. </summary>
  3774. </member>
  3775. <member name="M:NetCoreServer.TcpServer.OnConnecting(NetCoreServer.TcpSession)">
  3776. <summary>
  3777. Handle session connecting notification
  3778. </summary>
  3779. <param name="session">Connecting session</param>
  3780. </member>
  3781. <member name="M:NetCoreServer.TcpServer.OnConnected(NetCoreServer.TcpSession)">
  3782. <summary>
  3783. Handle session connected notification
  3784. </summary>
  3785. <param name="session">Connected session</param>
  3786. </member>
  3787. <member name="M:NetCoreServer.TcpServer.OnDisconnecting(NetCoreServer.TcpSession)">
  3788. <summary>
  3789. Handle session disconnecting notification
  3790. </summary>
  3791. <param name="session">Disconnecting session</param>
  3792. </member>
  3793. <member name="M:NetCoreServer.TcpServer.OnDisconnected(NetCoreServer.TcpSession)">
  3794. <summary>
  3795. Handle session disconnected notification
  3796. </summary>
  3797. <param name="session">Disconnected session</param>
  3798. </member>
  3799. <member name="M:NetCoreServer.TcpServer.OnError(System.Net.Sockets.SocketError)">
  3800. <summary>
  3801. Handle error notification
  3802. </summary>
  3803. <param name="error">Socket error code</param>
  3804. </member>
  3805. <member name="M:NetCoreServer.TcpServer.SendError(System.Net.Sockets.SocketError)">
  3806. <summary>
  3807. Send error notification
  3808. </summary>
  3809. <param name="error">Socket error code</param>
  3810. </member>
  3811. <member name="P:NetCoreServer.TcpServer.IsDisposed">
  3812. <summary>
  3813. Disposed flag
  3814. </summary>
  3815. </member>
  3816. <member name="P:NetCoreServer.TcpServer.IsSocketDisposed">
  3817. <summary>
  3818. Acceptor socket disposed flag
  3819. </summary>
  3820. </member>
  3821. <member name="T:NetCoreServer.TcpSession">
  3822. <summary>
  3823. TCP session is used to read and write data from the connected TCP client
  3824. </summary>
  3825. <remarks>Thread-safe</remarks>
  3826. </member>
  3827. <member name="M:NetCoreServer.TcpSession.#ctor(NetCoreServer.TcpServer)">
  3828. <summary>
  3829. Initialize the session with a given server
  3830. </summary>
  3831. <param name="server">TCP server</param>
  3832. </member>
  3833. <member name="P:NetCoreServer.TcpSession.Id">
  3834. <summary>
  3835. Session Id
  3836. </summary>
  3837. </member>
  3838. <member name="P:NetCoreServer.TcpSession.Server">
  3839. <summary>
  3840. Server
  3841. </summary>
  3842. </member>
  3843. <member name="P:NetCoreServer.TcpSession.Socket">
  3844. <summary>
  3845. Socket
  3846. </summary>
  3847. </member>
  3848. <member name="P:NetCoreServer.TcpSession.BytesPending">
  3849. <summary>
  3850. Number of bytes pending sent by the session
  3851. </summary>
  3852. </member>
  3853. <member name="P:NetCoreServer.TcpSession.BytesSending">
  3854. <summary>
  3855. Number of bytes sending by the session
  3856. </summary>
  3857. </member>
  3858. <member name="P:NetCoreServer.TcpSession.BytesSent">
  3859. <summary>
  3860. Number of bytes sent by the session
  3861. </summary>
  3862. </member>
  3863. <member name="P:NetCoreServer.TcpSession.BytesReceived">
  3864. <summary>
  3865. Number of bytes received by the session
  3866. </summary>
  3867. </member>
  3868. <member name="P:NetCoreServer.TcpSession.OptionReceiveBufferLimit">
  3869. <summary>
  3870. Option: receive buffer limit
  3871. </summary>
  3872. </member>
  3873. <member name="P:NetCoreServer.TcpSession.OptionReceiveBufferSize">
  3874. <summary>
  3875. Option: receive buffer size
  3876. </summary>
  3877. </member>
  3878. <member name="P:NetCoreServer.TcpSession.OptionSendBufferLimit">
  3879. <summary>
  3880. Option: send buffer limit
  3881. </summary>
  3882. </member>
  3883. <member name="P:NetCoreServer.TcpSession.OptionSendBufferSize">
  3884. <summary>
  3885. Option: send buffer size
  3886. </summary>
  3887. </member>
  3888. <member name="P:NetCoreServer.TcpSession.IsConnected">
  3889. <summary>
  3890. Is the session connected?
  3891. </summary>
  3892. </member>
  3893. <member name="M:NetCoreServer.TcpSession.Connect(System.Net.Sockets.Socket)">
  3894. <summary>
  3895. Connect the session
  3896. </summary>
  3897. <param name="socket">Session socket</param>
  3898. </member>
  3899. <member name="M:NetCoreServer.TcpSession.Disconnect">
  3900. <summary>
  3901. Disconnect the session
  3902. </summary>
  3903. <returns>'true' if the section was successfully disconnected, 'false' if the section is already disconnected</returns>
  3904. </member>
  3905. <member name="M:NetCoreServer.TcpSession.Send(System.Byte[])">
  3906. <summary>
  3907. Send data to the client (synchronous)
  3908. </summary>
  3909. <param name="buffer">Buffer to send</param>
  3910. <returns>Size of sent data</returns>
  3911. </member>
  3912. <member name="M:NetCoreServer.TcpSession.Send(System.Byte[],System.Int64,System.Int64)">
  3913. <summary>
  3914. Send data to the client (synchronous)
  3915. </summary>
  3916. <param name="buffer">Buffer to send</param>
  3917. <param name="offset">Buffer offset</param>
  3918. <param name="size">Buffer size</param>
  3919. <returns>Size of sent data</returns>
  3920. </member>
  3921. <member name="M:NetCoreServer.TcpSession.Send(System.ReadOnlySpan{System.Byte})">
  3922. <summary>
  3923. Send data to the client (synchronous)
  3924. </summary>
  3925. <param name="buffer">Buffer to send as a span of bytes</param>
  3926. <returns>Size of sent data</returns>
  3927. </member>
  3928. <member name="M:NetCoreServer.TcpSession.Send(System.String)">
  3929. <summary>
  3930. Send text to the client (synchronous)
  3931. </summary>
  3932. <param name="text">Text string to send</param>
  3933. <returns>Size of sent data</returns>
  3934. </member>
  3935. <member name="M:NetCoreServer.TcpSession.Send(System.ReadOnlySpan{System.Char})">
  3936. <summary>
  3937. Send text to the client (synchronous)
  3938. </summary>
  3939. <param name="text">Text to send as a span of characters</param>
  3940. <returns>Size of sent data</returns>
  3941. </member>
  3942. <member name="M:NetCoreServer.TcpSession.SendAsync(System.Byte[])">
  3943. <summary>
  3944. Send data to the client (asynchronous)
  3945. </summary>
  3946. <param name="buffer">Buffer to send</param>
  3947. <returns>'true' if the data was successfully sent, 'false' if the session is not connected</returns>
  3948. </member>
  3949. <member name="M:NetCoreServer.TcpSession.SendAsync(System.Byte[],System.Int64,System.Int64)">
  3950. <summary>
  3951. Send data to the client (asynchronous)
  3952. </summary>
  3953. <param name="buffer">Buffer to send</param>
  3954. <param name="offset">Buffer offset</param>
  3955. <param name="size">Buffer size</param>
  3956. <returns>'true' if the data was successfully sent, 'false' if the session is not connected</returns>
  3957. </member>
  3958. <member name="M:NetCoreServer.TcpSession.SendAsync(System.ReadOnlySpan{System.Byte})">
  3959. <summary>
  3960. Send data to the client (asynchronous)
  3961. </summary>
  3962. <param name="buffer">Buffer to send as a span of bytes</param>
  3963. <returns>'true' if the data was successfully sent, 'false' if the session is not connected</returns>
  3964. </member>
  3965. <member name="M:NetCoreServer.TcpSession.SendAsync(System.String)">
  3966. <summary>
  3967. Send text to the client (asynchronous)
  3968. </summary>
  3969. <param name="text">Text string to send</param>
  3970. <returns>'true' if the text was successfully sent, 'false' if the session is not connected</returns>
  3971. </member>
  3972. <member name="M:NetCoreServer.TcpSession.SendAsync(System.ReadOnlySpan{System.Char})">
  3973. <summary>
  3974. Send text to the client (asynchronous)
  3975. </summary>
  3976. <param name="text">Text to send as a span of characters</param>
  3977. <returns>'true' if the text was successfully sent, 'false' if the session is not connected</returns>
  3978. </member>
  3979. <member name="M:NetCoreServer.TcpSession.Receive(System.Byte[])">
  3980. <summary>
  3981. Receive data from the client (synchronous)
  3982. </summary>
  3983. <param name="buffer">Buffer to receive</param>
  3984. <returns>Size of received data</returns>
  3985. </member>
  3986. <member name="M:NetCoreServer.TcpSession.Receive(System.Byte[],System.Int64,System.Int64)">
  3987. <summary>
  3988. Receive data from the client (synchronous)
  3989. </summary>
  3990. <param name="buffer">Buffer to receive</param>
  3991. <param name="offset">Buffer offset</param>
  3992. <param name="size">Buffer size</param>
  3993. <returns>Size of received data</returns>
  3994. </member>
  3995. <member name="M:NetCoreServer.TcpSession.Receive(System.Int64)">
  3996. <summary>
  3997. Receive text from the client (synchronous)
  3998. </summary>
  3999. <param name="size">Text size to receive</param>
  4000. <returns>Received text</returns>
  4001. </member>
  4002. <member name="M:NetCoreServer.TcpSession.ReceiveAsync">
  4003. <summary>
  4004. Receive data from the client (asynchronous)
  4005. </summary>
  4006. </member>
  4007. <member name="M:NetCoreServer.TcpSession.TryReceive">
  4008. <summary>
  4009. Try to receive new data
  4010. </summary>
  4011. </member>
  4012. <member name="M:NetCoreServer.TcpSession.TrySend">
  4013. <summary>
  4014. Try to send pending data
  4015. </summary>
  4016. </member>
  4017. <member name="M:NetCoreServer.TcpSession.ClearBuffers">
  4018. <summary>
  4019. Clear send/receive buffers
  4020. </summary>
  4021. </member>
  4022. <member name="M:NetCoreServer.TcpSession.OnAsyncCompleted(System.Object,System.Net.Sockets.SocketAsyncEventArgs)">
  4023. <summary>
  4024. This method is called whenever a receive or send operation is completed on a socket
  4025. </summary>
  4026. </member>
  4027. <member name="M:NetCoreServer.TcpSession.ProcessReceive(System.Net.Sockets.SocketAsyncEventArgs)">
  4028. <summary>
  4029. This method is invoked when an asynchronous receive operation completes
  4030. </summary>
  4031. </member>
  4032. <member name="M:NetCoreServer.TcpSession.ProcessSend(System.Net.Sockets.SocketAsyncEventArgs)">
  4033. <summary>
  4034. This method is invoked when an asynchronous send operation completes
  4035. </summary>
  4036. </member>
  4037. <member name="M:NetCoreServer.TcpSession.OnConnecting">
  4038. <summary>
  4039. Handle client connecting notification
  4040. </summary>
  4041. </member>
  4042. <member name="M:NetCoreServer.TcpSession.OnConnected">
  4043. <summary>
  4044. Handle client connected notification
  4045. </summary>
  4046. </member>
  4047. <member name="M:NetCoreServer.TcpSession.OnDisconnecting">
  4048. <summary>
  4049. Handle client disconnecting notification
  4050. </summary>
  4051. </member>
  4052. <member name="M:NetCoreServer.TcpSession.OnDisconnected">
  4053. <summary>
  4054. Handle client disconnected notification
  4055. </summary>
  4056. </member>
  4057. <member name="M:NetCoreServer.TcpSession.OnReceived(System.Byte[],System.Int64,System.Int64)">
  4058. <summary>
  4059. Handle buffer received notification
  4060. </summary>
  4061. <param name="buffer">Received buffer</param>
  4062. <param name="offset">Received buffer offset</param>
  4063. <param name="size">Received buffer size</param>
  4064. <remarks>
  4065. Notification is called when another part of buffer was received from the client
  4066. </remarks>
  4067. </member>
  4068. <member name="M:NetCoreServer.TcpSession.OnSent(System.Int64,System.Int64)">
  4069. <summary>
  4070. Handle buffer sent notification
  4071. </summary>
  4072. <param name="sent">Size of sent buffer</param>
  4073. <param name="pending">Size of pending buffer</param>
  4074. <remarks>
  4075. Notification is called when another part of buffer was sent to the client.
  4076. This handler could be used to send another buffer to the client for instance when the pending size is zero.
  4077. </remarks>
  4078. </member>
  4079. <member name="M:NetCoreServer.TcpSession.OnEmpty">
  4080. <summary>
  4081. Handle empty send buffer notification
  4082. </summary>
  4083. <remarks>
  4084. Notification is called when the send buffer is empty and ready for a new data to send.
  4085. This handler could be used to send another buffer to the client.
  4086. </remarks>
  4087. </member>
  4088. <member name="M:NetCoreServer.TcpSession.OnError(System.Net.Sockets.SocketError)">
  4089. <summary>
  4090. Handle error notification
  4091. </summary>
  4092. <param name="error">Socket error code</param>
  4093. </member>
  4094. <member name="M:NetCoreServer.TcpSession.SendError(System.Net.Sockets.SocketError)">
  4095. <summary>
  4096. Send error notification
  4097. </summary>
  4098. <param name="error">Socket error code</param>
  4099. </member>
  4100. <member name="P:NetCoreServer.TcpSession.IsDisposed">
  4101. <summary>
  4102. Disposed flag
  4103. </summary>
  4104. </member>
  4105. <member name="P:NetCoreServer.TcpSession.IsSocketDisposed">
  4106. <summary>
  4107. Session socket disposed flag
  4108. </summary>
  4109. </member>
  4110. <member name="T:NetCoreServer.UdpClient">
  4111. <summary>
  4112. UDP client is used to read/write data from/into the connected UDP server
  4113. </summary>
  4114. <remarks>Thread-safe</remarks>
  4115. </member>
  4116. <member name="M:NetCoreServer.UdpClient.#ctor(System.Net.IPAddress,System.Int32)">
  4117. <summary>
  4118. Initialize UDP client with a given server IP address and port number
  4119. </summary>
  4120. <param name="address">IP address</param>
  4121. <param name="port">Port number</param>
  4122. </member>
  4123. <member name="M:NetCoreServer.UdpClient.#ctor(System.String,System.Int32)">
  4124. <summary>
  4125. Initialize UDP client with a given server IP address and port number
  4126. </summary>
  4127. <param name="address">IP address</param>
  4128. <param name="port">Port number</param>
  4129. </member>
  4130. <member name="M:NetCoreServer.UdpClient.#ctor(System.Net.DnsEndPoint)">
  4131. <summary>
  4132. Initialize UDP client with a given DNS endpoint
  4133. </summary>
  4134. <param name="endpoint">DNS endpoint</param>
  4135. </member>
  4136. <member name="M:NetCoreServer.UdpClient.#ctor(System.Net.IPEndPoint)">
  4137. <summary>
  4138. Initialize UDP client with a given IP endpoint
  4139. </summary>
  4140. <param name="endpoint">IP endpoint</param>
  4141. </member>
  4142. <member name="M:NetCoreServer.UdpClient.#ctor(System.Net.EndPoint,System.String,System.Int32)">
  4143. <summary>
  4144. Initialize UDP client with a given endpoint, address and port
  4145. </summary>
  4146. <param name="endpoint">Endpoint</param>
  4147. <param name="address">Server address</param>
  4148. <param name="port">Server port</param>
  4149. </member>
  4150. <member name="P:NetCoreServer.UdpClient.Id">
  4151. <summary>
  4152. Client Id
  4153. </summary>
  4154. </member>
  4155. <member name="P:NetCoreServer.UdpClient.Address">
  4156. <summary>
  4157. UDP server address
  4158. </summary>
  4159. </member>
  4160. <member name="P:NetCoreServer.UdpClient.Port">
  4161. <summary>
  4162. UDP server port
  4163. </summary>
  4164. </member>
  4165. <member name="P:NetCoreServer.UdpClient.Endpoint">
  4166. <summary>
  4167. Endpoint
  4168. </summary>
  4169. </member>
  4170. <member name="P:NetCoreServer.UdpClient.Socket">
  4171. <summary>
  4172. Socket
  4173. </summary>
  4174. </member>
  4175. <member name="P:NetCoreServer.UdpClient.BytesPending">
  4176. <summary>
  4177. Number of bytes pending sent by the client
  4178. </summary>
  4179. </member>
  4180. <member name="P:NetCoreServer.UdpClient.BytesSending">
  4181. <summary>
  4182. Number of bytes sending by the client
  4183. </summary>
  4184. </member>
  4185. <member name="P:NetCoreServer.UdpClient.BytesSent">
  4186. <summary>
  4187. Number of bytes sent by the client
  4188. </summary>
  4189. </member>
  4190. <member name="P:NetCoreServer.UdpClient.BytesReceived">
  4191. <summary>
  4192. Number of bytes received by the client
  4193. </summary>
  4194. </member>
  4195. <member name="P:NetCoreServer.UdpClient.DatagramsSent">
  4196. <summary>
  4197. Number of datagrams sent by the client
  4198. </summary>
  4199. </member>
  4200. <member name="P:NetCoreServer.UdpClient.DatagramsReceived">
  4201. <summary>
  4202. Number of datagrams received by the client
  4203. </summary>
  4204. </member>
  4205. <member name="P:NetCoreServer.UdpClient.OptionDualMode">
  4206. <summary>
  4207. Option: dual mode socket
  4208. </summary>
  4209. <remarks>
  4210. Specifies whether the Socket is a dual-mode socket used for both IPv4 and IPv6.
  4211. Will work only if socket is bound on IPv6 address.
  4212. </remarks>
  4213. </member>
  4214. <member name="P:NetCoreServer.UdpClient.OptionReuseAddress">
  4215. <summary>
  4216. Option: reuse address
  4217. </summary>
  4218. <remarks>
  4219. This option will enable/disable SO_REUSEADDR if the OS support this feature
  4220. </remarks>
  4221. </member>
  4222. <member name="P:NetCoreServer.UdpClient.OptionExclusiveAddressUse">
  4223. <summary>
  4224. Option: enables a socket to be bound for exclusive access
  4225. </summary>
  4226. <remarks>
  4227. This option will enable/disable SO_EXCLUSIVEADDRUSE if the OS support this feature
  4228. </remarks>
  4229. </member>
  4230. <member name="P:NetCoreServer.UdpClient.OptionMulticast">
  4231. <summary>
  4232. Option: bind the socket to the multicast UDP server
  4233. </summary>
  4234. </member>
  4235. <member name="P:NetCoreServer.UdpClient.OptionReceiveBufferLimit">
  4236. <summary>
  4237. Option: receive buffer limit
  4238. </summary>
  4239. </member>
  4240. <member name="P:NetCoreServer.UdpClient.OptionReceiveBufferSize">
  4241. <summary>
  4242. Option: receive buffer size
  4243. </summary>
  4244. </member>
  4245. <member name="P:NetCoreServer.UdpClient.OptionSendBufferLimit">
  4246. <summary>
  4247. Option: send buffer limit
  4248. </summary>
  4249. </member>
  4250. <member name="P:NetCoreServer.UdpClient.OptionSendBufferSize">
  4251. <summary>
  4252. Option: send buffer size
  4253. </summary>
  4254. </member>
  4255. <member name="P:NetCoreServer.UdpClient.IsConnected">
  4256. <summary>
  4257. Is the client connected?
  4258. </summary>
  4259. </member>
  4260. <member name="M:NetCoreServer.UdpClient.CreateSocket">
  4261. <summary>
  4262. Create a new socket object
  4263. </summary>
  4264. <remarks>
  4265. Method may be override if you need to prepare some specific socket object in your implementation.
  4266. </remarks>
  4267. <returns>Socket object</returns>
  4268. </member>
  4269. <member name="M:NetCoreServer.UdpClient.Connect">
  4270. <summary>
  4271. Connect the client (synchronous)
  4272. </summary>
  4273. <returns>'true' if the client was successfully connected, 'false' if the client failed to connect</returns>
  4274. </member>
  4275. <member name="M:NetCoreServer.UdpClient.Disconnect">
  4276. <summary>
  4277. Disconnect the client (synchronous)
  4278. </summary>
  4279. <returns>'true' if the client was successfully disconnected, 'false' if the client is already disconnected</returns>
  4280. </member>
  4281. <member name="M:NetCoreServer.UdpClient.Reconnect">
  4282. <summary>
  4283. Reconnect the client (synchronous)
  4284. </summary>
  4285. <returns>'true' if the client was successfully reconnected, 'false' if the client is already reconnected</returns>
  4286. </member>
  4287. <member name="M:NetCoreServer.UdpClient.SetupMulticast(System.Boolean)">
  4288. <summary>
  4289. Setup multicast: bind the socket to the multicast UDP server
  4290. </summary>
  4291. <param name="enable">Enable/disable multicast</param>
  4292. </member>
  4293. <member name="M:NetCoreServer.UdpClient.JoinMulticastGroup(System.Net.IPAddress)">
  4294. <summary>
  4295. Join multicast group with a given IP address (synchronous)
  4296. </summary>
  4297. <param name="address">IP address</param>
  4298. </member>
  4299. <member name="M:NetCoreServer.UdpClient.JoinMulticastGroup(System.String)">
  4300. <summary>
  4301. Join multicast group with a given IP address (synchronous)
  4302. </summary>
  4303. <param name="address">IP address</param>
  4304. </member>
  4305. <member name="M:NetCoreServer.UdpClient.LeaveMulticastGroup(System.Net.IPAddress)">
  4306. <summary>
  4307. Leave multicast group with a given IP address (synchronous)
  4308. </summary>
  4309. <param name="address">IP address</param>
  4310. </member>
  4311. <member name="M:NetCoreServer.UdpClient.LeaveMulticastGroup(System.String)">
  4312. <summary>
  4313. Leave multicast group with a given IP address (synchronous)
  4314. </summary>
  4315. <param name="address">IP address</param>
  4316. </member>
  4317. <member name="M:NetCoreServer.UdpClient.Send(System.Byte[])">
  4318. <summary>
  4319. Send datagram to the connected server (synchronous)
  4320. </summary>
  4321. <param name="buffer">Datagram buffer to send</param>
  4322. <returns>Size of sent datagram</returns>
  4323. </member>
  4324. <member name="M:NetCoreServer.UdpClient.Send(System.Byte[],System.Int64,System.Int64)">
  4325. <summary>
  4326. Send datagram to the connected server (synchronous)
  4327. </summary>
  4328. <param name="buffer">Datagram buffer to send</param>
  4329. <param name="offset">Datagram buffer offset</param>
  4330. <param name="size">Datagram buffer size</param>
  4331. <returns>Size of sent datagram</returns>
  4332. </member>
  4333. <member name="M:NetCoreServer.UdpClient.Send(System.ReadOnlySpan{System.Byte})">
  4334. <summary>
  4335. Send datagram to the connected server (synchronous)
  4336. </summary>
  4337. <param name="buffer">Datagram buffer to send as a span of bytes</param>
  4338. <returns>Size of sent datagram</returns>
  4339. </member>
  4340. <member name="M:NetCoreServer.UdpClient.Send(System.String)">
  4341. <summary>
  4342. Send text to the connected server (synchronous)
  4343. </summary>
  4344. <param name="text">Text string to send</param>
  4345. <returns>Size of sent datagram</returns>
  4346. </member>
  4347. <member name="M:NetCoreServer.UdpClient.Send(System.ReadOnlySpan{System.Char})">
  4348. <summary>
  4349. Send text to the connected server (synchronous)
  4350. </summary>
  4351. <param name="text">Text to send as a span of characters</param>
  4352. <returns>Size of sent datagram</returns>
  4353. </member>
  4354. <member name="M:NetCoreServer.UdpClient.Send(System.Net.EndPoint,System.Byte[])">
  4355. <summary>
  4356. Send datagram to the given endpoint (synchronous)
  4357. </summary>
  4358. <param name="endpoint">Endpoint to send</param>
  4359. <param name="buffer">Datagram buffer to send</param>
  4360. <returns>Size of sent datagram</returns>
  4361. </member>
  4362. <member name="M:NetCoreServer.UdpClient.Send(System.Net.EndPoint,System.Byte[],System.Int64,System.Int64)">
  4363. <summary>
  4364. Send datagram to the given endpoint (synchronous)
  4365. </summary>
  4366. <param name="endpoint">Endpoint to send</param>
  4367. <param name="buffer">Datagram buffer to send</param>
  4368. <param name="offset">Datagram buffer offset</param>
  4369. <param name="size">Datagram buffer size</param>
  4370. <returns>Size of sent datagram</returns>
  4371. </member>
  4372. <member name="M:NetCoreServer.UdpClient.Send(System.Net.EndPoint,System.ReadOnlySpan{System.Byte})">
  4373. <summary>
  4374. Send datagram to the given endpoint (synchronous)
  4375. </summary>
  4376. <param name="endpoint">Endpoint to send</param>
  4377. <param name="buffer">Datagram buffer to send as a span of bytes</param>
  4378. <returns>Size of sent datagram</returns>
  4379. </member>
  4380. <member name="M:NetCoreServer.UdpClient.Send(System.Net.EndPoint,System.String)">
  4381. <summary>
  4382. Send text to the given endpoint (synchronous)
  4383. </summary>
  4384. <param name="endpoint">Endpoint to send</param>
  4385. <param name="text">Text string to send</param>
  4386. <returns>Size of sent datagram</returns>
  4387. </member>
  4388. <member name="M:NetCoreServer.UdpClient.Send(System.Net.EndPoint,System.ReadOnlySpan{System.Char})">
  4389. <summary>
  4390. Send text to the given endpoint (synchronous)
  4391. </summary>
  4392. <param name="endpoint">Endpoint to send</param>
  4393. <param name="text">Text to send as a span of characters</param>
  4394. <returns>Size of sent datagram</returns>
  4395. </member>
  4396. <member name="M:NetCoreServer.UdpClient.SendAsync(System.Byte[])">
  4397. <summary>
  4398. Send datagram to the connected server (asynchronous)
  4399. </summary>
  4400. <param name="buffer">Datagram buffer to send</param>
  4401. <returns>'true' if the datagram was successfully sent, 'false' if the datagram was not sent</returns>
  4402. </member>
  4403. <member name="M:NetCoreServer.UdpClient.SendAsync(System.Byte[],System.Int64,System.Int64)">
  4404. <summary>
  4405. Send datagram to the connected server (asynchronous)
  4406. </summary>
  4407. <param name="buffer">Datagram buffer to send</param>
  4408. <param name="offset">Datagram buffer offset</param>
  4409. <param name="size">Datagram buffer size</param>
  4410. <returns>'true' if the datagram was successfully sent, 'false' if the datagram was not sent</returns>
  4411. </member>
  4412. <member name="M:NetCoreServer.UdpClient.SendAsync(System.ReadOnlySpan{System.Byte})">
  4413. <summary>
  4414. Send datagram to the connected server (asynchronous)
  4415. </summary>
  4416. <param name="buffer">Datagram buffer to send as a span of bytes</param>
  4417. <returns>'true' if the datagram was successfully sent, 'false' if the datagram was not sent</returns>
  4418. </member>
  4419. <member name="M:NetCoreServer.UdpClient.SendAsync(System.String)">
  4420. <summary>
  4421. Send text to the connected server (asynchronous)
  4422. </summary>
  4423. <param name="text">Text string to send</param>
  4424. <returns>'true' if the text was successfully sent, 'false' if the text was not sent</returns>
  4425. </member>
  4426. <member name="M:NetCoreServer.UdpClient.SendAsync(System.ReadOnlySpan{System.Char})">
  4427. <summary>
  4428. Send text to the connected server (asynchronous)
  4429. </summary>
  4430. <param name="text">Text to send as a span of characters</param>
  4431. <returns>'true' if the text was successfully sent, 'false' if the text was not sent</returns>
  4432. </member>
  4433. <member name="M:NetCoreServer.UdpClient.SendAsync(System.Net.EndPoint,System.Byte[])">
  4434. <summary>
  4435. Send datagram to the given endpoint (asynchronous)
  4436. </summary>
  4437. <param name="endpoint">Endpoint to send</param>
  4438. <param name="buffer">Datagram buffer to send</param>
  4439. <returns>'true' if the datagram was successfully sent, 'false' if the datagram was not sent</returns>
  4440. </member>
  4441. <member name="M:NetCoreServer.UdpClient.SendAsync(System.Net.EndPoint,System.Byte[],System.Int64,System.Int64)">
  4442. <summary>
  4443. Send datagram to the given endpoint (asynchronous)
  4444. </summary>
  4445. <param name="endpoint">Endpoint to send</param>
  4446. <param name="buffer">Datagram buffer to send</param>
  4447. <param name="offset">Datagram buffer offset</param>
  4448. <param name="size">Datagram buffer size</param>
  4449. <returns>'true' if the datagram was successfully sent, 'false' if the datagram was not sent</returns>
  4450. </member>
  4451. <member name="M:NetCoreServer.UdpClient.SendAsync(System.Net.EndPoint,System.ReadOnlySpan{System.Byte})">
  4452. <summary>
  4453. Send datagram to the given endpoint (asynchronous)
  4454. </summary>
  4455. <param name="endpoint">Endpoint to send</param>
  4456. <param name="buffer">Datagram buffer to send as a span of bytes</param>
  4457. <returns>'true' if the datagram was successfully sent, 'false' if the datagram was not sent</returns>
  4458. </member>
  4459. <member name="M:NetCoreServer.UdpClient.SendAsync(System.Net.EndPoint,System.String)">
  4460. <summary>
  4461. Send text to the given endpoint (asynchronous)
  4462. </summary>
  4463. <param name="endpoint">Endpoint to send</param>
  4464. <param name="text">Text string to send</param>
  4465. <returns>'true' if the text was successfully sent, 'false' if the text was not sent</returns>
  4466. </member>
  4467. <member name="M:NetCoreServer.UdpClient.SendAsync(System.Net.EndPoint,System.ReadOnlySpan{System.Char})">
  4468. <summary>
  4469. Send text to the given endpoint (asynchronous)
  4470. </summary>
  4471. <param name="endpoint">Endpoint to send</param>
  4472. <param name="text">Text to send as a span of characters</param>
  4473. <returns>'true' if the text was successfully sent, 'false' if the text was not sent</returns>
  4474. </member>
  4475. <member name="M:NetCoreServer.UdpClient.Receive(System.Net.EndPoint@,System.Byte[])">
  4476. <summary>
  4477. Receive a new datagram from the given endpoint (synchronous)
  4478. </summary>
  4479. <param name="endpoint">Endpoint to receive from</param>
  4480. <param name="buffer">Datagram buffer to receive</param>
  4481. <returns>Size of received datagram</returns>
  4482. </member>
  4483. <member name="M:NetCoreServer.UdpClient.Receive(System.Net.EndPoint@,System.Byte[],System.Int64,System.Int64)">
  4484. <summary>
  4485. Receive a new datagram from the given endpoint (synchronous)
  4486. </summary>
  4487. <param name="endpoint">Endpoint to receive from</param>
  4488. <param name="buffer">Datagram buffer to receive</param>
  4489. <param name="offset">Datagram buffer offset</param>
  4490. <param name="size">Datagram buffer size</param>
  4491. <returns>Size of received datagram</returns>
  4492. </member>
  4493. <member name="M:NetCoreServer.UdpClient.Receive(System.Net.EndPoint@,System.Int64)">
  4494. <summary>
  4495. Receive text from the given endpoint (synchronous)
  4496. </summary>
  4497. <param name="endpoint">Endpoint to receive from</param>
  4498. <param name="size">Text size to receive</param>
  4499. <returns>Received text</returns>
  4500. </member>
  4501. <member name="M:NetCoreServer.UdpClient.ReceiveAsync">
  4502. <summary>
  4503. Receive datagram from the server (asynchronous)
  4504. </summary>
  4505. </member>
  4506. <member name="M:NetCoreServer.UdpClient.TryReceive">
  4507. <summary>
  4508. Try to receive new data
  4509. </summary>
  4510. </member>
  4511. <member name="M:NetCoreServer.UdpClient.TrySend">
  4512. <summary>
  4513. Try to send pending data
  4514. </summary>
  4515. </member>
  4516. <member name="M:NetCoreServer.UdpClient.ClearBuffers">
  4517. <summary>
  4518. Clear send/receive buffers
  4519. </summary>
  4520. </member>
  4521. <member name="M:NetCoreServer.UdpClient.OnAsyncCompleted(System.Object,System.Net.Sockets.SocketAsyncEventArgs)">
  4522. <summary>
  4523. This method is called whenever a receive or send operation is completed on a socket
  4524. </summary>
  4525. </member>
  4526. <member name="M:NetCoreServer.UdpClient.ProcessReceiveFrom(System.Net.Sockets.SocketAsyncEventArgs)">
  4527. <summary>
  4528. This method is invoked when an asynchronous receive from operation completes
  4529. </summary>
  4530. </member>
  4531. <member name="M:NetCoreServer.UdpClient.ProcessSendTo(System.Net.Sockets.SocketAsyncEventArgs)">
  4532. <summary>
  4533. This method is invoked when an asynchronous send to operation completes
  4534. </summary>
  4535. </member>
  4536. <member name="M:NetCoreServer.UdpClient.OnConnecting">
  4537. <summary>
  4538. Handle client connecting notification
  4539. </summary>
  4540. </member>
  4541. <member name="M:NetCoreServer.UdpClient.OnConnected">
  4542. <summary>
  4543. Handle client connected notification
  4544. </summary>
  4545. </member>
  4546. <member name="M:NetCoreServer.UdpClient.OnDisconnecting">
  4547. <summary>
  4548. Handle client disconnecting notification
  4549. </summary>
  4550. </member>
  4551. <member name="M:NetCoreServer.UdpClient.OnDisconnected">
  4552. <summary>
  4553. Handle client disconnected notification
  4554. </summary>
  4555. </member>
  4556. <member name="M:NetCoreServer.UdpClient.OnJoinedMulticastGroup(System.Net.IPAddress)">
  4557. <summary>
  4558. Handle client joined multicast group notification
  4559. </summary>
  4560. <param name="address">IP address</param>
  4561. </member>
  4562. <member name="M:NetCoreServer.UdpClient.OnLeftMulticastGroup(System.Net.IPAddress)">
  4563. <summary>
  4564. Handle client left multicast group notification
  4565. </summary>
  4566. <param name="address">IP address</param>
  4567. </member>
  4568. <member name="M:NetCoreServer.UdpClient.OnReceived(System.Net.EndPoint,System.Byte[],System.Int64,System.Int64)">
  4569. <summary>
  4570. Handle datagram received notification
  4571. </summary>
  4572. <param name="endpoint">Received endpoint</param>
  4573. <param name="buffer">Received datagram buffer</param>
  4574. <param name="offset">Received datagram buffer offset</param>
  4575. <param name="size">Received datagram buffer size</param>
  4576. <remarks>
  4577. Notification is called when another datagram was received from some endpoint
  4578. </remarks>
  4579. </member>
  4580. <member name="M:NetCoreServer.UdpClient.OnSent(System.Net.EndPoint,System.Int64)">
  4581. <summary>
  4582. Handle datagram sent notification
  4583. </summary>
  4584. <param name="endpoint">Endpoint of sent datagram</param>
  4585. <param name="sent">Size of sent datagram buffer</param>
  4586. <remarks>
  4587. Notification is called when a datagram was sent to the server.
  4588. This handler could be used to send another datagram to the server for instance when the pending size is zero.
  4589. </remarks>
  4590. </member>
  4591. <member name="M:NetCoreServer.UdpClient.OnError(System.Net.Sockets.SocketError)">
  4592. <summary>
  4593. Handle error notification
  4594. </summary>
  4595. <param name="error">Socket error code</param>
  4596. </member>
  4597. <member name="M:NetCoreServer.UdpClient.SendError(System.Net.Sockets.SocketError)">
  4598. <summary>
  4599. Send error notification
  4600. </summary>
  4601. <param name="error">Socket error code</param>
  4602. </member>
  4603. <member name="P:NetCoreServer.UdpClient.IsDisposed">
  4604. <summary>
  4605. Disposed flag
  4606. </summary>
  4607. </member>
  4608. <member name="P:NetCoreServer.UdpClient.IsSocketDisposed">
  4609. <summary>
  4610. Client socket disposed flag
  4611. </summary>
  4612. </member>
  4613. <member name="T:NetCoreServer.UdpServer">
  4614. <summary>
  4615. UDP server is used to send or multicast datagrams to UDP endpoints
  4616. </summary>
  4617. <remarks>Thread-safe</remarks>
  4618. </member>
  4619. <member name="M:NetCoreServer.UdpServer.#ctor(System.Net.IPAddress,System.Int32)">
  4620. <summary>
  4621. Initialize UDP server with a given IP address and port number
  4622. </summary>
  4623. <param name="address">IP address</param>
  4624. <param name="port">Port number</param>
  4625. </member>
  4626. <member name="M:NetCoreServer.UdpServer.#ctor(System.String,System.Int32)">
  4627. <summary>
  4628. Initialize UDP server with a given IP address and port number
  4629. </summary>
  4630. <param name="address">IP address</param>
  4631. <param name="port">Port number</param>
  4632. </member>
  4633. <member name="M:NetCoreServer.UdpServer.#ctor(System.Net.DnsEndPoint)">
  4634. <summary>
  4635. Initialize UDP server with a given DNS endpoint
  4636. </summary>
  4637. <param name="endpoint">DNS endpoint</param>
  4638. </member>
  4639. <member name="M:NetCoreServer.UdpServer.#ctor(System.Net.IPEndPoint)">
  4640. <summary>
  4641. Initialize UDP server with a given IP endpoint
  4642. </summary>
  4643. <param name="endpoint">IP endpoint</param>
  4644. </member>
  4645. <member name="M:NetCoreServer.UdpServer.#ctor(System.Net.EndPoint,System.String,System.Int32)">
  4646. <summary>
  4647. Initialize UDP server with a given endpoint, address and port
  4648. </summary>
  4649. <param name="endpoint">Endpoint</param>
  4650. <param name="address">Server address</param>
  4651. <param name="port">Server port</param>
  4652. </member>
  4653. <member name="P:NetCoreServer.UdpServer.Id">
  4654. <summary>
  4655. Server Id
  4656. </summary>
  4657. </member>
  4658. <member name="P:NetCoreServer.UdpServer.Address">
  4659. <summary>
  4660. UDP server address
  4661. </summary>
  4662. </member>
  4663. <member name="P:NetCoreServer.UdpServer.Port">
  4664. <summary>
  4665. UDP server port
  4666. </summary>
  4667. </member>
  4668. <member name="P:NetCoreServer.UdpServer.Endpoint">
  4669. <summary>
  4670. Endpoint
  4671. </summary>
  4672. </member>
  4673. <member name="P:NetCoreServer.UdpServer.MulticastEndpoint">
  4674. <summary>
  4675. Multicast endpoint
  4676. </summary>
  4677. </member>
  4678. <member name="P:NetCoreServer.UdpServer.Socket">
  4679. <summary>
  4680. Socket
  4681. </summary>
  4682. </member>
  4683. <member name="P:NetCoreServer.UdpServer.BytesPending">
  4684. <summary>
  4685. Number of bytes pending sent by the server
  4686. </summary>
  4687. </member>
  4688. <member name="P:NetCoreServer.UdpServer.BytesSending">
  4689. <summary>
  4690. Number of bytes sending by the server
  4691. </summary>
  4692. </member>
  4693. <member name="P:NetCoreServer.UdpServer.BytesSent">
  4694. <summary>
  4695. Number of bytes sent by the server
  4696. </summary>
  4697. </member>
  4698. <member name="P:NetCoreServer.UdpServer.BytesReceived">
  4699. <summary>
  4700. Number of bytes received by the server
  4701. </summary>
  4702. </member>
  4703. <member name="P:NetCoreServer.UdpServer.DatagramsSent">
  4704. <summary>
  4705. Number of datagrams sent by the server
  4706. </summary>
  4707. </member>
  4708. <member name="P:NetCoreServer.UdpServer.DatagramsReceived">
  4709. <summary>
  4710. Number of datagrams received by the server
  4711. </summary>
  4712. </member>
  4713. <member name="P:NetCoreServer.UdpServer.OptionDualMode">
  4714. <summary>
  4715. Option: dual mode socket
  4716. </summary>
  4717. <remarks>
  4718. Specifies whether the Socket is a dual-mode socket used for both IPv4 and IPv6.
  4719. Will work only if socket is bound on IPv6 address.
  4720. </remarks>
  4721. </member>
  4722. <member name="P:NetCoreServer.UdpServer.OptionReuseAddress">
  4723. <summary>
  4724. Option: reuse address
  4725. </summary>
  4726. <remarks>
  4727. This option will enable/disable SO_REUSEADDR if the OS support this feature
  4728. </remarks>
  4729. </member>
  4730. <member name="P:NetCoreServer.UdpServer.OptionExclusiveAddressUse">
  4731. <summary>
  4732. Option: enables a socket to be bound for exclusive access
  4733. </summary>
  4734. <remarks>
  4735. This option will enable/disable SO_EXCLUSIVEADDRUSE if the OS support this feature
  4736. </remarks>
  4737. </member>
  4738. <member name="P:NetCoreServer.UdpServer.OptionReceiveBufferLimit">
  4739. <summary>
  4740. Option: receive buffer limit
  4741. </summary>
  4742. </member>
  4743. <member name="P:NetCoreServer.UdpServer.OptionReceiveBufferSize">
  4744. <summary>
  4745. Option: receive buffer size
  4746. </summary>
  4747. </member>
  4748. <member name="P:NetCoreServer.UdpServer.OptionSendBufferLimit">
  4749. <summary>
  4750. Option: send buffer limit
  4751. </summary>
  4752. </member>
  4753. <member name="P:NetCoreServer.UdpServer.OptionSendBufferSize">
  4754. <summary>
  4755. Option: send buffer size
  4756. </summary>
  4757. </member>
  4758. <member name="P:NetCoreServer.UdpServer.IsStarted">
  4759. <summary>
  4760. Is the server started?
  4761. </summary>
  4762. </member>
  4763. <member name="M:NetCoreServer.UdpServer.CreateSocket">
  4764. <summary>
  4765. Create a new socket object
  4766. </summary>
  4767. <remarks>
  4768. Method may be override if you need to prepare some specific socket object in your implementation.
  4769. </remarks>
  4770. <returns>Socket object</returns>
  4771. </member>
  4772. <member name="M:NetCoreServer.UdpServer.Start">
  4773. <summary>
  4774. Start the server (synchronous)
  4775. </summary>
  4776. <returns>'true' if the server was successfully started, 'false' if the server failed to start</returns>
  4777. </member>
  4778. <member name="M:NetCoreServer.UdpServer.Start(System.Net.IPAddress,System.Int32)">
  4779. <summary>
  4780. Start the server with a given multicast IP address and port number (synchronous)
  4781. </summary>
  4782. <param name="multicastAddress">Multicast IP address</param>
  4783. <param name="multicastPort">Multicast port number</param>
  4784. <returns>'true' if the server was successfully started, 'false' if the server failed to start</returns>
  4785. </member>
  4786. <member name="M:NetCoreServer.UdpServer.Start(System.String,System.Int32)">
  4787. <summary>
  4788. Start the server with a given multicast IP address and port number (synchronous)
  4789. </summary>
  4790. <param name="multicastAddress">Multicast IP address</param>
  4791. <param name="multicastPort">Multicast port number</param>
  4792. <returns>'true' if the server was successfully started, 'false' if the server failed to start</returns>
  4793. </member>
  4794. <member name="M:NetCoreServer.UdpServer.Start(System.Net.EndPoint)">
  4795. <summary>
  4796. Start the server with a given multicast endpoint (synchronous)
  4797. </summary>
  4798. <param name="multicastEndpoint">Multicast endpoint</param>
  4799. <returns>'true' if the server was successfully started, 'false' if the server failed to start</returns>
  4800. </member>
  4801. <member name="M:NetCoreServer.UdpServer.Stop">
  4802. <summary>
  4803. Stop the server (synchronous)
  4804. </summary>
  4805. <returns>'true' if the server was successfully stopped, 'false' if the server is already stopped</returns>
  4806. </member>
  4807. <member name="M:NetCoreServer.UdpServer.Restart">
  4808. <summary>
  4809. Restart the server (synchronous)
  4810. </summary>
  4811. <returns>'true' if the server was successfully restarted, 'false' if the server failed to restart</returns>
  4812. </member>
  4813. <member name="M:NetCoreServer.UdpServer.Multicast(System.Byte[])">
  4814. <summary>
  4815. Multicast datagram to the prepared mulicast endpoint (synchronous)
  4816. </summary>
  4817. <param name="buffer">Datagram buffer to multicast</param>
  4818. <returns>Size of multicasted datagram</returns>
  4819. </member>
  4820. <member name="M:NetCoreServer.UdpServer.Multicast(System.Byte[],System.Int64,System.Int64)">
  4821. <summary>
  4822. Multicast datagram to the prepared mulicast endpoint (synchronous)
  4823. </summary>
  4824. <param name="buffer">Datagram buffer to multicast</param>
  4825. <param name="offset">Datagram buffer offset</param>
  4826. <param name="size">Datagram buffer size</param>
  4827. <returns>Size of multicasted datagram</returns>
  4828. </member>
  4829. <member name="M:NetCoreServer.UdpServer.Multicast(System.ReadOnlySpan{System.Byte})">
  4830. <summary>
  4831. Multicast datagram to the prepared mulicast endpoint (synchronous)
  4832. </summary>
  4833. <param name="buffer">Datagram buffer to multicast as a span of bytes</param>
  4834. <returns>Size of multicasted datagram</returns>
  4835. </member>
  4836. <member name="M:NetCoreServer.UdpServer.Multicast(System.String)">
  4837. <summary>
  4838. Multicast text to the prepared mulicast endpoint (synchronous)
  4839. </summary>
  4840. <param name="text">Text string to multicast</param>
  4841. <returns>Size of multicasted datagram</returns>
  4842. </member>
  4843. <member name="M:NetCoreServer.UdpServer.Multicast(System.ReadOnlySpan{System.Char})">
  4844. <summary>
  4845. Multicast text to the prepared mulicast endpoint (synchronous)
  4846. </summary>
  4847. <param name="text">Text to multicast as a span of characters</param>
  4848. <returns>Size of multicasted datagram</returns>
  4849. </member>
  4850. <member name="M:NetCoreServer.UdpServer.MulticastAsync(System.Byte[])">
  4851. <summary>
  4852. Multicast datagram to the prepared mulicast endpoint (asynchronous)
  4853. </summary>
  4854. <param name="buffer">Datagram buffer to multicast</param>
  4855. <returns>'true' if the datagram was successfully multicasted, 'false' if the datagram was not multicasted</returns>
  4856. </member>
  4857. <member name="M:NetCoreServer.UdpServer.MulticastAsync(System.Byte[],System.Int64,System.Int64)">
  4858. <summary>
  4859. Multicast datagram to the prepared mulicast endpoint (asynchronous)
  4860. </summary>
  4861. <param name="buffer">Datagram buffer to multicast</param>
  4862. <param name="offset">Datagram buffer offset</param>
  4863. <param name="size">Datagram buffer size</param>
  4864. <returns>'true' if the datagram was successfully multicasted, 'false' if the datagram was not multicasted</returns>
  4865. </member>
  4866. <member name="M:NetCoreServer.UdpServer.MulticastAsync(System.ReadOnlySpan{System.Byte})">
  4867. <summary>
  4868. Multicast datagram to the prepared mulicast endpoint (asynchronous)
  4869. </summary>
  4870. <param name="buffer">Datagram buffer to multicast as a span of bytes</param>
  4871. <returns>'true' if the datagram was successfully multicasted, 'false' if the datagram was not multicasted</returns>
  4872. </member>
  4873. <member name="M:NetCoreServer.UdpServer.MulticastAsync(System.String)">
  4874. <summary>
  4875. Multicast text to the prepared mulicast endpoint (asynchronous)
  4876. </summary>
  4877. <param name="text">Text string to multicast</param>
  4878. <returns>'true' if the text was successfully multicasted, 'false' if the text was not multicasted</returns>
  4879. </member>
  4880. <member name="M:NetCoreServer.UdpServer.MulticastAsync(System.ReadOnlySpan{System.Char})">
  4881. <summary>
  4882. Multicast text to the prepared mulicast endpoint (asynchronous)
  4883. </summary>
  4884. <param name="text">Text to multicast as a span of characters</param>
  4885. <returns>'true' if the text was successfully multicasted, 'false' if the text was not multicasted</returns>
  4886. </member>
  4887. <member name="M:NetCoreServer.UdpServer.Send(System.Byte[])">
  4888. <summary>
  4889. Send datagram to the connected server (synchronous)
  4890. </summary>
  4891. <param name="buffer">Datagram buffer to send</param>
  4892. <returns>Size of sent datagram</returns>
  4893. </member>
  4894. <member name="M:NetCoreServer.UdpServer.Send(System.Byte[],System.Int64,System.Int64)">
  4895. <summary>
  4896. Send datagram to the connected server (synchronous)
  4897. </summary>
  4898. <param name="buffer">Datagram buffer to send</param>
  4899. <param name="offset">Datagram buffer offset</param>
  4900. <param name="size">Datagram buffer size</param>
  4901. <returns>Size of sent datagram</returns>
  4902. </member>
  4903. <member name="M:NetCoreServer.UdpServer.Send(System.ReadOnlySpan{System.Byte})">
  4904. <summary>
  4905. Send datagram to the connected server (synchronous)
  4906. </summary>
  4907. <param name="buffer">Datagram buffer to send as a span of bytes</param>
  4908. <returns>Size of sent datagram</returns>
  4909. </member>
  4910. <member name="M:NetCoreServer.UdpServer.Send(System.String)">
  4911. <summary>
  4912. Send text to the connected server (synchronous)
  4913. </summary>
  4914. <param name="text">Text string to send</param>
  4915. <returns>Size of sent datagram</returns>
  4916. </member>
  4917. <member name="M:NetCoreServer.UdpServer.Send(System.ReadOnlySpan{System.Char})">
  4918. <summary>
  4919. Send text to the connected server (synchronous)
  4920. </summary>
  4921. <param name="text">Text to send as a span of characters</param>
  4922. <returns>Size of sent datagram</returns>
  4923. </member>
  4924. <member name="M:NetCoreServer.UdpServer.Send(System.Net.EndPoint,System.Byte[])">
  4925. <summary>
  4926. Send datagram to the given endpoint (synchronous)
  4927. </summary>
  4928. <param name="endpoint">Endpoint to send</param>
  4929. <param name="buffer">Datagram buffer to send</param>
  4930. <returns>Size of sent datagram</returns>
  4931. </member>
  4932. <member name="M:NetCoreServer.UdpServer.Send(System.Net.EndPoint,System.Byte[],System.Int64,System.Int64)">
  4933. <summary>
  4934. Send datagram to the given endpoint (synchronous)
  4935. </summary>
  4936. <param name="endpoint">Endpoint to send</param>
  4937. <param name="buffer">Datagram buffer to send</param>
  4938. <param name="offset">Datagram buffer offset</param>
  4939. <param name="size">Datagram buffer size</param>
  4940. <returns>Size of sent datagram</returns>
  4941. </member>
  4942. <member name="M:NetCoreServer.UdpServer.Send(System.Net.EndPoint,System.ReadOnlySpan{System.Byte})">
  4943. <summary>
  4944. Send datagram to the given endpoint (synchronous)
  4945. </summary>
  4946. <param name="endpoint">Endpoint to send</param>
  4947. <param name="buffer">Datagram buffer to send as a span of bytes</param>
  4948. <returns>Size of sent datagram</returns>
  4949. </member>
  4950. <member name="M:NetCoreServer.UdpServer.Send(System.Net.EndPoint,System.String)">
  4951. <summary>
  4952. Send text to the given endpoint (synchronous)
  4953. </summary>
  4954. <param name="endpoint">Endpoint to send</param>
  4955. <param name="text">Text string to send</param>
  4956. <returns>Size of sent datagram</returns>
  4957. </member>
  4958. <member name="M:NetCoreServer.UdpServer.Send(System.Net.EndPoint,System.ReadOnlySpan{System.Char})">
  4959. <summary>
  4960. Send text to the given endpoint (synchronous)
  4961. </summary>
  4962. <param name="endpoint">Endpoint to send</param>
  4963. <param name="text">Text to send as a span of characters</param>
  4964. <returns>Size of sent datagram</returns>
  4965. </member>
  4966. <member name="M:NetCoreServer.UdpServer.SendAsync(System.Net.EndPoint,System.Byte[])">
  4967. <summary>
  4968. Send datagram to the given endpoint (asynchronous)
  4969. </summary>
  4970. <param name="endpoint">Endpoint to send</param>
  4971. <param name="buffer">Datagram buffer to send</param>
  4972. <returns>'true' if the datagram was successfully sent, 'false' if the datagram was not sent</returns>
  4973. </member>
  4974. <member name="M:NetCoreServer.UdpServer.SendAsync(System.Net.EndPoint,System.Byte[],System.Int64,System.Int64)">
  4975. <summary>
  4976. Send datagram to the given endpoint (asynchronous)
  4977. </summary>
  4978. <param name="endpoint">Endpoint to send</param>
  4979. <param name="buffer">Datagram buffer to send</param>
  4980. <param name="offset">Datagram buffer offset</param>
  4981. <param name="size">Datagram buffer size</param>
  4982. <returns>'true' if the datagram was successfully sent, 'false' if the datagram was not sent</returns>
  4983. </member>
  4984. <member name="M:NetCoreServer.UdpServer.SendAsync(System.Net.EndPoint,System.ReadOnlySpan{System.Byte})">
  4985. <summary>
  4986. Send datagram to the given endpoint (asynchronous)
  4987. </summary>
  4988. <param name="endpoint">Endpoint to send</param>
  4989. <param name="buffer">Datagram buffer to send as a span of bytes</param>
  4990. <returns>'true' if the datagram was successfully sent, 'false' if the datagram was not sent</returns>
  4991. </member>
  4992. <member name="M:NetCoreServer.UdpServer.SendAsync(System.Net.EndPoint,System.String)">
  4993. <summary>
  4994. Send text to the given endpoint (asynchronous)
  4995. </summary>
  4996. <param name="endpoint">Endpoint to send</param>
  4997. <param name="text">Text string to send</param>
  4998. <returns>'true' if the text was successfully sent, 'false' if the text was not sent</returns>
  4999. </member>
  5000. <member name="M:NetCoreServer.UdpServer.SendAsync(System.Net.EndPoint,System.ReadOnlySpan{System.Char})">
  5001. <summary>
  5002. Send text to the given endpoint (asynchronous)
  5003. </summary>
  5004. <param name="endpoint">Endpoint to send</param>
  5005. <param name="text">Text to send as a span of characters</param>
  5006. <returns>'true' if the text was successfully sent, 'false' if the text was not sent</returns>
  5007. </member>
  5008. <member name="M:NetCoreServer.UdpServer.Receive(System.Net.EndPoint@,System.Byte[])">
  5009. <summary>
  5010. Receive a new datagram from the given endpoint (synchronous)
  5011. </summary>
  5012. <param name="endpoint">Endpoint to receive from</param>
  5013. <param name="buffer">Datagram buffer to receive</param>
  5014. <returns>Size of received datagram</returns>
  5015. </member>
  5016. <member name="M:NetCoreServer.UdpServer.Receive(System.Net.EndPoint@,System.Byte[],System.Int64,System.Int64)">
  5017. <summary>
  5018. Receive a new datagram from the given endpoint (synchronous)
  5019. </summary>
  5020. <param name="endpoint">Endpoint to receive from</param>
  5021. <param name="buffer">Datagram buffer to receive</param>
  5022. <param name="offset">Datagram buffer offset</param>
  5023. <param name="size">Datagram buffer size</param>
  5024. <returns>Size of received datagram</returns>
  5025. </member>
  5026. <member name="M:NetCoreServer.UdpServer.Receive(System.Net.EndPoint@,System.Int64)">
  5027. <summary>
  5028. Receive text from the given endpoint (synchronous)
  5029. </summary>
  5030. <param name="endpoint">Endpoint to receive from</param>
  5031. <param name="size">Text size to receive</param>
  5032. <returns>Received text</returns>
  5033. </member>
  5034. <member name="M:NetCoreServer.UdpServer.ReceiveAsync">
  5035. <summary>
  5036. Receive datagram from the client (asynchronous)
  5037. </summary>
  5038. </member>
  5039. <member name="M:NetCoreServer.UdpServer.TryReceive">
  5040. <summary>
  5041. Try to receive new data
  5042. </summary>
  5043. </member>
  5044. <member name="M:NetCoreServer.UdpServer.TrySend">
  5045. <summary>
  5046. Try to send pending data
  5047. </summary>
  5048. </member>
  5049. <member name="M:NetCoreServer.UdpServer.ClearBuffers">
  5050. <summary>
  5051. Clear send/receive buffers
  5052. </summary>
  5053. </member>
  5054. <member name="M:NetCoreServer.UdpServer.OnAsyncCompleted(System.Object,System.Net.Sockets.SocketAsyncEventArgs)">
  5055. <summary>
  5056. This method is called whenever a receive or send operation is completed on a socket
  5057. </summary>
  5058. </member>
  5059. <member name="M:NetCoreServer.UdpServer.ProcessReceiveFrom(System.Net.Sockets.SocketAsyncEventArgs)">
  5060. <summary>
  5061. This method is invoked when an asynchronous receive from operation completes
  5062. </summary>
  5063. </member>
  5064. <member name="M:NetCoreServer.UdpServer.ProcessSendTo(System.Net.Sockets.SocketAsyncEventArgs)">
  5065. <summary>
  5066. This method is invoked when an asynchronous send to operation completes
  5067. </summary>
  5068. </member>
  5069. <member name="M:NetCoreServer.UdpServer.OnStarting">
  5070. <summary>
  5071. Handle server starting notification
  5072. </summary>
  5073. </member>
  5074. <member name="M:NetCoreServer.UdpServer.OnStarted">
  5075. <summary>
  5076. Handle server started notification
  5077. </summary>
  5078. </member>
  5079. <member name="M:NetCoreServer.UdpServer.OnStopping">
  5080. <summary>
  5081. Handle server stopping notification
  5082. </summary>
  5083. </member>
  5084. <member name="M:NetCoreServer.UdpServer.OnStopped">
  5085. <summary>
  5086. Handle server stopped notification
  5087. </summary>
  5088. </member>
  5089. <member name="M:NetCoreServer.UdpServer.OnReceived(System.Net.EndPoint,System.Byte[],System.Int64,System.Int64)">
  5090. <summary>
  5091. Handle datagram received notification
  5092. </summary>
  5093. <param name="endpoint">Received endpoint</param>
  5094. <param name="buffer">Received datagram buffer</param>
  5095. <param name="offset">Received datagram buffer offset</param>
  5096. <param name="size">Received datagram buffer size</param>
  5097. <remarks>
  5098. Notification is called when another datagram was received from some endpoint
  5099. </remarks>
  5100. </member>
  5101. <member name="M:NetCoreServer.UdpServer.OnSent(System.Net.EndPoint,System.Int64)">
  5102. <summary>
  5103. Handle datagram sent notification
  5104. </summary>
  5105. <param name="endpoint">Endpoint of sent datagram</param>
  5106. <param name="sent">Size of sent datagram buffer</param>
  5107. <remarks>
  5108. Notification is called when a datagram was sent to the client.
  5109. This handler could be used to send another datagram to the client for instance when the pending size is zero.
  5110. </remarks>
  5111. </member>
  5112. <member name="M:NetCoreServer.UdpServer.OnError(System.Net.Sockets.SocketError)">
  5113. <summary>
  5114. Handle error notification
  5115. </summary>
  5116. <param name="error">Socket error code</param>
  5117. </member>
  5118. <member name="M:NetCoreServer.UdpServer.SendError(System.Net.Sockets.SocketError)">
  5119. <summary>
  5120. Send error notification
  5121. </summary>
  5122. <param name="error">Socket error code</param>
  5123. </member>
  5124. <member name="P:NetCoreServer.UdpServer.IsDisposed">
  5125. <summary>
  5126. Disposed flag
  5127. </summary>
  5128. </member>
  5129. <member name="P:NetCoreServer.UdpServer.IsSocketDisposed">
  5130. <summary>
  5131. Server socket disposed flag
  5132. </summary>
  5133. </member>
  5134. <member name="T:NetCoreServer.UdsClient">
  5135. <summary>
  5136. Unix Domain Socket client is used to read/write data from/into the connected Unix Domain Socket server
  5137. </summary>
  5138. <remarks>Thread-safe</remarks>
  5139. </member>
  5140. <member name="M:NetCoreServer.UdsClient.#ctor(System.String)">
  5141. <summary>
  5142. Initialize Unix Domain Socket client with a given socket path
  5143. </summary>
  5144. <param name="path">Socket path</param>
  5145. </member>
  5146. <member name="M:NetCoreServer.UdsClient.#ctor(System.Net.Sockets.UnixDomainSocketEndPoint)">
  5147. <summary>
  5148. Initialize Unix Domain Socket client with a given Unix Domain Socket endpoint
  5149. </summary>
  5150. <param name="endpoint">Unix Domain Socket endpoint</param>
  5151. </member>
  5152. <member name="P:NetCoreServer.UdsClient.Id">
  5153. <summary>
  5154. Client Id
  5155. </summary>
  5156. </member>
  5157. <member name="P:NetCoreServer.UdsClient.Endpoint">
  5158. <summary>
  5159. Endpoint
  5160. </summary>
  5161. </member>
  5162. <member name="P:NetCoreServer.UdsClient.Socket">
  5163. <summary>
  5164. Socket
  5165. </summary>
  5166. </member>
  5167. <member name="P:NetCoreServer.UdsClient.BytesPending">
  5168. <summary>
  5169. Number of bytes pending sent by the client
  5170. </summary>
  5171. </member>
  5172. <member name="P:NetCoreServer.UdsClient.BytesSending">
  5173. <summary>
  5174. Number of bytes sending by the client
  5175. </summary>
  5176. </member>
  5177. <member name="P:NetCoreServer.UdsClient.BytesSent">
  5178. <summary>
  5179. Number of bytes sent by the client
  5180. </summary>
  5181. </member>
  5182. <member name="P:NetCoreServer.UdsClient.BytesReceived">
  5183. <summary>
  5184. Number of bytes received by the client
  5185. </summary>
  5186. </member>
  5187. <member name="P:NetCoreServer.UdsClient.OptionReceiveBufferLimit">
  5188. <summary>
  5189. Option: receive buffer limit
  5190. </summary>
  5191. </member>
  5192. <member name="P:NetCoreServer.UdsClient.OptionReceiveBufferSize">
  5193. <summary>
  5194. Option: receive buffer size
  5195. </summary>
  5196. </member>
  5197. <member name="P:NetCoreServer.UdsClient.OptionSendBufferLimit">
  5198. <summary>
  5199. Option: send buffer limit
  5200. </summary>
  5201. </member>
  5202. <member name="P:NetCoreServer.UdsClient.OptionSendBufferSize">
  5203. <summary>
  5204. Option: send buffer size
  5205. </summary>
  5206. </member>
  5207. <member name="P:NetCoreServer.UdsClient.IsConnecting">
  5208. <summary>
  5209. Is the client connecting?
  5210. </summary>
  5211. </member>
  5212. <member name="P:NetCoreServer.UdsClient.IsConnected">
  5213. <summary>
  5214. Is the client connected?
  5215. </summary>
  5216. </member>
  5217. <member name="M:NetCoreServer.UdsClient.CreateSocket">
  5218. <summary>
  5219. Create a new socket object
  5220. </summary>
  5221. <remarks>
  5222. Method may be override if you need to prepare some specific socket object in your implementation.
  5223. </remarks>
  5224. <returns>Socket object</returns>
  5225. </member>
  5226. <member name="M:NetCoreServer.UdsClient.Connect">
  5227. <summary>
  5228. Connect the client (synchronous)
  5229. </summary>
  5230. <remarks>
  5231. Please note that synchronous connect will not receive data automatically!
  5232. You should use Receive() or ReceiveAsync() method manually after successful connection.
  5233. </remarks>
  5234. <returns>'true' if the client was successfully connected, 'false' if the client failed to connect</returns>
  5235. </member>
  5236. <member name="M:NetCoreServer.UdsClient.Disconnect">
  5237. <summary>
  5238. Disconnect the client (synchronous)
  5239. </summary>
  5240. <returns>'true' if the client was successfully disconnected, 'false' if the client is already disconnected</returns>
  5241. </member>
  5242. <member name="M:NetCoreServer.UdsClient.Reconnect">
  5243. <summary>
  5244. Reconnect the client (synchronous)
  5245. </summary>
  5246. <returns>'true' if the client was successfully reconnected, 'false' if the client is already reconnected</returns>
  5247. </member>
  5248. <member name="M:NetCoreServer.UdsClient.ConnectAsync">
  5249. <summary>
  5250. Connect the client (asynchronous)
  5251. </summary>
  5252. <returns>'true' if the client was successfully connected, 'false' if the client failed to connect</returns>
  5253. </member>
  5254. <member name="M:NetCoreServer.UdsClient.DisconnectAsync">
  5255. <summary>
  5256. Disconnect the client (asynchronous)
  5257. </summary>
  5258. <returns>'true' if the client was successfully disconnected, 'false' if the client is already disconnected</returns>
  5259. </member>
  5260. <member name="M:NetCoreServer.UdsClient.ReconnectAsync">
  5261. <summary>
  5262. Reconnect the client (asynchronous)
  5263. </summary>
  5264. <returns>'true' if the client was successfully reconnected, 'false' if the client is already reconnected</returns>
  5265. </member>
  5266. <member name="M:NetCoreServer.UdsClient.Send(System.Byte[])">
  5267. <summary>
  5268. Send data to the server (synchronous)
  5269. </summary>
  5270. <param name="buffer">Buffer to send</param>
  5271. <returns>Size of sent data</returns>
  5272. </member>
  5273. <member name="M:NetCoreServer.UdsClient.Send(System.Byte[],System.Int64,System.Int64)">
  5274. <summary>
  5275. Send data to the server (synchronous)
  5276. </summary>
  5277. <param name="buffer">Buffer to send</param>
  5278. <param name="offset">Buffer offset</param>
  5279. <param name="size">Buffer size</param>
  5280. <returns>Size of sent data</returns>
  5281. </member>
  5282. <member name="M:NetCoreServer.UdsClient.Send(System.ReadOnlySpan{System.Byte})">
  5283. <summary>
  5284. Send data to the server (synchronous)
  5285. </summary>
  5286. <param name="buffer">Buffer to send as a span of bytes</param>
  5287. <returns>Size of sent data</returns>
  5288. </member>
  5289. <member name="M:NetCoreServer.UdsClient.Send(System.String)">
  5290. <summary>
  5291. Send text to the server (synchronous)
  5292. </summary>
  5293. <param name="text">Text string to send</param>
  5294. <returns>Size of sent text</returns>
  5295. </member>
  5296. <member name="M:NetCoreServer.UdsClient.Send(System.ReadOnlySpan{System.Char})">
  5297. <summary>
  5298. Send text to the server (synchronous)
  5299. </summary>
  5300. <param name="text">Text to send as a span of characters</param>
  5301. <returns>Size of sent text</returns>
  5302. </member>
  5303. <member name="M:NetCoreServer.UdsClient.SendAsync(System.Byte[])">
  5304. <summary>
  5305. Send data to the server (asynchronous)
  5306. </summary>
  5307. <param name="buffer">Buffer to send</param>
  5308. <returns>'true' if the data was successfully sent, 'false' if the client is not connected</returns>
  5309. </member>
  5310. <member name="M:NetCoreServer.UdsClient.SendAsync(System.Byte[],System.Int64,System.Int64)">
  5311. <summary>
  5312. Send data to the server (asynchronous)
  5313. </summary>
  5314. <param name="buffer">Buffer to send</param>
  5315. <param name="offset">Buffer offset</param>
  5316. <param name="size">Buffer size</param>
  5317. <returns>'true' if the data was successfully sent, 'false' if the client is not connected</returns>
  5318. </member>
  5319. <member name="M:NetCoreServer.UdsClient.SendAsync(System.ReadOnlySpan{System.Byte})">
  5320. <summary>
  5321. Send data to the server (asynchronous)
  5322. </summary>
  5323. <param name="buffer">Buffer to send as a span of bytes</param>
  5324. <returns>'true' if the data was successfully sent, 'false' if the client is not connected</returns>
  5325. </member>
  5326. <member name="M:NetCoreServer.UdsClient.SendAsync(System.String)">
  5327. <summary>
  5328. Send text to the server (asynchronous)
  5329. </summary>
  5330. <param name="text">Text string to send</param>
  5331. <returns>'true' if the text was successfully sent, 'false' if the client is not connected</returns>
  5332. </member>
  5333. <member name="M:NetCoreServer.UdsClient.SendAsync(System.ReadOnlySpan{System.Char})">
  5334. <summary>
  5335. Send text to the server (asynchronous)
  5336. </summary>
  5337. <param name="text">Text to send as a span of characters</param>
  5338. <returns>'true' if the text was successfully sent, 'false' if the client is not connected</returns>
  5339. </member>
  5340. <member name="M:NetCoreServer.UdsClient.Receive(System.Byte[])">
  5341. <summary>
  5342. Receive data from the server (synchronous)
  5343. </summary>
  5344. <param name="buffer">Buffer to receive</param>
  5345. <returns>Size of received data</returns>
  5346. </member>
  5347. <member name="M:NetCoreServer.UdsClient.Receive(System.Byte[],System.Int64,System.Int64)">
  5348. <summary>
  5349. Receive data from the server (synchronous)
  5350. </summary>
  5351. <param name="buffer">Buffer to receive</param>
  5352. <param name="offset">Buffer offset</param>
  5353. <param name="size">Buffer size</param>
  5354. <returns>Size of received data</returns>
  5355. </member>
  5356. <member name="M:NetCoreServer.UdsClient.Receive(System.Int64)">
  5357. <summary>
  5358. Receive text from the server (synchronous)
  5359. </summary>
  5360. <param name="size">Text size to receive</param>
  5361. <returns>Received text</returns>
  5362. </member>
  5363. <member name="M:NetCoreServer.UdsClient.ReceiveAsync">
  5364. <summary>
  5365. Receive data from the server (asynchronous)
  5366. </summary>
  5367. </member>
  5368. <member name="M:NetCoreServer.UdsClient.TryReceive">
  5369. <summary>
  5370. Try to receive new data
  5371. </summary>
  5372. </member>
  5373. <member name="M:NetCoreServer.UdsClient.TrySend">
  5374. <summary>
  5375. Try to send pending data
  5376. </summary>
  5377. </member>
  5378. <member name="M:NetCoreServer.UdsClient.ClearBuffers">
  5379. <summary>
  5380. Clear send/receive buffers
  5381. </summary>
  5382. </member>
  5383. <member name="M:NetCoreServer.UdsClient.OnAsyncCompleted(System.Object,System.Net.Sockets.SocketAsyncEventArgs)">
  5384. <summary>
  5385. This method is called whenever a receive or send operation is completed on a socket
  5386. </summary>
  5387. </member>
  5388. <member name="M:NetCoreServer.UdsClient.ProcessConnect(System.Net.Sockets.SocketAsyncEventArgs)">
  5389. <summary>
  5390. This method is invoked when an asynchronous connect operation completes
  5391. </summary>
  5392. </member>
  5393. <member name="M:NetCoreServer.UdsClient.ProcessReceive(System.Net.Sockets.SocketAsyncEventArgs)">
  5394. <summary>
  5395. This method is invoked when an asynchronous receive operation completes
  5396. </summary>
  5397. </member>
  5398. <member name="M:NetCoreServer.UdsClient.ProcessSend(System.Net.Sockets.SocketAsyncEventArgs)">
  5399. <summary>
  5400. This method is invoked when an asynchronous send operation completes
  5401. </summary>
  5402. </member>
  5403. <member name="M:NetCoreServer.UdsClient.OnConnecting">
  5404. <summary>
  5405. Handle client connecting notification
  5406. </summary>
  5407. </member>
  5408. <member name="M:NetCoreServer.UdsClient.OnConnected">
  5409. <summary>
  5410. Handle client connected notification
  5411. </summary>
  5412. </member>
  5413. <member name="M:NetCoreServer.UdsClient.OnDisconnecting">
  5414. <summary>
  5415. Handle client disconnecting notification
  5416. </summary>
  5417. </member>
  5418. <member name="M:NetCoreServer.UdsClient.OnDisconnected">
  5419. <summary>
  5420. Handle client disconnected notification
  5421. </summary>
  5422. </member>
  5423. <member name="M:NetCoreServer.UdsClient.OnReceived(System.Byte[],System.Int64,System.Int64)">
  5424. <summary>
  5425. Handle buffer received notification
  5426. </summary>
  5427. <param name="buffer">Received buffer</param>
  5428. <param name="offset">Received buffer offset</param>
  5429. <param name="size">Received buffer size</param>
  5430. <remarks>
  5431. Notification is called when another part of buffer was received from the server
  5432. </remarks>
  5433. </member>
  5434. <member name="M:NetCoreServer.UdsClient.OnSent(System.Int64,System.Int64)">
  5435. <summary>
  5436. Handle buffer sent notification
  5437. </summary>
  5438. <param name="sent">Size of sent buffer</param>
  5439. <param name="pending">Size of pending buffer</param>
  5440. <remarks>
  5441. Notification is called when another part of buffer was sent to the server.
  5442. This handler could be used to send another buffer to the server for instance when the pending size is zero.
  5443. </remarks>
  5444. </member>
  5445. <member name="M:NetCoreServer.UdsClient.OnEmpty">
  5446. <summary>
  5447. Handle empty send buffer notification
  5448. </summary>
  5449. <remarks>
  5450. Notification is called when the send buffer is empty and ready for a new data to send.
  5451. This handler could be used to send another buffer to the server.
  5452. </remarks>
  5453. </member>
  5454. <member name="M:NetCoreServer.UdsClient.OnError(System.Net.Sockets.SocketError)">
  5455. <summary>
  5456. Handle error notification
  5457. </summary>
  5458. <param name="error">Socket error code</param>
  5459. </member>
  5460. <member name="M:NetCoreServer.UdsClient.SendError(System.Net.Sockets.SocketError)">
  5461. <summary>
  5462. Send error notification
  5463. </summary>
  5464. <param name="error">Socket error code</param>
  5465. </member>
  5466. <member name="P:NetCoreServer.UdsClient.IsDisposed">
  5467. <summary>
  5468. Disposed flag
  5469. </summary>
  5470. </member>
  5471. <member name="P:NetCoreServer.UdsClient.IsSocketDisposed">
  5472. <summary>
  5473. Client socket disposed flag
  5474. </summary>
  5475. </member>
  5476. <member name="T:NetCoreServer.UdsServer">
  5477. <summary>
  5478. Unix Domain Socket server is used to connect, disconnect and manage Unix Domain Socket sessions
  5479. </summary>
  5480. <remarks>Thread-safe</remarks>
  5481. </member>
  5482. <member name="M:NetCoreServer.UdsServer.#ctor(System.String)">
  5483. <summary>
  5484. Initialize Unix Domain Socket server with a given socket path
  5485. </summary>
  5486. <param name="path">Socket path</param>
  5487. </member>
  5488. <member name="M:NetCoreServer.UdsServer.#ctor(System.Net.Sockets.UnixDomainSocketEndPoint)">
  5489. <summary>
  5490. Initialize Unix Domain Socket server with a given Unix Domain Socket endpoint
  5491. </summary>
  5492. <param name="endpoint">Unix Domain Socket endpoint</param>
  5493. </member>
  5494. <member name="P:NetCoreServer.UdsServer.Id">
  5495. <summary>
  5496. Server Id
  5497. </summary>
  5498. </member>
  5499. <member name="P:NetCoreServer.UdsServer.Endpoint">
  5500. <summary>
  5501. Endpoint
  5502. </summary>
  5503. </member>
  5504. <member name="P:NetCoreServer.UdsServer.ConnectedSessions">
  5505. <summary>
  5506. Number of sessions connected to the server
  5507. </summary>
  5508. </member>
  5509. <member name="P:NetCoreServer.UdsServer.BytesPending">
  5510. <summary>
  5511. Number of bytes pending sent by the server
  5512. </summary>
  5513. </member>
  5514. <member name="P:NetCoreServer.UdsServer.BytesSent">
  5515. <summary>
  5516. Number of bytes sent by the server
  5517. </summary>
  5518. </member>
  5519. <member name="P:NetCoreServer.UdsServer.BytesReceived">
  5520. <summary>
  5521. Number of bytes received by the server
  5522. </summary>
  5523. </member>
  5524. <member name="P:NetCoreServer.UdsServer.OptionAcceptorBacklog">
  5525. <summary>
  5526. Option: acceptor backlog size
  5527. </summary>
  5528. <remarks>
  5529. This option will set the listening socket's backlog size
  5530. </remarks>
  5531. </member>
  5532. <member name="P:NetCoreServer.UdsServer.OptionReceiveBufferSize">
  5533. <summary>
  5534. Option: receive buffer size
  5535. </summary>
  5536. </member>
  5537. <member name="P:NetCoreServer.UdsServer.OptionSendBufferSize">
  5538. <summary>
  5539. Option: send buffer size
  5540. </summary>
  5541. </member>
  5542. <member name="P:NetCoreServer.UdsServer.IsStarted">
  5543. <summary>
  5544. Is the server started?
  5545. </summary>
  5546. </member>
  5547. <member name="P:NetCoreServer.UdsServer.IsAccepting">
  5548. <summary>
  5549. Is the server accepting new clients?
  5550. </summary>
  5551. </member>
  5552. <member name="M:NetCoreServer.UdsServer.CreateSocket">
  5553. <summary>
  5554. Create a new socket object
  5555. </summary>
  5556. <remarks>
  5557. Method may be override if you need to prepare some specific socket object in your implementation.
  5558. </remarks>
  5559. <returns>Socket object</returns>
  5560. </member>
  5561. <member name="M:NetCoreServer.UdsServer.Start">
  5562. <summary>
  5563. Start the server
  5564. </summary>
  5565. <returns>'true' if the server was successfully started, 'false' if the server failed to start</returns>
  5566. </member>
  5567. <member name="M:NetCoreServer.UdsServer.Stop">
  5568. <summary>
  5569. Stop the server
  5570. </summary>
  5571. <returns>'true' if the server was successfully stopped, 'false' if the server is already stopped</returns>
  5572. </member>
  5573. <member name="M:NetCoreServer.UdsServer.Restart">
  5574. <summary>
  5575. Restart the server
  5576. </summary>
  5577. <returns>'true' if the server was successfully restarted, 'false' if the server failed to restart</returns>
  5578. </member>
  5579. <member name="M:NetCoreServer.UdsServer.StartAccept(System.Net.Sockets.SocketAsyncEventArgs)">
  5580. <summary>
  5581. Start accept a new client connection
  5582. </summary>
  5583. </member>
  5584. <member name="M:NetCoreServer.UdsServer.ProcessAccept(System.Net.Sockets.SocketAsyncEventArgs)">
  5585. <summary>
  5586. Process accepted client connection
  5587. </summary>
  5588. </member>
  5589. <member name="M:NetCoreServer.UdsServer.OnAsyncCompleted(System.Object,System.Net.Sockets.SocketAsyncEventArgs)">
  5590. <summary>
  5591. This method is the callback method associated with Socket.AcceptAsync()
  5592. operations and is invoked when an accept operation is complete
  5593. </summary>
  5594. </member>
  5595. <member name="M:NetCoreServer.UdsServer.CreateSession">
  5596. <summary>
  5597. Create Unix Domain Socket session factory method
  5598. </summary>
  5599. <returns>Unix Domain Socket session</returns>
  5600. </member>
  5601. <member name="F:NetCoreServer.UdsServer.Sessions">
  5602. <summary>
  5603. Server sessions
  5604. </summary>
  5605. </member>
  5606. <member name="M:NetCoreServer.UdsServer.DisconnectAll">
  5607. <summary>
  5608. Disconnect all connected sessions
  5609. </summary>
  5610. <returns>'true' if all sessions were successfully disconnected, 'false' if the server is not started</returns>
  5611. </member>
  5612. <member name="M:NetCoreServer.UdsServer.FindSession(System.Guid)">
  5613. <summary>
  5614. Find a session with a given Id
  5615. </summary>
  5616. <param name="id">Session Id</param>
  5617. <returns>Session with a given Id or null if the session it not connected</returns>
  5618. </member>
  5619. <member name="M:NetCoreServer.UdsServer.RegisterSession(NetCoreServer.UdsSession)">
  5620. <summary>
  5621. Register a new session
  5622. </summary>
  5623. <param name="session">Session to register</param>
  5624. </member>
  5625. <member name="M:NetCoreServer.UdsServer.UnregisterSession(System.Guid)">
  5626. <summary>
  5627. Unregister session by Id
  5628. </summary>
  5629. <param name="id">Session Id</param>
  5630. </member>
  5631. <member name="M:NetCoreServer.UdsServer.Multicast(System.Byte[])">
  5632. <summary>
  5633. Multicast data to all connected sessions
  5634. </summary>
  5635. <param name="buffer">Buffer to multicast</param>
  5636. <returns>'true' if the data was successfully multicasted, 'false' if the data was not multicasted</returns>
  5637. </member>
  5638. <member name="M:NetCoreServer.UdsServer.Multicast(System.Byte[],System.Int64,System.Int64)">
  5639. <summary>
  5640. Multicast data to all connected clients
  5641. </summary>
  5642. <param name="buffer">Buffer to multicast</param>
  5643. <param name="offset">Buffer offset</param>
  5644. <param name="size">Buffer size</param>
  5645. <returns>'true' if the data was successfully multicasted, 'false' if the data was not multicasted</returns>
  5646. </member>
  5647. <member name="M:NetCoreServer.UdsServer.Multicast(System.ReadOnlySpan{System.Byte})">
  5648. <summary>
  5649. Multicast data to all connected clients
  5650. </summary>
  5651. <param name="buffer">Buffer to send as a span of bytes</param>
  5652. <returns>'true' if the data was successfully multicasted, 'false' if the data was not multicasted</returns>
  5653. </member>
  5654. <member name="M:NetCoreServer.UdsServer.Multicast(System.String)">
  5655. <summary>
  5656. Multicast text to all connected clients
  5657. </summary>
  5658. <param name="text">Text string to multicast</param>
  5659. <returns>'true' if the text was successfully multicasted, 'false' if the text was not multicasted</returns>
  5660. </member>
  5661. <member name="M:NetCoreServer.UdsServer.Multicast(System.ReadOnlySpan{System.Char})">
  5662. <summary>
  5663. Multicast text to all connected clients
  5664. </summary>
  5665. <param name="text">Text to multicast as a span of characters</param>
  5666. <returns>'true' if the text was successfully multicasted, 'false' if the text was not multicasted</returns>
  5667. </member>
  5668. <member name="M:NetCoreServer.UdsServer.OnStarting">
  5669. <summary>
  5670. Handle server starting notification
  5671. </summary>
  5672. </member>
  5673. <member name="M:NetCoreServer.UdsServer.OnStarted">
  5674. <summary>
  5675. Handle server started notification
  5676. </summary>
  5677. </member>
  5678. <member name="M:NetCoreServer.UdsServer.OnStopping">
  5679. <summary>
  5680. Handle server stopping notification
  5681. </summary>
  5682. </member>
  5683. <member name="M:NetCoreServer.UdsServer.OnStopped">
  5684. <summary>
  5685. Handle server stopped notification
  5686. </summary>
  5687. </member>
  5688. <member name="M:NetCoreServer.UdsServer.OnConnecting(NetCoreServer.UdsSession)">
  5689. <summary>
  5690. Handle session connecting notification
  5691. </summary>
  5692. <param name="session">Connecting session</param>
  5693. </member>
  5694. <member name="M:NetCoreServer.UdsServer.OnConnected(NetCoreServer.UdsSession)">
  5695. <summary>
  5696. Handle session connected notification
  5697. </summary>
  5698. <param name="session">Connected session</param>
  5699. </member>
  5700. <member name="M:NetCoreServer.UdsServer.OnDisconnecting(NetCoreServer.UdsSession)">
  5701. <summary>
  5702. Handle session disconnecting notification
  5703. </summary>
  5704. <param name="session">Disconnecting session</param>
  5705. </member>
  5706. <member name="M:NetCoreServer.UdsServer.OnDisconnected(NetCoreServer.UdsSession)">
  5707. <summary>
  5708. Handle session disconnected notification
  5709. </summary>
  5710. <param name="session">Disconnected session</param>
  5711. </member>
  5712. <member name="M:NetCoreServer.UdsServer.OnError(System.Net.Sockets.SocketError)">
  5713. <summary>
  5714. Handle error notification
  5715. </summary>
  5716. <param name="error">Socket error code</param>
  5717. </member>
  5718. <member name="M:NetCoreServer.UdsServer.SendError(System.Net.Sockets.SocketError)">
  5719. <summary>
  5720. Send error notification
  5721. </summary>
  5722. <param name="error">Socket error code</param>
  5723. </member>
  5724. <member name="P:NetCoreServer.UdsServer.IsDisposed">
  5725. <summary>
  5726. Disposed flag
  5727. </summary>
  5728. </member>
  5729. <member name="P:NetCoreServer.UdsServer.IsSocketDisposed">
  5730. <summary>
  5731. Acceptor socket disposed flag
  5732. </summary>
  5733. </member>
  5734. <member name="T:NetCoreServer.UdsSession">
  5735. <summary>
  5736. Unix Domain Socket session is used to read and write data from the connected Unix Domain Socket client
  5737. </summary>
  5738. <remarks>Thread-safe</remarks>
  5739. </member>
  5740. <member name="M:NetCoreServer.UdsSession.#ctor(NetCoreServer.UdsServer)">
  5741. <summary>
  5742. Initialize the session with a given server
  5743. </summary>
  5744. <param name="server">Unix Domain Socket server</param>
  5745. </member>
  5746. <member name="P:NetCoreServer.UdsSession.Id">
  5747. <summary>
  5748. Session Id
  5749. </summary>
  5750. </member>
  5751. <member name="P:NetCoreServer.UdsSession.Server">
  5752. <summary>
  5753. Server
  5754. </summary>
  5755. </member>
  5756. <member name="P:NetCoreServer.UdsSession.Socket">
  5757. <summary>
  5758. Socket
  5759. </summary>
  5760. </member>
  5761. <member name="P:NetCoreServer.UdsSession.BytesPending">
  5762. <summary>
  5763. Number of bytes pending sent by the session
  5764. </summary>
  5765. </member>
  5766. <member name="P:NetCoreServer.UdsSession.BytesSending">
  5767. <summary>
  5768. Number of bytes sending by the session
  5769. </summary>
  5770. </member>
  5771. <member name="P:NetCoreServer.UdsSession.BytesSent">
  5772. <summary>
  5773. Number of bytes sent by the session
  5774. </summary>
  5775. </member>
  5776. <member name="P:NetCoreServer.UdsSession.BytesReceived">
  5777. <summary>
  5778. Number of bytes received by the session
  5779. </summary>
  5780. </member>
  5781. <member name="P:NetCoreServer.UdsSession.OptionReceiveBufferLimit">
  5782. <summary>
  5783. Option: receive buffer limit
  5784. </summary>
  5785. </member>
  5786. <member name="P:NetCoreServer.UdsSession.OptionReceiveBufferSize">
  5787. <summary>
  5788. Option: receive buffer size
  5789. </summary>
  5790. </member>
  5791. <member name="P:NetCoreServer.UdsSession.OptionSendBufferLimit">
  5792. <summary>
  5793. Option: send buffer limit
  5794. </summary>
  5795. </member>
  5796. <member name="P:NetCoreServer.UdsSession.OptionSendBufferSize">
  5797. <summary>
  5798. Option: send buffer size
  5799. </summary>
  5800. </member>
  5801. <member name="P:NetCoreServer.UdsSession.IsConnected">
  5802. <summary>
  5803. Is the session connected?
  5804. </summary>
  5805. </member>
  5806. <member name="M:NetCoreServer.UdsSession.Connect(System.Net.Sockets.Socket)">
  5807. <summary>
  5808. Connect the session
  5809. </summary>
  5810. <param name="socket">Session socket</param>
  5811. </member>
  5812. <member name="M:NetCoreServer.UdsSession.Disconnect">
  5813. <summary>
  5814. Disconnect the session
  5815. </summary>
  5816. <returns>'true' if the section was successfully disconnected, 'false' if the section is already disconnected</returns>
  5817. </member>
  5818. <member name="M:NetCoreServer.UdsSession.Send(System.Byte[])">
  5819. <summary>
  5820. Send data to the client (synchronous)
  5821. </summary>
  5822. <param name="buffer">Buffer to send</param>
  5823. <returns>Size of sent data</returns>
  5824. </member>
  5825. <member name="M:NetCoreServer.UdsSession.Send(System.Byte[],System.Int64,System.Int64)">
  5826. <summary>
  5827. Send data to the client (synchronous)
  5828. </summary>
  5829. <param name="buffer">Buffer to send</param>
  5830. <param name="offset">Buffer offset</param>
  5831. <param name="size">Buffer size</param>
  5832. <returns>Size of sent data</returns>
  5833. </member>
  5834. <member name="M:NetCoreServer.UdsSession.Send(System.ReadOnlySpan{System.Byte})">
  5835. <summary>
  5836. Send data to the client (synchronous)
  5837. </summary>
  5838. <param name="buffer">Buffer to send as a span of bytes</param>
  5839. <returns>Size of sent data</returns>
  5840. </member>
  5841. <member name="M:NetCoreServer.UdsSession.Send(System.String)">
  5842. <summary>
  5843. Send text to the client (synchronous)
  5844. </summary>
  5845. <param name="text">Text string to send</param>
  5846. <returns>Size of sent data</returns>
  5847. </member>
  5848. <member name="M:NetCoreServer.UdsSession.SendAsync(System.Byte[])">
  5849. <summary>
  5850. Send data to the client (asynchronous)
  5851. </summary>
  5852. <param name="buffer">Buffer to send</param>
  5853. <returns>'true' if the data was successfully sent, 'false' if the session is not connected</returns>
  5854. </member>
  5855. <member name="M:NetCoreServer.UdsSession.SendAsync(System.Byte[],System.Int64,System.Int64)">
  5856. <summary>
  5857. Send data to the client (asynchronous)
  5858. </summary>
  5859. <param name="buffer">Buffer to send</param>
  5860. <param name="offset">Buffer offset</param>
  5861. <param name="size">Buffer size</param>
  5862. <returns>'true' if the data was successfully sent, 'false' if the session is not connected</returns>
  5863. </member>
  5864. <member name="M:NetCoreServer.UdsSession.SendAsync(System.ReadOnlySpan{System.Byte})">
  5865. <summary>
  5866. Send data to the client (asynchronous)
  5867. </summary>
  5868. <param name="buffer">Buffer to send as a span of bytes</param>
  5869. <returns>'true' if the data was successfully sent, 'false' if the session is not connected</returns>
  5870. </member>
  5871. <member name="M:NetCoreServer.UdsSession.SendAsync(System.String)">
  5872. <summary>
  5873. Send text to the client (asynchronous)
  5874. </summary>
  5875. <param name="text">Text string to send</param>
  5876. <returns>'true' if the text was successfully sent, 'false' if the session is not connected</returns>
  5877. </member>
  5878. <member name="M:NetCoreServer.UdsSession.SendAsync(System.ReadOnlySpan{System.Char})">
  5879. <summary>
  5880. Send text to the client (asynchronous)
  5881. </summary>
  5882. <param name="text">Text to send as a span of characters</param>
  5883. <returns>'true' if the text was successfully sent, 'false' if the session is not connected</returns>
  5884. </member>
  5885. <member name="M:NetCoreServer.UdsSession.Receive(System.Byte[])">
  5886. <summary>
  5887. Receive data from the client (synchronous)
  5888. </summary>
  5889. <param name="buffer">Buffer to receive</param>
  5890. <returns>Size of received data</returns>
  5891. </member>
  5892. <member name="M:NetCoreServer.UdsSession.Receive(System.Byte[],System.Int64,System.Int64)">
  5893. <summary>
  5894. Receive data from the client (synchronous)
  5895. </summary>
  5896. <param name="buffer">Buffer to receive</param>
  5897. <param name="offset">Buffer offset</param>
  5898. <param name="size">Buffer size</param>
  5899. <returns>Size of received data</returns>
  5900. </member>
  5901. <member name="M:NetCoreServer.UdsSession.Receive(System.Int64)">
  5902. <summary>
  5903. Receive text from the client (synchronous)
  5904. </summary>
  5905. <param name="size">Text size to receive</param>
  5906. <returns>Received text</returns>
  5907. </member>
  5908. <member name="M:NetCoreServer.UdsSession.ReceiveAsync">
  5909. <summary>
  5910. Receive data from the client (asynchronous)
  5911. </summary>
  5912. </member>
  5913. <member name="M:NetCoreServer.UdsSession.TryReceive">
  5914. <summary>
  5915. Try to receive new data
  5916. </summary>
  5917. </member>
  5918. <member name="M:NetCoreServer.UdsSession.TrySend">
  5919. <summary>
  5920. Try to send pending data
  5921. </summary>
  5922. </member>
  5923. <member name="M:NetCoreServer.UdsSession.ClearBuffers">
  5924. <summary>
  5925. Clear send/receive buffers
  5926. </summary>
  5927. </member>
  5928. <member name="M:NetCoreServer.UdsSession.OnAsyncCompleted(System.Object,System.Net.Sockets.SocketAsyncEventArgs)">
  5929. <summary>
  5930. This method is called whenever a receive or send operation is completed on a socket
  5931. </summary>
  5932. </member>
  5933. <member name="M:NetCoreServer.UdsSession.ProcessReceive(System.Net.Sockets.SocketAsyncEventArgs)">
  5934. <summary>
  5935. This method is invoked when an asynchronous receive operation completes
  5936. </summary>
  5937. </member>
  5938. <member name="M:NetCoreServer.UdsSession.ProcessSend(System.Net.Sockets.SocketAsyncEventArgs)">
  5939. <summary>
  5940. This method is invoked when an asynchronous send operation completes
  5941. </summary>
  5942. </member>
  5943. <member name="M:NetCoreServer.UdsSession.OnConnecting">
  5944. <summary>
  5945. Handle client connecting notification
  5946. </summary>
  5947. </member>
  5948. <member name="M:NetCoreServer.UdsSession.OnConnected">
  5949. <summary>
  5950. Handle client connected notification
  5951. </summary>
  5952. </member>
  5953. <member name="M:NetCoreServer.UdsSession.OnDisconnecting">
  5954. <summary>
  5955. Handle client disconnecting notification
  5956. </summary>
  5957. </member>
  5958. <member name="M:NetCoreServer.UdsSession.OnDisconnected">
  5959. <summary>
  5960. Handle client disconnected notification
  5961. </summary>
  5962. </member>
  5963. <member name="M:NetCoreServer.UdsSession.OnReceived(System.Byte[],System.Int64,System.Int64)">
  5964. <summary>
  5965. Handle buffer received notification
  5966. </summary>
  5967. <param name="buffer">Received buffer</param>
  5968. <param name="offset">Received buffer offset</param>
  5969. <param name="size">Received buffer size</param>
  5970. <remarks>
  5971. Notification is called when another part of buffer was received from the client
  5972. </remarks>
  5973. </member>
  5974. <member name="M:NetCoreServer.UdsSession.OnSent(System.Int64,System.Int64)">
  5975. <summary>
  5976. Handle buffer sent notification
  5977. </summary>
  5978. <param name="sent">Size of sent buffer</param>
  5979. <param name="pending">Size of pending buffer</param>
  5980. <remarks>
  5981. Notification is called when another part of buffer was sent to the client.
  5982. This handler could be used to send another buffer to the client for instance when the pending size is zero.
  5983. </remarks>
  5984. </member>
  5985. <member name="M:NetCoreServer.UdsSession.OnEmpty">
  5986. <summary>
  5987. Handle empty send buffer notification
  5988. </summary>
  5989. <remarks>
  5990. Notification is called when the send buffer is empty and ready for a new data to send.
  5991. This handler could be used to send another buffer to the client.
  5992. </remarks>
  5993. </member>
  5994. <member name="M:NetCoreServer.UdsSession.OnError(System.Net.Sockets.SocketError)">
  5995. <summary>
  5996. Handle error notification
  5997. </summary>
  5998. <param name="error">Socket error code</param>
  5999. </member>
  6000. <member name="M:NetCoreServer.UdsSession.SendError(System.Net.Sockets.SocketError)">
  6001. <summary>
  6002. Send error notification
  6003. </summary>
  6004. <param name="error">Socket error code</param>
  6005. </member>
  6006. <member name="P:NetCoreServer.UdsSession.IsDisposed">
  6007. <summary>
  6008. Disposed flag
  6009. </summary>
  6010. </member>
  6011. <member name="P:NetCoreServer.UdsSession.IsSocketDisposed">
  6012. <summary>
  6013. Session socket disposed flag
  6014. </summary>
  6015. </member>
  6016. <member name="T:NetCoreServer.Utilities">
  6017. <summary>
  6018. Conversion metrics utilities
  6019. </summary>
  6020. </member>
  6021. <member name="M:NetCoreServer.Utilities.GenerateDataSize(System.Double)">
  6022. <summary>
  6023. Generate data size string. Will return a pretty string of bytes, KiB, MiB, GiB, TiB based on the given bytes.
  6024. </summary>
  6025. <param name="b">Data size in bytes</param>
  6026. <returns>String with data size representation</returns>
  6027. </member>
  6028. <member name="M:NetCoreServer.Utilities.GenerateTimePeriod(System.Double)">
  6029. <summary>
  6030. Generate time period string. Will return a pretty string of ns, mcs, ms, s, m, h based on the given nanoseconds.
  6031. </summary>
  6032. <param name="ms">Milliseconds</param>
  6033. <returns>String with time period representation</returns>
  6034. </member>
  6035. <member name="T:NetCoreServer.WebSocket">
  6036. <summary>
  6037. WebSocket utility class
  6038. </summary>
  6039. </member>
  6040. <member name="M:NetCoreServer.WebSocket.#ctor(NetCoreServer.IWebSocket)">
  6041. <summary>
  6042. Initialize a new WebSocket
  6043. </summary>
  6044. <param name="wsHandler">WebSocket handler</param>
  6045. </member>
  6046. <member name="F:NetCoreServer.WebSocket.WS_FIN">
  6047. <summary>
  6048. Final frame
  6049. </summary>
  6050. </member>
  6051. <member name="F:NetCoreServer.WebSocket.WS_TEXT">
  6052. <summary>
  6053. Text frame
  6054. </summary>
  6055. </member>
  6056. <member name="F:NetCoreServer.WebSocket.WS_BINARY">
  6057. <summary>
  6058. Binary frame
  6059. </summary>
  6060. </member>
  6061. <member name="F:NetCoreServer.WebSocket.WS_CLOSE">
  6062. <summary>
  6063. Close frame
  6064. </summary>
  6065. </member>
  6066. <member name="F:NetCoreServer.WebSocket.WS_PING">
  6067. <summary>
  6068. Ping frame
  6069. </summary>
  6070. </member>
  6071. <member name="F:NetCoreServer.WebSocket.WS_PONG">
  6072. <summary>
  6073. Pong frame
  6074. </summary>
  6075. </member>
  6076. <member name="M:NetCoreServer.WebSocket.PerformClientUpgrade(NetCoreServer.HttpResponse,System.Guid)">
  6077. <summary>
  6078. Perform WebSocket client upgrade
  6079. </summary>
  6080. <param name="response">WebSocket upgrade HTTP response</param>
  6081. <param name="id">WebSocket client Id</param>
  6082. <returns>'true' if the WebSocket was successfully upgrade, 'false' if the WebSocket was not upgrade</returns>
  6083. </member>
  6084. <member name="M:NetCoreServer.WebSocket.PerformServerUpgrade(NetCoreServer.HttpRequest,NetCoreServer.HttpResponse)">
  6085. <summary>
  6086. Perform WebSocket server upgrade
  6087. </summary>
  6088. <param name="request">WebSocket upgrade HTTP request</param>
  6089. <param name="response">WebSocket upgrade HTTP response</param>
  6090. <returns>'true' if the WebSocket was successfully upgrade, 'false' if the WebSocket was not upgrade</returns>
  6091. </member>
  6092. <member name="M:NetCoreServer.WebSocket.PrepareSendFrame(System.Byte,System.Boolean,System.ReadOnlySpan{System.Byte},System.Int32)">
  6093. <summary>
  6094. Prepare WebSocket send frame
  6095. </summary>
  6096. <param name="opcode">WebSocket opcode</param>
  6097. <param name="mask">WebSocket mask</param>
  6098. <param name="buffer">Buffer to send as a span of bytes</param>
  6099. <param name="status">WebSocket status (default is 0)</param>
  6100. </member>
  6101. <member name="M:NetCoreServer.WebSocket.PrepareReceiveFrame(System.Byte[],System.Int64,System.Int64)">
  6102. <summary>
  6103. Prepare WebSocket send frame
  6104. </summary>
  6105. <param name="buffer">Buffer to send</param>
  6106. <param name="offset">Buffer offset</param>
  6107. <param name="size">Buffer size</param>
  6108. </member>
  6109. <member name="M:NetCoreServer.WebSocket.RequiredReceiveFrameSize">
  6110. <summary>
  6111. Required WebSocket receive frame size
  6112. </summary>
  6113. </member>
  6114. <member name="M:NetCoreServer.WebSocket.ClearWsBuffers">
  6115. <summary>
  6116. Clear WebSocket send/receive buffers
  6117. </summary>
  6118. </member>
  6119. <member name="M:NetCoreServer.WebSocket.InitWsNonce">
  6120. <summary>
  6121. Initialize WebSocket random nonce
  6122. </summary>
  6123. </member>
  6124. <member name="F:NetCoreServer.WebSocket.WsHandshaked">
  6125. <summary>
  6126. Handshaked flag
  6127. </summary>
  6128. </member>
  6129. <member name="F:NetCoreServer.WebSocket.WsFrameReceived">
  6130. <summary>
  6131. Received frame flag
  6132. </summary>
  6133. </member>
  6134. <member name="F:NetCoreServer.WebSocket.WsFinalReceived">
  6135. <summary>
  6136. Received final flag
  6137. </summary>
  6138. </member>
  6139. <member name="F:NetCoreServer.WebSocket.WsOpcode">
  6140. <summary>
  6141. Received frame opcode
  6142. </summary>
  6143. </member>
  6144. <member name="F:NetCoreServer.WebSocket.WsHeaderSize">
  6145. <summary>
  6146. Received frame header size
  6147. </summary>
  6148. </member>
  6149. <member name="F:NetCoreServer.WebSocket.WsPayloadSize">
  6150. <summary>
  6151. Received frame payload size
  6152. </summary>
  6153. </member>
  6154. <member name="F:NetCoreServer.WebSocket.WsReceiveLock">
  6155. <summary>
  6156. Receive buffer lock
  6157. </summary>
  6158. </member>
  6159. <member name="F:NetCoreServer.WebSocket.WsReceiveFrameBuffer">
  6160. <summary>
  6161. Receive frame buffer
  6162. </summary>
  6163. </member>
  6164. <member name="F:NetCoreServer.WebSocket.WsReceiveFinalBuffer">
  6165. <summary>
  6166. Receive final buffer
  6167. </summary>
  6168. </member>
  6169. <member name="F:NetCoreServer.WebSocket.WsReceiveMask">
  6170. <summary>
  6171. Receive mask
  6172. </summary>
  6173. </member>
  6174. <member name="F:NetCoreServer.WebSocket.WsSendLock">
  6175. <summary>
  6176. Send buffer lock
  6177. </summary>
  6178. </member>
  6179. <member name="F:NetCoreServer.WebSocket.WsSendBuffer">
  6180. <summary>
  6181. Send buffer
  6182. </summary>
  6183. </member>
  6184. <member name="F:NetCoreServer.WebSocket.WsSendMask">
  6185. <summary>
  6186. Send mask
  6187. </summary>
  6188. </member>
  6189. <member name="F:NetCoreServer.WebSocket.WsRandom">
  6190. <summary>
  6191. WebSocket random generator
  6192. </summary>
  6193. </member>
  6194. <member name="F:NetCoreServer.WebSocket.WsNonce">
  6195. <summary>
  6196. WebSocket random nonce of 16 bytes
  6197. </summary>
  6198. </member>
  6199. <member name="T:NetCoreServer.WsClient">
  6200. <summary>
  6201. WebSocket client
  6202. </summary>
  6203. <remarks>WebSocket client is used to communicate with WebSocket server. Thread-safe.</remarks>
  6204. </member>
  6205. <member name="M:NetCoreServer.WsClient.#ctor(System.Net.IPAddress,System.Int32)">
  6206. <summary>
  6207. Initialize WebSocket client with a given IP address and port number
  6208. </summary>
  6209. <param name="address">IP address</param>
  6210. <param name="port">Port number</param>
  6211. </member>
  6212. <member name="M:NetCoreServer.WsClient.#ctor(System.String,System.Int32)">
  6213. <summary>
  6214. Initialize WebSocket client with a given IP address and port number
  6215. </summary>
  6216. <param name="address">IP address</param>
  6217. <param name="port">Port number</param>
  6218. </member>
  6219. <member name="M:NetCoreServer.WsClient.#ctor(System.Net.DnsEndPoint)">
  6220. <summary>
  6221. Initialize WebSocket client with a given DNS endpoint
  6222. </summary>
  6223. <param name="endpoint">DNS endpoint</param>
  6224. </member>
  6225. <member name="M:NetCoreServer.WsClient.#ctor(System.Net.IPEndPoint)">
  6226. <summary>
  6227. Initialize WebSocket client with a given IP endpoint
  6228. </summary>
  6229. <param name="endpoint">IP endpoint</param>
  6230. </member>
  6231. <member name="P:NetCoreServer.WsClient.WsNonce">
  6232. <summary>
  6233. WebSocket random nonce
  6234. </summary>
  6235. </member>
  6236. <member name="T:NetCoreServer.WssClient">
  6237. <summary>
  6238. WebSocket secure client
  6239. </summary>
  6240. <remarks>WebSocket secure client is used to communicate with secure WebSocket server. Thread-safe.</remarks>
  6241. </member>
  6242. <member name="M:NetCoreServer.WssClient.#ctor(NetCoreServer.SslContext,System.Net.IPAddress,System.Int32)">
  6243. <summary>
  6244. Initialize WebSocket client with a given IP address and port number
  6245. </summary>
  6246. <param name="context">SSL context</param>
  6247. <param name="address">IP address</param>
  6248. <param name="port">Port number</param>
  6249. </member>
  6250. <member name="M:NetCoreServer.WssClient.#ctor(NetCoreServer.SslContext,System.String,System.Int32)">
  6251. <summary>
  6252. Initialize WebSocket client with a given IP address and port number
  6253. </summary>
  6254. <param name="context">SSL context</param>
  6255. <param name="address">IP address</param>
  6256. <param name="port">Port number</param>
  6257. </member>
  6258. <member name="M:NetCoreServer.WssClient.#ctor(NetCoreServer.SslContext,System.Net.DnsEndPoint)">
  6259. <summary>
  6260. Initialize WebSocket client with a given DNS endpoint
  6261. </summary>
  6262. <param name="context">SSL context</param>
  6263. <param name="endpoint">DNS endpoint</param>
  6264. </member>
  6265. <member name="M:NetCoreServer.WssClient.#ctor(NetCoreServer.SslContext,System.Net.IPEndPoint)">
  6266. <summary>
  6267. Initialize WebSocket client with a given IP endpoint
  6268. </summary>
  6269. <param name="context">SSL context</param>
  6270. <param name="endpoint">IP endpoint</param>
  6271. </member>
  6272. <member name="P:NetCoreServer.WssClient.WsNonce">
  6273. <summary>
  6274. WebSocket random nonce
  6275. </summary>
  6276. </member>
  6277. <member name="T:NetCoreServer.WsServer">
  6278. <summary>
  6279. WebSocket server
  6280. </summary>
  6281. <remarks> WebSocket server is used to communicate with clients using WebSocket protocol. Thread-safe.</remarks>
  6282. </member>
  6283. <member name="M:NetCoreServer.WsServer.#ctor(System.Net.IPAddress,System.Int32)">
  6284. <summary>
  6285. Initialize WebSocket server with a given IP address and port number
  6286. </summary>
  6287. <param name="address">IP address</param>
  6288. <param name="port">Port number</param>
  6289. </member>
  6290. <member name="M:NetCoreServer.WsServer.#ctor(System.String,System.Int32)">
  6291. <summary>
  6292. Initialize WebSocket server with a given IP address and port number
  6293. </summary>
  6294. <param name="address">IP address</param>
  6295. <param name="port">Port number</param>
  6296. </member>
  6297. <member name="M:NetCoreServer.WsServer.#ctor(System.Net.DnsEndPoint)">
  6298. <summary>
  6299. Initialize WebSocket server with a given DNS endpoint
  6300. </summary>
  6301. <param name="endpoint">DNS endpoint</param>
  6302. </member>
  6303. <member name="M:NetCoreServer.WsServer.#ctor(System.Net.IPEndPoint)">
  6304. <summary>
  6305. Initialize WebSocket server with a given IP endpoint
  6306. </summary>
  6307. <param name="endpoint">IP endpoint</param>
  6308. </member>
  6309. <member name="T:NetCoreServer.WsSession">
  6310. <summary>
  6311. WebSocket session
  6312. </summary>
  6313. <remarks> WebSocket session is used to read and write data from the connected WebSocket client. Thread-safe.</remarks>
  6314. </member>
  6315. <member name="M:NetCoreServer.WsSession.#ctor(NetCoreServer.WsServer)">
  6316. <summary>
  6317. Initialize a new WebSocket session
  6318. </summary>
  6319. <param name="server">WebSocket server</param>
  6320. </member>
  6321. <member name="T:NetCoreServer.WssServer">
  6322. <summary>
  6323. WebSocket secure server
  6324. </summary>
  6325. <remarks> WebSocket secure server is used to communicate with clients using WebSocket protocol. Thread-safe.</remarks>
  6326. </member>
  6327. <member name="M:NetCoreServer.WssServer.#ctor(NetCoreServer.SslContext,System.Net.IPAddress,System.Int32)">
  6328. <summary>
  6329. Initialize WebSocket server with a given IP address and port number
  6330. </summary>
  6331. <param name="context">SSL context</param>
  6332. <param name="address">IP address</param>
  6333. <param name="port">Port number</param>
  6334. </member>
  6335. <member name="M:NetCoreServer.WssServer.#ctor(NetCoreServer.SslContext,System.String,System.Int32)">
  6336. <summary>
  6337. Initialize WebSocket server with a given IP address and port number
  6338. </summary>
  6339. <param name="context">SSL context</param>
  6340. <param name="address">IP address</param>
  6341. <param name="port">Port number</param>
  6342. </member>
  6343. <member name="M:NetCoreServer.WssServer.#ctor(NetCoreServer.SslContext,System.Net.DnsEndPoint)">
  6344. <summary>
  6345. Initialize WebSocket server with a given DNS endpoint
  6346. </summary>
  6347. <param name="context">SSL context</param>
  6348. <param name="endpoint">DNS endpoint</param>
  6349. </member>
  6350. <member name="M:NetCoreServer.WssServer.#ctor(NetCoreServer.SslContext,System.Net.IPEndPoint)">
  6351. <summary>
  6352. Initialize WebSocket server with a given IP endpoint
  6353. </summary>
  6354. <param name="context">SSL context</param>
  6355. <param name="endpoint">IP endpoint</param>
  6356. </member>
  6357. <member name="T:NetCoreServer.WssSession">
  6358. <summary>
  6359. WebSocket secure session
  6360. </summary>
  6361. <remarks> WebSocket secure session is used to read and write data from the connected WebSocket client. Thread-safe.</remarks>
  6362. </member>
  6363. <member name="M:NetCoreServer.WssSession.#ctor(NetCoreServer.WssServer)">
  6364. <summary>
  6365. Initialize a new WebSocket session
  6366. </summary>
  6367. <param name="server">WebSocket server</param>
  6368. </member>
  6369. </members>
  6370. </doc>