websocket-sharp.xml 438 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>websocket-sharp</name>
  5. </assembly>
  6. <members>
  7. <member name="T:WebSocketSharp.ByteOrder">
  8. <summary>
  9. Specifies the byte order.
  10. </summary>
  11. </member>
  12. <member name="F:WebSocketSharp.ByteOrder.Little">
  13. <summary>
  14. Specifies Little-endian.
  15. </summary>
  16. </member>
  17. <member name="F:WebSocketSharp.ByteOrder.Big">
  18. <summary>
  19. Specifies Big-endian.
  20. </summary>
  21. </member>
  22. <member name="T:WebSocketSharp.CloseEventArgs">
  23. <summary>
  24. Represents the event data for the <see cref="E:WebSocketSharp.WebSocket.OnClose"/> event.
  25. </summary>
  26. <remarks>
  27. <para>
  28. That event occurs when the WebSocket connection has been closed.
  29. </para>
  30. <para>
  31. If you would like to get the reason for the close, you should access
  32. the <see cref="P:WebSocketSharp.CloseEventArgs.Code"/> or <see cref="P:WebSocketSharp.CloseEventArgs.Reason"/> property.
  33. </para>
  34. </remarks>
  35. </member>
  36. <member name="P:WebSocketSharp.CloseEventArgs.Code">
  37. <summary>
  38. Gets the status code for the close.
  39. </summary>
  40. <value>
  41. A <see cref="T:System.UInt16"/> that represents the status code for the close if any.
  42. </value>
  43. </member>
  44. <member name="P:WebSocketSharp.CloseEventArgs.Reason">
  45. <summary>
  46. Gets the reason for the close.
  47. </summary>
  48. <value>
  49. A <see cref="T:System.String"/> that represents the reason for the close if any.
  50. </value>
  51. </member>
  52. <member name="P:WebSocketSharp.CloseEventArgs.WasClean">
  53. <summary>
  54. Gets a value indicating whether the connection has been closed cleanly.
  55. </summary>
  56. <value>
  57. <c>true</c> if the connection has been closed cleanly; otherwise, <c>false</c>.
  58. </value>
  59. </member>
  60. <member name="T:WebSocketSharp.CloseStatusCode">
  61. <summary>
  62. Indicates the status code for the WebSocket connection close.
  63. </summary>
  64. <remarks>
  65. <para>
  66. The values of this enumeration are defined in
  67. <see href="http://tools.ietf.org/html/rfc6455#section-7.4">
  68. Section 7.4</see> of RFC 6455.
  69. </para>
  70. <para>
  71. "Reserved value" cannot be sent as a status code in
  72. closing handshake by an endpoint.
  73. </para>
  74. </remarks>
  75. </member>
  76. <member name="F:WebSocketSharp.CloseStatusCode.Normal">
  77. <summary>
  78. Equivalent to close status 1000. Indicates normal close.
  79. </summary>
  80. </member>
  81. <member name="F:WebSocketSharp.CloseStatusCode.Away">
  82. <summary>
  83. Equivalent to close status 1001. Indicates that an endpoint is
  84. going away.
  85. </summary>
  86. </member>
  87. <member name="F:WebSocketSharp.CloseStatusCode.ProtocolError">
  88. <summary>
  89. Equivalent to close status 1002. Indicates that an endpoint is
  90. terminating the connection due to a protocol error.
  91. </summary>
  92. </member>
  93. <member name="F:WebSocketSharp.CloseStatusCode.UnsupportedData">
  94. <summary>
  95. Equivalent to close status 1003. Indicates that an endpoint is
  96. terminating the connection because it has received a type of
  97. data that it cannot accept.
  98. </summary>
  99. </member>
  100. <member name="F:WebSocketSharp.CloseStatusCode.Undefined">
  101. <summary>
  102. Equivalent to close status 1004. Still undefined. A Reserved value.
  103. </summary>
  104. </member>
  105. <member name="F:WebSocketSharp.CloseStatusCode.NoStatus">
  106. <summary>
  107. Equivalent to close status 1005. Indicates that no status code was
  108. actually present. A Reserved value.
  109. </summary>
  110. </member>
  111. <member name="F:WebSocketSharp.CloseStatusCode.Abnormal">
  112. <summary>
  113. Equivalent to close status 1006. Indicates that the connection was
  114. closed abnormally. A Reserved value.
  115. </summary>
  116. </member>
  117. <member name="F:WebSocketSharp.CloseStatusCode.InvalidData">
  118. <summary>
  119. Equivalent to close status 1007. Indicates that an endpoint is
  120. terminating the connection because it has received a message that
  121. contains data that is not consistent with the type of the message.
  122. </summary>
  123. </member>
  124. <member name="F:WebSocketSharp.CloseStatusCode.PolicyViolation">
  125. <summary>
  126. Equivalent to close status 1008. Indicates that an endpoint is
  127. terminating the connection because it has received a message that
  128. violates its policy.
  129. </summary>
  130. </member>
  131. <member name="F:WebSocketSharp.CloseStatusCode.TooBig">
  132. <summary>
  133. Equivalent to close status 1009. Indicates that an endpoint is
  134. terminating the connection because it has received a message that
  135. is too big to process.
  136. </summary>
  137. </member>
  138. <member name="F:WebSocketSharp.CloseStatusCode.MandatoryExtension">
  139. <summary>
  140. Equivalent to close status 1010. Indicates that a client is
  141. terminating the connection because it has expected the server to
  142. negotiate one or more extension, but the server did not return
  143. them in the handshake response.
  144. </summary>
  145. </member>
  146. <member name="F:WebSocketSharp.CloseStatusCode.ServerError">
  147. <summary>
  148. Equivalent to close status 1011. Indicates that a server is
  149. terminating the connection because it has encountered an unexpected
  150. condition that prevented it from fulfilling the request.
  151. </summary>
  152. </member>
  153. <member name="F:WebSocketSharp.CloseStatusCode.TlsHandshakeFailure">
  154. <summary>
  155. Equivalent to close status 1015. Indicates that the connection was
  156. closed due to a failure to perform a TLS handshake. A Reserved value.
  157. </summary>
  158. </member>
  159. <member name="T:WebSocketSharp.CompressionMethod">
  160. <summary>
  161. Specifies the method for compression.
  162. </summary>
  163. <remarks>
  164. The methods are defined in
  165. <see href="https://tools.ietf.org/html/rfc7692">
  166. Compression Extensions for WebSocket</see>.
  167. </remarks>
  168. </member>
  169. <member name="F:WebSocketSharp.CompressionMethod.None">
  170. <summary>
  171. Specifies no compression.
  172. </summary>
  173. </member>
  174. <member name="F:WebSocketSharp.CompressionMethod.Deflate">
  175. <summary>
  176. Specifies DEFLATE.
  177. </summary>
  178. </member>
  179. <member name="T:WebSocketSharp.ErrorEventArgs">
  180. <summary>
  181. Represents the event data for the <see cref="E:WebSocketSharp.WebSocket.OnError"/> event.
  182. </summary>
  183. <remarks>
  184. <para>
  185. That event occurs when the <see cref="T:WebSocketSharp.WebSocket"/> gets an error.
  186. </para>
  187. <para>
  188. If you would like to get the error message, you should access
  189. the <see cref="P:WebSocketSharp.ErrorEventArgs.Message"/> property.
  190. </para>
  191. <para>
  192. And if the error is due to an exception, you can get it by accessing
  193. the <see cref="P:WebSocketSharp.ErrorEventArgs.Exception"/> property.
  194. </para>
  195. </remarks>
  196. </member>
  197. <member name="P:WebSocketSharp.ErrorEventArgs.Exception">
  198. <summary>
  199. Gets the exception that caused the error.
  200. </summary>
  201. <value>
  202. An <see cref="T:System.Exception"/> instance that represents the cause of
  203. the error if it is due to an exception; otherwise, <see langword="null"/>.
  204. </value>
  205. </member>
  206. <member name="P:WebSocketSharp.ErrorEventArgs.Message">
  207. <summary>
  208. Gets the error message.
  209. </summary>
  210. <value>
  211. A <see cref="T:System.String"/> that represents the error message.
  212. </value>
  213. </member>
  214. <member name="T:WebSocketSharp.Ext">
  215. <summary>
  216. Provides a set of static methods for websocket-sharp.
  217. </summary>
  218. </member>
  219. <member name="M:WebSocketSharp.Ext.EqualsWith(System.Int32,System.Char,System.Action{System.Int32})">
  220. <summary>
  221. Determines whether the specified <see cref="T:System.Int32"/> equals the specified <see cref="T:System.Char"/>,
  222. and invokes the specified <c>Action&lt;int&gt;</c> delegate at the same time.
  223. </summary>
  224. <returns>
  225. <c>true</c> if <paramref name="value"/> equals <paramref name="c"/>;
  226. otherwise, <c>false</c>.
  227. </returns>
  228. <param name="value">
  229. An <see cref="T:System.Int32"/> to compare.
  230. </param>
  231. <param name="c">
  232. A <see cref="T:System.Char"/> to compare.
  233. </param>
  234. <param name="action">
  235. An <c>Action&lt;int&gt;</c> delegate that references the method(s) called
  236. at the same time as comparing. An <see cref="T:System.Int32"/> parameter to pass to
  237. the method(s) is <paramref name="value"/>.
  238. </param>
  239. </member>
  240. <member name="M:WebSocketSharp.Ext.GetAbsolutePath(System.Uri)">
  241. <summary>
  242. Gets the absolute path from the specified <see cref="T:System.Uri"/>.
  243. </summary>
  244. <returns>
  245. A <see cref="T:System.String"/> that represents the absolute path if it's successfully found;
  246. otherwise, <see langword="null"/>.
  247. </returns>
  248. <param name="uri">
  249. A <see cref="T:System.Uri"/> that represents the URI to get the absolute path from.
  250. </param>
  251. </member>
  252. <member name="M:WebSocketSharp.Ext.GetName(System.String,System.Char)">
  253. <summary>
  254. Gets the name from the specified <see cref="T:System.String"/> that contains a pair of name and
  255. value separated by a separator character.
  256. </summary>
  257. <returns>
  258. A <see cref="T:System.String"/> that represents the name if any; otherwise, <c>null</c>.
  259. </returns>
  260. <param name="nameAndValue">
  261. A <see cref="T:System.String"/> that contains a pair of name and value separated by
  262. a separator character.
  263. </param>
  264. <param name="separator">
  265. A <see cref="T:System.Char"/> that represents the separator character.
  266. </param>
  267. </member>
  268. <member name="M:WebSocketSharp.Ext.GetValue(System.String,System.Char)">
  269. <summary>
  270. Gets the value from the specified <see cref="T:System.String"/> that contains a pair of name and
  271. value separated by a separator character.
  272. </summary>
  273. <returns>
  274. A <see cref="T:System.String"/> that represents the value if any; otherwise, <c>null</c>.
  275. </returns>
  276. <param name="nameAndValue">
  277. A <see cref="T:System.String"/> that contains a pair of name and value separated by
  278. a separator character.
  279. </param>
  280. <param name="separator">
  281. A <see cref="T:System.Char"/> that represents the separator character.
  282. </param>
  283. </member>
  284. <member name="M:WebSocketSharp.Ext.TryCreateWebSocketUri(System.String,System.Uri@,System.String@)">
  285. <summary>
  286. Tries to create a new <see cref="T:System.Uri"/> for WebSocket with
  287. the specified <paramref name="uriString"/>.
  288. </summary>
  289. <returns>
  290. <c>true</c> if the <see cref="T:System.Uri"/> was successfully created;
  291. otherwise, <c>false</c>.
  292. </returns>
  293. <param name="uriString">
  294. A <see cref="T:System.String"/> that represents a WebSocket URL to try.
  295. </param>
  296. <param name="result">
  297. When this method returns, a <see cref="T:System.Uri"/> that
  298. represents the WebSocket URL or <see langword="null"/>
  299. if <paramref name="uriString"/> is invalid.
  300. </param>
  301. <param name="message">
  302. When this method returns, a <see cref="T:System.String"/> that
  303. represents an error message or <see langword="null"/>
  304. if <paramref name="uriString"/> is valid.
  305. </param>
  306. </member>
  307. <member name="M:WebSocketSharp.Ext.Contains(System.String,System.Char[])">
  308. <summary>
  309. Determines whether the specified <see cref="T:System.String"/> contains any of characters in
  310. the specified array of <see cref="T:System.Char"/>.
  311. </summary>
  312. <returns>
  313. <c>true</c> if <paramref name="value"/> contains any of <paramref name="chars"/>;
  314. otherwise, <c>false</c>.
  315. </returns>
  316. <param name="value">
  317. A <see cref="T:System.String"/> to test.
  318. </param>
  319. <param name="chars">
  320. An array of <see cref="T:System.Char"/> that contains characters to find.
  321. </param>
  322. </member>
  323. <member name="M:WebSocketSharp.Ext.Contains(System.Collections.Specialized.NameValueCollection,System.String)">
  324. <summary>
  325. Determines whether the specified <see cref="T:System.Collections.Specialized.NameValueCollection"/> contains
  326. the entry with the specified <paramref name="name"/>.
  327. </summary>
  328. <returns>
  329. <c>true</c> if <paramref name="collection"/> contains the entry with
  330. <paramref name="name"/>; otherwise, <c>false</c>.
  331. </returns>
  332. <param name="collection">
  333. A <see cref="T:System.Collections.Specialized.NameValueCollection"/> to test.
  334. </param>
  335. <param name="name">
  336. A <see cref="T:System.String"/> that represents the key of the entry to find.
  337. </param>
  338. </member>
  339. <member name="M:WebSocketSharp.Ext.Contains(System.Collections.Specialized.NameValueCollection,System.String,System.String)">
  340. <summary>
  341. Determines whether the specified <see cref="T:System.Collections.Specialized.NameValueCollection"/> contains the entry with
  342. the specified both <paramref name="name"/> and <paramref name="value"/>.
  343. </summary>
  344. <returns>
  345. <c>true</c> if <paramref name="collection"/> contains the entry with both
  346. <paramref name="name"/> and <paramref name="value"/>; otherwise, <c>false</c>.
  347. </returns>
  348. <param name="collection">
  349. A <see cref="T:System.Collections.Specialized.NameValueCollection"/> to test.
  350. </param>
  351. <param name="name">
  352. A <see cref="T:System.String"/> that represents the key of the entry to find.
  353. </param>
  354. <param name="value">
  355. A <see cref="T:System.String"/> that represents the value of the entry to find.
  356. </param>
  357. </member>
  358. <member name="M:WebSocketSharp.Ext.Emit(System.EventHandler,System.Object,System.EventArgs)">
  359. <summary>
  360. Emits the specified <see cref="T:System.EventHandler"/> delegate if it isn't <see langword="null"/>.
  361. </summary>
  362. <param name="eventHandler">
  363. A <see cref="T:System.EventHandler"/> to emit.
  364. </param>
  365. <param name="sender">
  366. An <see cref="T:System.Object"/> from which emits this <paramref name="eventHandler"/>.
  367. </param>
  368. <param name="e">
  369. A <see cref="T:System.EventArgs"/> that contains no event data.
  370. </param>
  371. </member>
  372. <member name="M:WebSocketSharp.Ext.Emit``1(System.EventHandler{``0},System.Object,``0)">
  373. <summary>
  374. Emits the specified <c>EventHandler&lt;TEventArgs&gt;</c> delegate if it isn't
  375. <see langword="null"/>.
  376. </summary>
  377. <param name="eventHandler">
  378. An <c>EventHandler&lt;TEventArgs&gt;</c> to emit.
  379. </param>
  380. <param name="sender">
  381. An <see cref="T:System.Object"/> from which emits this <paramref name="eventHandler"/>.
  382. </param>
  383. <param name="e">
  384. A <c>TEventArgs</c> that represents the event data.
  385. </param>
  386. <typeparam name="TEventArgs">
  387. The type of the event data generated by the event.
  388. </typeparam>
  389. </member>
  390. <member name="M:WebSocketSharp.Ext.GetCookies(System.Collections.Specialized.NameValueCollection,System.Boolean)">
  391. <summary>
  392. Gets the collection of the HTTP cookies from the specified HTTP <paramref name="headers"/>.
  393. </summary>
  394. <returns>
  395. A <see cref="T:WebSocketSharp.Net.CookieCollection"/> that receives a collection of the HTTP cookies.
  396. </returns>
  397. <param name="headers">
  398. A <see cref="T:System.Collections.Specialized.NameValueCollection"/> that contains a collection of the HTTP headers.
  399. </param>
  400. <param name="response">
  401. <c>true</c> if <paramref name="headers"/> is a collection of the response headers;
  402. otherwise, <c>false</c>.
  403. </param>
  404. </member>
  405. <member name="M:WebSocketSharp.Ext.GetDescription(WebSocketSharp.Net.HttpStatusCode)">
  406. <summary>
  407. Gets the description of the specified HTTP status <paramref name="code"/>.
  408. </summary>
  409. <returns>
  410. A <see cref="T:System.String"/> that represents the description of the HTTP status code.
  411. </returns>
  412. <param name="code">
  413. One of <see cref="T:WebSocketSharp.Net.HttpStatusCode"/> enum values, indicates the HTTP status code.
  414. </param>
  415. </member>
  416. <member name="M:WebSocketSharp.Ext.GetStatusDescription(System.Int32)">
  417. <summary>
  418. Gets the description of the specified HTTP status <paramref name="code"/>.
  419. </summary>
  420. <returns>
  421. A <see cref="T:System.String"/> that represents the description of the HTTP status code.
  422. </returns>
  423. <param name="code">
  424. An <see cref="T:System.Int32"/> that represents the HTTP status code.
  425. </param>
  426. </member>
  427. <member name="M:WebSocketSharp.Ext.IsCloseStatusCode(System.UInt16)">
  428. <summary>
  429. Determines whether the specified <see cref="T:System.UInt16"/> is in the
  430. range of the status code for the WebSocket connection close.
  431. </summary>
  432. <remarks>
  433. <para>
  434. The ranges are the following:
  435. </para>
  436. <list type="bullet">
  437. <item>
  438. <term>
  439. 1000-2999: These numbers are reserved for definition by
  440. the WebSocket protocol.
  441. </term>
  442. </item>
  443. <item>
  444. <term>
  445. 3000-3999: These numbers are reserved for use by libraries,
  446. frameworks, and applications.
  447. </term>
  448. </item>
  449. <item>
  450. <term>
  451. 4000-4999: These numbers are reserved for private use.
  452. </term>
  453. </item>
  454. </list>
  455. </remarks>
  456. <returns>
  457. <c>true</c> if <paramref name="value"/> is in the range of
  458. the status code for the close; otherwise, <c>false</c>.
  459. </returns>
  460. <param name="value">
  461. A <see cref="T:System.UInt16"/> to test.
  462. </param>
  463. </member>
  464. <member name="M:WebSocketSharp.Ext.IsEnclosedIn(System.String,System.Char)">
  465. <summary>
  466. Determines whether the specified <see cref="T:System.String"/> is
  467. enclosed in the specified <see cref="T:System.Char"/>.
  468. </summary>
  469. <returns>
  470. <c>true</c> if <paramref name="value"/> is enclosed in
  471. <paramref name="c"/>; otherwise, <c>false</c>.
  472. </returns>
  473. <param name="value">
  474. A <see cref="T:System.String"/> to test.
  475. </param>
  476. <param name="c">
  477. A <see cref="T:System.Char"/> to find.
  478. </param>
  479. </member>
  480. <member name="M:WebSocketSharp.Ext.IsHostOrder(WebSocketSharp.ByteOrder)">
  481. <summary>
  482. Determines whether the specified <see cref="T:WebSocketSharp.ByteOrder"/> is host (this computer
  483. architecture) byte order.
  484. </summary>
  485. <returns>
  486. <c>true</c> if <paramref name="order"/> is host byte order; otherwise, <c>false</c>.
  487. </returns>
  488. <param name="order">
  489. One of the <see cref="T:WebSocketSharp.ByteOrder"/> enum values, to test.
  490. </param>
  491. </member>
  492. <member name="M:WebSocketSharp.Ext.IsLocal(System.Net.IPAddress)">
  493. <summary>
  494. Determines whether the specified <see cref="T:System.Net.IPAddress"/>
  495. represents a local IP address.
  496. </summary>
  497. <remarks>
  498. This local means NOT REMOTE for the current host.
  499. </remarks>
  500. <returns>
  501. <c>true</c> if <paramref name="address"/> represents a local IP address;
  502. otherwise, <c>false</c>.
  503. </returns>
  504. <param name="address">
  505. A <see cref="T:System.Net.IPAddress"/> to test.
  506. </param>
  507. </member>
  508. <member name="M:WebSocketSharp.Ext.IsNullOrEmpty(System.String)">
  509. <summary>
  510. Determines whether the specified string is <see langword="null"/> or
  511. an empty string.
  512. </summary>
  513. <returns>
  514. <c>true</c> if the string is <see langword="null"/> or an empty string;
  515. otherwise, <c>false</c>.
  516. </returns>
  517. <param name="value">
  518. A <see cref="T:System.String"/> to test.
  519. </param>
  520. </member>
  521. <member name="M:WebSocketSharp.Ext.IsPredefinedScheme(System.String)">
  522. <summary>
  523. Determines whether the specified <see cref="T:System.String"/> is
  524. a predefined scheme.
  525. </summary>
  526. <returns>
  527. <c>true</c> if <paramref name="value"/> is a predefined scheme;
  528. otherwise, <c>false</c>.
  529. </returns>
  530. <param name="value">
  531. A <see cref="T:System.String"/> to test.
  532. </param>
  533. </member>
  534. <member name="M:WebSocketSharp.Ext.IsUpgradeTo(WebSocketSharp.Net.HttpListenerRequest,System.String)">
  535. <summary>
  536. Determines whether the specified <see cref="T:WebSocketSharp.Net.HttpListenerRequest"/> is
  537. an HTTP Upgrade request to switch to the specified <paramref name="protocol"/>.
  538. </summary>
  539. <returns>
  540. <c>true</c> if <paramref name="request"/> is an HTTP Upgrade request to switch to
  541. <paramref name="protocol"/>; otherwise, <c>false</c>.
  542. </returns>
  543. <param name="request">
  544. A <see cref="T:WebSocketSharp.Net.HttpListenerRequest"/> that represents the HTTP request.
  545. </param>
  546. <param name="protocol">
  547. A <see cref="T:System.String"/> that represents the protocol name.
  548. </param>
  549. <exception cref="T:System.ArgumentNullException">
  550. <para>
  551. <paramref name="request"/> is <see langword="null"/>.
  552. </para>
  553. <para>
  554. -or-
  555. </para>
  556. <para>
  557. <paramref name="protocol"/> is <see langword="null"/>.
  558. </para>
  559. </exception>
  560. <exception cref="T:System.ArgumentException">
  561. <paramref name="protocol"/> is empty.
  562. </exception>
  563. </member>
  564. <member name="M:WebSocketSharp.Ext.MaybeUri(System.String)">
  565. <summary>
  566. Determines whether the specified <see cref="T:System.String"/> is a URI string.
  567. </summary>
  568. <returns>
  569. <c>true</c> if <paramref name="value"/> may be a URI string;
  570. otherwise, <c>false</c>.
  571. </returns>
  572. <param name="value">
  573. A <see cref="T:System.String"/> to test.
  574. </param>
  575. </member>
  576. <member name="M:WebSocketSharp.Ext.SubArray``1(``0[],System.Int32,System.Int32)">
  577. <summary>
  578. Retrieves a sub-array from the specified <paramref name="array"/>. A sub-array starts at
  579. the specified element position in <paramref name="array"/>.
  580. </summary>
  581. <returns>
  582. An array of T that receives a sub-array, or an empty array of T if any problems with
  583. the parameters.
  584. </returns>
  585. <param name="array">
  586. An array of T from which to retrieve a sub-array.
  587. </param>
  588. <param name="startIndex">
  589. An <see cref="T:System.Int32"/> that represents the zero-based starting position of
  590. a sub-array in <paramref name="array"/>.
  591. </param>
  592. <param name="length">
  593. An <see cref="T:System.Int32"/> that represents the number of elements to retrieve.
  594. </param>
  595. <typeparam name="T">
  596. The type of elements in <paramref name="array"/>.
  597. </typeparam>
  598. </member>
  599. <member name="M:WebSocketSharp.Ext.SubArray``1(``0[],System.Int64,System.Int64)">
  600. <summary>
  601. Retrieves a sub-array from the specified <paramref name="array"/>. A sub-array starts at
  602. the specified element position in <paramref name="array"/>.
  603. </summary>
  604. <returns>
  605. An array of T that receives a sub-array, or an empty array of T if any problems with
  606. the parameters.
  607. </returns>
  608. <param name="array">
  609. An array of T from which to retrieve a sub-array.
  610. </param>
  611. <param name="startIndex">
  612. A <see cref="T:System.Int64"/> that represents the zero-based starting position of
  613. a sub-array in <paramref name="array"/>.
  614. </param>
  615. <param name="length">
  616. A <see cref="T:System.Int64"/> that represents the number of elements to retrieve.
  617. </param>
  618. <typeparam name="T">
  619. The type of elements in <paramref name="array"/>.
  620. </typeparam>
  621. </member>
  622. <member name="M:WebSocketSharp.Ext.Times(System.Int32,System.Action)">
  623. <summary>
  624. Executes the specified <see cref="T:System.Action"/> delegate <paramref name="n"/> times.
  625. </summary>
  626. <param name="n">
  627. An <see cref="T:System.Int32"/> is the number of times to execute.
  628. </param>
  629. <param name="action">
  630. An <see cref="T:System.Action"/> delegate that references the method(s) to execute.
  631. </param>
  632. </member>
  633. <member name="M:WebSocketSharp.Ext.Times(System.Int64,System.Action)">
  634. <summary>
  635. Executes the specified <see cref="T:System.Action"/> delegate <paramref name="n"/> times.
  636. </summary>
  637. <param name="n">
  638. A <see cref="T:System.Int64"/> is the number of times to execute.
  639. </param>
  640. <param name="action">
  641. An <see cref="T:System.Action"/> delegate that references the method(s) to execute.
  642. </param>
  643. </member>
  644. <member name="M:WebSocketSharp.Ext.Times(System.UInt32,System.Action)">
  645. <summary>
  646. Executes the specified <see cref="T:System.Action"/> delegate <paramref name="n"/> times.
  647. </summary>
  648. <param name="n">
  649. A <see cref="T:System.UInt32"/> is the number of times to execute.
  650. </param>
  651. <param name="action">
  652. An <see cref="T:System.Action"/> delegate that references the method(s) to execute.
  653. </param>
  654. </member>
  655. <member name="M:WebSocketSharp.Ext.Times(System.UInt64,System.Action)">
  656. <summary>
  657. Executes the specified <see cref="T:System.Action"/> delegate <paramref name="n"/> times.
  658. </summary>
  659. <param name="n">
  660. A <see cref="T:System.UInt64"/> is the number of times to execute.
  661. </param>
  662. <param name="action">
  663. An <see cref="T:System.Action"/> delegate that references the method(s) to execute.
  664. </param>
  665. </member>
  666. <member name="M:WebSocketSharp.Ext.Times(System.Int32,System.Action{System.Int32})">
  667. <summary>
  668. Executes the specified <c>Action&lt;int&gt;</c> delegate <paramref name="n"/> times.
  669. </summary>
  670. <param name="n">
  671. An <see cref="T:System.Int32"/> is the number of times to execute.
  672. </param>
  673. <param name="action">
  674. An <c>Action&lt;int&gt;</c> delegate that references the method(s) to execute.
  675. An <see cref="T:System.Int32"/> parameter to pass to the method(s) is the zero-based count of
  676. iteration.
  677. </param>
  678. </member>
  679. <member name="M:WebSocketSharp.Ext.Times(System.Int64,System.Action{System.Int64})">
  680. <summary>
  681. Executes the specified <c>Action&lt;long&gt;</c> delegate <paramref name="n"/> times.
  682. </summary>
  683. <param name="n">
  684. A <see cref="T:System.Int64"/> is the number of times to execute.
  685. </param>
  686. <param name="action">
  687. An <c>Action&lt;long&gt;</c> delegate that references the method(s) to execute.
  688. A <see cref="T:System.Int64"/> parameter to pass to the method(s) is the zero-based count of
  689. iteration.
  690. </param>
  691. </member>
  692. <member name="M:WebSocketSharp.Ext.Times(System.UInt32,System.Action{System.UInt32})">
  693. <summary>
  694. Executes the specified <c>Action&lt;uint&gt;</c> delegate <paramref name="n"/> times.
  695. </summary>
  696. <param name="n">
  697. A <see cref="T:System.UInt32"/> is the number of times to execute.
  698. </param>
  699. <param name="action">
  700. An <c>Action&lt;uint&gt;</c> delegate that references the method(s) to execute.
  701. A <see cref="T:System.UInt32"/> parameter to pass to the method(s) is the zero-based count of
  702. iteration.
  703. </param>
  704. </member>
  705. <member name="M:WebSocketSharp.Ext.Times(System.UInt64,System.Action{System.UInt64})">
  706. <summary>
  707. Executes the specified <c>Action&lt;ulong&gt;</c> delegate <paramref name="n"/> times.
  708. </summary>
  709. <param name="n">
  710. A <see cref="T:System.UInt64"/> is the number of times to execute.
  711. </param>
  712. <param name="action">
  713. An <c>Action&lt;ulong&gt;</c> delegate that references the method(s) to execute.
  714. A <see cref="T:System.UInt64"/> parameter to pass to this method(s) is the zero-based count of
  715. iteration.
  716. </param>
  717. </member>
  718. <member name="M:WebSocketSharp.Ext.To``1(System.Byte[],WebSocketSharp.ByteOrder)">
  719. <summary>
  720. Converts the specified array of <see cref="T:System.Byte"/> to the specified type data.
  721. </summary>
  722. <returns>
  723. A T converted from <paramref name="source"/>, or a default value of
  724. T if <paramref name="source"/> is an empty array of <see cref="T:System.Byte"/> or
  725. if the type of T isn't <see cref="T:System.Boolean"/>, <see cref="T:System.Char"/>, <see cref="T:System.Double"/>,
  726. <see cref="T:System.Single"/>, <see cref="T:System.Int32"/>, <see cref="T:System.Int64"/>, <see cref="T:System.Int16"/>,
  727. <see cref="T:System.UInt32"/>, <see cref="T:System.UInt64"/>, or <see cref="T:System.UInt16"/>.
  728. </returns>
  729. <param name="source">
  730. An array of <see cref="T:System.Byte"/> to convert.
  731. </param>
  732. <param name="sourceOrder">
  733. One of the <see cref="T:WebSocketSharp.ByteOrder"/> enum values, specifies the byte order of
  734. <paramref name="source"/>.
  735. </param>
  736. <typeparam name="T">
  737. The type of the return. The T must be a value type.
  738. </typeparam>
  739. <exception cref="T:System.ArgumentNullException">
  740. <paramref name="source"/> is <see langword="null"/>.
  741. </exception>
  742. </member>
  743. <member name="M:WebSocketSharp.Ext.ToByteArray``1(``0,WebSocketSharp.ByteOrder)">
  744. <summary>
  745. Converts the specified <paramref name="value"/> to an array of <see cref="T:System.Byte"/>.
  746. </summary>
  747. <returns>
  748. An array of <see cref="T:System.Byte"/> converted from <paramref name="value"/>.
  749. </returns>
  750. <param name="value">
  751. A T to convert.
  752. </param>
  753. <param name="order">
  754. One of the <see cref="T:WebSocketSharp.ByteOrder"/> enum values, specifies the byte order of the return.
  755. </param>
  756. <typeparam name="T">
  757. The type of <paramref name="value"/>. The T must be a value type.
  758. </typeparam>
  759. </member>
  760. <member name="M:WebSocketSharp.Ext.ToHostOrder(System.Byte[],WebSocketSharp.ByteOrder)">
  761. <summary>
  762. Converts the order of the specified array of <see cref="T:System.Byte"/> to the host byte order.
  763. </summary>
  764. <returns>
  765. An array of <see cref="T:System.Byte"/> converted from <paramref name="source"/>.
  766. </returns>
  767. <param name="source">
  768. An array of <see cref="T:System.Byte"/> to convert.
  769. </param>
  770. <param name="sourceOrder">
  771. One of the <see cref="T:WebSocketSharp.ByteOrder"/> enum values, specifies the byte order of
  772. <paramref name="source"/>.
  773. </param>
  774. <exception cref="T:System.ArgumentNullException">
  775. <paramref name="source"/> is <see langword="null"/>.
  776. </exception>
  777. </member>
  778. <member name="M:WebSocketSharp.Ext.ToString``1(``0[],System.String)">
  779. <summary>
  780. Converts the specified <paramref name="array"/> to a <see cref="T:System.String"/> that
  781. concatenates the each element of <paramref name="array"/> across the specified
  782. <paramref name="separator"/>.
  783. </summary>
  784. <returns>
  785. A <see cref="T:System.String"/> converted from <paramref name="array"/>,
  786. or <see cref="F:System.String.Empty"/> if <paramref name="array"/> is empty.
  787. </returns>
  788. <param name="array">
  789. An array of T to convert.
  790. </param>
  791. <param name="separator">
  792. A <see cref="T:System.String"/> that represents the separator string.
  793. </param>
  794. <typeparam name="T">
  795. The type of elements in <paramref name="array"/>.
  796. </typeparam>
  797. <exception cref="T:System.ArgumentNullException">
  798. <paramref name="array"/> is <see langword="null"/>.
  799. </exception>
  800. </member>
  801. <member name="M:WebSocketSharp.Ext.ToUri(System.String)">
  802. <summary>
  803. Converts the specified <see cref="T:System.String"/> to a <see cref="T:System.Uri"/>.
  804. </summary>
  805. <returns>
  806. A <see cref="T:System.Uri"/> converted from <paramref name="value"/> or
  807. <see langword="null"/> if the convert has failed.
  808. </returns>
  809. <param name="value">
  810. A <see cref="T:System.String"/> to convert.
  811. </param>
  812. </member>
  813. <member name="M:WebSocketSharp.Ext.UrlDecode(System.String)">
  814. <summary>
  815. URL-decodes the specified <see cref="T:System.String"/>.
  816. </summary>
  817. <returns>
  818. A <see cref="T:System.String"/> that receives the decoded string or
  819. <paramref name="value"/> if it is <see langword="null"/> or empty.
  820. </returns>
  821. <param name="value">
  822. A <see cref="T:System.String"/> to decode.
  823. </param>
  824. </member>
  825. <member name="M:WebSocketSharp.Ext.UrlEncode(System.String)">
  826. <summary>
  827. URL-encodes the specified <see cref="T:System.String"/>.
  828. </summary>
  829. <returns>
  830. A <see cref="T:System.String"/> that receives the encoded string or
  831. <paramref name="value"/> if it is <see langword="null"/> or empty.
  832. </returns>
  833. <param name="value">
  834. A <see cref="T:System.String"/> to encode.
  835. </param>
  836. </member>
  837. <member name="M:WebSocketSharp.Ext.WriteContent(WebSocketSharp.Net.HttpListenerResponse,System.Byte[])">
  838. <summary>
  839. Writes and sends the specified <paramref name="content"/> data with the specified
  840. <see cref="T:WebSocketSharp.Net.HttpListenerResponse"/>.
  841. </summary>
  842. <param name="response">
  843. A <see cref="T:WebSocketSharp.Net.HttpListenerResponse"/> that represents the HTTP response used to
  844. send the content data.
  845. </param>
  846. <param name="content">
  847. An array of <see cref="T:System.Byte"/> that represents the content data to send.
  848. </param>
  849. <exception cref="T:System.ArgumentNullException">
  850. <para>
  851. <paramref name="response"/> is <see langword="null"/>.
  852. </para>
  853. <para>
  854. -or-
  855. </para>
  856. <para>
  857. <paramref name="content"/> is <see langword="null"/>.
  858. </para>
  859. </exception>
  860. </member>
  861. <member name="T:WebSocketSharp.Fin">
  862. <summary>
  863. Indicates whether a WebSocket frame is the final frame of a message.
  864. </summary>
  865. <remarks>
  866. The values of this enumeration are defined in
  867. <see href="http://tools.ietf.org/html/rfc6455#section-5.2">Section 5.2</see> of RFC 6455.
  868. </remarks>
  869. </member>
  870. <member name="F:WebSocketSharp.Fin.More">
  871. <summary>
  872. Equivalent to numeric value 0. Indicates more frames of a message follow.
  873. </summary>
  874. </member>
  875. <member name="F:WebSocketSharp.Fin.Final">
  876. <summary>
  877. Equivalent to numeric value 1. Indicates the final frame of a message.
  878. </summary>
  879. </member>
  880. <member name="T:WebSocketSharp.LogData">
  881. <summary>
  882. Represents a log data used by the <see cref="T:WebSocketSharp.Logger"/> class.
  883. </summary>
  884. </member>
  885. <member name="P:WebSocketSharp.LogData.Caller">
  886. <summary>
  887. Gets the information of the logging method caller.
  888. </summary>
  889. <value>
  890. A <see cref="T:System.Diagnostics.StackFrame"/> that provides the information of the logging method caller.
  891. </value>
  892. </member>
  893. <member name="P:WebSocketSharp.LogData.Date">
  894. <summary>
  895. Gets the date and time when the log data was created.
  896. </summary>
  897. <value>
  898. A <see cref="T:System.DateTime"/> that represents the date and time when the log data was created.
  899. </value>
  900. </member>
  901. <member name="P:WebSocketSharp.LogData.Level">
  902. <summary>
  903. Gets the logging level of the log data.
  904. </summary>
  905. <value>
  906. One of the <see cref="T:WebSocketSharp.LogLevel"/> enum values, indicates the logging level of the log data.
  907. </value>
  908. </member>
  909. <member name="P:WebSocketSharp.LogData.Message">
  910. <summary>
  911. Gets the message of the log data.
  912. </summary>
  913. <value>
  914. A <see cref="T:System.String"/> that represents the message of the log data.
  915. </value>
  916. </member>
  917. <member name="M:WebSocketSharp.LogData.ToString">
  918. <summary>
  919. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:WebSocketSharp.LogData"/>.
  920. </summary>
  921. <returns>
  922. A <see cref="T:System.String"/> that represents the current <see cref="T:WebSocketSharp.LogData"/>.
  923. </returns>
  924. </member>
  925. <member name="T:WebSocketSharp.Logger">
  926. <summary>
  927. Provides a set of methods and properties for logging.
  928. </summary>
  929. <remarks>
  930. <para>
  931. If you output a log with lower than the value of the <see cref="P:WebSocketSharp.Logger.Level"/> property,
  932. it cannot be outputted.
  933. </para>
  934. <para>
  935. The default output action writes a log to the standard output stream and the log file
  936. if the <see cref="P:WebSocketSharp.Logger.File"/> property has a valid path to it.
  937. </para>
  938. <para>
  939. If you would like to use the custom output action, you should set
  940. the <see cref="P:WebSocketSharp.Logger.Output"/> property to any <c>Action&lt;LogData, string&gt;</c>
  941. delegate.
  942. </para>
  943. </remarks>
  944. </member>
  945. <member name="M:WebSocketSharp.Logger.#ctor">
  946. <summary>
  947. Initializes a new instance of the <see cref="T:WebSocketSharp.Logger"/> class.
  948. </summary>
  949. <remarks>
  950. This constructor initializes the current logging level with <see cref="F:WebSocketSharp.LogLevel.Error"/>.
  951. </remarks>
  952. </member>
  953. <member name="M:WebSocketSharp.Logger.#ctor(WebSocketSharp.LogLevel)">
  954. <summary>
  955. Initializes a new instance of the <see cref="T:WebSocketSharp.Logger"/> class with
  956. the specified logging <paramref name="level"/>.
  957. </summary>
  958. <param name="level">
  959. One of the <see cref="T:WebSocketSharp.LogLevel"/> enum values.
  960. </param>
  961. </member>
  962. <member name="M:WebSocketSharp.Logger.#ctor(WebSocketSharp.LogLevel,System.String,System.Action{WebSocketSharp.LogData,System.String})">
  963. <summary>
  964. Initializes a new instance of the <see cref="T:WebSocketSharp.Logger"/> class with
  965. the specified logging <paramref name="level"/>, path to the log <paramref name="file"/>,
  966. and <paramref name="output"/> action.
  967. </summary>
  968. <param name="level">
  969. One of the <see cref="T:WebSocketSharp.LogLevel"/> enum values.
  970. </param>
  971. <param name="file">
  972. A <see cref="T:System.String"/> that represents the path to the log file.
  973. </param>
  974. <param name="output">
  975. An <c>Action&lt;LogData, string&gt;</c> delegate that references the method(s) used to
  976. output a log. A <see cref="T:System.String"/> parameter passed to this delegate is
  977. <paramref name="file"/>.
  978. </param>
  979. </member>
  980. <member name="P:WebSocketSharp.Logger.File">
  981. <summary>
  982. Gets or sets the current path to the log file.
  983. </summary>
  984. <value>
  985. A <see cref="T:System.String"/> that represents the current path to the log file if any.
  986. </value>
  987. </member>
  988. <member name="P:WebSocketSharp.Logger.Level">
  989. <summary>
  990. Gets or sets the current logging level.
  991. </summary>
  992. <remarks>
  993. A log with lower than the value of this property cannot be outputted.
  994. </remarks>
  995. <value>
  996. One of the <see cref="T:WebSocketSharp.LogLevel"/> enum values, specifies the current logging level.
  997. </value>
  998. </member>
  999. <member name="P:WebSocketSharp.Logger.Output">
  1000. <summary>
  1001. Gets or sets the current output action used to output a log.
  1002. </summary>
  1003. <value>
  1004. <para>
  1005. An <c>Action&lt;LogData, string&gt;</c> delegate that references the method(s) used to
  1006. output a log. A <see cref="T:System.String"/> parameter passed to this delegate is the value of
  1007. the <see cref="P:WebSocketSharp.Logger.File"/> property.
  1008. </para>
  1009. <para>
  1010. If the value to set is <see langword="null"/>, the current output action is changed to
  1011. the default output action.
  1012. </para>
  1013. </value>
  1014. </member>
  1015. <member name="M:WebSocketSharp.Logger.Debug(System.String)">
  1016. <summary>
  1017. Outputs <paramref name="message"/> as a log with <see cref="F:WebSocketSharp.LogLevel.Debug"/>.
  1018. </summary>
  1019. <remarks>
  1020. If the current logging level is higher than <see cref="F:WebSocketSharp.LogLevel.Debug"/>,
  1021. this method doesn't output <paramref name="message"/> as a log.
  1022. </remarks>
  1023. <param name="message">
  1024. A <see cref="T:System.String"/> that represents the message to output as a log.
  1025. </param>
  1026. </member>
  1027. <member name="M:WebSocketSharp.Logger.Error(System.String)">
  1028. <summary>
  1029. Outputs <paramref name="message"/> as a log with <see cref="F:WebSocketSharp.LogLevel.Error"/>.
  1030. </summary>
  1031. <remarks>
  1032. If the current logging level is higher than <see cref="F:WebSocketSharp.LogLevel.Error"/>,
  1033. this method doesn't output <paramref name="message"/> as a log.
  1034. </remarks>
  1035. <param name="message">
  1036. A <see cref="T:System.String"/> that represents the message to output as a log.
  1037. </param>
  1038. </member>
  1039. <member name="M:WebSocketSharp.Logger.Fatal(System.String)">
  1040. <summary>
  1041. Outputs <paramref name="message"/> as a log with <see cref="F:WebSocketSharp.LogLevel.Fatal"/>.
  1042. </summary>
  1043. <param name="message">
  1044. A <see cref="T:System.String"/> that represents the message to output as a log.
  1045. </param>
  1046. </member>
  1047. <member name="M:WebSocketSharp.Logger.Info(System.String)">
  1048. <summary>
  1049. Outputs <paramref name="message"/> as a log with <see cref="F:WebSocketSharp.LogLevel.Info"/>.
  1050. </summary>
  1051. <remarks>
  1052. If the current logging level is higher than <see cref="F:WebSocketSharp.LogLevel.Info"/>,
  1053. this method doesn't output <paramref name="message"/> as a log.
  1054. </remarks>
  1055. <param name="message">
  1056. A <see cref="T:System.String"/> that represents the message to output as a log.
  1057. </param>
  1058. </member>
  1059. <member name="M:WebSocketSharp.Logger.Trace(System.String)">
  1060. <summary>
  1061. Outputs <paramref name="message"/> as a log with <see cref="F:WebSocketSharp.LogLevel.Trace"/>.
  1062. </summary>
  1063. <remarks>
  1064. If the current logging level is higher than <see cref="F:WebSocketSharp.LogLevel.Trace"/>,
  1065. this method doesn't output <paramref name="message"/> as a log.
  1066. </remarks>
  1067. <param name="message">
  1068. A <see cref="T:System.String"/> that represents the message to output as a log.
  1069. </param>
  1070. </member>
  1071. <member name="M:WebSocketSharp.Logger.Warn(System.String)">
  1072. <summary>
  1073. Outputs <paramref name="message"/> as a log with <see cref="F:WebSocketSharp.LogLevel.Warn"/>.
  1074. </summary>
  1075. <remarks>
  1076. If the current logging level is higher than <see cref="F:WebSocketSharp.LogLevel.Warn"/>,
  1077. this method doesn't output <paramref name="message"/> as a log.
  1078. </remarks>
  1079. <param name="message">
  1080. A <see cref="T:System.String"/> that represents the message to output as a log.
  1081. </param>
  1082. </member>
  1083. <member name="T:WebSocketSharp.LogLevel">
  1084. <summary>
  1085. Specifies the logging level.
  1086. </summary>
  1087. </member>
  1088. <member name="F:WebSocketSharp.LogLevel.Trace">
  1089. <summary>
  1090. Specifies the bottom logging level.
  1091. </summary>
  1092. </member>
  1093. <member name="F:WebSocketSharp.LogLevel.Debug">
  1094. <summary>
  1095. Specifies the 2nd logging level from the bottom.
  1096. </summary>
  1097. </member>
  1098. <member name="F:WebSocketSharp.LogLevel.Info">
  1099. <summary>
  1100. Specifies the 3rd logging level from the bottom.
  1101. </summary>
  1102. </member>
  1103. <member name="F:WebSocketSharp.LogLevel.Warn">
  1104. <summary>
  1105. Specifies the 3rd logging level from the top.
  1106. </summary>
  1107. </member>
  1108. <member name="F:WebSocketSharp.LogLevel.Error">
  1109. <summary>
  1110. Specifies the 2nd logging level from the top.
  1111. </summary>
  1112. </member>
  1113. <member name="F:WebSocketSharp.LogLevel.Fatal">
  1114. <summary>
  1115. Specifies the top logging level.
  1116. </summary>
  1117. </member>
  1118. <member name="T:WebSocketSharp.Mask">
  1119. <summary>
  1120. Indicates whether the payload data of a WebSocket frame is masked.
  1121. </summary>
  1122. <remarks>
  1123. The values of this enumeration are defined in
  1124. <see href="http://tools.ietf.org/html/rfc6455#section-5.2">Section 5.2</see> of RFC 6455.
  1125. </remarks>
  1126. </member>
  1127. <member name="F:WebSocketSharp.Mask.Off">
  1128. <summary>
  1129. Equivalent to numeric value 0. Indicates not masked.
  1130. </summary>
  1131. </member>
  1132. <member name="F:WebSocketSharp.Mask.On">
  1133. <summary>
  1134. Equivalent to numeric value 1. Indicates masked.
  1135. </summary>
  1136. </member>
  1137. <member name="T:WebSocketSharp.MessageEventArgs">
  1138. <summary>
  1139. Represents the event data for the <see cref="E:WebSocketSharp.WebSocket.OnMessage"/> event.
  1140. </summary>
  1141. <remarks>
  1142. <para>
  1143. That event occurs when the <see cref="T:WebSocketSharp.WebSocket"/> receives
  1144. a message or a ping if the <see cref="P:WebSocketSharp.WebSocket.EmitOnPing"/>
  1145. property is set to <c>true</c>.
  1146. </para>
  1147. <para>
  1148. If you would like to get the message data, you should access
  1149. the <see cref="P:WebSocketSharp.MessageEventArgs.Data"/> or <see cref="P:WebSocketSharp.MessageEventArgs.RawData"/> property.
  1150. </para>
  1151. </remarks>
  1152. </member>
  1153. <member name="P:WebSocketSharp.MessageEventArgs.Opcode">
  1154. <summary>
  1155. Gets the opcode for the message.
  1156. </summary>
  1157. <value>
  1158. <see cref="F:WebSocketSharp.Opcode.Text"/>, <see cref="F:WebSocketSharp.Opcode.Binary"/>,
  1159. or <see cref="F:WebSocketSharp.Opcode.Ping"/>.
  1160. </value>
  1161. </member>
  1162. <member name="P:WebSocketSharp.MessageEventArgs.Data">
  1163. <summary>
  1164. Gets the message data as a <see cref="T:System.String"/>.
  1165. </summary>
  1166. <value>
  1167. A <see cref="T:System.String"/> that represents the message data if its type is
  1168. text or ping and if decoding it to a string has successfully done;
  1169. otherwise, <see langword="null"/>.
  1170. </value>
  1171. </member>
  1172. <member name="P:WebSocketSharp.MessageEventArgs.IsBinary">
  1173. <summary>
  1174. Gets a value indicating whether the message type is binary.
  1175. </summary>
  1176. <value>
  1177. <c>true</c> if the message type is binary; otherwise, <c>false</c>.
  1178. </value>
  1179. </member>
  1180. <member name="P:WebSocketSharp.MessageEventArgs.IsPing">
  1181. <summary>
  1182. Gets a value indicating whether the message type is ping.
  1183. </summary>
  1184. <value>
  1185. <c>true</c> if the message type is ping; otherwise, <c>false</c>.
  1186. </value>
  1187. </member>
  1188. <member name="P:WebSocketSharp.MessageEventArgs.IsText">
  1189. <summary>
  1190. Gets a value indicating whether the message type is text.
  1191. </summary>
  1192. <value>
  1193. <c>true</c> if the message type is text; otherwise, <c>false</c>.
  1194. </value>
  1195. </member>
  1196. <member name="P:WebSocketSharp.MessageEventArgs.RawData">
  1197. <summary>
  1198. Gets the message data as an array of <see cref="T:System.Byte"/>.
  1199. </summary>
  1200. <value>
  1201. An array of <see cref="T:System.Byte"/> that represents the message data.
  1202. </value>
  1203. </member>
  1204. <member name="T:WebSocketSharp.Net.AuthenticationSchemes">
  1205. <summary>
  1206. Specifies the scheme for authentication.
  1207. </summary>
  1208. </member>
  1209. <member name="F:WebSocketSharp.Net.AuthenticationSchemes.None">
  1210. <summary>
  1211. No authentication is allowed.
  1212. </summary>
  1213. </member>
  1214. <member name="F:WebSocketSharp.Net.AuthenticationSchemes.Digest">
  1215. <summary>
  1216. Specifies digest authentication.
  1217. </summary>
  1218. </member>
  1219. <member name="F:WebSocketSharp.Net.AuthenticationSchemes.Basic">
  1220. <summary>
  1221. Specifies basic authentication.
  1222. </summary>
  1223. </member>
  1224. <member name="F:WebSocketSharp.Net.AuthenticationSchemes.Anonymous">
  1225. <summary>
  1226. Specifies anonymous authentication.
  1227. </summary>
  1228. </member>
  1229. <member name="T:WebSocketSharp.Net.ClientSslConfiguration">
  1230. <summary>
  1231. Stores the parameters for the <see cref="T:System.Net.Security.SslStream"/> used by clients.
  1232. </summary>
  1233. </member>
  1234. <member name="M:WebSocketSharp.Net.ClientSslConfiguration.#ctor">
  1235. <summary>
  1236. Initializes a new instance of the <see cref="T:WebSocketSharp.Net.ClientSslConfiguration"/> class.
  1237. </summary>
  1238. </member>
  1239. <member name="M:WebSocketSharp.Net.ClientSslConfiguration.#ctor(System.String)">
  1240. <summary>
  1241. Initializes a new instance of the <see cref="T:WebSocketSharp.Net.ClientSslConfiguration"/> class
  1242. with the specified <paramref name="targetHost"/>.
  1243. </summary>
  1244. <param name="targetHost">
  1245. A <see cref="T:System.String"/> that represents the target host server name.
  1246. </param>
  1247. </member>
  1248. <member name="M:WebSocketSharp.Net.ClientSslConfiguration.#ctor(WebSocketSharp.Net.ClientSslConfiguration)">
  1249. <summary>
  1250. Copies the parameters from the specified <paramref name="configuration"/> to
  1251. a new instance of the <see cref="T:WebSocketSharp.Net.ClientSslConfiguration"/> class.
  1252. </summary>
  1253. <param name="configuration">
  1254. A <see cref="T:WebSocketSharp.Net.ClientSslConfiguration"/> from which to copy.
  1255. </param>
  1256. <exception cref="T:System.ArgumentNullException">
  1257. <paramref name="configuration"/> is <see langword="null"/>.
  1258. </exception>
  1259. </member>
  1260. <member name="P:WebSocketSharp.Net.ClientSslConfiguration.CheckCertificateRevocation">
  1261. <summary>
  1262. Gets or sets a value indicating whether the certificate revocation
  1263. list is checked during authentication.
  1264. </summary>
  1265. <value>
  1266. <para>
  1267. <c>true</c> if the certificate revocation list is checked during
  1268. authentication; otherwise, <c>false</c>.
  1269. </para>
  1270. <para>
  1271. The default value is <c>false</c>.
  1272. </para>
  1273. </value>
  1274. </member>
  1275. <member name="P:WebSocketSharp.Net.ClientSslConfiguration.ClientCertificates">
  1276. <summary>
  1277. Gets or sets the certificates from which to select one to
  1278. supply to the server.
  1279. </summary>
  1280. <value>
  1281. <para>
  1282. A <see cref="T:System.Security.Cryptography.X509Certificates.X509CertificateCollection"/> or <see langword="null"/>.
  1283. </para>
  1284. <para>
  1285. That collection contains client certificates from which to select.
  1286. </para>
  1287. <para>
  1288. The default value is <see langword="null"/>.
  1289. </para>
  1290. </value>
  1291. </member>
  1292. <member name="P:WebSocketSharp.Net.ClientSslConfiguration.ClientCertificateSelectionCallback">
  1293. <summary>
  1294. Gets or sets the callback used to select the certificate to
  1295. supply to the server.
  1296. </summary>
  1297. <remarks>
  1298. No certificate is supplied if the callback returns
  1299. <see langword="null"/>.
  1300. </remarks>
  1301. <value>
  1302. <para>
  1303. A <see cref="T:System.Net.Security.LocalCertificateSelectionCallback"/> delegate that
  1304. invokes the method called for selecting the certificate.
  1305. </para>
  1306. <para>
  1307. The default value is a delegate that invokes a method that
  1308. only returns <see langword="null"/>.
  1309. </para>
  1310. </value>
  1311. </member>
  1312. <member name="P:WebSocketSharp.Net.ClientSslConfiguration.EnabledSslProtocols">
  1313. <summary>
  1314. Gets or sets the protocols used for authentication.
  1315. </summary>
  1316. <value>
  1317. <para>
  1318. The <see cref="T:System.Security.Authentication.SslProtocols"/> enum values that represent
  1319. the protocols used for authentication.
  1320. </para>
  1321. <para>
  1322. The default value is <see cref="F:System.Security.Authentication.SslProtocols.Default"/>.
  1323. </para>
  1324. </value>
  1325. </member>
  1326. <member name="P:WebSocketSharp.Net.ClientSslConfiguration.ServerCertificateValidationCallback">
  1327. <summary>
  1328. Gets or sets the callback used to validate the certificate
  1329. supplied by the server.
  1330. </summary>
  1331. <remarks>
  1332. The certificate is valid if the callback returns <c>true</c>.
  1333. </remarks>
  1334. <value>
  1335. <para>
  1336. A <see cref="T:System.Net.Security.RemoteCertificateValidationCallback"/> delegate that
  1337. invokes the method called for validating the certificate.
  1338. </para>
  1339. <para>
  1340. The default value is a delegate that invokes a method that
  1341. only returns <c>true</c>.
  1342. </para>
  1343. </value>
  1344. </member>
  1345. <member name="P:WebSocketSharp.Net.ClientSslConfiguration.TargetHost">
  1346. <summary>
  1347. Gets or sets the target host server name.
  1348. </summary>
  1349. <value>
  1350. <para>
  1351. A <see cref="T:System.String"/> or <see langword="null"/>
  1352. if not specified.
  1353. </para>
  1354. <para>
  1355. That string represents the name of the server that
  1356. will share a secure connection with a client.
  1357. </para>
  1358. </value>
  1359. </member>
  1360. <member name="T:WebSocketSharp.Net.Cookie">
  1361. <summary>
  1362. Provides a set of methods and properties used to manage an HTTP Cookie.
  1363. </summary>
  1364. <remarks>
  1365. <para>
  1366. The Cookie class supports the following cookie formats:
  1367. <see href="http://web.archive.org/web/20020803110822/http://wp.netscape.com/newsref/std/cookie_spec.html">Netscape specification</see>,
  1368. <see href="http://www.ietf.org/rfc/rfc2109.txt">RFC 2109</see>, and
  1369. <see href="http://www.ietf.org/rfc/rfc2965.txt">RFC 2965</see>
  1370. </para>
  1371. <para>
  1372. The Cookie class cannot be inherited.
  1373. </para>
  1374. </remarks>
  1375. </member>
  1376. <member name="M:WebSocketSharp.Net.Cookie.#ctor">
  1377. <summary>
  1378. Initializes a new instance of the <see cref="T:WebSocketSharp.Net.Cookie"/> class.
  1379. </summary>
  1380. </member>
  1381. <member name="M:WebSocketSharp.Net.Cookie.#ctor(System.String,System.String)">
  1382. <summary>
  1383. Initializes a new instance of the <see cref="T:WebSocketSharp.Net.Cookie"/> class with the specified
  1384. <paramref name="name"/> and <paramref name="value"/>.
  1385. </summary>
  1386. <param name="name">
  1387. A <see cref="T:System.String"/> that represents the Name of the cookie.
  1388. </param>
  1389. <param name="value">
  1390. A <see cref="T:System.String"/> that represents the Value of the cookie.
  1391. </param>
  1392. <exception cref="T:WebSocketSharp.Net.CookieException">
  1393. <para>
  1394. <paramref name="name"/> is <see langword="null"/> or empty.
  1395. </para>
  1396. <para>
  1397. - or -
  1398. </para>
  1399. <para>
  1400. <paramref name="name"/> contains an invalid character.
  1401. </para>
  1402. <para>
  1403. - or -
  1404. </para>
  1405. <para>
  1406. <paramref name="value"/> is <see langword="null"/>.
  1407. </para>
  1408. <para>
  1409. - or -
  1410. </para>
  1411. <para>
  1412. <paramref name="value"/> contains a string not enclosed in double quotes
  1413. that contains an invalid character.
  1414. </para>
  1415. </exception>
  1416. </member>
  1417. <member name="M:WebSocketSharp.Net.Cookie.#ctor(System.String,System.String,System.String)">
  1418. <summary>
  1419. Initializes a new instance of the <see cref="T:WebSocketSharp.Net.Cookie"/> class with the specified
  1420. <paramref name="name"/>, <paramref name="value"/>, and <paramref name="path"/>.
  1421. </summary>
  1422. <param name="name">
  1423. A <see cref="T:System.String"/> that represents the Name of the cookie.
  1424. </param>
  1425. <param name="value">
  1426. A <see cref="T:System.String"/> that represents the Value of the cookie.
  1427. </param>
  1428. <param name="path">
  1429. A <see cref="T:System.String"/> that represents the value of the Path attribute of the cookie.
  1430. </param>
  1431. <exception cref="T:WebSocketSharp.Net.CookieException">
  1432. <para>
  1433. <paramref name="name"/> is <see langword="null"/> or empty.
  1434. </para>
  1435. <para>
  1436. - or -
  1437. </para>
  1438. <para>
  1439. <paramref name="name"/> contains an invalid character.
  1440. </para>
  1441. <para>
  1442. - or -
  1443. </para>
  1444. <para>
  1445. <paramref name="value"/> is <see langword="null"/>.
  1446. </para>
  1447. <para>
  1448. - or -
  1449. </para>
  1450. <para>
  1451. <paramref name="value"/> contains a string not enclosed in double quotes
  1452. that contains an invalid character.
  1453. </para>
  1454. </exception>
  1455. </member>
  1456. <member name="M:WebSocketSharp.Net.Cookie.#ctor(System.String,System.String,System.String,System.String)">
  1457. <summary>
  1458. Initializes a new instance of the <see cref="T:WebSocketSharp.Net.Cookie"/> class with the specified
  1459. <paramref name="name"/>, <paramref name="value"/>, <paramref name="path"/>, and
  1460. <paramref name="domain"/>.
  1461. </summary>
  1462. <param name="name">
  1463. A <see cref="T:System.String"/> that represents the Name of the cookie.
  1464. </param>
  1465. <param name="value">
  1466. A <see cref="T:System.String"/> that represents the Value of the cookie.
  1467. </param>
  1468. <param name="path">
  1469. A <see cref="T:System.String"/> that represents the value of the Path attribute of the cookie.
  1470. </param>
  1471. <param name="domain">
  1472. A <see cref="T:System.String"/> that represents the value of the Domain attribute of the cookie.
  1473. </param>
  1474. <exception cref="T:WebSocketSharp.Net.CookieException">
  1475. <para>
  1476. <paramref name="name"/> is <see langword="null"/> or empty.
  1477. </para>
  1478. <para>
  1479. - or -
  1480. </para>
  1481. <para>
  1482. <paramref name="name"/> contains an invalid character.
  1483. </para>
  1484. <para>
  1485. - or -
  1486. </para>
  1487. <para>
  1488. <paramref name="value"/> is <see langword="null"/>.
  1489. </para>
  1490. <para>
  1491. - or -
  1492. </para>
  1493. <para>
  1494. <paramref name="value"/> contains a string not enclosed in double quotes
  1495. that contains an invalid character.
  1496. </para>
  1497. </exception>
  1498. </member>
  1499. <member name="P:WebSocketSharp.Net.Cookie.Comment">
  1500. <summary>
  1501. Gets or sets the value of the Comment attribute of the cookie.
  1502. </summary>
  1503. <value>
  1504. A <see cref="T:System.String"/> that represents the comment to document intended use of the cookie.
  1505. </value>
  1506. </member>
  1507. <member name="P:WebSocketSharp.Net.Cookie.CommentUri">
  1508. <summary>
  1509. Gets or sets the value of the CommentURL attribute of the cookie.
  1510. </summary>
  1511. <value>
  1512. A <see cref="T:System.Uri"/> that represents the URI that provides the comment to document intended
  1513. use of the cookie.
  1514. </value>
  1515. </member>
  1516. <member name="P:WebSocketSharp.Net.Cookie.Discard">
  1517. <summary>
  1518. Gets or sets a value indicating whether the client discards the cookie unconditionally
  1519. when the client terminates.
  1520. </summary>
  1521. <value>
  1522. <c>true</c> if the client discards the cookie unconditionally when the client terminates;
  1523. otherwise, <c>false</c>. The default value is <c>false</c>.
  1524. </value>
  1525. </member>
  1526. <member name="P:WebSocketSharp.Net.Cookie.Domain">
  1527. <summary>
  1528. Gets or sets the value of the Domain attribute of the cookie.
  1529. </summary>
  1530. <value>
  1531. A <see cref="T:System.String"/> that represents the URI for which the cookie is valid.
  1532. </value>
  1533. </member>
  1534. <member name="P:WebSocketSharp.Net.Cookie.Expired">
  1535. <summary>
  1536. Gets or sets a value indicating whether the cookie has expired.
  1537. </summary>
  1538. <value>
  1539. <c>true</c> if the cookie has expired; otherwise, <c>false</c>.
  1540. The default value is <c>false</c>.
  1541. </value>
  1542. </member>
  1543. <member name="P:WebSocketSharp.Net.Cookie.Expires">
  1544. <summary>
  1545. Gets or sets the value of the Expires attribute of the cookie.
  1546. </summary>
  1547. <value>
  1548. A <see cref="T:System.DateTime"/> that represents the date and time at which the cookie expires.
  1549. The default value is <see cref="F:System.DateTime.MinValue"/>.
  1550. </value>
  1551. </member>
  1552. <member name="P:WebSocketSharp.Net.Cookie.HttpOnly">
  1553. <summary>
  1554. Gets or sets a value indicating whether non-HTTP APIs can access the cookie.
  1555. </summary>
  1556. <value>
  1557. <c>true</c> if non-HTTP APIs cannot access the cookie; otherwise, <c>false</c>.
  1558. The default value is <c>false</c>.
  1559. </value>
  1560. </member>
  1561. <member name="P:WebSocketSharp.Net.Cookie.Name">
  1562. <summary>
  1563. Gets or sets the Name of the cookie.
  1564. </summary>
  1565. <value>
  1566. A <see cref="T:System.String"/> that represents the Name of the cookie.
  1567. </value>
  1568. <exception cref="T:WebSocketSharp.Net.CookieException">
  1569. <para>
  1570. The value specified for a set operation is <see langword="null"/> or empty.
  1571. </para>
  1572. <para>
  1573. - or -
  1574. </para>
  1575. <para>
  1576. The value specified for a set operation contains an invalid character.
  1577. </para>
  1578. </exception>
  1579. </member>
  1580. <member name="P:WebSocketSharp.Net.Cookie.Path">
  1581. <summary>
  1582. Gets or sets the value of the Path attribute of the cookie.
  1583. </summary>
  1584. <value>
  1585. A <see cref="T:System.String"/> that represents the subset of URI on the origin server
  1586. to which the cookie applies.
  1587. </value>
  1588. </member>
  1589. <member name="P:WebSocketSharp.Net.Cookie.Port">
  1590. <summary>
  1591. Gets or sets the value of the Port attribute of the cookie.
  1592. </summary>
  1593. <value>
  1594. A <see cref="T:System.String"/> that represents the list of TCP ports to which the cookie applies.
  1595. </value>
  1596. <exception cref="T:WebSocketSharp.Net.CookieException">
  1597. The value specified for a set operation isn't enclosed in double quotes or
  1598. couldn't be parsed.
  1599. </exception>
  1600. </member>
  1601. <member name="P:WebSocketSharp.Net.Cookie.Secure">
  1602. <summary>
  1603. Gets or sets a value indicating whether the security level of the cookie is secure.
  1604. </summary>
  1605. <remarks>
  1606. When this property is <c>true</c>, the cookie may be included in the HTTP request
  1607. only if the request is transmitted over the HTTPS.
  1608. </remarks>
  1609. <value>
  1610. <c>true</c> if the security level of the cookie is secure; otherwise, <c>false</c>.
  1611. The default value is <c>false</c>.
  1612. </value>
  1613. </member>
  1614. <member name="P:WebSocketSharp.Net.Cookie.TimeStamp">
  1615. <summary>
  1616. Gets the time when the cookie was issued.
  1617. </summary>
  1618. <value>
  1619. A <see cref="T:System.DateTime"/> that represents the time when the cookie was issued.
  1620. </value>
  1621. </member>
  1622. <member name="P:WebSocketSharp.Net.Cookie.Value">
  1623. <summary>
  1624. Gets or sets the Value of the cookie.
  1625. </summary>
  1626. <value>
  1627. A <see cref="T:System.String"/> that represents the Value of the cookie.
  1628. </value>
  1629. <exception cref="T:WebSocketSharp.Net.CookieException">
  1630. <para>
  1631. The value specified for a set operation is <see langword="null"/>.
  1632. </para>
  1633. <para>
  1634. - or -
  1635. </para>
  1636. <para>
  1637. The value specified for a set operation contains a string not enclosed in double quotes
  1638. that contains an invalid character.
  1639. </para>
  1640. </exception>
  1641. </member>
  1642. <member name="P:WebSocketSharp.Net.Cookie.Version">
  1643. <summary>
  1644. Gets or sets the value of the Version attribute of the cookie.
  1645. </summary>
  1646. <value>
  1647. An <see cref="T:System.Int32"/> that represents the version of the HTTP state management
  1648. to which the cookie conforms.
  1649. </value>
  1650. <exception cref="T:System.ArgumentOutOfRangeException">
  1651. The value specified for a set operation isn't 0 or 1.
  1652. </exception>
  1653. </member>
  1654. <member name="M:WebSocketSharp.Net.Cookie.Equals(System.Object)">
  1655. <summary>
  1656. Determines whether the specified <see cref="T:System.Object"/> is equal to the current
  1657. <see cref="T:WebSocketSharp.Net.Cookie"/>.
  1658. </summary>
  1659. <param name="comparand">
  1660. An <see cref="T:System.Object"/> to compare with the current <see cref="T:WebSocketSharp.Net.Cookie"/>.
  1661. </param>
  1662. <returns>
  1663. <c>true</c> if <paramref name="comparand"/> is equal to the current <see cref="T:WebSocketSharp.Net.Cookie"/>;
  1664. otherwise, <c>false</c>.
  1665. </returns>
  1666. </member>
  1667. <member name="M:WebSocketSharp.Net.Cookie.GetHashCode">
  1668. <summary>
  1669. Serves as a hash function for a <see cref="T:WebSocketSharp.Net.Cookie"/> object.
  1670. </summary>
  1671. <returns>
  1672. An <see cref="T:System.Int32"/> that represents the hash code for the current <see cref="T:WebSocketSharp.Net.Cookie"/>.
  1673. </returns>
  1674. </member>
  1675. <member name="M:WebSocketSharp.Net.Cookie.ToString">
  1676. <summary>
  1677. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:WebSocketSharp.Net.Cookie"/>.
  1678. </summary>
  1679. <remarks>
  1680. This method returns a <see cref="T:System.String"/> to use to send an HTTP Cookie to
  1681. an origin server.
  1682. </remarks>
  1683. <returns>
  1684. A <see cref="T:System.String"/> that represents the current <see cref="T:WebSocketSharp.Net.Cookie"/>.
  1685. </returns>
  1686. </member>
  1687. <member name="T:WebSocketSharp.Net.CookieCollection">
  1688. <summary>
  1689. Provides a collection container for instances of the <see cref="T:WebSocketSharp.Net.Cookie"/> class.
  1690. </summary>
  1691. </member>
  1692. <member name="M:WebSocketSharp.Net.CookieCollection.#ctor">
  1693. <summary>
  1694. Initializes a new instance of the <see cref="T:WebSocketSharp.Net.CookieCollection"/> class.
  1695. </summary>
  1696. </member>
  1697. <member name="P:WebSocketSharp.Net.CookieCollection.Count">
  1698. <summary>
  1699. Gets the number of cookies in the collection.
  1700. </summary>
  1701. <value>
  1702. An <see cref="T:System.Int32"/> that represents the number of cookies in the collection.
  1703. </value>
  1704. </member>
  1705. <member name="P:WebSocketSharp.Net.CookieCollection.IsReadOnly">
  1706. <summary>
  1707. Gets a value indicating whether the collection is read-only.
  1708. </summary>
  1709. <value>
  1710. <c>true</c> if the collection is read-only; otherwise, <c>false</c>.
  1711. The default value is <c>true</c>.
  1712. </value>
  1713. </member>
  1714. <member name="P:WebSocketSharp.Net.CookieCollection.IsSynchronized">
  1715. <summary>
  1716. Gets a value indicating whether the access to the collection is thread safe.
  1717. </summary>
  1718. <value>
  1719. <c>true</c> if the access to the collection is thread safe; otherwise, <c>false</c>.
  1720. The default value is <c>false</c>.
  1721. </value>
  1722. </member>
  1723. <member name="P:WebSocketSharp.Net.CookieCollection.Item(System.Int32)">
  1724. <summary>
  1725. Gets the <see cref="T:WebSocketSharp.Net.Cookie"/> at the specified <paramref name="index"/> from
  1726. the collection.
  1727. </summary>
  1728. <value>
  1729. A <see cref="T:WebSocketSharp.Net.Cookie"/> at the specified <paramref name="index"/> in the collection.
  1730. </value>
  1731. <param name="index">
  1732. An <see cref="T:System.Int32"/> that represents the zero-based index of the <see cref="T:WebSocketSharp.Net.Cookie"/>
  1733. to find.
  1734. </param>
  1735. <exception cref="T:System.ArgumentOutOfRangeException">
  1736. <paramref name="index"/> is out of allowable range of indexes for the collection.
  1737. </exception>
  1738. </member>
  1739. <member name="P:WebSocketSharp.Net.CookieCollection.Item(System.String)">
  1740. <summary>
  1741. Gets the <see cref="T:WebSocketSharp.Net.Cookie"/> with the specified <paramref name="name"/> from
  1742. the collection.
  1743. </summary>
  1744. <value>
  1745. A <see cref="T:WebSocketSharp.Net.Cookie"/> with the specified <paramref name="name"/> in the collection.
  1746. </value>
  1747. <param name="name">
  1748. A <see cref="T:System.String"/> that represents the name of the <see cref="T:WebSocketSharp.Net.Cookie"/> to find.
  1749. </param>
  1750. <exception cref="T:System.ArgumentNullException">
  1751. <paramref name="name"/> is <see langword="null"/>.
  1752. </exception>
  1753. </member>
  1754. <member name="P:WebSocketSharp.Net.CookieCollection.SyncRoot">
  1755. <summary>
  1756. Gets an object used to synchronize access to the collection.
  1757. </summary>
  1758. <value>
  1759. An <see cref="T:System.Object"/> used to synchronize access to the collection.
  1760. </value>
  1761. </member>
  1762. <member name="M:WebSocketSharp.Net.CookieCollection.Add(WebSocketSharp.Net.Cookie)">
  1763. <summary>
  1764. Adds the specified <paramref name="cookie"/> to the collection.
  1765. </summary>
  1766. <param name="cookie">
  1767. A <see cref="T:WebSocketSharp.Net.Cookie"/> to add.
  1768. </param>
  1769. <exception cref="T:System.ArgumentNullException">
  1770. <paramref name="cookie"/> is <see langword="null"/>.
  1771. </exception>
  1772. </member>
  1773. <member name="M:WebSocketSharp.Net.CookieCollection.Add(WebSocketSharp.Net.CookieCollection)">
  1774. <summary>
  1775. Adds the specified <paramref name="cookies"/> to the collection.
  1776. </summary>
  1777. <param name="cookies">
  1778. A <see cref="T:WebSocketSharp.Net.CookieCollection"/> that contains the cookies to add.
  1779. </param>
  1780. <exception cref="T:System.ArgumentNullException">
  1781. <paramref name="cookies"/> is <see langword="null"/>.
  1782. </exception>
  1783. </member>
  1784. <member name="M:WebSocketSharp.Net.CookieCollection.CopyTo(System.Array,System.Int32)">
  1785. <summary>
  1786. Copies the elements of the collection to the specified <see cref="T:System.Array"/>, starting at
  1787. the specified <paramref name="index"/> in the <paramref name="array"/>.
  1788. </summary>
  1789. <param name="array">
  1790. An <see cref="T:System.Array"/> that represents the destination of the elements copied from
  1791. the collection.
  1792. </param>
  1793. <param name="index">
  1794. An <see cref="T:System.Int32"/> that represents the zero-based index in <paramref name="array"/>
  1795. at which copying begins.
  1796. </param>
  1797. <exception cref="T:System.ArgumentNullException">
  1798. <paramref name="array"/> is <see langword="null"/>.
  1799. </exception>
  1800. <exception cref="T:System.ArgumentOutOfRangeException">
  1801. <paramref name="index"/> is less than zero.
  1802. </exception>
  1803. <exception cref="T:System.ArgumentException">
  1804. <para>
  1805. <paramref name="array"/> is multidimensional.
  1806. </para>
  1807. <para>
  1808. -or-
  1809. </para>
  1810. <para>
  1811. The number of elements in the collection is greater than the available space from
  1812. <paramref name="index"/> to the end of the destination <paramref name="array"/>.
  1813. </para>
  1814. </exception>
  1815. <exception cref="T:System.InvalidCastException">
  1816. The elements in the collection cannot be cast automatically to the type of the destination
  1817. <paramref name="array"/>.
  1818. </exception>
  1819. </member>
  1820. <member name="M:WebSocketSharp.Net.CookieCollection.CopyTo(WebSocketSharp.Net.Cookie[],System.Int32)">
  1821. <summary>
  1822. Copies the elements of the collection to the specified array of <see cref="T:WebSocketSharp.Net.Cookie"/>,
  1823. starting at the specified <paramref name="index"/> in the <paramref name="array"/>.
  1824. </summary>
  1825. <param name="array">
  1826. An array of <see cref="T:WebSocketSharp.Net.Cookie"/> that represents the destination of the elements
  1827. copied from the collection.
  1828. </param>
  1829. <param name="index">
  1830. An <see cref="T:System.Int32"/> that represents the zero-based index in <paramref name="array"/>
  1831. at which copying begins.
  1832. </param>
  1833. <exception cref="T:System.ArgumentNullException">
  1834. <paramref name="array"/> is <see langword="null"/>.
  1835. </exception>
  1836. <exception cref="T:System.ArgumentOutOfRangeException">
  1837. <paramref name="index"/> is less than zero.
  1838. </exception>
  1839. <exception cref="T:System.ArgumentException">
  1840. The number of elements in the collection is greater than the available space from
  1841. <paramref name="index"/> to the end of the destination <paramref name="array"/>.
  1842. </exception>
  1843. </member>
  1844. <member name="M:WebSocketSharp.Net.CookieCollection.GetEnumerator">
  1845. <summary>
  1846. Gets the enumerator used to iterate through the collection.
  1847. </summary>
  1848. <returns>
  1849. An <see cref="T:System.Collections.IEnumerator"/> instance used to iterate through the collection.
  1850. </returns>
  1851. </member>
  1852. <member name="T:WebSocketSharp.Net.CookieException">
  1853. <summary>
  1854. The exception that is thrown when a <see cref="T:WebSocketSharp.Net.Cookie"/> gets an error.
  1855. </summary>
  1856. </member>
  1857. <member name="M:WebSocketSharp.Net.CookieException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  1858. <summary>
  1859. Initializes a new instance of the <see cref="T:WebSocketSharp.Net.CookieException"/> class from
  1860. the specified <see cref="T:System.Runtime.Serialization.SerializationInfo"/> and <see cref="T:System.Runtime.Serialization.StreamingContext"/>.
  1861. </summary>
  1862. <param name="serializationInfo">
  1863. A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that contains the serialized object data.
  1864. </param>
  1865. <param name="streamingContext">
  1866. A <see cref="T:System.Runtime.Serialization.StreamingContext"/> that specifies the source for the deserialization.
  1867. </param>
  1868. </member>
  1869. <member name="M:WebSocketSharp.Net.CookieException.#ctor">
  1870. <summary>
  1871. Initializes a new instance of the <see cref="T:WebSocketSharp.Net.CookieException"/> class.
  1872. </summary>
  1873. </member>
  1874. <member name="M:WebSocketSharp.Net.CookieException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  1875. <summary>
  1876. Populates the specified <see cref="T:System.Runtime.Serialization.SerializationInfo"/> with the data needed to serialize
  1877. the current <see cref="T:WebSocketSharp.Net.CookieException"/>.
  1878. </summary>
  1879. <param name="serializationInfo">
  1880. A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data.
  1881. </param>
  1882. <param name="streamingContext">
  1883. A <see cref="T:System.Runtime.Serialization.StreamingContext"/> that specifies the destination for the serialization.
  1884. </param>
  1885. </member>
  1886. <member name="M:WebSocketSharp.Net.CookieException.System#Runtime#Serialization#ISerializable#GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  1887. <summary>
  1888. Populates the specified <see cref="T:System.Runtime.Serialization.SerializationInfo"/> with the data needed to serialize
  1889. the current <see cref="T:WebSocketSharp.Net.CookieException"/>.
  1890. </summary>
  1891. <param name="serializationInfo">
  1892. A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data.
  1893. </param>
  1894. <param name="streamingContext">
  1895. A <see cref="T:System.Runtime.Serialization.StreamingContext"/> that specifies the destination for the serialization.
  1896. </param>
  1897. </member>
  1898. <member name="T:WebSocketSharp.Net.HttpBasicIdentity">
  1899. <summary>
  1900. Holds the username and password from an HTTP Basic authentication attempt.
  1901. </summary>
  1902. </member>
  1903. <member name="P:WebSocketSharp.Net.HttpBasicIdentity.Password">
  1904. <summary>
  1905. Gets the password from a basic authentication attempt.
  1906. </summary>
  1907. <value>
  1908. A <see cref="T:System.String"/> that represents the password.
  1909. </value>
  1910. </member>
  1911. <member name="T:WebSocketSharp.Net.HttpDigestIdentity">
  1912. <summary>
  1913. Holds the username and other parameters from
  1914. an HTTP Digest authentication attempt.
  1915. </summary>
  1916. </member>
  1917. <member name="P:WebSocketSharp.Net.HttpDigestIdentity.Algorithm">
  1918. <summary>
  1919. Gets the algorithm parameter from a digest authentication attempt.
  1920. </summary>
  1921. <value>
  1922. A <see cref="T:System.String"/> that represents the algorithm parameter.
  1923. </value>
  1924. </member>
  1925. <member name="P:WebSocketSharp.Net.HttpDigestIdentity.Cnonce">
  1926. <summary>
  1927. Gets the cnonce parameter from a digest authentication attempt.
  1928. </summary>
  1929. <value>
  1930. A <see cref="T:System.String"/> that represents the cnonce parameter.
  1931. </value>
  1932. </member>
  1933. <member name="P:WebSocketSharp.Net.HttpDigestIdentity.Nc">
  1934. <summary>
  1935. Gets the nc parameter from a digest authentication attempt.
  1936. </summary>
  1937. <value>
  1938. A <see cref="T:System.String"/> that represents the nc parameter.
  1939. </value>
  1940. </member>
  1941. <member name="P:WebSocketSharp.Net.HttpDigestIdentity.Nonce">
  1942. <summary>
  1943. Gets the nonce parameter from a digest authentication attempt.
  1944. </summary>
  1945. <value>
  1946. A <see cref="T:System.String"/> that represents the nonce parameter.
  1947. </value>
  1948. </member>
  1949. <member name="P:WebSocketSharp.Net.HttpDigestIdentity.Opaque">
  1950. <summary>
  1951. Gets the opaque parameter from a digest authentication attempt.
  1952. </summary>
  1953. <value>
  1954. A <see cref="T:System.String"/> that represents the opaque parameter.
  1955. </value>
  1956. </member>
  1957. <member name="P:WebSocketSharp.Net.HttpDigestIdentity.Qop">
  1958. <summary>
  1959. Gets the qop parameter from a digest authentication attempt.
  1960. </summary>
  1961. <value>
  1962. A <see cref="T:System.String"/> that represents the qop parameter.
  1963. </value>
  1964. </member>
  1965. <member name="P:WebSocketSharp.Net.HttpDigestIdentity.Realm">
  1966. <summary>
  1967. Gets the realm parameter from a digest authentication attempt.
  1968. </summary>
  1969. <value>
  1970. A <see cref="T:System.String"/> that represents the realm parameter.
  1971. </value>
  1972. </member>
  1973. <member name="P:WebSocketSharp.Net.HttpDigestIdentity.Response">
  1974. <summary>
  1975. Gets the response parameter from a digest authentication attempt.
  1976. </summary>
  1977. <value>
  1978. A <see cref="T:System.String"/> that represents the response parameter.
  1979. </value>
  1980. </member>
  1981. <member name="P:WebSocketSharp.Net.HttpDigestIdentity.Uri">
  1982. <summary>
  1983. Gets the uri parameter from a digest authentication attempt.
  1984. </summary>
  1985. <value>
  1986. A <see cref="T:System.String"/> that represents the uri parameter.
  1987. </value>
  1988. </member>
  1989. <member name="T:WebSocketSharp.Net.HttpListener">
  1990. <summary>
  1991. Provides a simple, programmatically controlled HTTP listener.
  1992. </summary>
  1993. </member>
  1994. <member name="M:WebSocketSharp.Net.HttpListener.#ctor">
  1995. <summary>
  1996. Initializes a new instance of the <see cref="T:WebSocketSharp.Net.HttpListener"/> class.
  1997. </summary>
  1998. </member>
  1999. <member name="P:WebSocketSharp.Net.HttpListener.AuthenticationSchemes">
  2000. <summary>
  2001. Gets or sets the scheme used to authenticate the clients.
  2002. </summary>
  2003. <value>
  2004. One of the <see cref="T:WebSocketSharp.Net.AuthenticationSchemes"/> enum values,
  2005. represents the scheme used to authenticate the clients. The default value is
  2006. <see cref="F:WebSocketSharp.Net.AuthenticationSchemes.Anonymous"/>.
  2007. </value>
  2008. <exception cref="T:System.ObjectDisposedException">
  2009. This listener has been closed.
  2010. </exception>
  2011. </member>
  2012. <member name="P:WebSocketSharp.Net.HttpListener.AuthenticationSchemeSelector">
  2013. <summary>
  2014. Gets or sets the delegate called to select the scheme used to authenticate the clients.
  2015. </summary>
  2016. <remarks>
  2017. If you set this property, the listener uses the authentication scheme selected by
  2018. the delegate for each request. Or if you don't set, the listener uses the value of
  2019. the <see cref="P:WebSocketSharp.Net.HttpListener.AuthenticationSchemes"/> property as the authentication
  2020. scheme for all requests.
  2021. </remarks>
  2022. <value>
  2023. A <c>Func&lt;<see cref="T:WebSocketSharp.Net.HttpListenerRequest"/>, <see cref="P:WebSocketSharp.Net.HttpListener.AuthenticationSchemes"/>&gt;</c>
  2024. delegate that references the method used to select an authentication scheme. The default
  2025. value is <see langword="null"/>.
  2026. </value>
  2027. <exception cref="T:System.ObjectDisposedException">
  2028. This listener has been closed.
  2029. </exception>
  2030. </member>
  2031. <member name="P:WebSocketSharp.Net.HttpListener.CertificateFolderPath">
  2032. <summary>
  2033. Gets or sets the path to the folder in which stores the certificate files used to
  2034. authenticate the server on the secure connection.
  2035. </summary>
  2036. <remarks>
  2037. <para>
  2038. This property represents the path to the folder in which stores the certificate files
  2039. associated with each port number of added URI prefixes. A set of the certificate files
  2040. is a pair of the <c>'port number'.cer</c> (DER) and <c>'port number'.key</c>
  2041. (DER, RSA Private Key).
  2042. </para>
  2043. <para>
  2044. If this property is <see langword="null"/> or empty, the result of
  2045. <c>System.Environment.GetFolderPath
  2046. (<see cref="F:System.Environment.SpecialFolder.ApplicationData"/>)</c> is used as the default path.
  2047. </para>
  2048. </remarks>
  2049. <value>
  2050. A <see cref="T:System.String"/> that represents the path to the folder in which stores
  2051. the certificate files. The default value is <see langword="null"/>.
  2052. </value>
  2053. <exception cref="T:System.ObjectDisposedException">
  2054. This listener has been closed.
  2055. </exception>
  2056. </member>
  2057. <member name="P:WebSocketSharp.Net.HttpListener.IgnoreWriteExceptions">
  2058. <summary>
  2059. Gets or sets a value indicating whether the listener returns exceptions that occur when
  2060. sending the response to the client.
  2061. </summary>
  2062. <value>
  2063. <c>true</c> if the listener shouldn't return those exceptions; otherwise, <c>false</c>.
  2064. The default value is <c>false</c>.
  2065. </value>
  2066. <exception cref="T:System.ObjectDisposedException">
  2067. This listener has been closed.
  2068. </exception>
  2069. </member>
  2070. <member name="P:WebSocketSharp.Net.HttpListener.IsListening">
  2071. <summary>
  2072. Gets a value indicating whether the listener has been started.
  2073. </summary>
  2074. <value>
  2075. <c>true</c> if the listener has been started; otherwise, <c>false</c>.
  2076. </value>
  2077. </member>
  2078. <member name="P:WebSocketSharp.Net.HttpListener.IsSupported">
  2079. <summary>
  2080. Gets a value indicating whether the listener can be used with the current operating system.
  2081. </summary>
  2082. <value>
  2083. <c>true</c>.
  2084. </value>
  2085. </member>
  2086. <member name="P:WebSocketSharp.Net.HttpListener.Log">
  2087. <summary>
  2088. Gets the logging functions.
  2089. </summary>
  2090. <remarks>
  2091. The default logging level is <see cref="F:WebSocketSharp.LogLevel.Error"/>. If you would like to change it,
  2092. you should set the <c>Log.Level</c> property to any of the <see cref="T:WebSocketSharp.LogLevel"/> enum
  2093. values.
  2094. </remarks>
  2095. <value>
  2096. A <see cref="T:WebSocketSharp.Logger"/> that provides the logging functions.
  2097. </value>
  2098. </member>
  2099. <member name="P:WebSocketSharp.Net.HttpListener.Prefixes">
  2100. <summary>
  2101. Gets the URI prefixes handled by the listener.
  2102. </summary>
  2103. <value>
  2104. A <see cref="T:WebSocketSharp.Net.HttpListenerPrefixCollection"/> that contains the URI prefixes.
  2105. </value>
  2106. <exception cref="T:System.ObjectDisposedException">
  2107. This listener has been closed.
  2108. </exception>
  2109. </member>
  2110. <member name="P:WebSocketSharp.Net.HttpListener.Realm">
  2111. <summary>
  2112. Gets or sets the name of the realm associated with the listener.
  2113. </summary>
  2114. <remarks>
  2115. If this property is <see langword="null"/> or empty, <c>"SECRET AREA"</c> will be used as
  2116. the name of the realm.
  2117. </remarks>
  2118. <value>
  2119. A <see cref="T:System.String"/> that represents the name of the realm. The default value is
  2120. <see langword="null"/>.
  2121. </value>
  2122. <exception cref="T:System.ObjectDisposedException">
  2123. This listener has been closed.
  2124. </exception>
  2125. </member>
  2126. <member name="P:WebSocketSharp.Net.HttpListener.SslConfiguration">
  2127. <summary>
  2128. Gets or sets the SSL configuration used to authenticate the server and
  2129. optionally the client for secure connection.
  2130. </summary>
  2131. <value>
  2132. A <see cref="T:WebSocketSharp.Net.ServerSslConfiguration"/> that represents the configuration used to
  2133. authenticate the server and optionally the client for secure connection.
  2134. </value>
  2135. <exception cref="T:System.ObjectDisposedException">
  2136. This listener has been closed.
  2137. </exception>
  2138. </member>
  2139. <member name="P:WebSocketSharp.Net.HttpListener.UnsafeConnectionNtlmAuthentication">
  2140. <summary>
  2141. Gets or sets a value indicating whether, when NTLM authentication is used,
  2142. the authentication information of first request is used to authenticate
  2143. additional requests on the same connection.
  2144. </summary>
  2145. <remarks>
  2146. This property isn't currently supported and always throws
  2147. a <see cref="T:System.NotSupportedException"/>.
  2148. </remarks>
  2149. <value>
  2150. <c>true</c> if the authentication information of first request is used;
  2151. otherwise, <c>false</c>.
  2152. </value>
  2153. <exception cref="T:System.NotSupportedException">
  2154. Any use of this property.
  2155. </exception>
  2156. </member>
  2157. <member name="P:WebSocketSharp.Net.HttpListener.UserCredentialsFinder">
  2158. <summary>
  2159. Gets or sets the delegate called to find the credentials for an identity used to
  2160. authenticate a client.
  2161. </summary>
  2162. <value>
  2163. A <c>Func&lt;<see cref="T:System.Security.Principal.IIdentity"/>, <see cref="T:WebSocketSharp.Net.NetworkCredential"/>&gt;</c> delegate
  2164. that references the method used to find the credentials. The default value is
  2165. <see langword="null"/>.
  2166. </value>
  2167. <exception cref="T:System.ObjectDisposedException">
  2168. This listener has been closed.
  2169. </exception>
  2170. </member>
  2171. <member name="M:WebSocketSharp.Net.HttpListener.Abort">
  2172. <summary>
  2173. Shuts down the listener immediately.
  2174. </summary>
  2175. </member>
  2176. <member name="M:WebSocketSharp.Net.HttpListener.BeginGetContext(System.AsyncCallback,System.Object)">
  2177. <summary>
  2178. Begins getting an incoming request asynchronously.
  2179. </summary>
  2180. <remarks>
  2181. This asynchronous operation must be completed by calling the <c>EndGetContext</c> method.
  2182. Typically, the method is invoked by the <paramref name="callback"/> delegate.
  2183. </remarks>
  2184. <returns>
  2185. An <see cref="T:System.IAsyncResult"/> that represents the status of the asynchronous operation.
  2186. </returns>
  2187. <param name="callback">
  2188. An <see cref="T:System.AsyncCallback"/> delegate that references the method to invoke when
  2189. the asynchronous operation completes.
  2190. </param>
  2191. <param name="state">
  2192. An <see cref="T:System.Object"/> that represents a user defined object to pass to
  2193. the <paramref name="callback"/> delegate.
  2194. </param>
  2195. <exception cref="T:System.InvalidOperationException">
  2196. <para>
  2197. This listener has no URI prefix on which listens.
  2198. </para>
  2199. <para>
  2200. -or-
  2201. </para>
  2202. <para>
  2203. This listener hasn't been started, or is currently stopped.
  2204. </para>
  2205. </exception>
  2206. <exception cref="T:System.ObjectDisposedException">
  2207. This listener has been closed.
  2208. </exception>
  2209. </member>
  2210. <member name="M:WebSocketSharp.Net.HttpListener.Close">
  2211. <summary>
  2212. Shuts down the listener.
  2213. </summary>
  2214. </member>
  2215. <member name="M:WebSocketSharp.Net.HttpListener.EndGetContext(System.IAsyncResult)">
  2216. <summary>
  2217. Ends an asynchronous operation to get an incoming request.
  2218. </summary>
  2219. <remarks>
  2220. This method completes an asynchronous operation started by calling
  2221. the <c>BeginGetContext</c> method.
  2222. </remarks>
  2223. <returns>
  2224. A <see cref="T:WebSocketSharp.Net.HttpListenerContext"/> that represents a request.
  2225. </returns>
  2226. <param name="asyncResult">
  2227. An <see cref="T:System.IAsyncResult"/> obtained by calling the <c>BeginGetContext</c> method.
  2228. </param>
  2229. <exception cref="T:System.ArgumentNullException">
  2230. <paramref name="asyncResult"/> is <see langword="null"/>.
  2231. </exception>
  2232. <exception cref="T:System.ArgumentException">
  2233. <paramref name="asyncResult"/> wasn't obtained by calling the <c>BeginGetContext</c> method.
  2234. </exception>
  2235. <exception cref="T:System.InvalidOperationException">
  2236. This method was already called for the specified <paramref name="asyncResult"/>.
  2237. </exception>
  2238. <exception cref="T:System.ObjectDisposedException">
  2239. This listener has been closed.
  2240. </exception>
  2241. </member>
  2242. <member name="M:WebSocketSharp.Net.HttpListener.GetContext">
  2243. <summary>
  2244. Gets an incoming request.
  2245. </summary>
  2246. <remarks>
  2247. This method waits for an incoming request, and returns when a request is received.
  2248. </remarks>
  2249. <returns>
  2250. A <see cref="T:WebSocketSharp.Net.HttpListenerContext"/> that represents a request.
  2251. </returns>
  2252. <exception cref="T:System.InvalidOperationException">
  2253. <para>
  2254. This listener has no URI prefix on which listens.
  2255. </para>
  2256. <para>
  2257. -or-
  2258. </para>
  2259. <para>
  2260. This listener hasn't been started, or is currently stopped.
  2261. </para>
  2262. </exception>
  2263. <exception cref="T:System.ObjectDisposedException">
  2264. This listener has been closed.
  2265. </exception>
  2266. </member>
  2267. <member name="M:WebSocketSharp.Net.HttpListener.Start">
  2268. <summary>
  2269. Starts receiving incoming requests.
  2270. </summary>
  2271. <exception cref="T:System.ObjectDisposedException">
  2272. This listener has been closed.
  2273. </exception>
  2274. </member>
  2275. <member name="M:WebSocketSharp.Net.HttpListener.Stop">
  2276. <summary>
  2277. Stops receiving incoming requests.
  2278. </summary>
  2279. <exception cref="T:System.ObjectDisposedException">
  2280. This listener has been closed.
  2281. </exception>
  2282. </member>
  2283. <member name="M:WebSocketSharp.Net.HttpListener.System#IDisposable#Dispose">
  2284. <summary>
  2285. Releases all resources used by the listener.
  2286. </summary>
  2287. </member>
  2288. <member name="T:WebSocketSharp.Net.HttpListenerContext">
  2289. <summary>
  2290. Provides the access to the HTTP request and response objects used by
  2291. the <see cref="T:WebSocketSharp.Net.HttpListener"/>.
  2292. </summary>
  2293. <remarks>
  2294. This class cannot be inherited.
  2295. </remarks>
  2296. </member>
  2297. <member name="P:WebSocketSharp.Net.HttpListenerContext.Request">
  2298. <summary>
  2299. Gets the HTTP request object that represents a client request.
  2300. </summary>
  2301. <value>
  2302. A <see cref="T:WebSocketSharp.Net.HttpListenerRequest"/> that represents the client request.
  2303. </value>
  2304. </member>
  2305. <member name="P:WebSocketSharp.Net.HttpListenerContext.Response">
  2306. <summary>
  2307. Gets the HTTP response object used to send a response to the client.
  2308. </summary>
  2309. <value>
  2310. A <see cref="T:WebSocketSharp.Net.HttpListenerResponse"/> that represents a response to the client request.
  2311. </value>
  2312. </member>
  2313. <member name="P:WebSocketSharp.Net.HttpListenerContext.User">
  2314. <summary>
  2315. Gets the client information (identity, authentication, and security roles).
  2316. </summary>
  2317. <value>
  2318. A <see cref="T:System.Security.Principal.IPrincipal"/> instance that represents the client information.
  2319. </value>
  2320. </member>
  2321. <member name="M:WebSocketSharp.Net.HttpListenerContext.AcceptWebSocket(System.String)">
  2322. <summary>
  2323. Accepts a WebSocket handshake request.
  2324. </summary>
  2325. <returns>
  2326. A <see cref="T:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext"/> that represents
  2327. the WebSocket handshake request.
  2328. </returns>
  2329. <param name="protocol">
  2330. A <see cref="T:System.String"/> that represents the subprotocol supported on
  2331. this WebSocket connection.
  2332. </param>
  2333. <exception cref="T:System.ArgumentException">
  2334. <para>
  2335. <paramref name="protocol"/> is empty.
  2336. </para>
  2337. <para>
  2338. -or-
  2339. </para>
  2340. <para>
  2341. <paramref name="protocol"/> contains an invalid character.
  2342. </para>
  2343. </exception>
  2344. <exception cref="T:System.InvalidOperationException">
  2345. This method has already been called.
  2346. </exception>
  2347. </member>
  2348. <member name="T:WebSocketSharp.Net.HttpListenerException">
  2349. <summary>
  2350. The exception that is thrown when a <see cref="T:WebSocketSharp.Net.HttpListener"/> gets an error
  2351. processing an HTTP request.
  2352. </summary>
  2353. </member>
  2354. <member name="M:WebSocketSharp.Net.HttpListenerException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  2355. <summary>
  2356. Initializes a new instance of the <see cref="T:WebSocketSharp.Net.HttpListenerException"/> class from
  2357. the specified <see cref="T:System.Runtime.Serialization.SerializationInfo"/> and <see cref="T:System.Runtime.Serialization.StreamingContext"/>.
  2358. </summary>
  2359. <param name="serializationInfo">
  2360. A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that contains the serialized object data.
  2361. </param>
  2362. <param name="streamingContext">
  2363. A <see cref="T:System.Runtime.Serialization.StreamingContext"/> that specifies the source for the deserialization.
  2364. </param>
  2365. </member>
  2366. <member name="M:WebSocketSharp.Net.HttpListenerException.#ctor">
  2367. <summary>
  2368. Initializes a new instance of the <see cref="T:WebSocketSharp.Net.HttpListenerException"/> class.
  2369. </summary>
  2370. </member>
  2371. <member name="M:WebSocketSharp.Net.HttpListenerException.#ctor(System.Int32)">
  2372. <summary>
  2373. Initializes a new instance of the <see cref="T:WebSocketSharp.Net.HttpListenerException"/> class
  2374. with the specified <paramref name="errorCode"/>.
  2375. </summary>
  2376. <param name="errorCode">
  2377. An <see cref="T:System.Int32"/> that identifies the error.
  2378. </param>
  2379. </member>
  2380. <member name="M:WebSocketSharp.Net.HttpListenerException.#ctor(System.Int32,System.String)">
  2381. <summary>
  2382. Initializes a new instance of the <see cref="T:WebSocketSharp.Net.HttpListenerException"/> class
  2383. with the specified <paramref name="errorCode"/> and <paramref name="message"/>.
  2384. </summary>
  2385. <param name="errorCode">
  2386. An <see cref="T:System.Int32"/> that identifies the error.
  2387. </param>
  2388. <param name="message">
  2389. A <see cref="T:System.String"/> that describes the error.
  2390. </param>
  2391. </member>
  2392. <member name="P:WebSocketSharp.Net.HttpListenerException.ErrorCode">
  2393. <summary>
  2394. Gets the error code that identifies the error that occurred.
  2395. </summary>
  2396. <value>
  2397. An <see cref="T:System.Int32"/> that identifies the error.
  2398. </value>
  2399. </member>
  2400. <member name="M:WebSocketSharp.Net.HttpListenerPrefix.#ctor(System.String)">
  2401. <summary>
  2402. Initializes a new instance of the <see cref="T:WebSocketSharp.Net.HttpListenerPrefix"/> class with
  2403. the specified <paramref name="uriPrefix"/>.
  2404. </summary>
  2405. <remarks>
  2406. This constructor must be called after calling the CheckPrefix method.
  2407. </remarks>
  2408. <param name="uriPrefix">
  2409. A <see cref="T:System.String"/> that represents the URI prefix.
  2410. </param>
  2411. </member>
  2412. <member name="M:WebSocketSharp.Net.HttpListenerPrefix.Equals(System.Object)">
  2413. <summary>
  2414. Determines whether this instance and the specified <see cref="T:System.Object"/> have the same value.
  2415. </summary>
  2416. <remarks>
  2417. This method will be required to detect duplicates in any collection.
  2418. </remarks>
  2419. <param name="obj">
  2420. An <see cref="T:System.Object"/> to compare to this instance.
  2421. </param>
  2422. <returns>
  2423. <c>true</c> if <paramref name="obj"/> is a <see cref="T:WebSocketSharp.Net.HttpListenerPrefix"/> and
  2424. its value is the same as this instance; otherwise, <c>false</c>.
  2425. </returns>
  2426. </member>
  2427. <member name="M:WebSocketSharp.Net.HttpListenerPrefix.GetHashCode">
  2428. <summary>
  2429. Gets the hash code for this instance.
  2430. </summary>
  2431. <remarks>
  2432. This method will be required to detect duplicates in any collection.
  2433. </remarks>
  2434. <returns>
  2435. An <see cref="T:System.Int32"/> that represents the hash code.
  2436. </returns>
  2437. </member>
  2438. <member name="T:WebSocketSharp.Net.HttpListenerPrefixCollection">
  2439. <summary>
  2440. Provides the collection used to store the URI prefixes for the <see cref="T:WebSocketSharp.Net.HttpListener"/>.
  2441. </summary>
  2442. <remarks>
  2443. The <see cref="T:WebSocketSharp.Net.HttpListener"/> responds to the request which has a requested URI that
  2444. the prefixes most closely match.
  2445. </remarks>
  2446. </member>
  2447. <member name="P:WebSocketSharp.Net.HttpListenerPrefixCollection.Count">
  2448. <summary>
  2449. Gets the number of prefixes in the collection.
  2450. </summary>
  2451. <value>
  2452. An <see cref="T:System.Int32"/> that represents the number of prefixes.
  2453. </value>
  2454. </member>
  2455. <member name="P:WebSocketSharp.Net.HttpListenerPrefixCollection.IsReadOnly">
  2456. <summary>
  2457. Gets a value indicating whether the access to the collection is read-only.
  2458. </summary>
  2459. <value>
  2460. Always returns <c>false</c>.
  2461. </value>
  2462. </member>
  2463. <member name="P:WebSocketSharp.Net.HttpListenerPrefixCollection.IsSynchronized">
  2464. <summary>
  2465. Gets a value indicating whether the access to the collection is synchronized.
  2466. </summary>
  2467. <value>
  2468. Always returns <c>false</c>.
  2469. </value>
  2470. </member>
  2471. <member name="M:WebSocketSharp.Net.HttpListenerPrefixCollection.Add(System.String)">
  2472. <summary>
  2473. Adds the specified <paramref name="uriPrefix"/> to the collection.
  2474. </summary>
  2475. <param name="uriPrefix">
  2476. A <see cref="T:System.String"/> that represents the URI prefix to add. The prefix must be
  2477. a well-formed URI prefix with http or https scheme, and must end with a <c>'/'</c>.
  2478. </param>
  2479. <exception cref="T:System.ArgumentNullException">
  2480. <paramref name="uriPrefix"/> is <see langword="null"/>.
  2481. </exception>
  2482. <exception cref="T:System.ArgumentException">
  2483. <paramref name="uriPrefix"/> is invalid.
  2484. </exception>
  2485. <exception cref="T:System.ObjectDisposedException">
  2486. The <see cref="T:WebSocketSharp.Net.HttpListener"/> associated with this collection is closed.
  2487. </exception>
  2488. </member>
  2489. <member name="M:WebSocketSharp.Net.HttpListenerPrefixCollection.Clear">
  2490. <summary>
  2491. Removes all URI prefixes from the collection.
  2492. </summary>
  2493. <exception cref="T:System.ObjectDisposedException">
  2494. The <see cref="T:WebSocketSharp.Net.HttpListener"/> associated with this collection is closed.
  2495. </exception>
  2496. </member>
  2497. <member name="M:WebSocketSharp.Net.HttpListenerPrefixCollection.Contains(System.String)">
  2498. <summary>
  2499. Returns a value indicating whether the collection contains the specified
  2500. <paramref name="uriPrefix"/>.
  2501. </summary>
  2502. <returns>
  2503. <c>true</c> if the collection contains <paramref name="uriPrefix"/>;
  2504. otherwise, <c>false</c>.
  2505. </returns>
  2506. <param name="uriPrefix">
  2507. A <see cref="T:System.String"/> that represents the URI prefix to test.
  2508. </param>
  2509. <exception cref="T:System.ArgumentNullException">
  2510. <paramref name="uriPrefix"/> is <see langword="null"/>.
  2511. </exception>
  2512. <exception cref="T:System.ObjectDisposedException">
  2513. The <see cref="T:WebSocketSharp.Net.HttpListener"/> associated with this collection is closed.
  2514. </exception>
  2515. </member>
  2516. <member name="M:WebSocketSharp.Net.HttpListenerPrefixCollection.CopyTo(System.Array,System.Int32)">
  2517. <summary>
  2518. Copies the contents of the collection to the specified <see cref="T:System.Array"/>.
  2519. </summary>
  2520. <param name="array">
  2521. An <see cref="T:System.Array"/> that receives the URI prefix strings in the collection.
  2522. </param>
  2523. <param name="offset">
  2524. An <see cref="T:System.Int32"/> that represents the zero-based index in <paramref name="array"/>
  2525. at which copying begins.
  2526. </param>
  2527. <exception cref="T:System.ObjectDisposedException">
  2528. The <see cref="T:WebSocketSharp.Net.HttpListener"/> associated with this collection is closed.
  2529. </exception>
  2530. </member>
  2531. <member name="M:WebSocketSharp.Net.HttpListenerPrefixCollection.CopyTo(System.String[],System.Int32)">
  2532. <summary>
  2533. Copies the contents of the collection to the specified array of <see cref="T:System.String"/>.
  2534. </summary>
  2535. <param name="array">
  2536. An array of <see cref="T:System.String"/> that receives the URI prefix strings in the collection.
  2537. </param>
  2538. <param name="offset">
  2539. An <see cref="T:System.Int32"/> that represents the zero-based index in <paramref name="array"/>
  2540. at which copying begins.
  2541. </param>
  2542. <exception cref="T:System.ObjectDisposedException">
  2543. The <see cref="T:WebSocketSharp.Net.HttpListener"/> associated with this collection is closed.
  2544. </exception>
  2545. </member>
  2546. <member name="M:WebSocketSharp.Net.HttpListenerPrefixCollection.GetEnumerator">
  2547. <summary>
  2548. Gets the enumerator used to iterate through the <see cref="T:WebSocketSharp.Net.HttpListenerPrefixCollection"/>.
  2549. </summary>
  2550. <returns>
  2551. An <see cref="T:System.Collections.Generic.IEnumerator{string}"/> instance used to iterate
  2552. through the collection.
  2553. </returns>
  2554. </member>
  2555. <member name="M:WebSocketSharp.Net.HttpListenerPrefixCollection.Remove(System.String)">
  2556. <summary>
  2557. Removes the specified <paramref name="uriPrefix"/> from the collection.
  2558. </summary>
  2559. <returns>
  2560. <c>true</c> if <paramref name="uriPrefix"/> is successfully found and removed;
  2561. otherwise, <c>false</c>.
  2562. </returns>
  2563. <param name="uriPrefix">
  2564. A <see cref="T:System.String"/> that represents the URI prefix to remove.
  2565. </param>
  2566. <exception cref="T:System.ArgumentNullException">
  2567. <paramref name="uriPrefix"/> is <see langword="null"/>.
  2568. </exception>
  2569. <exception cref="T:System.ObjectDisposedException">
  2570. The <see cref="T:WebSocketSharp.Net.HttpListener"/> associated with this collection is closed.
  2571. </exception>
  2572. </member>
  2573. <member name="M:WebSocketSharp.Net.HttpListenerPrefixCollection.System#Collections#IEnumerable#GetEnumerator">
  2574. <summary>
  2575. Gets the enumerator used to iterate through the <see cref="T:WebSocketSharp.Net.HttpListenerPrefixCollection"/>.
  2576. </summary>
  2577. <returns>
  2578. An <see cref="T:System.Collections.IEnumerator"/> instance used to iterate through the collection.
  2579. </returns>
  2580. </member>
  2581. <member name="T:WebSocketSharp.Net.HttpListenerRequest">
  2582. <summary>
  2583. Provides the access to a request to the <see cref="T:WebSocketSharp.Net.HttpListener"/>.
  2584. </summary>
  2585. <remarks>
  2586. The HttpListenerRequest class cannot be inherited.
  2587. </remarks>
  2588. </member>
  2589. <member name="P:WebSocketSharp.Net.HttpListenerRequest.AcceptTypes">
  2590. <summary>
  2591. Gets the media types which are acceptable for the response.
  2592. </summary>
  2593. <value>
  2594. An array of <see cref="T:System.String"/> that contains the media type names in
  2595. the Accept request-header, or <see langword="null"/> if the request didn't include
  2596. the Accept header.
  2597. </value>
  2598. </member>
  2599. <member name="P:WebSocketSharp.Net.HttpListenerRequest.ClientCertificateError">
  2600. <summary>
  2601. Gets an error code that identifies a problem with the client's certificate.
  2602. </summary>
  2603. <value>
  2604. Always returns <c>0</c>.
  2605. </value>
  2606. </member>
  2607. <member name="P:WebSocketSharp.Net.HttpListenerRequest.ContentEncoding">
  2608. <summary>
  2609. Gets the encoding for the entity body data included in the request.
  2610. </summary>
  2611. <value>
  2612. A <see cref="T:System.Text.Encoding"/> that represents the encoding for the entity body data,
  2613. or <see cref="P:System.Text.Encoding.Default"/> if the request didn't include the information about
  2614. the encoding.
  2615. </value>
  2616. </member>
  2617. <member name="P:WebSocketSharp.Net.HttpListenerRequest.ContentLength64">
  2618. <summary>
  2619. Gets the number of bytes in the entity body data included in the request.
  2620. </summary>
  2621. <value>
  2622. A <see cref="T:System.Int64"/> that represents the value of the Content-Length entity-header,
  2623. or <c>-1</c> if the value isn't known.
  2624. </value>
  2625. </member>
  2626. <member name="P:WebSocketSharp.Net.HttpListenerRequest.ContentType">
  2627. <summary>
  2628. Gets the media type of the entity body included in the request.
  2629. </summary>
  2630. <value>
  2631. A <see cref="T:System.String"/> that represents the value of the Content-Type entity-header.
  2632. </value>
  2633. </member>
  2634. <member name="P:WebSocketSharp.Net.HttpListenerRequest.Cookies">
  2635. <summary>
  2636. Gets the cookies included in the request.
  2637. </summary>
  2638. <value>
  2639. A <see cref="T:WebSocketSharp.Net.CookieCollection"/> that contains the cookies included in the request.
  2640. </value>
  2641. </member>
  2642. <member name="P:WebSocketSharp.Net.HttpListenerRequest.HasEntityBody">
  2643. <summary>
  2644. Gets a value indicating whether the request has the entity body.
  2645. </summary>
  2646. <value>
  2647. <c>true</c> if the request has the entity body; otherwise, <c>false</c>.
  2648. </value>
  2649. </member>
  2650. <member name="P:WebSocketSharp.Net.HttpListenerRequest.Headers">
  2651. <summary>
  2652. Gets the HTTP headers used in the request.
  2653. </summary>
  2654. <value>
  2655. A <see cref="T:System.Collections.Specialized.NameValueCollection"/> that contains the HTTP headers used in the request.
  2656. </value>
  2657. </member>
  2658. <member name="P:WebSocketSharp.Net.HttpListenerRequest.HttpMethod">
  2659. <summary>
  2660. Gets the HTTP method used in the request.
  2661. </summary>
  2662. <value>
  2663. A <see cref="T:System.String"/> that represents the HTTP method used in the request.
  2664. </value>
  2665. </member>
  2666. <member name="P:WebSocketSharp.Net.HttpListenerRequest.InputStream">
  2667. <summary>
  2668. Gets a <see cref="T:System.IO.Stream"/> that contains the entity body data included in the request.
  2669. </summary>
  2670. <value>
  2671. A <see cref="T:System.IO.Stream"/> that contains the entity body data included in the request.
  2672. </value>
  2673. </member>
  2674. <member name="P:WebSocketSharp.Net.HttpListenerRequest.IsAuthenticated">
  2675. <summary>
  2676. Gets a value indicating whether the client that sent the request is authenticated.
  2677. </summary>
  2678. <value>
  2679. <c>true</c> if the client is authenticated; otherwise, <c>false</c>.
  2680. </value>
  2681. </member>
  2682. <member name="P:WebSocketSharp.Net.HttpListenerRequest.IsLocal">
  2683. <summary>
  2684. Gets a value indicating whether the request is sent from the local computer.
  2685. </summary>
  2686. <value>
  2687. <c>true</c> if the request is sent from the local computer; otherwise, <c>false</c>.
  2688. </value>
  2689. </member>
  2690. <member name="P:WebSocketSharp.Net.HttpListenerRequest.IsSecureConnection">
  2691. <summary>
  2692. Gets a value indicating whether the HTTP connection is secured using the SSL protocol.
  2693. </summary>
  2694. <value>
  2695. <c>true</c> if the HTTP connection is secured; otherwise, <c>false</c>.
  2696. </value>
  2697. </member>
  2698. <member name="P:WebSocketSharp.Net.HttpListenerRequest.IsWebSocketRequest">
  2699. <summary>
  2700. Gets a value indicating whether the request is a WebSocket connection request.
  2701. </summary>
  2702. <value>
  2703. <c>true</c> if the request is a WebSocket connection request; otherwise, <c>false</c>.
  2704. </value>
  2705. </member>
  2706. <member name="P:WebSocketSharp.Net.HttpListenerRequest.KeepAlive">
  2707. <summary>
  2708. Gets a value indicating whether the client requests a persistent connection.
  2709. </summary>
  2710. <value>
  2711. <c>true</c> if the client requests a persistent connection; otherwise, <c>false</c>.
  2712. </value>
  2713. </member>
  2714. <member name="P:WebSocketSharp.Net.HttpListenerRequest.LocalEndPoint">
  2715. <summary>
  2716. Gets the server endpoint as an IP address and a port number.
  2717. </summary>
  2718. <value>
  2719. A <see cref="T:System.Net.IPEndPoint"/> that represents the server endpoint.
  2720. </value>
  2721. </member>
  2722. <member name="P:WebSocketSharp.Net.HttpListenerRequest.ProtocolVersion">
  2723. <summary>
  2724. Gets the HTTP version used in the request.
  2725. </summary>
  2726. <value>
  2727. A <see cref="T:System.Version"/> that represents the HTTP version used in the request.
  2728. </value>
  2729. </member>
  2730. <member name="P:WebSocketSharp.Net.HttpListenerRequest.QueryString">
  2731. <summary>
  2732. Gets the query string included in the request.
  2733. </summary>
  2734. <value>
  2735. A <see cref="T:System.Collections.Specialized.NameValueCollection"/> that contains the query string parameters.
  2736. </value>
  2737. </member>
  2738. <member name="P:WebSocketSharp.Net.HttpListenerRequest.RawUrl">
  2739. <summary>
  2740. Gets the raw URL (without the scheme, host, and port) requested by the client.
  2741. </summary>
  2742. <value>
  2743. A <see cref="T:System.String"/> that represents the raw URL requested by the client.
  2744. </value>
  2745. </member>
  2746. <member name="P:WebSocketSharp.Net.HttpListenerRequest.RemoteEndPoint">
  2747. <summary>
  2748. Gets the client endpoint as an IP address and a port number.
  2749. </summary>
  2750. <value>
  2751. A <see cref="T:System.Net.IPEndPoint"/> that represents the client endpoint.
  2752. </value>
  2753. </member>
  2754. <member name="P:WebSocketSharp.Net.HttpListenerRequest.RequestTraceIdentifier">
  2755. <summary>
  2756. Gets the request identifier of a incoming HTTP request.
  2757. </summary>
  2758. <value>
  2759. A <see cref="T:System.Guid"/> that represents the identifier of a request.
  2760. </value>
  2761. </member>
  2762. <member name="P:WebSocketSharp.Net.HttpListenerRequest.Url">
  2763. <summary>
  2764. Gets the URL requested by the client.
  2765. </summary>
  2766. <value>
  2767. A <see cref="T:System.Uri"/> that represents the URL requested by the client.
  2768. </value>
  2769. </member>
  2770. <member name="P:WebSocketSharp.Net.HttpListenerRequest.UrlReferrer">
  2771. <summary>
  2772. Gets the URL of the resource from which the requested URL was obtained.
  2773. </summary>
  2774. <value>
  2775. A <see cref="T:System.Uri"/> that represents the value of the Referer request-header,
  2776. or <see langword="null"/> if the request didn't include an Referer header.
  2777. </value>
  2778. </member>
  2779. <member name="P:WebSocketSharp.Net.HttpListenerRequest.UserAgent">
  2780. <summary>
  2781. Gets the information about the user agent originating the request.
  2782. </summary>
  2783. <value>
  2784. A <see cref="T:System.String"/> that represents the value of the User-Agent request-header.
  2785. </value>
  2786. </member>
  2787. <member name="P:WebSocketSharp.Net.HttpListenerRequest.UserHostAddress">
  2788. <summary>
  2789. Gets the server endpoint as an IP address and a port number.
  2790. </summary>
  2791. <value>
  2792. A <see cref="T:System.String"/> that represents the server endpoint.
  2793. </value>
  2794. </member>
  2795. <member name="P:WebSocketSharp.Net.HttpListenerRequest.UserHostName">
  2796. <summary>
  2797. Gets the internet host name and port number (if present) specified by the client.
  2798. </summary>
  2799. <value>
  2800. A <see cref="T:System.String"/> that represents the value of the Host request-header.
  2801. </value>
  2802. </member>
  2803. <member name="P:WebSocketSharp.Net.HttpListenerRequest.UserLanguages">
  2804. <summary>
  2805. Gets the natural languages which are preferred for the response.
  2806. </summary>
  2807. <value>
  2808. An array of <see cref="T:System.String"/> that contains the natural language names in
  2809. the Accept-Language request-header, or <see langword="null"/> if the request
  2810. didn't include an Accept-Language header.
  2811. </value>
  2812. </member>
  2813. <member name="M:WebSocketSharp.Net.HttpListenerRequest.BeginGetClientCertificate(System.AsyncCallback,System.Object)">
  2814. <summary>
  2815. Begins getting the client's X.509 v.3 certificate asynchronously.
  2816. </summary>
  2817. <remarks>
  2818. This asynchronous operation must be completed by calling
  2819. the <see cref="M:WebSocketSharp.Net.HttpListenerRequest.EndGetClientCertificate(System.IAsyncResult)"/> method. Typically,
  2820. that method is invoked by the <paramref name="requestCallback"/> delegate.
  2821. </remarks>
  2822. <returns>
  2823. An <see cref="T:System.IAsyncResult"/> that contains the status of the asynchronous operation.
  2824. </returns>
  2825. <param name="requestCallback">
  2826. An <see cref="T:System.AsyncCallback"/> delegate that references the method(s) called when
  2827. the asynchronous operation completes.
  2828. </param>
  2829. <param name="state">
  2830. An <see cref="T:System.Object"/> that contains a user defined object to pass to
  2831. the <paramref name="requestCallback"/> delegate.
  2832. </param>
  2833. <exception cref="T:System.NotImplementedException">
  2834. This method isn't implemented.
  2835. </exception>
  2836. </member>
  2837. <member name="M:WebSocketSharp.Net.HttpListenerRequest.EndGetClientCertificate(System.IAsyncResult)">
  2838. <summary>
  2839. Ends an asynchronous operation to get the client's X.509 v.3 certificate.
  2840. </summary>
  2841. <remarks>
  2842. This method completes an asynchronous operation started by calling
  2843. the <see cref="M:WebSocketSharp.Net.HttpListenerRequest.BeginGetClientCertificate(System.AsyncCallback,System.Object)"/> method.
  2844. </remarks>
  2845. <returns>
  2846. A <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2"/> that contains the client's X.509 v.3 certificate.
  2847. </returns>
  2848. <param name="asyncResult">
  2849. An <see cref="T:System.IAsyncResult"/> obtained by calling
  2850. the <see cref="M:WebSocketSharp.Net.HttpListenerRequest.BeginGetClientCertificate(System.AsyncCallback,System.Object)"/> method.
  2851. </param>
  2852. <exception cref="T:System.NotImplementedException">
  2853. This method isn't implemented.
  2854. </exception>
  2855. </member>
  2856. <member name="M:WebSocketSharp.Net.HttpListenerRequest.GetClientCertificate">
  2857. <summary>
  2858. Gets the client's X.509 v.3 certificate.
  2859. </summary>
  2860. <returns>
  2861. A <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2"/> that contains the client's X.509 v.3 certificate.
  2862. </returns>
  2863. <exception cref="T:System.NotImplementedException">
  2864. This method isn't implemented.
  2865. </exception>
  2866. </member>
  2867. <member name="M:WebSocketSharp.Net.HttpListenerRequest.ToString">
  2868. <summary>
  2869. Returns a <see cref="T:System.String"/> that represents
  2870. the current <see cref="T:WebSocketSharp.Net.HttpListenerRequest"/>.
  2871. </summary>
  2872. <returns>
  2873. A <see cref="T:System.String"/> that represents the current <see cref="T:WebSocketSharp.Net.HttpListenerRequest"/>.
  2874. </returns>
  2875. </member>
  2876. <member name="T:WebSocketSharp.Net.HttpListenerResponse">
  2877. <summary>
  2878. Provides the access to a response to a request received by the <see cref="T:WebSocketSharp.Net.HttpListener"/>.
  2879. </summary>
  2880. <remarks>
  2881. The HttpListenerResponse class cannot be inherited.
  2882. </remarks>
  2883. </member>
  2884. <member name="P:WebSocketSharp.Net.HttpListenerResponse.ContentEncoding">
  2885. <summary>
  2886. Gets or sets the encoding for the entity body data included in the response.
  2887. </summary>
  2888. <value>
  2889. A <see cref="T:System.Text.Encoding"/> that represents the encoding for the entity body data,
  2890. or <see langword="null"/> if no encoding is specified.
  2891. </value>
  2892. <exception cref="T:System.ObjectDisposedException">
  2893. This object is closed.
  2894. </exception>
  2895. </member>
  2896. <member name="P:WebSocketSharp.Net.HttpListenerResponse.ContentLength64">
  2897. <summary>
  2898. Gets or sets the number of bytes in the entity body data included in the response.
  2899. </summary>
  2900. <value>
  2901. A <see cref="T:System.Int64"/> that represents the value of the Content-Length entity-header.
  2902. </value>
  2903. <exception cref="T:System.ArgumentOutOfRangeException">
  2904. The value specified for a set operation is less than zero.
  2905. </exception>
  2906. <exception cref="T:System.InvalidOperationException">
  2907. The response has already been sent.
  2908. </exception>
  2909. <exception cref="T:System.ObjectDisposedException">
  2910. This object is closed.
  2911. </exception>
  2912. </member>
  2913. <member name="P:WebSocketSharp.Net.HttpListenerResponse.ContentType">
  2914. <summary>
  2915. Gets or sets the media type of the entity body included in the response.
  2916. </summary>
  2917. <value>
  2918. A <see cref="T:System.String"/> that represents the media type of the entity body,
  2919. or <see langword="null"/> if no media type is specified. This value is
  2920. used for the value of the Content-Type entity-header.
  2921. </value>
  2922. <exception cref="T:System.ArgumentException">
  2923. The value specified for a set operation is empty.
  2924. </exception>
  2925. <exception cref="T:System.ObjectDisposedException">
  2926. This object is closed.
  2927. </exception>
  2928. </member>
  2929. <member name="P:WebSocketSharp.Net.HttpListenerResponse.Cookies">
  2930. <summary>
  2931. Gets or sets the cookies sent with the response.
  2932. </summary>
  2933. <value>
  2934. A <see cref="T:WebSocketSharp.Net.CookieCollection"/> that contains the cookies sent with the response.
  2935. </value>
  2936. </member>
  2937. <member name="P:WebSocketSharp.Net.HttpListenerResponse.Headers">
  2938. <summary>
  2939. Gets or sets the HTTP headers sent to the client.
  2940. </summary>
  2941. <value>
  2942. A <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/> that contains the headers sent to the client.
  2943. </value>
  2944. <exception cref="T:System.InvalidOperationException">
  2945. The value specified for a set operation isn't valid for a response.
  2946. </exception>
  2947. </member>
  2948. <member name="P:WebSocketSharp.Net.HttpListenerResponse.KeepAlive">
  2949. <summary>
  2950. Gets or sets a value indicating whether the server requests a persistent connection.
  2951. </summary>
  2952. <value>
  2953. <c>true</c> if the server requests a persistent connection; otherwise, <c>false</c>.
  2954. The default value is <c>true</c>.
  2955. </value>
  2956. <exception cref="T:System.InvalidOperationException">
  2957. The response has already been sent.
  2958. </exception>
  2959. <exception cref="T:System.ObjectDisposedException">
  2960. This object is closed.
  2961. </exception>
  2962. </member>
  2963. <member name="P:WebSocketSharp.Net.HttpListenerResponse.OutputStream">
  2964. <summary>
  2965. Gets a <see cref="T:System.IO.Stream"/> to use to write the entity body data.
  2966. </summary>
  2967. <value>
  2968. A <see cref="T:System.IO.Stream"/> to use to write the entity body data.
  2969. </value>
  2970. <exception cref="T:System.ObjectDisposedException">
  2971. This object is closed.
  2972. </exception>
  2973. </member>
  2974. <member name="P:WebSocketSharp.Net.HttpListenerResponse.ProtocolVersion">
  2975. <summary>
  2976. Gets or sets the HTTP version used in the response.
  2977. </summary>
  2978. <value>
  2979. A <see cref="T:System.Version"/> that represents the version used in the response.
  2980. </value>
  2981. <exception cref="T:System.ArgumentNullException">
  2982. The value specified for a set operation is <see langword="null"/>.
  2983. </exception>
  2984. <exception cref="T:System.ArgumentException">
  2985. The value specified for a set operation doesn't have its <c>Major</c> property set to 1 or
  2986. doesn't have its <c>Minor</c> property set to either 0 or 1.
  2987. </exception>
  2988. <exception cref="T:System.InvalidOperationException">
  2989. The response has already been sent.
  2990. </exception>
  2991. <exception cref="T:System.ObjectDisposedException">
  2992. This object is closed.
  2993. </exception>
  2994. </member>
  2995. <member name="P:WebSocketSharp.Net.HttpListenerResponse.RedirectLocation">
  2996. <summary>
  2997. Gets or sets the URL to which the client is redirected to locate a requested resource.
  2998. </summary>
  2999. <value>
  3000. A <see cref="T:System.String"/> that represents the value of the Location response-header,
  3001. or <see langword="null"/> if no redirect location is specified.
  3002. </value>
  3003. <exception cref="T:System.ArgumentException">
  3004. The value specified for a set operation isn't an absolute URL.
  3005. </exception>
  3006. <exception cref="T:System.ObjectDisposedException">
  3007. This object is closed.
  3008. </exception>
  3009. </member>
  3010. <member name="P:WebSocketSharp.Net.HttpListenerResponse.SendChunked">
  3011. <summary>
  3012. Gets or sets a value indicating whether the response uses the chunked transfer encoding.
  3013. </summary>
  3014. <value>
  3015. <c>true</c> if the response uses the chunked transfer encoding;
  3016. otherwise, <c>false</c>. The default value is <c>false</c>.
  3017. </value>
  3018. <exception cref="T:System.InvalidOperationException">
  3019. The response has already been sent.
  3020. </exception>
  3021. <exception cref="T:System.ObjectDisposedException">
  3022. This object is closed.
  3023. </exception>
  3024. </member>
  3025. <member name="P:WebSocketSharp.Net.HttpListenerResponse.StatusCode">
  3026. <summary>
  3027. Gets or sets the HTTP status code returned to the client.
  3028. </summary>
  3029. <value>
  3030. An <see cref="T:System.Int32"/> that represents the status code for the response to
  3031. the request. The default value is same as <see cref="F:WebSocketSharp.Net.HttpStatusCode.OK"/>.
  3032. </value>
  3033. <exception cref="T:System.InvalidOperationException">
  3034. The response has already been sent.
  3035. </exception>
  3036. <exception cref="T:System.ObjectDisposedException">
  3037. This object is closed.
  3038. </exception>
  3039. <exception cref="T:System.Net.ProtocolViolationException">
  3040. The value specified for a set operation is invalid. Valid values are
  3041. between 100 and 999 inclusive.
  3042. </exception>
  3043. </member>
  3044. <member name="P:WebSocketSharp.Net.HttpListenerResponse.StatusDescription">
  3045. <summary>
  3046. Gets or sets the description of the HTTP status code returned to the client.
  3047. </summary>
  3048. <value>
  3049. A <see cref="T:System.String"/> that represents the description of the status code. The default
  3050. value is the <see href="http://tools.ietf.org/html/rfc2616#section-10">RFC 2616</see>
  3051. description for the <see cref="P:WebSocketSharp.Net.HttpListenerResponse.StatusCode"/> property value,
  3052. or <see cref="F:System.String.Empty"/> if an RFC 2616 description doesn't exist.
  3053. </value>
  3054. <exception cref="T:System.ArgumentException">
  3055. The value specified for a set operation contains invalid characters.
  3056. </exception>
  3057. <exception cref="T:System.InvalidOperationException">
  3058. The response has already been sent.
  3059. </exception>
  3060. <exception cref="T:System.ObjectDisposedException">
  3061. This object is closed.
  3062. </exception>
  3063. </member>
  3064. <member name="M:WebSocketSharp.Net.HttpListenerResponse.Abort">
  3065. <summary>
  3066. Closes the connection to the client without returning a response.
  3067. </summary>
  3068. </member>
  3069. <member name="M:WebSocketSharp.Net.HttpListenerResponse.AddHeader(System.String,System.String)">
  3070. <summary>
  3071. Adds an HTTP header with the specified <paramref name="name"/> and
  3072. <paramref name="value"/> to the headers for the response.
  3073. </summary>
  3074. <param name="name">
  3075. A <see cref="T:System.String"/> that represents the name of the header to add.
  3076. </param>
  3077. <param name="value">
  3078. A <see cref="T:System.String"/> that represents the value of the header to add.
  3079. </param>
  3080. <exception cref="T:System.ArgumentNullException">
  3081. <paramref name="name"/> is <see langword="null"/> or empty.
  3082. </exception>
  3083. <exception cref="T:System.ArgumentException">
  3084. <para>
  3085. <paramref name="name"/> or <paramref name="value"/> contains invalid characters.
  3086. </para>
  3087. <para>
  3088. -or-
  3089. </para>
  3090. <para>
  3091. <paramref name="name"/> is a restricted header name.
  3092. </para>
  3093. </exception>
  3094. <exception cref="T:System.ArgumentOutOfRangeException">
  3095. The length of <paramref name="value"/> is greater than 65,535 characters.
  3096. </exception>
  3097. <exception cref="T:System.InvalidOperationException">
  3098. The header cannot be allowed to add to the current headers.
  3099. </exception>
  3100. </member>
  3101. <member name="M:WebSocketSharp.Net.HttpListenerResponse.AppendCookie(WebSocketSharp.Net.Cookie)">
  3102. <summary>
  3103. Appends the specified <paramref name="cookie"/> to the cookies sent with the response.
  3104. </summary>
  3105. <param name="cookie">
  3106. A <see cref="T:WebSocketSharp.Net.Cookie"/> to append.
  3107. </param>
  3108. <exception cref="T:System.ArgumentNullException">
  3109. <paramref name="cookie"/> is <see langword="null"/>.
  3110. </exception>
  3111. </member>
  3112. <member name="M:WebSocketSharp.Net.HttpListenerResponse.AppendHeader(System.String,System.String)">
  3113. <summary>
  3114. Appends a <paramref name="value"/> to the specified HTTP header sent with the response.
  3115. </summary>
  3116. <param name="name">
  3117. A <see cref="T:System.String"/> that represents the name of the header to append
  3118. <paramref name="value"/> to.
  3119. </param>
  3120. <param name="value">
  3121. A <see cref="T:System.String"/> that represents the value to append to the header.
  3122. </param>
  3123. <exception cref="T:System.ArgumentNullException">
  3124. <paramref name="name"/> is <see langword="null"/> or empty.
  3125. </exception>
  3126. <exception cref="T:System.ArgumentException">
  3127. <para>
  3128. <paramref name="name"/> or <paramref name="value"/> contains invalid characters.
  3129. </para>
  3130. <para>
  3131. -or-
  3132. </para>
  3133. <para>
  3134. <paramref name="name"/> is a restricted header name.
  3135. </para>
  3136. </exception>
  3137. <exception cref="T:System.ArgumentOutOfRangeException">
  3138. The length of <paramref name="value"/> is greater than 65,535 characters.
  3139. </exception>
  3140. <exception cref="T:System.InvalidOperationException">
  3141. The current headers cannot allow the header to append a value.
  3142. </exception>
  3143. </member>
  3144. <member name="M:WebSocketSharp.Net.HttpListenerResponse.Close">
  3145. <summary>
  3146. Returns the response to the client and releases the resources used by
  3147. this <see cref="T:WebSocketSharp.Net.HttpListenerResponse"/> instance.
  3148. </summary>
  3149. </member>
  3150. <member name="M:WebSocketSharp.Net.HttpListenerResponse.Close(System.Byte[],System.Boolean)">
  3151. <summary>
  3152. Returns the response with the specified array of <see cref="T:System.Byte"/> to the client and
  3153. releases the resources used by this <see cref="T:WebSocketSharp.Net.HttpListenerResponse"/> instance.
  3154. </summary>
  3155. <param name="responseEntity">
  3156. An array of <see cref="T:System.Byte"/> that contains the response entity body data.
  3157. </param>
  3158. <param name="willBlock">
  3159. <c>true</c> if this method blocks execution while flushing the stream to the client;
  3160. otherwise, <c>false</c>.
  3161. </param>
  3162. <exception cref="T:System.ArgumentNullException">
  3163. <paramref name="responseEntity"/> is <see langword="null"/>.
  3164. </exception>
  3165. <exception cref="T:System.ObjectDisposedException">
  3166. This object is closed.
  3167. </exception>
  3168. </member>
  3169. <member name="M:WebSocketSharp.Net.HttpListenerResponse.CopyFrom(WebSocketSharp.Net.HttpListenerResponse)">
  3170. <summary>
  3171. Copies some properties from the specified <see cref="T:WebSocketSharp.Net.HttpListenerResponse"/> to
  3172. this response.
  3173. </summary>
  3174. <param name="templateResponse">
  3175. A <see cref="T:WebSocketSharp.Net.HttpListenerResponse"/> to copy.
  3176. </param>
  3177. <exception cref="T:System.ArgumentNullException">
  3178. <paramref name="templateResponse"/> is <see langword="null"/>.
  3179. </exception>
  3180. </member>
  3181. <member name="M:WebSocketSharp.Net.HttpListenerResponse.Redirect(System.String)">
  3182. <summary>
  3183. Configures the response to redirect the client's request to
  3184. the specified <paramref name="url"/>.
  3185. </summary>
  3186. <remarks>
  3187. This method sets the <see cref="P:WebSocketSharp.Net.HttpListenerResponse.RedirectLocation"/> property to
  3188. <paramref name="url"/>, the <see cref="P:WebSocketSharp.Net.HttpListenerResponse.StatusCode"/> property to
  3189. <c>302</c>, and the <see cref="P:WebSocketSharp.Net.HttpListenerResponse.StatusDescription"/> property to
  3190. <c>"Found"</c>.
  3191. </remarks>
  3192. <param name="url">
  3193. A <see cref="T:System.String"/> that represents the URL to redirect the client's request to.
  3194. </param>
  3195. <exception cref="T:System.ArgumentNullException">
  3196. <paramref name="url"/> is <see langword="null"/>.
  3197. </exception>
  3198. <exception cref="T:System.ArgumentException">
  3199. <paramref name="url"/> isn't an absolute URL.
  3200. </exception>
  3201. <exception cref="T:System.InvalidOperationException">
  3202. The response has already been sent.
  3203. </exception>
  3204. <exception cref="T:System.ObjectDisposedException">
  3205. This object is closed.
  3206. </exception>
  3207. </member>
  3208. <member name="M:WebSocketSharp.Net.HttpListenerResponse.SetCookie(WebSocketSharp.Net.Cookie)">
  3209. <summary>
  3210. Adds or updates a <paramref name="cookie"/> in the cookies sent with the response.
  3211. </summary>
  3212. <param name="cookie">
  3213. A <see cref="T:WebSocketSharp.Net.Cookie"/> to set.
  3214. </param>
  3215. <exception cref="T:System.ArgumentNullException">
  3216. <paramref name="cookie"/> is <see langword="null"/>.
  3217. </exception>
  3218. <exception cref="T:System.ArgumentException">
  3219. <paramref name="cookie"/> already exists in the cookies and couldn't be replaced.
  3220. </exception>
  3221. </member>
  3222. <member name="M:WebSocketSharp.Net.HttpListenerResponse.System#IDisposable#Dispose">
  3223. <summary>
  3224. Releases all resources used by the <see cref="T:WebSocketSharp.Net.HttpListenerResponse"/>.
  3225. </summary>
  3226. </member>
  3227. <member name="T:WebSocketSharp.Net.HttpRequestHeader">
  3228. <summary>
  3229. Contains the HTTP headers that may be specified in a client request.
  3230. </summary>
  3231. <remarks>
  3232. The HttpRequestHeader enumeration contains the HTTP request headers defined in
  3233. <see href="http://tools.ietf.org/html/rfc2616#section-14">RFC 2616</see> for the HTTP/1.1 and
  3234. <see href="http://tools.ietf.org/html/rfc6455#section-11.3">RFC 6455</see> for the WebSocket.
  3235. </remarks>
  3236. </member>
  3237. <member name="F:WebSocketSharp.Net.HttpRequestHeader.CacheControl">
  3238. <summary>
  3239. Indicates the Cache-Control header.
  3240. </summary>
  3241. </member>
  3242. <member name="F:WebSocketSharp.Net.HttpRequestHeader.Connection">
  3243. <summary>
  3244. Indicates the Connection header.
  3245. </summary>
  3246. </member>
  3247. <member name="F:WebSocketSharp.Net.HttpRequestHeader.Date">
  3248. <summary>
  3249. Indicates the Date header.
  3250. </summary>
  3251. </member>
  3252. <member name="F:WebSocketSharp.Net.HttpRequestHeader.KeepAlive">
  3253. <summary>
  3254. Indicates the Keep-Alive header.
  3255. </summary>
  3256. </member>
  3257. <member name="F:WebSocketSharp.Net.HttpRequestHeader.Pragma">
  3258. <summary>
  3259. Indicates the Pragma header.
  3260. </summary>
  3261. </member>
  3262. <member name="F:WebSocketSharp.Net.HttpRequestHeader.Trailer">
  3263. <summary>
  3264. Indicates the Trailer header.
  3265. </summary>
  3266. </member>
  3267. <member name="F:WebSocketSharp.Net.HttpRequestHeader.TransferEncoding">
  3268. <summary>
  3269. Indicates the Transfer-Encoding header.
  3270. </summary>
  3271. </member>
  3272. <member name="F:WebSocketSharp.Net.HttpRequestHeader.Upgrade">
  3273. <summary>
  3274. Indicates the Upgrade header.
  3275. </summary>
  3276. </member>
  3277. <member name="F:WebSocketSharp.Net.HttpRequestHeader.Via">
  3278. <summary>
  3279. Indicates the Via header.
  3280. </summary>
  3281. </member>
  3282. <member name="F:WebSocketSharp.Net.HttpRequestHeader.Warning">
  3283. <summary>
  3284. Indicates the Warning header.
  3285. </summary>
  3286. </member>
  3287. <member name="F:WebSocketSharp.Net.HttpRequestHeader.Allow">
  3288. <summary>
  3289. Indicates the Allow header.
  3290. </summary>
  3291. </member>
  3292. <member name="F:WebSocketSharp.Net.HttpRequestHeader.ContentLength">
  3293. <summary>
  3294. Indicates the Content-Length header.
  3295. </summary>
  3296. </member>
  3297. <member name="F:WebSocketSharp.Net.HttpRequestHeader.ContentType">
  3298. <summary>
  3299. Indicates the Content-Type header.
  3300. </summary>
  3301. </member>
  3302. <member name="F:WebSocketSharp.Net.HttpRequestHeader.ContentEncoding">
  3303. <summary>
  3304. Indicates the Content-Encoding header.
  3305. </summary>
  3306. </member>
  3307. <member name="F:WebSocketSharp.Net.HttpRequestHeader.ContentLanguage">
  3308. <summary>
  3309. Indicates the Content-Language header.
  3310. </summary>
  3311. </member>
  3312. <member name="F:WebSocketSharp.Net.HttpRequestHeader.ContentLocation">
  3313. <summary>
  3314. Indicates the Content-Location header.
  3315. </summary>
  3316. </member>
  3317. <member name="F:WebSocketSharp.Net.HttpRequestHeader.ContentMd5">
  3318. <summary>
  3319. Indicates the Content-MD5 header.
  3320. </summary>
  3321. </member>
  3322. <member name="F:WebSocketSharp.Net.HttpRequestHeader.ContentRange">
  3323. <summary>
  3324. Indicates the Content-Range header.
  3325. </summary>
  3326. </member>
  3327. <member name="F:WebSocketSharp.Net.HttpRequestHeader.Expires">
  3328. <summary>
  3329. Indicates the Expires header.
  3330. </summary>
  3331. </member>
  3332. <member name="F:WebSocketSharp.Net.HttpRequestHeader.LastModified">
  3333. <summary>
  3334. Indicates the Last-Modified header.
  3335. </summary>
  3336. </member>
  3337. <member name="F:WebSocketSharp.Net.HttpRequestHeader.Accept">
  3338. <summary>
  3339. Indicates the Accept header.
  3340. </summary>
  3341. </member>
  3342. <member name="F:WebSocketSharp.Net.HttpRequestHeader.AcceptCharset">
  3343. <summary>
  3344. Indicates the Accept-Charset header.
  3345. </summary>
  3346. </member>
  3347. <member name="F:WebSocketSharp.Net.HttpRequestHeader.AcceptEncoding">
  3348. <summary>
  3349. Indicates the Accept-Encoding header.
  3350. </summary>
  3351. </member>
  3352. <member name="F:WebSocketSharp.Net.HttpRequestHeader.AcceptLanguage">
  3353. <summary>
  3354. Indicates the Accept-Language header.
  3355. </summary>
  3356. </member>
  3357. <member name="F:WebSocketSharp.Net.HttpRequestHeader.Authorization">
  3358. <summary>
  3359. Indicates the Authorization header.
  3360. </summary>
  3361. </member>
  3362. <member name="F:WebSocketSharp.Net.HttpRequestHeader.Cookie">
  3363. <summary>
  3364. Indicates the Cookie header.
  3365. </summary>
  3366. </member>
  3367. <member name="F:WebSocketSharp.Net.HttpRequestHeader.Expect">
  3368. <summary>
  3369. Indicates the Expect header.
  3370. </summary>
  3371. </member>
  3372. <member name="F:WebSocketSharp.Net.HttpRequestHeader.From">
  3373. <summary>
  3374. Indicates the From header.
  3375. </summary>
  3376. </member>
  3377. <member name="F:WebSocketSharp.Net.HttpRequestHeader.Host">
  3378. <summary>
  3379. Indicates the Host header.
  3380. </summary>
  3381. </member>
  3382. <member name="F:WebSocketSharp.Net.HttpRequestHeader.IfMatch">
  3383. <summary>
  3384. Indicates the If-Match header.
  3385. </summary>
  3386. </member>
  3387. <member name="F:WebSocketSharp.Net.HttpRequestHeader.IfModifiedSince">
  3388. <summary>
  3389. Indicates the If-Modified-Since header.
  3390. </summary>
  3391. </member>
  3392. <member name="F:WebSocketSharp.Net.HttpRequestHeader.IfNoneMatch">
  3393. <summary>
  3394. Indicates the If-None-Match header.
  3395. </summary>
  3396. </member>
  3397. <member name="F:WebSocketSharp.Net.HttpRequestHeader.IfRange">
  3398. <summary>
  3399. Indicates the If-Range header.
  3400. </summary>
  3401. </member>
  3402. <member name="F:WebSocketSharp.Net.HttpRequestHeader.IfUnmodifiedSince">
  3403. <summary>
  3404. Indicates the If-Unmodified-Since header.
  3405. </summary>
  3406. </member>
  3407. <member name="F:WebSocketSharp.Net.HttpRequestHeader.MaxForwards">
  3408. <summary>
  3409. Indicates the Max-Forwards header.
  3410. </summary>
  3411. </member>
  3412. <member name="F:WebSocketSharp.Net.HttpRequestHeader.ProxyAuthorization">
  3413. <summary>
  3414. Indicates the Proxy-Authorization header.
  3415. </summary>
  3416. </member>
  3417. <member name="F:WebSocketSharp.Net.HttpRequestHeader.Referer">
  3418. <summary>
  3419. Indicates the Referer header.
  3420. </summary>
  3421. </member>
  3422. <member name="F:WebSocketSharp.Net.HttpRequestHeader.Range">
  3423. <summary>
  3424. Indicates the Range header.
  3425. </summary>
  3426. </member>
  3427. <member name="F:WebSocketSharp.Net.HttpRequestHeader.Te">
  3428. <summary>
  3429. Indicates the TE header.
  3430. </summary>
  3431. </member>
  3432. <member name="F:WebSocketSharp.Net.HttpRequestHeader.Translate">
  3433. <summary>
  3434. Indicates the Translate header.
  3435. </summary>
  3436. </member>
  3437. <member name="F:WebSocketSharp.Net.HttpRequestHeader.UserAgent">
  3438. <summary>
  3439. Indicates the User-Agent header.
  3440. </summary>
  3441. </member>
  3442. <member name="F:WebSocketSharp.Net.HttpRequestHeader.SecWebSocketKey">
  3443. <summary>
  3444. Indicates the Sec-WebSocket-Key header.
  3445. </summary>
  3446. </member>
  3447. <member name="F:WebSocketSharp.Net.HttpRequestHeader.SecWebSocketExtensions">
  3448. <summary>
  3449. Indicates the Sec-WebSocket-Extensions header.
  3450. </summary>
  3451. </member>
  3452. <member name="F:WebSocketSharp.Net.HttpRequestHeader.SecWebSocketProtocol">
  3453. <summary>
  3454. Indicates the Sec-WebSocket-Protocol header.
  3455. </summary>
  3456. </member>
  3457. <member name="F:WebSocketSharp.Net.HttpRequestHeader.SecWebSocketVersion">
  3458. <summary>
  3459. Indicates the Sec-WebSocket-Version header.
  3460. </summary>
  3461. </member>
  3462. <member name="T:WebSocketSharp.Net.HttpResponseHeader">
  3463. <summary>
  3464. Contains the HTTP headers that can be specified in a server response.
  3465. </summary>
  3466. <remarks>
  3467. The HttpResponseHeader enumeration contains the HTTP response headers defined in
  3468. <see href="http://tools.ietf.org/html/rfc2616#section-14">RFC 2616</see> for the HTTP/1.1 and
  3469. <see href="http://tools.ietf.org/html/rfc6455#section-11.3">RFC 6455</see> for the WebSocket.
  3470. </remarks>
  3471. </member>
  3472. <member name="F:WebSocketSharp.Net.HttpResponseHeader.CacheControl">
  3473. <summary>
  3474. Indicates the Cache-Control header.
  3475. </summary>
  3476. </member>
  3477. <member name="F:WebSocketSharp.Net.HttpResponseHeader.Connection">
  3478. <summary>
  3479. Indicates the Connection header.
  3480. </summary>
  3481. </member>
  3482. <member name="F:WebSocketSharp.Net.HttpResponseHeader.Date">
  3483. <summary>
  3484. Indicates the Date header.
  3485. </summary>
  3486. </member>
  3487. <member name="F:WebSocketSharp.Net.HttpResponseHeader.KeepAlive">
  3488. <summary>
  3489. Indicates the Keep-Alive header.
  3490. </summary>
  3491. </member>
  3492. <member name="F:WebSocketSharp.Net.HttpResponseHeader.Pragma">
  3493. <summary>
  3494. Indicates the Pragma header.
  3495. </summary>
  3496. </member>
  3497. <member name="F:WebSocketSharp.Net.HttpResponseHeader.Trailer">
  3498. <summary>
  3499. Indicates the Trailer header.
  3500. </summary>
  3501. </member>
  3502. <member name="F:WebSocketSharp.Net.HttpResponseHeader.TransferEncoding">
  3503. <summary>
  3504. Indicates the Transfer-Encoding header.
  3505. </summary>
  3506. </member>
  3507. <member name="F:WebSocketSharp.Net.HttpResponseHeader.Upgrade">
  3508. <summary>
  3509. Indicates the Upgrade header.
  3510. </summary>
  3511. </member>
  3512. <member name="F:WebSocketSharp.Net.HttpResponseHeader.Via">
  3513. <summary>
  3514. Indicates the Via header.
  3515. </summary>
  3516. </member>
  3517. <member name="F:WebSocketSharp.Net.HttpResponseHeader.Warning">
  3518. <summary>
  3519. Indicates the Warning header.
  3520. </summary>
  3521. </member>
  3522. <member name="F:WebSocketSharp.Net.HttpResponseHeader.Allow">
  3523. <summary>
  3524. Indicates the Allow header.
  3525. </summary>
  3526. </member>
  3527. <member name="F:WebSocketSharp.Net.HttpResponseHeader.ContentLength">
  3528. <summary>
  3529. Indicates the Content-Length header.
  3530. </summary>
  3531. </member>
  3532. <member name="F:WebSocketSharp.Net.HttpResponseHeader.ContentType">
  3533. <summary>
  3534. Indicates the Content-Type header.
  3535. </summary>
  3536. </member>
  3537. <member name="F:WebSocketSharp.Net.HttpResponseHeader.ContentEncoding">
  3538. <summary>
  3539. Indicates the Content-Encoding header.
  3540. </summary>
  3541. </member>
  3542. <member name="F:WebSocketSharp.Net.HttpResponseHeader.ContentLanguage">
  3543. <summary>
  3544. Indicates the Content-Language header.
  3545. </summary>
  3546. </member>
  3547. <member name="F:WebSocketSharp.Net.HttpResponseHeader.ContentLocation">
  3548. <summary>
  3549. Indicates the Content-Location header.
  3550. </summary>
  3551. </member>
  3552. <member name="F:WebSocketSharp.Net.HttpResponseHeader.ContentMd5">
  3553. <summary>
  3554. Indicates the Content-MD5 header.
  3555. </summary>
  3556. </member>
  3557. <member name="F:WebSocketSharp.Net.HttpResponseHeader.ContentRange">
  3558. <summary>
  3559. Indicates the Content-Range header.
  3560. </summary>
  3561. </member>
  3562. <member name="F:WebSocketSharp.Net.HttpResponseHeader.Expires">
  3563. <summary>
  3564. Indicates the Expires header.
  3565. </summary>
  3566. </member>
  3567. <member name="F:WebSocketSharp.Net.HttpResponseHeader.LastModified">
  3568. <summary>
  3569. Indicates the Last-Modified header.
  3570. </summary>
  3571. </member>
  3572. <member name="F:WebSocketSharp.Net.HttpResponseHeader.AcceptRanges">
  3573. <summary>
  3574. Indicates the Accept-Ranges header.
  3575. </summary>
  3576. </member>
  3577. <member name="F:WebSocketSharp.Net.HttpResponseHeader.Age">
  3578. <summary>
  3579. Indicates the Age header.
  3580. </summary>
  3581. </member>
  3582. <member name="F:WebSocketSharp.Net.HttpResponseHeader.ETag">
  3583. <summary>
  3584. Indicates the ETag header.
  3585. </summary>
  3586. </member>
  3587. <member name="F:WebSocketSharp.Net.HttpResponseHeader.Location">
  3588. <summary>
  3589. Indicates the Location header.
  3590. </summary>
  3591. </member>
  3592. <member name="F:WebSocketSharp.Net.HttpResponseHeader.ProxyAuthenticate">
  3593. <summary>
  3594. Indicates the Proxy-Authenticate header.
  3595. </summary>
  3596. </member>
  3597. <member name="F:WebSocketSharp.Net.HttpResponseHeader.RetryAfter">
  3598. <summary>
  3599. Indicates the Retry-After header.
  3600. </summary>
  3601. </member>
  3602. <member name="F:WebSocketSharp.Net.HttpResponseHeader.Server">
  3603. <summary>
  3604. Indicates the Server header.
  3605. </summary>
  3606. </member>
  3607. <member name="F:WebSocketSharp.Net.HttpResponseHeader.SetCookie">
  3608. <summary>
  3609. Indicates the Set-Cookie header.
  3610. </summary>
  3611. </member>
  3612. <member name="F:WebSocketSharp.Net.HttpResponseHeader.Vary">
  3613. <summary>
  3614. Indicates the Vary header.
  3615. </summary>
  3616. </member>
  3617. <member name="F:WebSocketSharp.Net.HttpResponseHeader.WwwAuthenticate">
  3618. <summary>
  3619. Indicates the WWW-Authenticate header.
  3620. </summary>
  3621. </member>
  3622. <member name="F:WebSocketSharp.Net.HttpResponseHeader.SecWebSocketExtensions">
  3623. <summary>
  3624. Indicates the Sec-WebSocket-Extensions header.
  3625. </summary>
  3626. </member>
  3627. <member name="F:WebSocketSharp.Net.HttpResponseHeader.SecWebSocketAccept">
  3628. <summary>
  3629. Indicates the Sec-WebSocket-Accept header.
  3630. </summary>
  3631. </member>
  3632. <member name="F:WebSocketSharp.Net.HttpResponseHeader.SecWebSocketProtocol">
  3633. <summary>
  3634. Indicates the Sec-WebSocket-Protocol header.
  3635. </summary>
  3636. </member>
  3637. <member name="F:WebSocketSharp.Net.HttpResponseHeader.SecWebSocketVersion">
  3638. <summary>
  3639. Indicates the Sec-WebSocket-Version header.
  3640. </summary>
  3641. </member>
  3642. <member name="T:WebSocketSharp.Net.HttpStatusCode">
  3643. <summary>
  3644. Contains the values of the HTTP status codes.
  3645. </summary>
  3646. <remarks>
  3647. The HttpStatusCode enumeration contains the values of the HTTP status codes defined in
  3648. <see href="http://tools.ietf.org/html/rfc2616#section-10">RFC 2616</see> for the HTTP/1.1.
  3649. </remarks>
  3650. </member>
  3651. <member name="F:WebSocketSharp.Net.HttpStatusCode.Continue">
  3652. <summary>
  3653. Equivalent to status code 100.
  3654. Indicates that the client should continue with its request.
  3655. </summary>
  3656. </member>
  3657. <member name="F:WebSocketSharp.Net.HttpStatusCode.SwitchingProtocols">
  3658. <summary>
  3659. Equivalent to status code 101.
  3660. Indicates that the server is switching the HTTP version or protocol on the connection.
  3661. </summary>
  3662. </member>
  3663. <member name="F:WebSocketSharp.Net.HttpStatusCode.OK">
  3664. <summary>
  3665. Equivalent to status code 200.
  3666. Indicates that the client's request has succeeded.
  3667. </summary>
  3668. </member>
  3669. <member name="F:WebSocketSharp.Net.HttpStatusCode.Created">
  3670. <summary>
  3671. Equivalent to status code 201.
  3672. Indicates that the client's request has been fulfilled and resulted in a new resource being
  3673. created.
  3674. </summary>
  3675. </member>
  3676. <member name="F:WebSocketSharp.Net.HttpStatusCode.Accepted">
  3677. <summary>
  3678. Equivalent to status code 202.
  3679. Indicates that the client's request has been accepted for processing, but the processing
  3680. hasn't been completed.
  3681. </summary>
  3682. </member>
  3683. <member name="F:WebSocketSharp.Net.HttpStatusCode.NonAuthoritativeInformation">
  3684. <summary>
  3685. Equivalent to status code 203.
  3686. Indicates that the returned metainformation is from a local or a third-party copy instead of
  3687. the origin server.
  3688. </summary>
  3689. </member>
  3690. <member name="F:WebSocketSharp.Net.HttpStatusCode.NoContent">
  3691. <summary>
  3692. Equivalent to status code 204.
  3693. Indicates that the server has fulfilled the client's request but doesn't need to return
  3694. an entity-body.
  3695. </summary>
  3696. </member>
  3697. <member name="F:WebSocketSharp.Net.HttpStatusCode.ResetContent">
  3698. <summary>
  3699. Equivalent to status code 205.
  3700. Indicates that the server has fulfilled the client's request, and the user agent should
  3701. reset the document view which caused the request to be sent.
  3702. </summary>
  3703. </member>
  3704. <member name="F:WebSocketSharp.Net.HttpStatusCode.PartialContent">
  3705. <summary>
  3706. Equivalent to status code 206.
  3707. Indicates that the server has fulfilled the partial GET request for the resource.
  3708. </summary>
  3709. </member>
  3710. <member name="F:WebSocketSharp.Net.HttpStatusCode.MultipleChoices">
  3711. <summary>
  3712. <para>
  3713. Equivalent to status code 300.
  3714. Indicates that the requested resource corresponds to any of multiple representations.
  3715. </para>
  3716. <para>
  3717. MultipleChoices is a synonym for Ambiguous.
  3718. </para>
  3719. </summary>
  3720. </member>
  3721. <member name="F:WebSocketSharp.Net.HttpStatusCode.Ambiguous">
  3722. <summary>
  3723. <para>
  3724. Equivalent to status code 300.
  3725. Indicates that the requested resource corresponds to any of multiple representations.
  3726. </para>
  3727. <para>
  3728. Ambiguous is a synonym for MultipleChoices.
  3729. </para>
  3730. </summary>
  3731. </member>
  3732. <member name="F:WebSocketSharp.Net.HttpStatusCode.MovedPermanently">
  3733. <summary>
  3734. <para>
  3735. Equivalent to status code 301.
  3736. Indicates that the requested resource has been assigned a new permanent URI and
  3737. any future references to this resource should use one of the returned URIs.
  3738. </para>
  3739. <para>
  3740. MovedPermanently is a synonym for Moved.
  3741. </para>
  3742. </summary>
  3743. </member>
  3744. <member name="F:WebSocketSharp.Net.HttpStatusCode.Moved">
  3745. <summary>
  3746. <para>
  3747. Equivalent to status code 301.
  3748. Indicates that the requested resource has been assigned a new permanent URI and
  3749. any future references to this resource should use one of the returned URIs.
  3750. </para>
  3751. <para>
  3752. Moved is a synonym for MovedPermanently.
  3753. </para>
  3754. </summary>
  3755. </member>
  3756. <member name="F:WebSocketSharp.Net.HttpStatusCode.Found">
  3757. <summary>
  3758. <para>
  3759. Equivalent to status code 302.
  3760. Indicates that the requested resource is located temporarily under a different URI.
  3761. </para>
  3762. <para>
  3763. Found is a synonym for Redirect.
  3764. </para>
  3765. </summary>
  3766. </member>
  3767. <member name="F:WebSocketSharp.Net.HttpStatusCode.Redirect">
  3768. <summary>
  3769. <para>
  3770. Equivalent to status code 302.
  3771. Indicates that the requested resource is located temporarily under a different URI.
  3772. </para>
  3773. <para>
  3774. Redirect is a synonym for Found.
  3775. </para>
  3776. </summary>
  3777. </member>
  3778. <member name="F:WebSocketSharp.Net.HttpStatusCode.SeeOther">
  3779. <summary>
  3780. <para>
  3781. Equivalent to status code 303.
  3782. Indicates that the response to the request can be found under a different URI and
  3783. should be retrieved using a GET method on that resource.
  3784. </para>
  3785. <para>
  3786. SeeOther is a synonym for RedirectMethod.
  3787. </para>
  3788. </summary>
  3789. </member>
  3790. <member name="F:WebSocketSharp.Net.HttpStatusCode.RedirectMethod">
  3791. <summary>
  3792. <para>
  3793. Equivalent to status code 303.
  3794. Indicates that the response to the request can be found under a different URI and
  3795. should be retrieved using a GET method on that resource.
  3796. </para>
  3797. <para>
  3798. RedirectMethod is a synonym for SeeOther.
  3799. </para>
  3800. </summary>
  3801. </member>
  3802. <member name="F:WebSocketSharp.Net.HttpStatusCode.NotModified">
  3803. <summary>
  3804. Equivalent to status code 304.
  3805. Indicates that the client has performed a conditional GET request and access is allowed,
  3806. but the document hasn't been modified.
  3807. </summary>
  3808. </member>
  3809. <member name="F:WebSocketSharp.Net.HttpStatusCode.UseProxy">
  3810. <summary>
  3811. Equivalent to status code 305.
  3812. Indicates that the requested resource must be accessed through the proxy given by
  3813. the Location field.
  3814. </summary>
  3815. </member>
  3816. <member name="F:WebSocketSharp.Net.HttpStatusCode.Unused">
  3817. <summary>
  3818. Equivalent to status code 306.
  3819. This status code was used in a previous version of the specification, is no longer used,
  3820. and is reserved for future use.
  3821. </summary>
  3822. </member>
  3823. <member name="F:WebSocketSharp.Net.HttpStatusCode.TemporaryRedirect">
  3824. <summary>
  3825. <para>
  3826. Equivalent to status code 307.
  3827. Indicates that the requested resource is located temporarily under a different URI.
  3828. </para>
  3829. <para>
  3830. TemporaryRedirect is a synonym for RedirectKeepVerb.
  3831. </para>
  3832. </summary>
  3833. </member>
  3834. <member name="F:WebSocketSharp.Net.HttpStatusCode.RedirectKeepVerb">
  3835. <summary>
  3836. <para>
  3837. Equivalent to status code 307.
  3838. Indicates that the requested resource is located temporarily under a different URI.
  3839. </para>
  3840. <para>
  3841. RedirectKeepVerb is a synonym for TemporaryRedirect.
  3842. </para>
  3843. </summary>
  3844. </member>
  3845. <member name="F:WebSocketSharp.Net.HttpStatusCode.BadRequest">
  3846. <summary>
  3847. Equivalent to status code 400.
  3848. Indicates that the client's request couldn't be understood by the server due to
  3849. malformed syntax.
  3850. </summary>
  3851. </member>
  3852. <member name="F:WebSocketSharp.Net.HttpStatusCode.Unauthorized">
  3853. <summary>
  3854. Equivalent to status code 401.
  3855. Indicates that the client's request requires user authentication.
  3856. </summary>
  3857. </member>
  3858. <member name="F:WebSocketSharp.Net.HttpStatusCode.PaymentRequired">
  3859. <summary>
  3860. Equivalent to status code 402.
  3861. This status code is reserved for future use.
  3862. </summary>
  3863. </member>
  3864. <member name="F:WebSocketSharp.Net.HttpStatusCode.Forbidden">
  3865. <summary>
  3866. Equivalent to status code 403.
  3867. Indicates that the server understood the client's request but is refusing to fulfill it.
  3868. </summary>
  3869. </member>
  3870. <member name="F:WebSocketSharp.Net.HttpStatusCode.NotFound">
  3871. <summary>
  3872. Equivalent to status code 404.
  3873. Indicates that the server hasn't found anything matching the request URI.
  3874. </summary>
  3875. </member>
  3876. <member name="F:WebSocketSharp.Net.HttpStatusCode.MethodNotAllowed">
  3877. <summary>
  3878. Equivalent to status code 405.
  3879. Indicates that the method specified in the request line isn't allowed for the resource
  3880. identified by the request URI.
  3881. </summary>
  3882. </member>
  3883. <member name="F:WebSocketSharp.Net.HttpStatusCode.NotAcceptable">
  3884. <summary>
  3885. Equivalent to status code 406.
  3886. Indicates that the server doesn't have the appropriate resource to respond to the Accept
  3887. headers in the client's request.
  3888. </summary>
  3889. </member>
  3890. <member name="F:WebSocketSharp.Net.HttpStatusCode.ProxyAuthenticationRequired">
  3891. <summary>
  3892. Equivalent to status code 407.
  3893. Indicates that the client must first authenticate itself with the proxy.
  3894. </summary>
  3895. </member>
  3896. <member name="F:WebSocketSharp.Net.HttpStatusCode.RequestTimeout">
  3897. <summary>
  3898. Equivalent to status code 408.
  3899. Indicates that the client didn't produce a request within the time that the server was
  3900. prepared to wait.
  3901. </summary>
  3902. </member>
  3903. <member name="F:WebSocketSharp.Net.HttpStatusCode.Conflict">
  3904. <summary>
  3905. Equivalent to status code 409.
  3906. Indicates that the client's request couldn't be completed due to a conflict on the server.
  3907. </summary>
  3908. </member>
  3909. <member name="F:WebSocketSharp.Net.HttpStatusCode.Gone">
  3910. <summary>
  3911. Equivalent to status code 410.
  3912. Indicates that the requested resource is no longer available at the server and
  3913. no forwarding address is known.
  3914. </summary>
  3915. </member>
  3916. <member name="F:WebSocketSharp.Net.HttpStatusCode.LengthRequired">
  3917. <summary>
  3918. Equivalent to status code 411.
  3919. Indicates that the server refuses to accept the client's request without a defined
  3920. Content-Length.
  3921. </summary>
  3922. </member>
  3923. <member name="F:WebSocketSharp.Net.HttpStatusCode.PreconditionFailed">
  3924. <summary>
  3925. Equivalent to status code 412.
  3926. Indicates that the precondition given in one or more of the request headers evaluated to
  3927. false when it was tested on the server.
  3928. </summary>
  3929. </member>
  3930. <member name="F:WebSocketSharp.Net.HttpStatusCode.RequestEntityTooLarge">
  3931. <summary>
  3932. Equivalent to status code 413.
  3933. Indicates that the entity of the client's request is larger than the server is willing or
  3934. able to process.
  3935. </summary>
  3936. </member>
  3937. <member name="F:WebSocketSharp.Net.HttpStatusCode.RequestUriTooLong">
  3938. <summary>
  3939. Equivalent to status code 414.
  3940. Indicates that the request URI is longer than the server is willing to interpret.
  3941. </summary>
  3942. </member>
  3943. <member name="F:WebSocketSharp.Net.HttpStatusCode.UnsupportedMediaType">
  3944. <summary>
  3945. Equivalent to status code 415.
  3946. Indicates that the entity of the client's request is in a format not supported by
  3947. the requested resource for the requested method.
  3948. </summary>
  3949. </member>
  3950. <member name="F:WebSocketSharp.Net.HttpStatusCode.RequestedRangeNotSatisfiable">
  3951. <summary>
  3952. Equivalent to status code 416.
  3953. Indicates that none of the range specifier values in a Range request header overlap
  3954. the current extent of the selected resource.
  3955. </summary>
  3956. </member>
  3957. <member name="F:WebSocketSharp.Net.HttpStatusCode.ExpectationFailed">
  3958. <summary>
  3959. Equivalent to status code 417.
  3960. Indicates that the expectation given in an Expect request header couldn't be met by
  3961. the server.
  3962. </summary>
  3963. </member>
  3964. <member name="F:WebSocketSharp.Net.HttpStatusCode.InternalServerError">
  3965. <summary>
  3966. Equivalent to status code 500.
  3967. Indicates that the server encountered an unexpected condition which prevented it from
  3968. fulfilling the client's request.
  3969. </summary>
  3970. </member>
  3971. <member name="F:WebSocketSharp.Net.HttpStatusCode.NotImplemented">
  3972. <summary>
  3973. Equivalent to status code 501.
  3974. Indicates that the server doesn't support the functionality required to fulfill the client's
  3975. request.
  3976. </summary>
  3977. </member>
  3978. <member name="F:WebSocketSharp.Net.HttpStatusCode.BadGateway">
  3979. <summary>
  3980. Equivalent to status code 502.
  3981. Indicates that a gateway or proxy server received an invalid response from the upstream
  3982. server.
  3983. </summary>
  3984. </member>
  3985. <member name="F:WebSocketSharp.Net.HttpStatusCode.ServiceUnavailable">
  3986. <summary>
  3987. Equivalent to status code 503.
  3988. Indicates that the server is currently unable to handle the client's request due to
  3989. a temporary overloading or maintenance of the server.
  3990. </summary>
  3991. </member>
  3992. <member name="F:WebSocketSharp.Net.HttpStatusCode.GatewayTimeout">
  3993. <summary>
  3994. Equivalent to status code 504.
  3995. Indicates that a gateway or proxy server didn't receive a timely response from the upstream
  3996. server or some other auxiliary server.
  3997. </summary>
  3998. </member>
  3999. <member name="F:WebSocketSharp.Net.HttpStatusCode.HttpVersionNotSupported">
  4000. <summary>
  4001. Equivalent to status code 505.
  4002. Indicates that the server doesn't support the HTTP version used in the client's request.
  4003. </summary>
  4004. </member>
  4005. <member name="M:WebSocketSharp.Net.HttpUtility.HtmlDecode(System.String)">
  4006. <summary>
  4007. Decodes an HTML-encoded <see cref="T:System.String"/> and returns the decoded <see cref="T:System.String"/>.
  4008. </summary>
  4009. <returns>
  4010. A <see cref="T:System.String"/> that represents the decoded string.
  4011. </returns>
  4012. <param name="s">
  4013. A <see cref="T:System.String"/> to decode.
  4014. </param>
  4015. </member>
  4016. <member name="M:WebSocketSharp.Net.HttpUtility.HtmlDecode(System.String,System.IO.TextWriter)">
  4017. <summary>
  4018. Decodes an HTML-encoded <see cref="T:System.String"/> and sends the decoded <see cref="T:System.String"/>
  4019. to the specified <see cref="T:System.IO.TextWriter"/>.
  4020. </summary>
  4021. <param name="s">
  4022. A <see cref="T:System.String"/> to decode.
  4023. </param>
  4024. <param name="output">
  4025. A <see cref="T:System.IO.TextWriter"/> that receives the decoded string.
  4026. </param>
  4027. </member>
  4028. <member name="M:WebSocketSharp.Net.HttpUtility.HtmlEncode(System.String)">
  4029. <summary>
  4030. HTML-encodes a <see cref="T:System.String"/> and returns the encoded <see cref="T:System.String"/>.
  4031. </summary>
  4032. <returns>
  4033. A <see cref="T:System.String"/> that represents the encoded string.
  4034. </returns>
  4035. <param name="s">
  4036. A <see cref="T:System.String"/> to encode.
  4037. </param>
  4038. </member>
  4039. <member name="M:WebSocketSharp.Net.HttpUtility.HtmlEncode(System.String,System.IO.TextWriter)">
  4040. <summary>
  4041. HTML-encodes a <see cref="T:System.String"/> and sends the encoded <see cref="T:System.String"/>
  4042. to the specified <see cref="T:System.IO.TextWriter"/>.
  4043. </summary>
  4044. <param name="s">
  4045. A <see cref="T:System.String"/> to encode.
  4046. </param>
  4047. <param name="output">
  4048. A <see cref="T:System.IO.TextWriter"/> that receives the encoded string.
  4049. </param>
  4050. </member>
  4051. <member name="T:WebSocketSharp.Net.HttpVersion">
  4052. <summary>
  4053. Provides the HTTP version numbers.
  4054. </summary>
  4055. </member>
  4056. <member name="F:WebSocketSharp.Net.HttpVersion.Version10">
  4057. <summary>
  4058. Provides a <see cref="T:System.Version"/> instance for the HTTP/1.0.
  4059. </summary>
  4060. </member>
  4061. <member name="F:WebSocketSharp.Net.HttpVersion.Version11">
  4062. <summary>
  4063. Provides a <see cref="T:System.Version"/> instance for the HTTP/1.1.
  4064. </summary>
  4065. </member>
  4066. <member name="M:WebSocketSharp.Net.HttpVersion.#ctor">
  4067. <summary>
  4068. Initializes a new instance of the <see cref="T:WebSocketSharp.Net.HttpVersion"/> class.
  4069. </summary>
  4070. </member>
  4071. <member name="T:WebSocketSharp.Net.NetworkCredential">
  4072. <summary>
  4073. Provides the credentials for the password-based authentication.
  4074. </summary>
  4075. </member>
  4076. <member name="M:WebSocketSharp.Net.NetworkCredential.#ctor(System.String,System.String)">
  4077. <summary>
  4078. Initializes a new instance of the <see cref="T:WebSocketSharp.Net.NetworkCredential"/> class with
  4079. the specified <paramref name="username"/> and <paramref name="password"/>.
  4080. </summary>
  4081. <param name="username">
  4082. A <see cref="T:System.String"/> that represents the username associated with
  4083. the credentials.
  4084. </param>
  4085. <param name="password">
  4086. A <see cref="T:System.String"/> that represents the password for the username
  4087. associated with the credentials.
  4088. </param>
  4089. <exception cref="T:System.ArgumentNullException">
  4090. <paramref name="username"/> is <see langword="null"/>.
  4091. </exception>
  4092. <exception cref="T:System.ArgumentException">
  4093. <paramref name="username"/> is empty.
  4094. </exception>
  4095. </member>
  4096. <member name="M:WebSocketSharp.Net.NetworkCredential.#ctor(System.String,System.String,System.String,System.String[])">
  4097. <summary>
  4098. Initializes a new instance of the <see cref="T:WebSocketSharp.Net.NetworkCredential"/> class with
  4099. the specified <paramref name="username"/>, <paramref name="password"/>,
  4100. <paramref name="domain"/> and <paramref name="roles"/>.
  4101. </summary>
  4102. <param name="username">
  4103. A <see cref="T:System.String"/> that represents the username associated with
  4104. the credentials.
  4105. </param>
  4106. <param name="password">
  4107. A <see cref="T:System.String"/> that represents the password for the username
  4108. associated with the credentials.
  4109. </param>
  4110. <param name="domain">
  4111. A <see cref="T:System.String"/> that represents the domain associated with
  4112. the credentials.
  4113. </param>
  4114. <param name="roles">
  4115. An array of <see cref="T:System.String"/> that represents the roles
  4116. associated with the credentials if any.
  4117. </param>
  4118. <exception cref="T:System.ArgumentNullException">
  4119. <paramref name="username"/> is <see langword="null"/>.
  4120. </exception>
  4121. <exception cref="T:System.ArgumentException">
  4122. <paramref name="username"/> is empty.
  4123. </exception>
  4124. </member>
  4125. <member name="P:WebSocketSharp.Net.NetworkCredential.Domain">
  4126. <summary>
  4127. Gets the domain associated with the credentials.
  4128. </summary>
  4129. <remarks>
  4130. This property returns an empty string if the domain was
  4131. initialized with <see langword="null"/>.
  4132. </remarks>
  4133. <value>
  4134. A <see cref="T:System.String"/> that represents the domain name
  4135. to which the username belongs.
  4136. </value>
  4137. </member>
  4138. <member name="P:WebSocketSharp.Net.NetworkCredential.Password">
  4139. <summary>
  4140. Gets the password for the username associated with the credentials.
  4141. </summary>
  4142. <remarks>
  4143. This property returns an empty string if the password was
  4144. initialized with <see langword="null"/>.
  4145. </remarks>
  4146. <value>
  4147. A <see cref="T:System.String"/> that represents the password.
  4148. </value>
  4149. </member>
  4150. <member name="P:WebSocketSharp.Net.NetworkCredential.Roles">
  4151. <summary>
  4152. Gets the roles associated with the credentials.
  4153. </summary>
  4154. <remarks>
  4155. This property returns an empty array if the roles were
  4156. initialized with <see langword="null"/>.
  4157. </remarks>
  4158. <value>
  4159. An array of <see cref="T:System.String"/> that represents the role names
  4160. to which the username belongs.
  4161. </value>
  4162. </member>
  4163. <member name="P:WebSocketSharp.Net.NetworkCredential.Username">
  4164. <summary>
  4165. Gets the username associated with the credentials.
  4166. </summary>
  4167. <value>
  4168. A <see cref="T:System.String"/> that represents the username.
  4169. </value>
  4170. </member>
  4171. <member name="T:WebSocketSharp.Net.ServerSslConfiguration">
  4172. <summary>
  4173. Stores the parameters for the <see cref="T:System.Net.Security.SslStream"/> used by servers.
  4174. </summary>
  4175. </member>
  4176. <member name="M:WebSocketSharp.Net.ServerSslConfiguration.#ctor">
  4177. <summary>
  4178. Initializes a new instance of the <see cref="T:WebSocketSharp.Net.ServerSslConfiguration"/> class.
  4179. </summary>
  4180. </member>
  4181. <member name="M:WebSocketSharp.Net.ServerSslConfiguration.#ctor(System.Security.Cryptography.X509Certificates.X509Certificate2)">
  4182. <summary>
  4183. Initializes a new instance of the <see cref="T:WebSocketSharp.Net.ServerSslConfiguration"/> class
  4184. with the specified <paramref name="serverCertificate"/>.
  4185. </summary>
  4186. <param name="serverCertificate">
  4187. A <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2"/> that represents the certificate used to
  4188. authenticate the server.
  4189. </param>
  4190. </member>
  4191. <member name="M:WebSocketSharp.Net.ServerSslConfiguration.#ctor(WebSocketSharp.Net.ServerSslConfiguration)">
  4192. <summary>
  4193. Copies the parameters from the specified <paramref name="configuration"/> to
  4194. a new instance of the <see cref="T:WebSocketSharp.Net.ServerSslConfiguration"/> class.
  4195. </summary>
  4196. <param name="configuration">
  4197. A <see cref="T:WebSocketSharp.Net.ServerSslConfiguration"/> from which to copy.
  4198. </param>
  4199. <exception cref="T:System.ArgumentNullException">
  4200. <paramref name="configuration"/> is <see langword="null"/>.
  4201. </exception>
  4202. </member>
  4203. <member name="P:WebSocketSharp.Net.ServerSslConfiguration.CheckCertificateRevocation">
  4204. <summary>
  4205. Gets or sets a value indicating whether the certificate revocation
  4206. list is checked during authentication.
  4207. </summary>
  4208. <value>
  4209. <para>
  4210. <c>true</c> if the certificate revocation list is checked during
  4211. authentication; otherwise, <c>false</c>.
  4212. </para>
  4213. <para>
  4214. The default value is <c>false</c>.
  4215. </para>
  4216. </value>
  4217. </member>
  4218. <member name="P:WebSocketSharp.Net.ServerSslConfiguration.ClientCertificateRequired">
  4219. <summary>
  4220. Gets or sets a value indicating whether the client is asked for
  4221. a certificate for authentication.
  4222. </summary>
  4223. <value>
  4224. <para>
  4225. <c>true</c> if the client is asked for a certificate for
  4226. authentication; otherwise, <c>false</c>.
  4227. </para>
  4228. <para>
  4229. The default value is <c>false</c>.
  4230. </para>
  4231. </value>
  4232. </member>
  4233. <member name="P:WebSocketSharp.Net.ServerSslConfiguration.ClientCertificateValidationCallback">
  4234. <summary>
  4235. Gets or sets the callback used to validate the certificate
  4236. supplied by the client.
  4237. </summary>
  4238. <remarks>
  4239. The certificate is valid if the callback returns <c>true</c>.
  4240. </remarks>
  4241. <value>
  4242. <para>
  4243. A <see cref="T:System.Net.Security.RemoteCertificateValidationCallback"/> delegate that
  4244. invokes the method called for validating the certificate.
  4245. </para>
  4246. <para>
  4247. The default value is a delegate that invokes a method that
  4248. only returns <c>true</c>.
  4249. </para>
  4250. </value>
  4251. </member>
  4252. <member name="P:WebSocketSharp.Net.ServerSslConfiguration.EnabledSslProtocols">
  4253. <summary>
  4254. Gets or sets the protocols used for authentication.
  4255. </summary>
  4256. <value>
  4257. <para>
  4258. The <see cref="T:System.Security.Authentication.SslProtocols"/> enum values that represent
  4259. the protocols used for authentication.
  4260. </para>
  4261. <para>
  4262. The default value is <see cref="F:System.Security.Authentication.SslProtocols.Default"/>.
  4263. </para>
  4264. </value>
  4265. </member>
  4266. <member name="P:WebSocketSharp.Net.ServerSslConfiguration.ServerCertificate">
  4267. <summary>
  4268. Gets or sets the certificate used to authenticate the server.
  4269. </summary>
  4270. <value>
  4271. <para>
  4272. A <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2"/> or <see langword="null"/>
  4273. if not specified.
  4274. </para>
  4275. <para>
  4276. That instance represents an X.509 certificate.
  4277. </para>
  4278. </value>
  4279. </member>
  4280. <member name="T:WebSocketSharp.Net.WebHeaderCollection">
  4281. <summary>
  4282. Provides a collection of the HTTP headers associated with a request or response.
  4283. </summary>
  4284. </member>
  4285. <member name="M:WebSocketSharp.Net.WebHeaderCollection.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  4286. <summary>
  4287. Initializes a new instance of the <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/> class from
  4288. the specified <see cref="T:System.Runtime.Serialization.SerializationInfo"/> and <see cref="T:System.Runtime.Serialization.StreamingContext"/>.
  4289. </summary>
  4290. <param name="serializationInfo">
  4291. A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that contains the serialized object data.
  4292. </param>
  4293. <param name="streamingContext">
  4294. A <see cref="T:System.Runtime.Serialization.StreamingContext"/> that specifies the source for the deserialization.
  4295. </param>
  4296. <exception cref="T:System.ArgumentNullException">
  4297. <paramref name="serializationInfo"/> is <see langword="null"/>.
  4298. </exception>
  4299. <exception cref="T:System.ArgumentException">
  4300. An element with the specified name isn't found in <paramref name="serializationInfo"/>.
  4301. </exception>
  4302. </member>
  4303. <member name="M:WebSocketSharp.Net.WebHeaderCollection.#ctor">
  4304. <summary>
  4305. Initializes a new instance of the <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/> class.
  4306. </summary>
  4307. </member>
  4308. <member name="P:WebSocketSharp.Net.WebHeaderCollection.AllKeys">
  4309. <summary>
  4310. Gets all header names in the collection.
  4311. </summary>
  4312. <value>
  4313. An array of <see cref="T:System.String"/> that contains all header names in the collection.
  4314. </value>
  4315. </member>
  4316. <member name="P:WebSocketSharp.Net.WebHeaderCollection.Count">
  4317. <summary>
  4318. Gets the number of headers in the collection.
  4319. </summary>
  4320. <value>
  4321. An <see cref="T:System.Int32"/> that represents the number of headers in the collection.
  4322. </value>
  4323. </member>
  4324. <member name="P:WebSocketSharp.Net.WebHeaderCollection.Item(WebSocketSharp.Net.HttpRequestHeader)">
  4325. <summary>
  4326. Gets or sets the specified request <paramref name="header"/> in the collection.
  4327. </summary>
  4328. <value>
  4329. A <see cref="T:System.String"/> that represents the value of the request <paramref name="header"/>.
  4330. </value>
  4331. <param name="header">
  4332. One of the <see cref="T:WebSocketSharp.Net.HttpRequestHeader"/> enum values, represents
  4333. the request header to get or set.
  4334. </param>
  4335. <exception cref="T:System.ArgumentException">
  4336. <para>
  4337. <paramref name="header"/> is a restricted header.
  4338. </para>
  4339. <para>
  4340. -or-
  4341. </para>
  4342. <para>
  4343. <paramref name="value"/> contains invalid characters.
  4344. </para>
  4345. </exception>
  4346. <exception cref="T:System.ArgumentOutOfRangeException">
  4347. The length of <paramref name="value"/> is greater than 65,535 characters.
  4348. </exception>
  4349. <exception cref="T:System.InvalidOperationException">
  4350. The current <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/> instance doesn't allow
  4351. the request <paramref name="header"/>.
  4352. </exception>
  4353. </member>
  4354. <member name="P:WebSocketSharp.Net.WebHeaderCollection.Item(WebSocketSharp.Net.HttpResponseHeader)">
  4355. <summary>
  4356. Gets or sets the specified response <paramref name="header"/> in the collection.
  4357. </summary>
  4358. <value>
  4359. A <see cref="T:System.String"/> that represents the value of the response <paramref name="header"/>.
  4360. </value>
  4361. <param name="header">
  4362. One of the <see cref="T:WebSocketSharp.Net.HttpResponseHeader"/> enum values, represents
  4363. the response header to get or set.
  4364. </param>
  4365. <exception cref="T:System.ArgumentException">
  4366. <para>
  4367. <paramref name="header"/> is a restricted header.
  4368. </para>
  4369. <para>
  4370. -or-
  4371. </para>
  4372. <para>
  4373. <paramref name="value"/> contains invalid characters.
  4374. </para>
  4375. </exception>
  4376. <exception cref="T:System.ArgumentOutOfRangeException">
  4377. The length of <paramref name="value"/> is greater than 65,535 characters.
  4378. </exception>
  4379. <exception cref="T:System.InvalidOperationException">
  4380. The current <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/> instance doesn't allow
  4381. the response <paramref name="header"/>.
  4382. </exception>
  4383. </member>
  4384. <member name="P:WebSocketSharp.Net.WebHeaderCollection.Keys">
  4385. <summary>
  4386. Gets a collection of header names in the collection.
  4387. </summary>
  4388. <value>
  4389. A <see cref="T:System.Collections.Specialized.NameObjectCollectionBase.KeysCollection"/> that contains
  4390. all header names in the collection.
  4391. </value>
  4392. </member>
  4393. <member name="M:WebSocketSharp.Net.WebHeaderCollection.AddWithoutValidate(System.String,System.String)">
  4394. <summary>
  4395. Adds a header to the collection without checking if the header is on
  4396. the restricted header list.
  4397. </summary>
  4398. <param name="headerName">
  4399. A <see cref="T:System.String"/> that represents the name of the header to add.
  4400. </param>
  4401. <param name="headerValue">
  4402. A <see cref="T:System.String"/> that represents the value of the header to add.
  4403. </param>
  4404. <exception cref="T:System.ArgumentNullException">
  4405. <paramref name="headerName"/> is <see langword="null"/> or empty.
  4406. </exception>
  4407. <exception cref="T:System.ArgumentException">
  4408. <paramref name="headerName"/> or <paramref name="headerValue"/> contains invalid characters.
  4409. </exception>
  4410. <exception cref="T:System.ArgumentOutOfRangeException">
  4411. The length of <paramref name="headerValue"/> is greater than 65,535 characters.
  4412. </exception>
  4413. <exception cref="T:System.InvalidOperationException">
  4414. The current <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/> instance doesn't allow
  4415. the <paramref name="headerName"/>.
  4416. </exception>
  4417. </member>
  4418. <member name="M:WebSocketSharp.Net.WebHeaderCollection.Add(System.String)">
  4419. <summary>
  4420. Adds the specified <paramref name="header"/> to the collection.
  4421. </summary>
  4422. <param name="header">
  4423. A <see cref="T:System.String"/> that represents the header with the name and value separated by
  4424. a colon (<c>':'</c>).
  4425. </param>
  4426. <exception cref="T:System.ArgumentNullException">
  4427. <paramref name="header"/> is <see langword="null"/>, empty, or the name part of
  4428. <paramref name="header"/> is empty.
  4429. </exception>
  4430. <exception cref="T:System.ArgumentException">
  4431. <para>
  4432. <paramref name="header"/> doesn't contain a colon.
  4433. </para>
  4434. <para>
  4435. -or-
  4436. </para>
  4437. <para>
  4438. <paramref name="header"/> is a restricted header.
  4439. </para>
  4440. <para>
  4441. -or-
  4442. </para>
  4443. <para>
  4444. The name or value part of <paramref name="header"/> contains invalid characters.
  4445. </para>
  4446. </exception>
  4447. <exception cref="T:System.ArgumentOutOfRangeException">
  4448. The length of the value part of <paramref name="header"/> is greater than 65,535 characters.
  4449. </exception>
  4450. <exception cref="T:System.InvalidOperationException">
  4451. The current <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/> instance doesn't allow
  4452. the <paramref name="header"/>.
  4453. </exception>
  4454. </member>
  4455. <member name="M:WebSocketSharp.Net.WebHeaderCollection.Add(WebSocketSharp.Net.HttpRequestHeader,System.String)">
  4456. <summary>
  4457. Adds the specified request <paramref name="header"/> with
  4458. the specified <paramref name="value"/> to the collection.
  4459. </summary>
  4460. <param name="header">
  4461. One of the <see cref="T:WebSocketSharp.Net.HttpRequestHeader"/> enum values, represents
  4462. the request header to add.
  4463. </param>
  4464. <param name="value">
  4465. A <see cref="T:System.String"/> that represents the value of the header to add.
  4466. </param>
  4467. <exception cref="T:System.ArgumentException">
  4468. <para>
  4469. <paramref name="header"/> is a restricted header.
  4470. </para>
  4471. <para>
  4472. -or-
  4473. </para>
  4474. <para>
  4475. <paramref name="value"/> contains invalid characters.
  4476. </para>
  4477. </exception>
  4478. <exception cref="T:System.ArgumentOutOfRangeException">
  4479. The length of <paramref name="value"/> is greater than 65,535 characters.
  4480. </exception>
  4481. <exception cref="T:System.InvalidOperationException">
  4482. The current <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/> instance doesn't allow
  4483. the request <paramref name="header"/>.
  4484. </exception>
  4485. </member>
  4486. <member name="M:WebSocketSharp.Net.WebHeaderCollection.Add(WebSocketSharp.Net.HttpResponseHeader,System.String)">
  4487. <summary>
  4488. Adds the specified response <paramref name="header"/> with
  4489. the specified <paramref name="value"/> to the collection.
  4490. </summary>
  4491. <param name="header">
  4492. One of the <see cref="T:WebSocketSharp.Net.HttpResponseHeader"/> enum values, represents
  4493. the response header to add.
  4494. </param>
  4495. <param name="value">
  4496. A <see cref="T:System.String"/> that represents the value of the header to add.
  4497. </param>
  4498. <exception cref="T:System.ArgumentException">
  4499. <para>
  4500. <paramref name="header"/> is a restricted header.
  4501. </para>
  4502. <para>
  4503. -or-
  4504. </para>
  4505. <para>
  4506. <paramref name="value"/> contains invalid characters.
  4507. </para>
  4508. </exception>
  4509. <exception cref="T:System.ArgumentOutOfRangeException">
  4510. The length of <paramref name="value"/> is greater than 65,535 characters.
  4511. </exception>
  4512. <exception cref="T:System.InvalidOperationException">
  4513. The current <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/> instance doesn't allow
  4514. the response <paramref name="header"/>.
  4515. </exception>
  4516. </member>
  4517. <member name="M:WebSocketSharp.Net.WebHeaderCollection.Add(System.String,System.String)">
  4518. <summary>
  4519. Adds a header with the specified <paramref name="name"/> and
  4520. <paramref name="value"/> to the collection.
  4521. </summary>
  4522. <param name="name">
  4523. A <see cref="T:System.String"/> that represents the name of the header to add.
  4524. </param>
  4525. <param name="value">
  4526. A <see cref="T:System.String"/> that represents the value of the header to add.
  4527. </param>
  4528. <exception cref="T:System.ArgumentNullException">
  4529. <paramref name="name"/> is <see langword="null"/> or empty.
  4530. </exception>
  4531. <exception cref="T:System.ArgumentException">
  4532. <para>
  4533. <paramref name="name"/> or <paramref name="value"/> contains invalid characters.
  4534. </para>
  4535. <para>
  4536. -or-
  4537. </para>
  4538. <para>
  4539. <paramref name="name"/> is a restricted header name.
  4540. </para>
  4541. </exception>
  4542. <exception cref="T:System.ArgumentOutOfRangeException">
  4543. The length of <paramref name="value"/> is greater than 65,535 characters.
  4544. </exception>
  4545. <exception cref="T:System.InvalidOperationException">
  4546. The current <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/> instance doesn't allow
  4547. the header <paramref name="name"/>.
  4548. </exception>
  4549. </member>
  4550. <member name="M:WebSocketSharp.Net.WebHeaderCollection.Clear">
  4551. <summary>
  4552. Removes all headers from the collection.
  4553. </summary>
  4554. </member>
  4555. <member name="M:WebSocketSharp.Net.WebHeaderCollection.Get(System.Int32)">
  4556. <summary>
  4557. Get the value of the header at the specified <paramref name="index"/> in the collection.
  4558. </summary>
  4559. <returns>
  4560. A <see cref="T:System.String"/> that receives the value of the header.
  4561. </returns>
  4562. <param name="index">
  4563. An <see cref="T:System.Int32"/> that represents the zero-based index of the header to find.
  4564. </param>
  4565. <exception cref="T:System.ArgumentOutOfRangeException">
  4566. <paramref name="index"/> is out of allowable range of indexes for the collection.
  4567. </exception>
  4568. </member>
  4569. <member name="M:WebSocketSharp.Net.WebHeaderCollection.Get(System.String)">
  4570. <summary>
  4571. Get the value of the header with the specified <paramref name="name"/> in the collection.
  4572. </summary>
  4573. <returns>
  4574. A <see cref="T:System.String"/> that receives the value of the header if found;
  4575. otherwise, <see langword="null"/>.
  4576. </returns>
  4577. <param name="name">
  4578. A <see cref="T:System.String"/> that represents the name of the header to find.
  4579. </param>
  4580. </member>
  4581. <member name="M:WebSocketSharp.Net.WebHeaderCollection.GetEnumerator">
  4582. <summary>
  4583. Gets the enumerator used to iterate through the collection.
  4584. </summary>
  4585. <returns>
  4586. An <see cref="T:System.Collections.IEnumerator"/> instance used to iterate through the collection.
  4587. </returns>
  4588. </member>
  4589. <member name="M:WebSocketSharp.Net.WebHeaderCollection.GetKey(System.Int32)">
  4590. <summary>
  4591. Get the name of the header at the specified <paramref name="index"/> in the collection.
  4592. </summary>
  4593. <returns>
  4594. A <see cref="T:System.String"/> that receives the header name.
  4595. </returns>
  4596. <param name="index">
  4597. An <see cref="T:System.Int32"/> that represents the zero-based index of the header to find.
  4598. </param>
  4599. <exception cref="T:System.ArgumentOutOfRangeException">
  4600. <paramref name="index"/> is out of allowable range of indexes for the collection.
  4601. </exception>
  4602. </member>
  4603. <member name="M:WebSocketSharp.Net.WebHeaderCollection.GetValues(System.Int32)">
  4604. <summary>
  4605. Gets an array of header values stored in the specified <paramref name="index"/> position of
  4606. the collection.
  4607. </summary>
  4608. <returns>
  4609. An array of <see cref="T:System.String"/> that receives the header values if found;
  4610. otherwise, <see langword="null"/>.
  4611. </returns>
  4612. <param name="index">
  4613. An <see cref="T:System.Int32"/> that represents the zero-based index of the header to find.
  4614. </param>
  4615. <exception cref="T:System.ArgumentOutOfRangeException">
  4616. <paramref name="index"/> is out of allowable range of indexes for the collection.
  4617. </exception>
  4618. </member>
  4619. <member name="M:WebSocketSharp.Net.WebHeaderCollection.GetValues(System.String)">
  4620. <summary>
  4621. Gets an array of header values stored in the specified <paramref name="header"/>.
  4622. </summary>
  4623. <returns>
  4624. An array of <see cref="T:System.String"/> that receives the header values if found;
  4625. otherwise, <see langword="null"/>.
  4626. </returns>
  4627. <param name="header">
  4628. A <see cref="T:System.String"/> that represents the name of the header to find.
  4629. </param>
  4630. </member>
  4631. <member name="M:WebSocketSharp.Net.WebHeaderCollection.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  4632. <summary>
  4633. Populates the specified <see cref="T:System.Runtime.Serialization.SerializationInfo"/> with the data needed to serialize
  4634. the <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/>.
  4635. </summary>
  4636. <param name="serializationInfo">
  4637. A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data.
  4638. </param>
  4639. <param name="streamingContext">
  4640. A <see cref="T:System.Runtime.Serialization.StreamingContext"/> that specifies the destination for the serialization.
  4641. </param>
  4642. <exception cref="T:System.ArgumentNullException">
  4643. <paramref name="serializationInfo"/> is <see langword="null"/>.
  4644. </exception>
  4645. </member>
  4646. <member name="M:WebSocketSharp.Net.WebHeaderCollection.IsRestricted(System.String)">
  4647. <summary>
  4648. Determines whether the specified header can be set for the request.
  4649. </summary>
  4650. <returns>
  4651. <c>true</c> if the header is restricted; otherwise, <c>false</c>.
  4652. </returns>
  4653. <param name="headerName">
  4654. A <see cref="T:System.String"/> that represents the name of the header to test.
  4655. </param>
  4656. <exception cref="T:System.ArgumentNullException">
  4657. <paramref name="headerName"/> is <see langword="null"/> or empty.
  4658. </exception>
  4659. <exception cref="T:System.ArgumentException">
  4660. <paramref name="headerName"/> contains invalid characters.
  4661. </exception>
  4662. </member>
  4663. <member name="M:WebSocketSharp.Net.WebHeaderCollection.IsRestricted(System.String,System.Boolean)">
  4664. <summary>
  4665. Determines whether the specified header can be set for the request or the response.
  4666. </summary>
  4667. <returns>
  4668. <c>true</c> if the header is restricted; otherwise, <c>false</c>.
  4669. </returns>
  4670. <param name="headerName">
  4671. A <see cref="T:System.String"/> that represents the name of the header to test.
  4672. </param>
  4673. <param name="response">
  4674. <c>true</c> if does the test for the response; for the request, <c>false</c>.
  4675. </param>
  4676. <exception cref="T:System.ArgumentNullException">
  4677. <paramref name="headerName"/> is <see langword="null"/> or empty.
  4678. </exception>
  4679. <exception cref="T:System.ArgumentException">
  4680. <paramref name="headerName"/> contains invalid characters.
  4681. </exception>
  4682. </member>
  4683. <member name="M:WebSocketSharp.Net.WebHeaderCollection.OnDeserialization(System.Object)">
  4684. <summary>
  4685. Implements the <see cref="T:System.Runtime.Serialization.ISerializable"/> interface and raises the deserialization event
  4686. when the deserialization is complete.
  4687. </summary>
  4688. <param name="sender">
  4689. An <see cref="T:System.Object"/> that represents the source of the deserialization event.
  4690. </param>
  4691. </member>
  4692. <member name="M:WebSocketSharp.Net.WebHeaderCollection.Remove(WebSocketSharp.Net.HttpRequestHeader)">
  4693. <summary>
  4694. Removes the specified request <paramref name="header"/> from the collection.
  4695. </summary>
  4696. <param name="header">
  4697. One of the <see cref="T:WebSocketSharp.Net.HttpRequestHeader"/> enum values, represents
  4698. the request header to remove.
  4699. </param>
  4700. <exception cref="T:System.ArgumentException">
  4701. <paramref name="header"/> is a restricted header.
  4702. </exception>
  4703. <exception cref="T:System.InvalidOperationException">
  4704. The current <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/> instance doesn't allow
  4705. the request <paramref name="header"/>.
  4706. </exception>
  4707. </member>
  4708. <member name="M:WebSocketSharp.Net.WebHeaderCollection.Remove(WebSocketSharp.Net.HttpResponseHeader)">
  4709. <summary>
  4710. Removes the specified response <paramref name="header"/> from the collection.
  4711. </summary>
  4712. <param name="header">
  4713. One of the <see cref="T:WebSocketSharp.Net.HttpResponseHeader"/> enum values, represents
  4714. the response header to remove.
  4715. </param>
  4716. <exception cref="T:System.ArgumentException">
  4717. <paramref name="header"/> is a restricted header.
  4718. </exception>
  4719. <exception cref="T:System.InvalidOperationException">
  4720. The current <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/> instance doesn't allow
  4721. the response <paramref name="header"/>.
  4722. </exception>
  4723. </member>
  4724. <member name="M:WebSocketSharp.Net.WebHeaderCollection.Remove(System.String)">
  4725. <summary>
  4726. Removes the specified header from the collection.
  4727. </summary>
  4728. <param name="name">
  4729. A <see cref="T:System.String"/> that represents the name of the header to remove.
  4730. </param>
  4731. <exception cref="T:System.ArgumentNullException">
  4732. <paramref name="name"/> is <see langword="null"/> or empty.
  4733. </exception>
  4734. <exception cref="T:System.ArgumentException">
  4735. <para>
  4736. <paramref name="name"/> contains invalid characters.
  4737. </para>
  4738. <para>
  4739. -or-
  4740. </para>
  4741. <para>
  4742. <paramref name="name"/> is a restricted header name.
  4743. </para>
  4744. </exception>
  4745. <exception cref="T:System.InvalidOperationException">
  4746. The current <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/> instance doesn't allow
  4747. the header <paramref name="name"/>.
  4748. </exception>
  4749. </member>
  4750. <member name="M:WebSocketSharp.Net.WebHeaderCollection.Set(WebSocketSharp.Net.HttpRequestHeader,System.String)">
  4751. <summary>
  4752. Sets the specified request <paramref name="header"/> to the specified value.
  4753. </summary>
  4754. <param name="header">
  4755. One of the <see cref="T:WebSocketSharp.Net.HttpRequestHeader"/> enum values, represents
  4756. the request header to set.
  4757. </param>
  4758. <param name="value">
  4759. A <see cref="T:System.String"/> that represents the value of the request header to set.
  4760. </param>
  4761. <exception cref="T:System.ArgumentException">
  4762. <para>
  4763. <paramref name="header"/> is a restricted header.
  4764. </para>
  4765. <para>
  4766. -or-
  4767. </para>
  4768. <para>
  4769. <paramref name="value"/> contains invalid characters.
  4770. </para>
  4771. </exception>
  4772. <exception cref="T:System.ArgumentOutOfRangeException">
  4773. The length of <paramref name="value"/> is greater than 65,535 characters.
  4774. </exception>
  4775. <exception cref="T:System.InvalidOperationException">
  4776. The current <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/> instance doesn't allow
  4777. the request <paramref name="header"/>.
  4778. </exception>
  4779. </member>
  4780. <member name="M:WebSocketSharp.Net.WebHeaderCollection.Set(WebSocketSharp.Net.HttpResponseHeader,System.String)">
  4781. <summary>
  4782. Sets the specified response <paramref name="header"/> to the specified value.
  4783. </summary>
  4784. <param name="header">
  4785. One of the <see cref="T:WebSocketSharp.Net.HttpResponseHeader"/> enum values, represents
  4786. the response header to set.
  4787. </param>
  4788. <param name="value">
  4789. A <see cref="T:System.String"/> that represents the value of the response header to set.
  4790. </param>
  4791. <exception cref="T:System.ArgumentException">
  4792. <para>
  4793. <paramref name="header"/> is a restricted header.
  4794. </para>
  4795. <para>
  4796. -or-
  4797. </para>
  4798. <para>
  4799. <paramref name="value"/> contains invalid characters.
  4800. </para>
  4801. </exception>
  4802. <exception cref="T:System.ArgumentOutOfRangeException">
  4803. The length of <paramref name="value"/> is greater than 65,535 characters.
  4804. </exception>
  4805. <exception cref="T:System.InvalidOperationException">
  4806. The current <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/> instance doesn't allow
  4807. the response <paramref name="header"/>.
  4808. </exception>
  4809. </member>
  4810. <member name="M:WebSocketSharp.Net.WebHeaderCollection.Set(System.String,System.String)">
  4811. <summary>
  4812. Sets the specified header to the specified value.
  4813. </summary>
  4814. <param name="name">
  4815. A <see cref="T:System.String"/> that represents the name of the header to set.
  4816. </param>
  4817. <param name="value">
  4818. A <see cref="T:System.String"/> that represents the value of the header to set.
  4819. </param>
  4820. <exception cref="T:System.ArgumentNullException">
  4821. <paramref name="name"/> is <see langword="null"/> or empty.
  4822. </exception>
  4823. <exception cref="T:System.ArgumentException">
  4824. <para>
  4825. <paramref name="name"/> or <paramref name="value"/> contains invalid characters.
  4826. </para>
  4827. <para>
  4828. -or-
  4829. </para>
  4830. <para>
  4831. <paramref name="name"/> is a restricted header name.
  4832. </para>
  4833. </exception>
  4834. <exception cref="T:System.ArgumentOutOfRangeException">
  4835. The length of <paramref name="value"/> is greater than 65,535 characters.
  4836. </exception>
  4837. <exception cref="T:System.InvalidOperationException">
  4838. The current <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/> instance doesn't allow
  4839. the header <paramref name="name"/>.
  4840. </exception>
  4841. </member>
  4842. <member name="M:WebSocketSharp.Net.WebHeaderCollection.ToByteArray">
  4843. <summary>
  4844. Converts the current <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/> to an array of <see cref="T:System.Byte"/>.
  4845. </summary>
  4846. <returns>
  4847. An array of <see cref="T:System.Byte"/> that receives the converted current
  4848. <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/>.
  4849. </returns>
  4850. </member>
  4851. <member name="M:WebSocketSharp.Net.WebHeaderCollection.ToString">
  4852. <summary>
  4853. Returns a <see cref="T:System.String"/> that represents the current
  4854. <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/>.
  4855. </summary>
  4856. <returns>
  4857. A <see cref="T:System.String"/> that represents the current <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/>.
  4858. </returns>
  4859. </member>
  4860. <member name="M:WebSocketSharp.Net.WebHeaderCollection.System#Runtime#Serialization#ISerializable#GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  4861. <summary>
  4862. Populates the specified <see cref="T:System.Runtime.Serialization.SerializationInfo"/> with the data needed to serialize
  4863. the current <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/>.
  4864. </summary>
  4865. <param name="serializationInfo">
  4866. A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data.
  4867. </param>
  4868. <param name="streamingContext">
  4869. A <see cref="T:System.Runtime.Serialization.StreamingContext"/> that specifies the destination for the serialization.
  4870. </param>
  4871. <exception cref="T:System.ArgumentNullException">
  4872. <paramref name="serializationInfo"/> is <see langword="null"/>.
  4873. </exception>
  4874. </member>
  4875. <member name="T:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext">
  4876. <summary>
  4877. Provides the properties used to access the information in
  4878. a WebSocket handshake request received by the <see cref="T:WebSocketSharp.Net.HttpListener"/>.
  4879. </summary>
  4880. </member>
  4881. <member name="P:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext.CookieCollection">
  4882. <summary>
  4883. Gets the HTTP cookies included in the request.
  4884. </summary>
  4885. <value>
  4886. A <see cref="T:WebSocketSharp.Net.CookieCollection"/> that contains the cookies.
  4887. </value>
  4888. </member>
  4889. <member name="P:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext.Headers">
  4890. <summary>
  4891. Gets the HTTP headers included in the request.
  4892. </summary>
  4893. <value>
  4894. A <see cref="T:System.Collections.Specialized.NameValueCollection"/> that contains the headers.
  4895. </value>
  4896. </member>
  4897. <member name="P:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext.Host">
  4898. <summary>
  4899. Gets the value of the Host header included in the request.
  4900. </summary>
  4901. <value>
  4902. A <see cref="T:System.String"/> that represents the value of the Host header.
  4903. </value>
  4904. </member>
  4905. <member name="P:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext.IsAuthenticated">
  4906. <summary>
  4907. Gets a value indicating whether the client is authenticated.
  4908. </summary>
  4909. <value>
  4910. <c>true</c> if the client is authenticated; otherwise, <c>false</c>.
  4911. </value>
  4912. </member>
  4913. <member name="P:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext.IsLocal">
  4914. <summary>
  4915. Gets a value indicating whether the client connected from the local computer.
  4916. </summary>
  4917. <value>
  4918. <c>true</c> if the client connected from the local computer; otherwise, <c>false</c>.
  4919. </value>
  4920. </member>
  4921. <member name="P:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext.IsSecureConnection">
  4922. <summary>
  4923. Gets a value indicating whether the WebSocket connection is secured.
  4924. </summary>
  4925. <value>
  4926. <c>true</c> if the connection is secured; otherwise, <c>false</c>.
  4927. </value>
  4928. </member>
  4929. <member name="P:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext.IsWebSocketRequest">
  4930. <summary>
  4931. Gets a value indicating whether the request is a WebSocket handshake request.
  4932. </summary>
  4933. <value>
  4934. <c>true</c> if the request is a WebSocket handshake request; otherwise, <c>false</c>.
  4935. </value>
  4936. </member>
  4937. <member name="P:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext.Origin">
  4938. <summary>
  4939. Gets the value of the Origin header included in the request.
  4940. </summary>
  4941. <value>
  4942. A <see cref="T:System.String"/> that represents the value of the Origin header.
  4943. </value>
  4944. </member>
  4945. <member name="P:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext.QueryString">
  4946. <summary>
  4947. Gets the query string included in the request.
  4948. </summary>
  4949. <value>
  4950. A <see cref="T:System.Collections.Specialized.NameValueCollection"/> that contains the query string parameters.
  4951. </value>
  4952. </member>
  4953. <member name="P:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext.RequestUri">
  4954. <summary>
  4955. Gets the URI requested by the client.
  4956. </summary>
  4957. <value>
  4958. A <see cref="T:System.Uri"/> that represents the requested URI.
  4959. </value>
  4960. </member>
  4961. <member name="P:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext.SecWebSocketKey">
  4962. <summary>
  4963. Gets the value of the Sec-WebSocket-Key header included in the request.
  4964. </summary>
  4965. <remarks>
  4966. This property provides a part of the information used by the server to prove that
  4967. it received a valid WebSocket handshake request.
  4968. </remarks>
  4969. <value>
  4970. A <see cref="T:System.String"/> that represents the value of the Sec-WebSocket-Key header.
  4971. </value>
  4972. </member>
  4973. <member name="P:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext.SecWebSocketProtocols">
  4974. <summary>
  4975. Gets the values of the Sec-WebSocket-Protocol header included in the request.
  4976. </summary>
  4977. <remarks>
  4978. This property represents the subprotocols requested by the client.
  4979. </remarks>
  4980. <value>
  4981. An <see cref="T:System.Collections.Generic.IEnumerable{string}"/> instance that provides
  4982. an enumerator which supports the iteration over the values of the Sec-WebSocket-Protocol
  4983. header.
  4984. </value>
  4985. </member>
  4986. <member name="P:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext.SecWebSocketVersion">
  4987. <summary>
  4988. Gets the value of the Sec-WebSocket-Version header included in the request.
  4989. </summary>
  4990. <remarks>
  4991. This property represents the WebSocket protocol version.
  4992. </remarks>
  4993. <value>
  4994. A <see cref="T:System.String"/> that represents the value of the Sec-WebSocket-Version header.
  4995. </value>
  4996. </member>
  4997. <member name="P:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext.ServerEndPoint">
  4998. <summary>
  4999. Gets the server endpoint as an IP address and a port number.
  5000. </summary>
  5001. <value>
  5002. A <see cref="T:System.Net.IPEndPoint"/> that represents the server endpoint.
  5003. </value>
  5004. </member>
  5005. <member name="P:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext.User">
  5006. <summary>
  5007. Gets the client information (identity, authentication, and security roles).
  5008. </summary>
  5009. <value>
  5010. A <see cref="T:System.Security.Principal.IPrincipal"/> instance that represents the client information.
  5011. </value>
  5012. </member>
  5013. <member name="P:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext.UserEndPoint">
  5014. <summary>
  5015. Gets the client endpoint as an IP address and a port number.
  5016. </summary>
  5017. <value>
  5018. A <see cref="T:System.Net.IPEndPoint"/> that represents the client endpoint.
  5019. </value>
  5020. </member>
  5021. <member name="P:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext.WebSocket">
  5022. <summary>
  5023. Gets the <see cref="T:WebSocketSharp.WebSocket"/> instance used for
  5024. two-way communication between client and server.
  5025. </summary>
  5026. <value>
  5027. A <see cref="T:WebSocketSharp.WebSocket"/>.
  5028. </value>
  5029. </member>
  5030. <member name="M:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext.ToString">
  5031. <summary>
  5032. Returns a <see cref="T:System.String"/> that represents
  5033. the current <see cref="T:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext"/>.
  5034. </summary>
  5035. <returns>
  5036. A <see cref="T:System.String"/> that represents
  5037. the current <see cref="T:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext"/>.
  5038. </returns>
  5039. </member>
  5040. <member name="T:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext">
  5041. <summary>
  5042. Provides the properties used to access the information in
  5043. a WebSocket handshake request received by the <see cref="T:System.Net.Sockets.TcpListener"/>.
  5044. </summary>
  5045. </member>
  5046. <member name="P:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext.CookieCollection">
  5047. <summary>
  5048. Gets the HTTP cookies included in the request.
  5049. </summary>
  5050. <value>
  5051. A <see cref="T:WebSocketSharp.Net.CookieCollection"/> that contains the cookies.
  5052. </value>
  5053. </member>
  5054. <member name="P:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext.Headers">
  5055. <summary>
  5056. Gets the HTTP headers included in the request.
  5057. </summary>
  5058. <value>
  5059. A <see cref="T:System.Collections.Specialized.NameValueCollection"/> that contains the headers.
  5060. </value>
  5061. </member>
  5062. <member name="P:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext.Host">
  5063. <summary>
  5064. Gets the value of the Host header included in the request.
  5065. </summary>
  5066. <value>
  5067. A <see cref="T:System.String"/> that represents the value of the Host header.
  5068. </value>
  5069. </member>
  5070. <member name="P:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext.IsAuthenticated">
  5071. <summary>
  5072. Gets a value indicating whether the client is authenticated.
  5073. </summary>
  5074. <value>
  5075. <c>true</c> if the client is authenticated; otherwise, <c>false</c>.
  5076. </value>
  5077. </member>
  5078. <member name="P:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext.IsLocal">
  5079. <summary>
  5080. Gets a value indicating whether the client connected from the local computer.
  5081. </summary>
  5082. <value>
  5083. <c>true</c> if the client connected from the local computer; otherwise, <c>false</c>.
  5084. </value>
  5085. </member>
  5086. <member name="P:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext.IsSecureConnection">
  5087. <summary>
  5088. Gets a value indicating whether the WebSocket connection is secured.
  5089. </summary>
  5090. <value>
  5091. <c>true</c> if the connection is secured; otherwise, <c>false</c>.
  5092. </value>
  5093. </member>
  5094. <member name="P:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext.IsWebSocketRequest">
  5095. <summary>
  5096. Gets a value indicating whether the request is a WebSocket handshake request.
  5097. </summary>
  5098. <value>
  5099. <c>true</c> if the request is a WebSocket handshake request; otherwise, <c>false</c>.
  5100. </value>
  5101. </member>
  5102. <member name="P:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext.Origin">
  5103. <summary>
  5104. Gets the value of the Origin header included in the request.
  5105. </summary>
  5106. <value>
  5107. A <see cref="T:System.String"/> that represents the value of the Origin header.
  5108. </value>
  5109. </member>
  5110. <member name="P:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext.QueryString">
  5111. <summary>
  5112. Gets the query string included in the request.
  5113. </summary>
  5114. <value>
  5115. A <see cref="T:System.Collections.Specialized.NameValueCollection"/> that contains the query string parameters.
  5116. </value>
  5117. </member>
  5118. <member name="P:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext.RequestUri">
  5119. <summary>
  5120. Gets the URI requested by the client.
  5121. </summary>
  5122. <value>
  5123. A <see cref="T:System.Uri"/> that represents the requested URI.
  5124. </value>
  5125. </member>
  5126. <member name="P:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext.SecWebSocketKey">
  5127. <summary>
  5128. Gets the value of the Sec-WebSocket-Key header included in the request.
  5129. </summary>
  5130. <remarks>
  5131. This property provides a part of the information used by the server to prove that
  5132. it received a valid WebSocket handshake request.
  5133. </remarks>
  5134. <value>
  5135. A <see cref="T:System.String"/> that represents the value of the Sec-WebSocket-Key header.
  5136. </value>
  5137. </member>
  5138. <member name="P:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext.SecWebSocketProtocols">
  5139. <summary>
  5140. Gets the values of the Sec-WebSocket-Protocol header included in the request.
  5141. </summary>
  5142. <remarks>
  5143. This property represents the subprotocols requested by the client.
  5144. </remarks>
  5145. <value>
  5146. An <see cref="T:System.Collections.Generic.IEnumerable{string}"/> instance that provides
  5147. an enumerator which supports the iteration over the values of the Sec-WebSocket-Protocol
  5148. header.
  5149. </value>
  5150. </member>
  5151. <member name="P:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext.SecWebSocketVersion">
  5152. <summary>
  5153. Gets the value of the Sec-WebSocket-Version header included in the request.
  5154. </summary>
  5155. <remarks>
  5156. This property represents the WebSocket protocol version.
  5157. </remarks>
  5158. <value>
  5159. A <see cref="T:System.String"/> that represents the value of the Sec-WebSocket-Version header.
  5160. </value>
  5161. </member>
  5162. <member name="P:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext.ServerEndPoint">
  5163. <summary>
  5164. Gets the server endpoint as an IP address and a port number.
  5165. </summary>
  5166. <value>
  5167. A <see cref="T:System.Net.IPEndPoint"/> that represents the server endpoint.
  5168. </value>
  5169. </member>
  5170. <member name="P:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext.User">
  5171. <summary>
  5172. Gets the client information (identity, authentication, and security roles).
  5173. </summary>
  5174. <value>
  5175. A <see cref="T:System.Security.Principal.IPrincipal"/> instance that represents the client information.
  5176. </value>
  5177. </member>
  5178. <member name="P:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext.UserEndPoint">
  5179. <summary>
  5180. Gets the client endpoint as an IP address and a port number.
  5181. </summary>
  5182. <value>
  5183. A <see cref="T:System.Net.IPEndPoint"/> that represents the client endpoint.
  5184. </value>
  5185. </member>
  5186. <member name="P:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext.WebSocket">
  5187. <summary>
  5188. Gets the <see cref="T:WebSocketSharp.WebSocket"/> instance used for
  5189. two-way communication between client and server.
  5190. </summary>
  5191. <value>
  5192. A <see cref="T:WebSocketSharp.WebSocket"/>.
  5193. </value>
  5194. </member>
  5195. <member name="M:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext.ToString">
  5196. <summary>
  5197. Returns a <see cref="T:System.String"/> that represents
  5198. the current <see cref="T:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext"/>.
  5199. </summary>
  5200. <returns>
  5201. A <see cref="T:System.String"/> that represents
  5202. the current <see cref="T:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext"/>.
  5203. </returns>
  5204. </member>
  5205. <member name="T:WebSocketSharp.Net.WebSockets.WebSocketContext">
  5206. <summary>
  5207. Exposes the properties used to access the information in a WebSocket handshake request.
  5208. </summary>
  5209. <remarks>
  5210. This class is an abstract class.
  5211. </remarks>
  5212. </member>
  5213. <member name="M:WebSocketSharp.Net.WebSockets.WebSocketContext.#ctor">
  5214. <summary>
  5215. Initializes a new instance of the <see cref="T:WebSocketSharp.Net.WebSockets.WebSocketContext"/> class.
  5216. </summary>
  5217. </member>
  5218. <member name="P:WebSocketSharp.Net.WebSockets.WebSocketContext.CookieCollection">
  5219. <summary>
  5220. Gets the HTTP cookies included in the request.
  5221. </summary>
  5222. <value>
  5223. A <see cref="T:WebSocketSharp.Net.CookieCollection"/> that contains the cookies.
  5224. </value>
  5225. </member>
  5226. <member name="P:WebSocketSharp.Net.WebSockets.WebSocketContext.Headers">
  5227. <summary>
  5228. Gets the HTTP headers included in the request.
  5229. </summary>
  5230. <value>
  5231. A <see cref="T:System.Collections.Specialized.NameValueCollection"/> that contains the headers.
  5232. </value>
  5233. </member>
  5234. <member name="P:WebSocketSharp.Net.WebSockets.WebSocketContext.Host">
  5235. <summary>
  5236. Gets the value of the Host header included in the request.
  5237. </summary>
  5238. <value>
  5239. A <see cref="T:System.String"/> that represents the value of the Host header.
  5240. </value>
  5241. </member>
  5242. <member name="P:WebSocketSharp.Net.WebSockets.WebSocketContext.IsAuthenticated">
  5243. <summary>
  5244. Gets a value indicating whether the client is authenticated.
  5245. </summary>
  5246. <value>
  5247. <c>true</c> if the client is authenticated; otherwise, <c>false</c>.
  5248. </value>
  5249. </member>
  5250. <member name="P:WebSocketSharp.Net.WebSockets.WebSocketContext.IsLocal">
  5251. <summary>
  5252. Gets a value indicating whether the client connected from the local computer.
  5253. </summary>
  5254. <value>
  5255. <c>true</c> if the client connected from the local computer; otherwise, <c>false</c>.
  5256. </value>
  5257. </member>
  5258. <member name="P:WebSocketSharp.Net.WebSockets.WebSocketContext.IsSecureConnection">
  5259. <summary>
  5260. Gets a value indicating whether the WebSocket connection is secured.
  5261. </summary>
  5262. <value>
  5263. <c>true</c> if the connection is secured; otherwise, <c>false</c>.
  5264. </value>
  5265. </member>
  5266. <member name="P:WebSocketSharp.Net.WebSockets.WebSocketContext.IsWebSocketRequest">
  5267. <summary>
  5268. Gets a value indicating whether the request is a WebSocket handshake request.
  5269. </summary>
  5270. <value>
  5271. <c>true</c> if the request is a WebSocket handshake request; otherwise, <c>false</c>.
  5272. </value>
  5273. </member>
  5274. <member name="P:WebSocketSharp.Net.WebSockets.WebSocketContext.Origin">
  5275. <summary>
  5276. Gets the value of the Origin header included in the request.
  5277. </summary>
  5278. <value>
  5279. A <see cref="T:System.String"/> that represents the value of the Origin header.
  5280. </value>
  5281. </member>
  5282. <member name="P:WebSocketSharp.Net.WebSockets.WebSocketContext.QueryString">
  5283. <summary>
  5284. Gets the query string included in the request.
  5285. </summary>
  5286. <value>
  5287. A <see cref="T:System.Collections.Specialized.NameValueCollection"/> that contains the query string parameters.
  5288. </value>
  5289. </member>
  5290. <member name="P:WebSocketSharp.Net.WebSockets.WebSocketContext.RequestUri">
  5291. <summary>
  5292. Gets the URI requested by the client.
  5293. </summary>
  5294. <value>
  5295. A <see cref="T:System.Uri"/> that represents the requested URI.
  5296. </value>
  5297. </member>
  5298. <member name="P:WebSocketSharp.Net.WebSockets.WebSocketContext.SecWebSocketKey">
  5299. <summary>
  5300. Gets the value of the Sec-WebSocket-Key header included in the request.
  5301. </summary>
  5302. <remarks>
  5303. This property provides a part of the information used by the server to prove that
  5304. it received a valid WebSocket handshake request.
  5305. </remarks>
  5306. <value>
  5307. A <see cref="T:System.String"/> that represents the value of the Sec-WebSocket-Key header.
  5308. </value>
  5309. </member>
  5310. <member name="P:WebSocketSharp.Net.WebSockets.WebSocketContext.SecWebSocketProtocols">
  5311. <summary>
  5312. Gets the values of the Sec-WebSocket-Protocol header included in the request.
  5313. </summary>
  5314. <remarks>
  5315. This property represents the subprotocols requested by the client.
  5316. </remarks>
  5317. <value>
  5318. An <see cref="T:System.Collections.Generic.IEnumerable{string}"/> instance that provides
  5319. an enumerator which supports the iteration over the values of the Sec-WebSocket-Protocol
  5320. header.
  5321. </value>
  5322. </member>
  5323. <member name="P:WebSocketSharp.Net.WebSockets.WebSocketContext.SecWebSocketVersion">
  5324. <summary>
  5325. Gets the value of the Sec-WebSocket-Version header included in the request.
  5326. </summary>
  5327. <remarks>
  5328. This property represents the WebSocket protocol version.
  5329. </remarks>
  5330. <value>
  5331. A <see cref="T:System.String"/> that represents the value of the Sec-WebSocket-Version header.
  5332. </value>
  5333. </member>
  5334. <member name="P:WebSocketSharp.Net.WebSockets.WebSocketContext.ServerEndPoint">
  5335. <summary>
  5336. Gets the server endpoint as an IP address and a port number.
  5337. </summary>
  5338. <value>
  5339. A <see cref="T:System.Net.IPEndPoint"/> that represents the server endpoint.
  5340. </value>
  5341. </member>
  5342. <member name="P:WebSocketSharp.Net.WebSockets.WebSocketContext.User">
  5343. <summary>
  5344. Gets the client information (identity, authentication, and security roles).
  5345. </summary>
  5346. <value>
  5347. A <see cref="T:System.Security.Principal.IPrincipal"/> instance that represents the client information.
  5348. </value>
  5349. </member>
  5350. <member name="P:WebSocketSharp.Net.WebSockets.WebSocketContext.UserEndPoint">
  5351. <summary>
  5352. Gets the client endpoint as an IP address and a port number.
  5353. </summary>
  5354. <value>
  5355. A <see cref="T:System.Net.IPEndPoint"/> that represents the client endpoint.
  5356. </value>
  5357. </member>
  5358. <member name="P:WebSocketSharp.Net.WebSockets.WebSocketContext.WebSocket">
  5359. <summary>
  5360. Gets the <see cref="T:WebSocketSharp.WebSocket"/> instance used for
  5361. two-way communication between client and server.
  5362. </summary>
  5363. <value>
  5364. A <see cref="T:WebSocketSharp.WebSocket"/>.
  5365. </value>
  5366. </member>
  5367. <member name="T:WebSocketSharp.Opcode">
  5368. <summary>
  5369. Indicates the WebSocket frame type.
  5370. </summary>
  5371. <remarks>
  5372. The values of this enumeration are defined in
  5373. <see href="http://tools.ietf.org/html/rfc6455#section-5.2">
  5374. Section 5.2</see> of RFC 6455.
  5375. </remarks>
  5376. </member>
  5377. <member name="F:WebSocketSharp.Opcode.Cont">
  5378. <summary>
  5379. Equivalent to numeric value 0. Indicates continuation frame.
  5380. </summary>
  5381. </member>
  5382. <member name="F:WebSocketSharp.Opcode.Text">
  5383. <summary>
  5384. Equivalent to numeric value 1. Indicates text frame.
  5385. </summary>
  5386. </member>
  5387. <member name="F:WebSocketSharp.Opcode.Binary">
  5388. <summary>
  5389. Equivalent to numeric value 2. Indicates binary frame.
  5390. </summary>
  5391. </member>
  5392. <member name="F:WebSocketSharp.Opcode.Close">
  5393. <summary>
  5394. Equivalent to numeric value 8. Indicates connection close frame.
  5395. </summary>
  5396. </member>
  5397. <member name="F:WebSocketSharp.Opcode.Ping">
  5398. <summary>
  5399. Equivalent to numeric value 9. Indicates ping frame.
  5400. </summary>
  5401. </member>
  5402. <member name="F:WebSocketSharp.Opcode.Pong">
  5403. <summary>
  5404. Equivalent to numeric value 10. Indicates pong frame.
  5405. </summary>
  5406. </member>
  5407. <member name="F:WebSocketSharp.PayloadData.Empty">
  5408. <summary>
  5409. Represents the empty payload data.
  5410. </summary>
  5411. </member>
  5412. <member name="F:WebSocketSharp.PayloadData.MaxLength">
  5413. <summary>
  5414. Represents the allowable max length.
  5415. </summary>
  5416. <remarks>
  5417. <para>
  5418. A <see cref="T:WebSocketSharp.WebSocketException"/> will occur if the payload data length is
  5419. greater than the value of this field.
  5420. </para>
  5421. <para>
  5422. If you would like to change the value, you must set it to a value between
  5423. <c>WebSocket.FragmentLength</c> and <c>Int64.MaxValue</c> inclusive.
  5424. </para>
  5425. </remarks>
  5426. </member>
  5427. <member name="T:WebSocketSharp.Rsv">
  5428. <summary>
  5429. Indicates whether each RSV (RSV1, RSV2, and RSV3) of a WebSocket frame is non-zero.
  5430. </summary>
  5431. <remarks>
  5432. The values of this enumeration are defined in
  5433. <see href="http://tools.ietf.org/html/rfc6455#section-5.2">Section 5.2</see> of RFC 6455.
  5434. </remarks>
  5435. </member>
  5436. <member name="F:WebSocketSharp.Rsv.Off">
  5437. <summary>
  5438. Equivalent to numeric value 0. Indicates zero.
  5439. </summary>
  5440. </member>
  5441. <member name="F:WebSocketSharp.Rsv.On">
  5442. <summary>
  5443. Equivalent to numeric value 1. Indicates non-zero.
  5444. </summary>
  5445. </member>
  5446. <member name="T:WebSocketSharp.Server.HttpRequestEventArgs">
  5447. <summary>
  5448. Represents the event data for the HTTP request events of
  5449. the <see cref="T:WebSocketSharp.Server.HttpServer"/>.
  5450. </summary>
  5451. <remarks>
  5452. <para>
  5453. An HTTP request event occurs when the <see cref="T:WebSocketSharp.Server.HttpServer"/>
  5454. receives an HTTP request.
  5455. </para>
  5456. <para>
  5457. You should access the <see cref="P:WebSocketSharp.Server.HttpRequestEventArgs.Request"/> property if you would
  5458. like to get the request data sent from a client.
  5459. </para>
  5460. <para>
  5461. And you should access the <see cref="P:WebSocketSharp.Server.HttpRequestEventArgs.Response"/> property if you would
  5462. like to get the response data to return to the client.
  5463. </para>
  5464. </remarks>
  5465. </member>
  5466. <member name="P:WebSocketSharp.Server.HttpRequestEventArgs.Request">
  5467. <summary>
  5468. Gets the request data sent from a client.
  5469. </summary>
  5470. <value>
  5471. A <see cref="T:WebSocketSharp.Net.HttpListenerRequest"/> that provides the methods and
  5472. properties for the request data.
  5473. </value>
  5474. </member>
  5475. <member name="P:WebSocketSharp.Server.HttpRequestEventArgs.Response">
  5476. <summary>
  5477. Gets the response data to return to the client.
  5478. </summary>
  5479. <value>
  5480. A <see cref="T:WebSocketSharp.Net.HttpListenerResponse"/> that provides the methods and
  5481. properties for the response data.
  5482. </value>
  5483. </member>
  5484. <member name="P:WebSocketSharp.Server.HttpRequestEventArgs.User">
  5485. <summary>
  5486. Gets the information for the client.
  5487. </summary>
  5488. <value>
  5489. <para>
  5490. A <see cref="T:System.Security.Principal.IPrincipal"/> instance or <see langword="null"/>
  5491. if not authenticated.
  5492. </para>
  5493. <para>
  5494. That instance describes the identity, authentication scheme,
  5495. and security roles for the client.
  5496. </para>
  5497. </value>
  5498. </member>
  5499. <member name="M:WebSocketSharp.Server.HttpRequestEventArgs.ReadFile(System.String)">
  5500. <summary>
  5501. Reads the specified file from the document folder of
  5502. the <see cref="T:WebSocketSharp.Server.HttpServer"/>.
  5503. </summary>
  5504. <returns>
  5505. <para>
  5506. An array of <see cref="T:System.Byte"/> or <see langword="null"/>
  5507. if it fails.
  5508. </para>
  5509. <para>
  5510. That array receives the contents of the file.
  5511. </para>
  5512. </returns>
  5513. <param name="path">
  5514. A <see cref="T:System.String"/> that represents a virtual path to
  5515. find the file from the document folder.
  5516. </param>
  5517. <exception cref="T:System.ArgumentNullException">
  5518. <paramref name="path"/> is <see langword="null"/>.
  5519. </exception>
  5520. <exception cref="T:System.ArgumentException">
  5521. <para>
  5522. <paramref name="path"/> is an empty string.
  5523. </para>
  5524. <para>
  5525. -or-
  5526. </para>
  5527. <para>
  5528. <paramref name="path"/> contains "..".
  5529. </para>
  5530. </exception>
  5531. </member>
  5532. <member name="M:WebSocketSharp.Server.HttpRequestEventArgs.TryReadFile(System.String,System.Byte[]@)">
  5533. <summary>
  5534. Tries to read the specified file from the document folder of
  5535. the <see cref="T:WebSocketSharp.Server.HttpServer"/>.
  5536. </summary>
  5537. <returns>
  5538. <c>true</c> if it succeeds to read; otherwise, <c>false</c>.
  5539. </returns>
  5540. <param name="path">
  5541. A <see cref="T:System.String"/> that represents a virtual path to
  5542. find the file from the document folder.
  5543. </param>
  5544. <param name="contents">
  5545. <para>
  5546. When this method returns, an array of <see cref="T:System.Byte"/> or
  5547. <see langword="null"/> if it fails.
  5548. </para>
  5549. <para>
  5550. That array receives the contents of the file.
  5551. </para>
  5552. </param>
  5553. <exception cref="T:System.ArgumentNullException">
  5554. <paramref name="path"/> is <see langword="null"/>.
  5555. </exception>
  5556. <exception cref="T:System.ArgumentException">
  5557. <para>
  5558. <paramref name="path"/> is an empty string.
  5559. </para>
  5560. <para>
  5561. -or-
  5562. </para>
  5563. <para>
  5564. <paramref name="path"/> contains "..".
  5565. </para>
  5566. </exception>
  5567. </member>
  5568. <member name="T:WebSocketSharp.Server.HttpServer">
  5569. <summary>
  5570. Provides a simple HTTP server that allows to accept
  5571. WebSocket handshake requests.
  5572. </summary>
  5573. <remarks>
  5574. This class can provide multiple WebSocket services.
  5575. </remarks>
  5576. </member>
  5577. <member name="M:WebSocketSharp.Server.HttpServer.#ctor">
  5578. <summary>
  5579. Initializes a new instance of the <see cref="T:WebSocketSharp.Server.HttpServer"/> class.
  5580. </summary>
  5581. <remarks>
  5582. The new instance listens for incoming requests on
  5583. <see cref="F:System.Net.IPAddress.Any"/> and port 80.
  5584. </remarks>
  5585. </member>
  5586. <member name="M:WebSocketSharp.Server.HttpServer.#ctor(System.Int32)">
  5587. <summary>
  5588. Initializes a new instance of the <see cref="T:WebSocketSharp.Server.HttpServer"/> class with
  5589. the specified <paramref name="port"/>.
  5590. </summary>
  5591. <remarks>
  5592. <para>
  5593. The new instance listens for incoming requests on
  5594. <see cref="F:System.Net.IPAddress.Any"/> and <paramref name="port"/>.
  5595. </para>
  5596. <para>
  5597. It provides secure connections if <paramref name="port"/> is 443.
  5598. </para>
  5599. </remarks>
  5600. <param name="port">
  5601. An <see cref="T:System.Int32"/> that represents the number of the port
  5602. on which to listen.
  5603. </param>
  5604. <exception cref="T:System.ArgumentOutOfRangeException">
  5605. <paramref name="port"/> is less than 1 or greater than 65535.
  5606. </exception>
  5607. </member>
  5608. <member name="M:WebSocketSharp.Server.HttpServer.#ctor(System.String)">
  5609. <summary>
  5610. Initializes a new instance of the <see cref="T:WebSocketSharp.Server.HttpServer"/> class with
  5611. the specified <paramref name="url"/>.
  5612. </summary>
  5613. <remarks>
  5614. <para>
  5615. The new instance listens for incoming requests on the IP address of the
  5616. host of <paramref name="url"/> and the port of <paramref name="url"/>.
  5617. </para>
  5618. <para>
  5619. Either port 80 or 443 is used if <paramref name="url"/> includes
  5620. no port. Port 443 is used if the scheme of <paramref name="url"/>
  5621. is https; otherwise, port 80 is used.
  5622. </para>
  5623. <para>
  5624. The new instance provides secure connections if the scheme of
  5625. <paramref name="url"/> is https.
  5626. </para>
  5627. </remarks>
  5628. <param name="url">
  5629. A <see cref="T:System.String"/> that represents the HTTP URL of the server.
  5630. </param>
  5631. <exception cref="T:System.ArgumentNullException">
  5632. <paramref name="url"/> is <see langword="null"/>.
  5633. </exception>
  5634. <exception cref="T:System.ArgumentException">
  5635. <para>
  5636. <paramref name="url"/> is empty.
  5637. </para>
  5638. <para>
  5639. -or-
  5640. </para>
  5641. <para>
  5642. <paramref name="url"/> is invalid.
  5643. </para>
  5644. </exception>
  5645. </member>
  5646. <member name="M:WebSocketSharp.Server.HttpServer.#ctor(System.Int32,System.Boolean)">
  5647. <summary>
  5648. Initializes a new instance of the <see cref="T:WebSocketSharp.Server.HttpServer"/> class with
  5649. the specified <paramref name="port"/> and <paramref name="secure"/>.
  5650. </summary>
  5651. <remarks>
  5652. The new instance listens for incoming requests on
  5653. <see cref="F:System.Net.IPAddress.Any"/> and <paramref name="port"/>.
  5654. </remarks>
  5655. <param name="port">
  5656. An <see cref="T:System.Int32"/> that represents the number of the port
  5657. on which to listen.
  5658. </param>
  5659. <param name="secure">
  5660. A <see cref="T:System.Boolean"/>: <c>true</c> if the new instance provides
  5661. secure connections; otherwise, <c>false</c>.
  5662. </param>
  5663. <exception cref="T:System.ArgumentOutOfRangeException">
  5664. <paramref name="port"/> is less than 1 or greater than 65535.
  5665. </exception>
  5666. </member>
  5667. <member name="M:WebSocketSharp.Server.HttpServer.#ctor(System.Net.IPAddress,System.Int32)">
  5668. <summary>
  5669. Initializes a new instance of the <see cref="T:WebSocketSharp.Server.HttpServer"/> class with
  5670. the specified <paramref name="address"/> and <paramref name="port"/>.
  5671. </summary>
  5672. <remarks>
  5673. <para>
  5674. The new instance listens for incoming requests on
  5675. <paramref name="address"/> and <paramref name="port"/>.
  5676. </para>
  5677. <para>
  5678. It provides secure connections if <paramref name="port"/> is 443.
  5679. </para>
  5680. </remarks>
  5681. <param name="address">
  5682. A <see cref="T:System.Net.IPAddress"/> that represents
  5683. the local IP address on which to listen.
  5684. </param>
  5685. <param name="port">
  5686. An <see cref="T:System.Int32"/> that represents the number of the port
  5687. on which to listen.
  5688. </param>
  5689. <exception cref="T:System.ArgumentNullException">
  5690. <paramref name="address"/> is <see langword="null"/>.
  5691. </exception>
  5692. <exception cref="T:System.ArgumentException">
  5693. <paramref name="address"/> is not a local IP address.
  5694. </exception>
  5695. <exception cref="T:System.ArgumentOutOfRangeException">
  5696. <paramref name="port"/> is less than 1 or greater than 65535.
  5697. </exception>
  5698. </member>
  5699. <member name="M:WebSocketSharp.Server.HttpServer.#ctor(System.Net.IPAddress,System.Int32,System.Boolean)">
  5700. <summary>
  5701. Initializes a new instance of the <see cref="T:WebSocketSharp.Server.HttpServer"/> class with
  5702. the specified <paramref name="address"/>, <paramref name="port"/>,
  5703. and <paramref name="secure"/>.
  5704. </summary>
  5705. <remarks>
  5706. The new instance listens for incoming requests on
  5707. <paramref name="address"/> and <paramref name="port"/>.
  5708. </remarks>
  5709. <param name="address">
  5710. A <see cref="T:System.Net.IPAddress"/> that represents
  5711. the local IP address on which to listen.
  5712. </param>
  5713. <param name="port">
  5714. An <see cref="T:System.Int32"/> that represents the number of the port
  5715. on which to listen.
  5716. </param>
  5717. <param name="secure">
  5718. A <see cref="T:System.Boolean"/>: <c>true</c> if the new instance provides
  5719. secure connections; otherwise, <c>false</c>.
  5720. </param>
  5721. <exception cref="T:System.ArgumentNullException">
  5722. <paramref name="address"/> is <see langword="null"/>.
  5723. </exception>
  5724. <exception cref="T:System.ArgumentException">
  5725. <paramref name="address"/> is not a local IP address.
  5726. </exception>
  5727. <exception cref="T:System.ArgumentOutOfRangeException">
  5728. <paramref name="port"/> is less than 1 or greater than 65535.
  5729. </exception>
  5730. </member>
  5731. <member name="P:WebSocketSharp.Server.HttpServer.Address">
  5732. <summary>
  5733. Gets the IP address of the server.
  5734. </summary>
  5735. <value>
  5736. A <see cref="T:System.Net.IPAddress"/> that represents the local
  5737. IP address on which to listen for incoming requests.
  5738. </value>
  5739. </member>
  5740. <member name="P:WebSocketSharp.Server.HttpServer.AuthenticationSchemes">
  5741. <summary>
  5742. Gets or sets the scheme used to authenticate the clients.
  5743. </summary>
  5744. <remarks>
  5745. The set operation does nothing if the server has already
  5746. started or it is shutting down.
  5747. </remarks>
  5748. <value>
  5749. <para>
  5750. One of the <see cref="T:WebSocketSharp.Net.AuthenticationSchemes"/>
  5751. enum values.
  5752. </para>
  5753. <para>
  5754. It represents the scheme used to authenticate the clients.
  5755. </para>
  5756. <para>
  5757. The default value is
  5758. <see cref="F:WebSocketSharp.Net.AuthenticationSchemes.Anonymous"/>.
  5759. </para>
  5760. </value>
  5761. </member>
  5762. <member name="P:WebSocketSharp.Server.HttpServer.DocumentRootPath">
  5763. <summary>
  5764. Gets or sets the path to the document folder of the server.
  5765. </summary>
  5766. <remarks>
  5767. <para>
  5768. '/' or '\' is trimmed from the end of the value if any.
  5769. </para>
  5770. <para>
  5771. The set operation does nothing if the server has already
  5772. started or it is shutting down.
  5773. </para>
  5774. </remarks>
  5775. <value>
  5776. <para>
  5777. A <see cref="T:System.String"/> that represents a path to the folder
  5778. from which to find the requested file.
  5779. </para>
  5780. <para>
  5781. The default value is "./Public".
  5782. </para>
  5783. </value>
  5784. <exception cref="T:System.ArgumentNullException">
  5785. The value specified for a set operation is <see langword="null"/>.
  5786. </exception>
  5787. <exception cref="T:System.ArgumentException">
  5788. <para>
  5789. The value specified for a set operation is an empty string.
  5790. </para>
  5791. <para>
  5792. -or-
  5793. </para>
  5794. <para>
  5795. The value specified for a set operation is an invalid path string.
  5796. </para>
  5797. <para>
  5798. -or-
  5799. </para>
  5800. <para>
  5801. The value specified for a set operation is an absolute root.
  5802. </para>
  5803. </exception>
  5804. </member>
  5805. <member name="P:WebSocketSharp.Server.HttpServer.IsListening">
  5806. <summary>
  5807. Gets a value indicating whether the server has started.
  5808. </summary>
  5809. <value>
  5810. <c>true</c> if the server has started; otherwise, <c>false</c>.
  5811. </value>
  5812. </member>
  5813. <member name="P:WebSocketSharp.Server.HttpServer.IsSecure">
  5814. <summary>
  5815. Gets a value indicating whether the server provides
  5816. secure connections.
  5817. </summary>
  5818. <value>
  5819. <c>true</c> if the server provides secure connections;
  5820. otherwise, <c>false</c>.
  5821. </value>
  5822. </member>
  5823. <member name="P:WebSocketSharp.Server.HttpServer.KeepClean">
  5824. <summary>
  5825. Gets or sets a value indicating whether the server cleans up
  5826. the inactive sessions periodically.
  5827. </summary>
  5828. <remarks>
  5829. The set operation does nothing if the server has already
  5830. started or it is shutting down.
  5831. </remarks>
  5832. <value>
  5833. <para>
  5834. <c>true</c> if the server cleans up the inactive sessions
  5835. every 60 seconds; otherwise, <c>false</c>.
  5836. </para>
  5837. <para>
  5838. The default value is <c>true</c>.
  5839. </para>
  5840. </value>
  5841. </member>
  5842. <member name="P:WebSocketSharp.Server.HttpServer.Log">
  5843. <summary>
  5844. Gets the logging function for the server.
  5845. </summary>
  5846. <remarks>
  5847. The default logging level is <see cref="F:WebSocketSharp.LogLevel.Error"/>.
  5848. </remarks>
  5849. <value>
  5850. A <see cref="T:WebSocketSharp.Logger"/> that provides the logging function.
  5851. </value>
  5852. </member>
  5853. <member name="P:WebSocketSharp.Server.HttpServer.Port">
  5854. <summary>
  5855. Gets the port of the server.
  5856. </summary>
  5857. <value>
  5858. An <see cref="T:System.Int32"/> that represents the number of the port
  5859. on which to listen for incoming requests.
  5860. </value>
  5861. </member>
  5862. <member name="P:WebSocketSharp.Server.HttpServer.Realm">
  5863. <summary>
  5864. Gets or sets the realm used for authentication.
  5865. </summary>
  5866. <remarks>
  5867. <para>
  5868. "SECRET AREA" is used as the realm if the value is
  5869. <see langword="null"/> or an empty string.
  5870. </para>
  5871. <para>
  5872. The set operation does nothing if the server has
  5873. already started or it is shutting down.
  5874. </para>
  5875. </remarks>
  5876. <value>
  5877. <para>
  5878. A <see cref="T:System.String"/> or <see langword="null"/> by default.
  5879. </para>
  5880. <para>
  5881. That string represents the name of the realm.
  5882. </para>
  5883. </value>
  5884. </member>
  5885. <member name="P:WebSocketSharp.Server.HttpServer.ReuseAddress">
  5886. <summary>
  5887. Gets or sets a value indicating whether the server is allowed to
  5888. be bound to an address that is already in use.
  5889. </summary>
  5890. <remarks>
  5891. <para>
  5892. You should set this property to <c>true</c> if you would
  5893. like to resolve to wait for socket in TIME_WAIT state.
  5894. </para>
  5895. <para>
  5896. The set operation does nothing if the server has already
  5897. started or it is shutting down.
  5898. </para>
  5899. </remarks>
  5900. <value>
  5901. <para>
  5902. <c>true</c> if the server is allowed to be bound to an address
  5903. that is already in use; otherwise, <c>false</c>.
  5904. </para>
  5905. <para>
  5906. The default value is <c>false</c>.
  5907. </para>
  5908. </value>
  5909. </member>
  5910. <member name="P:WebSocketSharp.Server.HttpServer.SslConfiguration">
  5911. <summary>
  5912. Gets the configuration for secure connections.
  5913. </summary>
  5914. <remarks>
  5915. This configuration will be referenced when attempts to start,
  5916. so it must be configured before the start method is called.
  5917. </remarks>
  5918. <value>
  5919. A <see cref="T:WebSocketSharp.Net.ServerSslConfiguration"/> that represents
  5920. the configuration used to provide secure connections.
  5921. </value>
  5922. <exception cref="T:System.InvalidOperationException">
  5923. This instance does not provide secure connections.
  5924. </exception>
  5925. </member>
  5926. <member name="P:WebSocketSharp.Server.HttpServer.UserCredentialsFinder">
  5927. <summary>
  5928. Gets or sets the delegate used to find the credentials
  5929. for an identity.
  5930. </summary>
  5931. <remarks>
  5932. <para>
  5933. No credentials are found if the method invoked by
  5934. the delegate returns <see langword="null"/> or
  5935. the value is <see langword="null"/>.
  5936. </para>
  5937. <para>
  5938. The set operation does nothing if the server has
  5939. already started or it is shutting down.
  5940. </para>
  5941. </remarks>
  5942. <value>
  5943. <para>
  5944. A <c>Func&lt;<see cref="T:System.Security.Principal.IIdentity"/>,
  5945. <see cref="T:WebSocketSharp.Net.NetworkCredential"/>&gt;</c> delegate or
  5946. <see langword="null"/> if not needed.
  5947. </para>
  5948. <para>
  5949. That delegate invokes the method called for finding
  5950. the credentials used to authenticate a client.
  5951. </para>
  5952. <para>
  5953. The default value is <see langword="null"/>.
  5954. </para>
  5955. </value>
  5956. </member>
  5957. <member name="P:WebSocketSharp.Server.HttpServer.WaitTime">
  5958. <summary>
  5959. Gets or sets the time to wait for the response to the WebSocket Ping or
  5960. Close.
  5961. </summary>
  5962. <remarks>
  5963. The set operation does nothing if the server has already started or
  5964. it is shutting down.
  5965. </remarks>
  5966. <value>
  5967. <para>
  5968. A <see cref="T:System.TimeSpan"/> to wait for the response.
  5969. </para>
  5970. <para>
  5971. The default value is the same as 1 second.
  5972. </para>
  5973. </value>
  5974. <exception cref="T:System.ArgumentOutOfRangeException">
  5975. The value specified for a set operation is zero or less.
  5976. </exception>
  5977. </member>
  5978. <member name="P:WebSocketSharp.Server.HttpServer.WebSocketServices">
  5979. <summary>
  5980. Gets the management function for the WebSocket services
  5981. provided by the server.
  5982. </summary>
  5983. <value>
  5984. A <see cref="T:WebSocketSharp.Server.WebSocketServiceManager"/> that manages
  5985. the WebSocket services provided by the server.
  5986. </value>
  5987. </member>
  5988. <member name="E:WebSocketSharp.Server.HttpServer.OnConnect">
  5989. <summary>
  5990. Occurs when the server receives an HTTP CONNECT request.
  5991. </summary>
  5992. </member>
  5993. <member name="E:WebSocketSharp.Server.HttpServer.OnDelete">
  5994. <summary>
  5995. Occurs when the server receives an HTTP DELETE request.
  5996. </summary>
  5997. </member>
  5998. <member name="E:WebSocketSharp.Server.HttpServer.OnGet">
  5999. <summary>
  6000. Occurs when the server receives an HTTP GET request.
  6001. </summary>
  6002. </member>
  6003. <member name="E:WebSocketSharp.Server.HttpServer.OnHead">
  6004. <summary>
  6005. Occurs when the server receives an HTTP HEAD request.
  6006. </summary>
  6007. </member>
  6008. <member name="E:WebSocketSharp.Server.HttpServer.OnOptions">
  6009. <summary>
  6010. Occurs when the server receives an HTTP OPTIONS request.
  6011. </summary>
  6012. </member>
  6013. <member name="E:WebSocketSharp.Server.HttpServer.OnPatch">
  6014. <summary>
  6015. Occurs when the server receives an HTTP PATCH request.
  6016. </summary>
  6017. </member>
  6018. <member name="E:WebSocketSharp.Server.HttpServer.OnPost">
  6019. <summary>
  6020. Occurs when the server receives an HTTP POST request.
  6021. </summary>
  6022. </member>
  6023. <member name="E:WebSocketSharp.Server.HttpServer.OnPut">
  6024. <summary>
  6025. Occurs when the server receives an HTTP PUT request.
  6026. </summary>
  6027. </member>
  6028. <member name="E:WebSocketSharp.Server.HttpServer.OnTrace">
  6029. <summary>
  6030. Occurs when the server receives an HTTP TRACE request.
  6031. </summary>
  6032. </member>
  6033. <member name="M:WebSocketSharp.Server.HttpServer.AddWebSocketService``1(System.String,System.Func{``0})">
  6034. <summary>
  6035. Adds a WebSocket service with the specified behavior,
  6036. <paramref name="path"/>, and <paramref name="creator"/>.
  6037. </summary>
  6038. <remarks>
  6039. <paramref name="path"/> is converted to a URL-decoded string and
  6040. '/' is trimmed from the end of the converted string if any.
  6041. </remarks>
  6042. <param name="path">
  6043. A <see cref="T:System.String"/> that represents an absolute path to
  6044. the service to add.
  6045. </param>
  6046. <param name="creator">
  6047. <para>
  6048. A <c>Func&lt;TBehavior&gt;</c> delegate.
  6049. </para>
  6050. <para>
  6051. It invokes the method called for creating
  6052. a new session instance for the service.
  6053. </para>
  6054. <para>
  6055. The method must create a new instance of
  6056. the specified behavior class and return it.
  6057. </para>
  6058. </param>
  6059. <typeparam name="TBehavior">
  6060. <para>
  6061. The type of the behavior for the service.
  6062. </para>
  6063. <para>
  6064. It must inherit the <see cref="T:WebSocketSharp.Server.WebSocketBehavior"/> class.
  6065. </para>
  6066. </typeparam>
  6067. <exception cref="T:System.ArgumentNullException">
  6068. <para>
  6069. <paramref name="path"/> is <see langword="null"/>.
  6070. </para>
  6071. <para>
  6072. -or-
  6073. </para>
  6074. <para>
  6075. <paramref name="creator"/> is <see langword="null"/>.
  6076. </para>
  6077. </exception>
  6078. <exception cref="T:System.ArgumentException">
  6079. <para>
  6080. <paramref name="path"/> is an empty string.
  6081. </para>
  6082. <para>
  6083. -or-
  6084. </para>
  6085. <para>
  6086. <paramref name="path"/> is not an absolute path.
  6087. </para>
  6088. <para>
  6089. -or-
  6090. </para>
  6091. <para>
  6092. <paramref name="path"/> includes either or both
  6093. query and fragment components.
  6094. </para>
  6095. <para>
  6096. -or-
  6097. </para>
  6098. <para>
  6099. <paramref name="path"/> is already in use.
  6100. </para>
  6101. </exception>
  6102. </member>
  6103. <member name="M:WebSocketSharp.Server.HttpServer.AddWebSocketService``1(System.String)">
  6104. <summary>
  6105. Adds a WebSocket service with the specified behavior and
  6106. <paramref name="path"/>.
  6107. </summary>
  6108. <remarks>
  6109. <paramref name="path"/> is converted to a URL-decoded string and
  6110. '/' is trimmed from the end of the converted string if any.
  6111. </remarks>
  6112. <param name="path">
  6113. A <see cref="T:System.String"/> that represents an absolute path to
  6114. the service to add.
  6115. </param>
  6116. <typeparam name="TBehaviorWithNew">
  6117. <para>
  6118. The type of the behavior for the service.
  6119. </para>
  6120. <para>
  6121. It must inherit the <see cref="T:WebSocketSharp.Server.WebSocketBehavior"/> class and
  6122. must have a public parameterless constructor.
  6123. </para>
  6124. </typeparam>
  6125. <exception cref="T:System.ArgumentNullException">
  6126. <paramref name="path"/> is <see langword="null"/>.
  6127. </exception>
  6128. <exception cref="T:System.ArgumentException">
  6129. <para>
  6130. <paramref name="path"/> is an empty string.
  6131. </para>
  6132. <para>
  6133. -or-
  6134. </para>
  6135. <para>
  6136. <paramref name="path"/> is not an absolute path.
  6137. </para>
  6138. <para>
  6139. -or-
  6140. </para>
  6141. <para>
  6142. <paramref name="path"/> includes either or both
  6143. query and fragment components.
  6144. </para>
  6145. <para>
  6146. -or-
  6147. </para>
  6148. <para>
  6149. <paramref name="path"/> is already in use.
  6150. </para>
  6151. </exception>
  6152. </member>
  6153. <member name="M:WebSocketSharp.Server.HttpServer.AddWebSocketService``1(System.String,System.Action{``0})">
  6154. <summary>
  6155. Adds a WebSocket service with the specified behavior,
  6156. <paramref name="path"/>, and <paramref name="initializer"/>.
  6157. </summary>
  6158. <remarks>
  6159. <paramref name="path"/> is converted to a URL-decoded string and
  6160. '/' is trimmed from the end of the converted string if any.
  6161. </remarks>
  6162. <param name="path">
  6163. A <see cref="T:System.String"/> that represents an absolute path to
  6164. the service to add.
  6165. </param>
  6166. <param name="initializer">
  6167. <para>
  6168. An <c>Action&lt;TBehaviorWithNew&gt;</c> delegate or
  6169. <see langword="null"/> if not needed.
  6170. </para>
  6171. <para>
  6172. That delegate invokes the method called for initializing
  6173. a new session instance for the service.
  6174. </para>
  6175. </param>
  6176. <typeparam name="TBehaviorWithNew">
  6177. <para>
  6178. The type of the behavior for the service.
  6179. </para>
  6180. <para>
  6181. It must inherit the <see cref="T:WebSocketSharp.Server.WebSocketBehavior"/> class and
  6182. must have a public parameterless constructor.
  6183. </para>
  6184. </typeparam>
  6185. <exception cref="T:System.ArgumentNullException">
  6186. <paramref name="path"/> is <see langword="null"/>.
  6187. </exception>
  6188. <exception cref="T:System.ArgumentException">
  6189. <para>
  6190. <paramref name="path"/> is an empty string.
  6191. </para>
  6192. <para>
  6193. -or-
  6194. </para>
  6195. <para>
  6196. <paramref name="path"/> is not an absolute path.
  6197. </para>
  6198. <para>
  6199. -or-
  6200. </para>
  6201. <para>
  6202. <paramref name="path"/> includes either or both
  6203. query and fragment components.
  6204. </para>
  6205. <para>
  6206. -or-
  6207. </para>
  6208. <para>
  6209. <paramref name="path"/> is already in use.
  6210. </para>
  6211. </exception>
  6212. </member>
  6213. <member name="M:WebSocketSharp.Server.HttpServer.GetFile(System.String)">
  6214. <summary>
  6215. Gets the contents of the specified file from the document
  6216. folder of the server.
  6217. </summary>
  6218. <returns>
  6219. <para>
  6220. An array of <see cref="T:System.Byte"/> or <see langword="null"/>
  6221. if it fails.
  6222. </para>
  6223. <para>
  6224. That array represents the contents of the file.
  6225. </para>
  6226. </returns>
  6227. <param name="path">
  6228. A <see cref="T:System.String"/> that represents a virtual path to
  6229. find the file from the document folder.
  6230. </param>
  6231. <exception cref="T:System.ArgumentNullException">
  6232. <paramref name="path"/> is <see langword="null"/>.
  6233. </exception>
  6234. <exception cref="T:System.ArgumentException">
  6235. <para>
  6236. <paramref name="path"/> is an empty string.
  6237. </para>
  6238. <para>
  6239. -or-
  6240. </para>
  6241. <para>
  6242. <paramref name="path"/> contains "..".
  6243. </para>
  6244. </exception>
  6245. </member>
  6246. <member name="M:WebSocketSharp.Server.HttpServer.RemoveWebSocketService(System.String)">
  6247. <summary>
  6248. Removes a WebSocket service with the specified <paramref name="path"/>.
  6249. </summary>
  6250. <remarks>
  6251. <para>
  6252. <paramref name="path"/> is converted to a URL-decoded string and
  6253. '/' is trimmed from the end of the converted string if any.
  6254. </para>
  6255. <para>
  6256. The service is stopped with close status 1001 (going away)
  6257. if it has already started.
  6258. </para>
  6259. </remarks>
  6260. <returns>
  6261. <c>true</c> if the service is successfully found and removed;
  6262. otherwise, <c>false</c>.
  6263. </returns>
  6264. <param name="path">
  6265. A <see cref="T:System.String"/> that represents an absolute path to
  6266. the service to remove.
  6267. </param>
  6268. <exception cref="T:System.ArgumentNullException">
  6269. <paramref name="path"/> is <see langword="null"/>.
  6270. </exception>
  6271. <exception cref="T:System.ArgumentException">
  6272. <para>
  6273. <paramref name="path"/> is an empty string.
  6274. </para>
  6275. <para>
  6276. -or-
  6277. </para>
  6278. <para>
  6279. <paramref name="path"/> is not an absolute path.
  6280. </para>
  6281. <para>
  6282. -or-
  6283. </para>
  6284. <para>
  6285. <paramref name="path"/> includes either or both
  6286. query and fragment components.
  6287. </para>
  6288. </exception>
  6289. </member>
  6290. <member name="M:WebSocketSharp.Server.HttpServer.Start">
  6291. <summary>
  6292. Starts receiving incoming requests.
  6293. </summary>
  6294. <remarks>
  6295. This method does nothing if the server has already started or
  6296. it is shutting down.
  6297. </remarks>
  6298. <exception cref="T:System.InvalidOperationException">
  6299. <para>
  6300. There is no server certificate for secure connections.
  6301. </para>
  6302. <para>
  6303. -or-
  6304. </para>
  6305. <para>
  6306. The underlying <see cref="T:WebSocketSharp.Net.HttpListener"/> has failed to start.
  6307. </para>
  6308. </exception>
  6309. </member>
  6310. <member name="M:WebSocketSharp.Server.HttpServer.Stop">
  6311. <summary>
  6312. Stops receiving incoming requests and closes each connection.
  6313. </summary>
  6314. <remarks>
  6315. This method does nothing if the server is not started,
  6316. it is shutting down, or it has already stopped.
  6317. </remarks>
  6318. </member>
  6319. <member name="M:WebSocketSharp.Server.HttpServer.Stop(System.UInt16,System.String)">
  6320. <summary>
  6321. Stops receiving incoming requests and closes each connection.
  6322. </summary>
  6323. <remarks>
  6324. This method does nothing if the server is not started,
  6325. it is shutting down, or it has already stopped.
  6326. </remarks>
  6327. <param name="code">
  6328. <para>
  6329. A <see cref="T:System.UInt16"/> that represents the status code
  6330. indicating the reason for the WebSocket connection close.
  6331. </para>
  6332. <para>
  6333. The status codes are defined in
  6334. <see href="http://tools.ietf.org/html/rfc6455#section-7.4">
  6335. Section 7.4</see> of RFC 6455.
  6336. </para>
  6337. </param>
  6338. <param name="reason">
  6339. <para>
  6340. A <see cref="T:System.String"/> that represents the reason for
  6341. the WebSocket connection close.
  6342. </para>
  6343. <para>
  6344. The size must be 123 bytes or less in UTF-8.
  6345. </para>
  6346. </param>
  6347. <exception cref="T:System.ArgumentOutOfRangeException">
  6348. <para>
  6349. <paramref name="code"/> is less than 1000 or greater than 4999.
  6350. </para>
  6351. <para>
  6352. -or-
  6353. </para>
  6354. <para>
  6355. The size of <paramref name="reason"/> is greater than 123 bytes.
  6356. </para>
  6357. </exception>
  6358. <exception cref="T:System.ArgumentException">
  6359. <para>
  6360. <paramref name="code"/> is 1010 (mandatory extension).
  6361. </para>
  6362. <para>
  6363. -or-
  6364. </para>
  6365. <para>
  6366. <paramref name="code"/> is 1005 (no status) and
  6367. there is <paramref name="reason"/>.
  6368. </para>
  6369. <para>
  6370. -or-
  6371. </para>
  6372. <para>
  6373. <paramref name="reason"/> could not be UTF-8-encoded.
  6374. </para>
  6375. </exception>
  6376. </member>
  6377. <member name="M:WebSocketSharp.Server.HttpServer.Stop(WebSocketSharp.CloseStatusCode,System.String)">
  6378. <summary>
  6379. Stops receiving incoming requests and closes each connection.
  6380. </summary>
  6381. <remarks>
  6382. This method does nothing if the server is not started,
  6383. it is shutting down, or it has already stopped.
  6384. </remarks>
  6385. <param name="code">
  6386. <para>
  6387. One of the <see cref="T:WebSocketSharp.CloseStatusCode"/> enum values.
  6388. </para>
  6389. <para>
  6390. It represents the status code indicating the reason for
  6391. the WebSocket connection close.
  6392. </para>
  6393. </param>
  6394. <param name="reason">
  6395. <para>
  6396. A <see cref="T:System.String"/> that represents the reason for
  6397. the WebSocket connection close.
  6398. </para>
  6399. <para>
  6400. The size must be 123 bytes or less in UTF-8.
  6401. </para>
  6402. </param>
  6403. <exception cref="T:System.ArgumentOutOfRangeException">
  6404. The size of <paramref name="reason"/> is greater than 123 bytes.
  6405. </exception>
  6406. <exception cref="T:System.ArgumentException">
  6407. <para>
  6408. <paramref name="code"/> is
  6409. <see cref="F:WebSocketSharp.CloseStatusCode.MandatoryExtension"/>.
  6410. </para>
  6411. <para>
  6412. -or-
  6413. </para>
  6414. <para>
  6415. <paramref name="code"/> is
  6416. <see cref="F:WebSocketSharp.CloseStatusCode.NoStatus"/> and
  6417. there is <paramref name="reason"/>.
  6418. </para>
  6419. <para>
  6420. -or-
  6421. </para>
  6422. <para>
  6423. <paramref name="reason"/> could not be UTF-8-encoded.
  6424. </para>
  6425. </exception>
  6426. </member>
  6427. <member name="T:WebSocketSharp.Server.IWebSocketSession">
  6428. <summary>
  6429. Exposes the properties used to access the information in a session in a WebSocket service.
  6430. </summary>
  6431. </member>
  6432. <member name="P:WebSocketSharp.Server.IWebSocketSession.Context">
  6433. <summary>
  6434. Gets the information in the connection request to the WebSocket service.
  6435. </summary>
  6436. <value>
  6437. A <see cref="T:WebSocketSharp.Net.WebSockets.WebSocketContext"/> that provides the access to the connection request.
  6438. </value>
  6439. </member>
  6440. <member name="P:WebSocketSharp.Server.IWebSocketSession.ID">
  6441. <summary>
  6442. Gets the unique ID of the session.
  6443. </summary>
  6444. <value>
  6445. A <see cref="T:System.String"/> that represents the unique ID of the session.
  6446. </value>
  6447. </member>
  6448. <member name="P:WebSocketSharp.Server.IWebSocketSession.Protocol">
  6449. <summary>
  6450. Gets the WebSocket subprotocol used in the session.
  6451. </summary>
  6452. <value>
  6453. A <see cref="T:System.String"/> that represents the subprotocol if any.
  6454. </value>
  6455. </member>
  6456. <member name="P:WebSocketSharp.Server.IWebSocketSession.StartTime">
  6457. <summary>
  6458. Gets the time that the session has started.
  6459. </summary>
  6460. <value>
  6461. A <see cref="T:System.DateTime"/> that represents the time that the session has started.
  6462. </value>
  6463. </member>
  6464. <member name="P:WebSocketSharp.Server.IWebSocketSession.State">
  6465. <summary>
  6466. Gets the state of the <see cref="T:WebSocketSharp.WebSocket"/> used in the session.
  6467. </summary>
  6468. <value>
  6469. One of the <see cref="T:WebSocketSharp.WebSocketState"/> enum values, indicates the state of
  6470. the <see cref="T:WebSocketSharp.WebSocket"/> used in the session.
  6471. </value>
  6472. </member>
  6473. <member name="T:WebSocketSharp.Server.WebSocketBehavior">
  6474. <summary>
  6475. Exposes the methods and properties used to define the behavior of a WebSocket service
  6476. provided by the <see cref="T:WebSocketSharp.Server.WebSocketServer"/> or <see cref="T:WebSocketSharp.Server.HttpServer"/>.
  6477. </summary>
  6478. <remarks>
  6479. The WebSocketBehavior class is an abstract class.
  6480. </remarks>
  6481. </member>
  6482. <member name="M:WebSocketSharp.Server.WebSocketBehavior.#ctor">
  6483. <summary>
  6484. Initializes a new instance of the <see cref="T:WebSocketSharp.Server.WebSocketBehavior"/> class.
  6485. </summary>
  6486. </member>
  6487. <member name="P:WebSocketSharp.Server.WebSocketBehavior.Log">
  6488. <summary>
  6489. Gets the logging functions.
  6490. </summary>
  6491. <value>
  6492. A <see cref="T:WebSocketSharp.Logger"/> that provides the logging functions,
  6493. or <see langword="null"/> if the WebSocket connection isn't established.
  6494. </value>
  6495. </member>
  6496. <member name="P:WebSocketSharp.Server.WebSocketBehavior.Sessions">
  6497. <summary>
  6498. Gets the access to the sessions in the WebSocket service.
  6499. </summary>
  6500. <value>
  6501. A <see cref="T:WebSocketSharp.Server.WebSocketSessionManager"/> that provides the access to the sessions,
  6502. or <see langword="null"/> if the WebSocket connection isn't established.
  6503. </value>
  6504. </member>
  6505. <member name="P:WebSocketSharp.Server.WebSocketBehavior.Context">
  6506. <summary>
  6507. Gets the information in a handshake request to the WebSocket service.
  6508. </summary>
  6509. <value>
  6510. A <see cref="T:WebSocketSharp.Net.WebSockets.WebSocketContext"/> instance that provides the access to the handshake request,
  6511. or <see langword="null"/> if the WebSocket connection isn't established.
  6512. </value>
  6513. </member>
  6514. <member name="P:WebSocketSharp.Server.WebSocketBehavior.CookiesValidator">
  6515. <summary>
  6516. Gets or sets the delegate called to validate the HTTP cookies included in
  6517. a handshake request to the WebSocket service.
  6518. </summary>
  6519. <remarks>
  6520. This delegate is called when the <see cref="T:WebSocketSharp.WebSocket"/> used in a session validates
  6521. the handshake request.
  6522. </remarks>
  6523. <value>
  6524. <para>
  6525. A <c>Func&lt;CookieCollection, CookieCollection, bool&gt;</c> delegate that references
  6526. the method(s) used to validate the cookies.
  6527. </para>
  6528. <para>
  6529. 1st <see cref="T:WebSocketSharp.Net.CookieCollection"/> parameter passed to this delegate contains
  6530. the cookies to validate if any.
  6531. </para>
  6532. <para>
  6533. 2nd <see cref="T:WebSocketSharp.Net.CookieCollection"/> parameter passed to this delegate receives
  6534. the cookies to send to the client.
  6535. </para>
  6536. <para>
  6537. This delegate should return <c>true</c> if the cookies are valid.
  6538. </para>
  6539. <para>
  6540. The default value is <see langword="null"/>, and it does nothing to validate.
  6541. </para>
  6542. </value>
  6543. </member>
  6544. <member name="P:WebSocketSharp.Server.WebSocketBehavior.EmitOnPing">
  6545. <summary>
  6546. Gets or sets a value indicating whether the <see cref="T:WebSocketSharp.WebSocket"/> used in a session emits
  6547. a <see cref="E:WebSocketSharp.WebSocket.OnMessage"/> event when receives a Ping.
  6548. </summary>
  6549. <value>
  6550. <c>true</c> if the <see cref="T:WebSocketSharp.WebSocket"/> emits a <see cref="E:WebSocketSharp.WebSocket.OnMessage"/> event
  6551. when receives a Ping; otherwise, <c>false</c>. The default value is <c>false</c>.
  6552. </value>
  6553. </member>
  6554. <member name="P:WebSocketSharp.Server.WebSocketBehavior.ID">
  6555. <summary>
  6556. Gets the unique ID of a session.
  6557. </summary>
  6558. <value>
  6559. A <see cref="T:System.String"/> that represents the unique ID of the session,
  6560. or <see langword="null"/> if the WebSocket connection isn't established.
  6561. </value>
  6562. </member>
  6563. <member name="P:WebSocketSharp.Server.WebSocketBehavior.IgnoreExtensions">
  6564. <summary>
  6565. Gets or sets a value indicating whether the WebSocket service ignores
  6566. the Sec-WebSocket-Extensions header included in a handshake request.
  6567. </summary>
  6568. <value>
  6569. <c>true</c> if the WebSocket service ignores the extensions requested from
  6570. a client; otherwise, <c>false</c>. The default value is <c>false</c>.
  6571. </value>
  6572. </member>
  6573. <member name="P:WebSocketSharp.Server.WebSocketBehavior.OriginValidator">
  6574. <summary>
  6575. Gets or sets the delegate called to validate the Origin header included in
  6576. a handshake request to the WebSocket service.
  6577. </summary>
  6578. <remarks>
  6579. This delegate is called when the <see cref="T:WebSocketSharp.WebSocket"/> used in a session validates
  6580. the handshake request.
  6581. </remarks>
  6582. <value>
  6583. <para>
  6584. A <c>Func&lt;string, bool&gt;</c> delegate that references the method(s) used to
  6585. validate the origin header.
  6586. </para>
  6587. <para>
  6588. <see cref="T:System.String"/> parameter passed to this delegate represents the value of
  6589. the origin header to validate if any.
  6590. </para>
  6591. <para>
  6592. This delegate should return <c>true</c> if the origin header is valid.
  6593. </para>
  6594. <para>
  6595. The default value is <see langword="null"/>, and it does nothing to validate.
  6596. </para>
  6597. </value>
  6598. </member>
  6599. <member name="P:WebSocketSharp.Server.WebSocketBehavior.Protocol">
  6600. <summary>
  6601. Gets or sets the WebSocket subprotocol used in the WebSocket service.
  6602. </summary>
  6603. <remarks>
  6604. Set operation of this property is available before the WebSocket connection has
  6605. been established.
  6606. </remarks>
  6607. <value>
  6608. <para>
  6609. A <see cref="T:System.String"/> that represents the subprotocol if any.
  6610. The default value is <see cref="F:System.String.Empty"/>.
  6611. </para>
  6612. <para>
  6613. The value to set must be a token defined in
  6614. <see href="http://tools.ietf.org/html/rfc2616#section-2.2">RFC 2616</see>.
  6615. </para>
  6616. </value>
  6617. </member>
  6618. <member name="P:WebSocketSharp.Server.WebSocketBehavior.StartTime">
  6619. <summary>
  6620. Gets the time that a session has started.
  6621. </summary>
  6622. <value>
  6623. A <see cref="T:System.DateTime"/> that represents the time that the session has started,
  6624. or <see cref="F:System.DateTime.MaxValue"/> if the WebSocket connection isn't established.
  6625. </value>
  6626. </member>
  6627. <member name="P:WebSocketSharp.Server.WebSocketBehavior.State">
  6628. <summary>
  6629. Gets the state of the <see cref="T:WebSocketSharp.WebSocket"/> used in a session.
  6630. </summary>
  6631. <value>
  6632. One of the <see cref="T:WebSocketSharp.WebSocketState"/> enum values, indicates the state of
  6633. the <see cref="T:WebSocketSharp.WebSocket"/>.
  6634. </value>
  6635. </member>
  6636. <member name="M:WebSocketSharp.Server.WebSocketBehavior.Error(System.String,System.Exception)">
  6637. <summary>
  6638. Calls the <see cref="M:WebSocketSharp.Server.WebSocketBehavior.OnError(WebSocketSharp.ErrorEventArgs)"/> method with the specified <paramref name="message"/> and
  6639. <paramref name="exception"/>.
  6640. </summary>
  6641. <remarks>
  6642. This method doesn't call the <see cref="M:WebSocketSharp.Server.WebSocketBehavior.OnError(WebSocketSharp.ErrorEventArgs)"/> method if <paramref name="message"/> is
  6643. <see langword="null"/> or empty.
  6644. </remarks>
  6645. <param name="message">
  6646. A <see cref="T:System.String"/> that represents the error message.
  6647. </param>
  6648. <param name="exception">
  6649. An <see cref="T:System.Exception"/> instance that represents the cause of the error if any.
  6650. </param>
  6651. </member>
  6652. <member name="M:WebSocketSharp.Server.WebSocketBehavior.OnClose(WebSocketSharp.CloseEventArgs)">
  6653. <summary>
  6654. Called when the WebSocket connection used in a session has been closed.
  6655. </summary>
  6656. <param name="e">
  6657. A <see cref="T:WebSocketSharp.CloseEventArgs"/> that represents the event data passed to
  6658. a <see cref="E:WebSocketSharp.WebSocket.OnClose"/> event.
  6659. </param>
  6660. </member>
  6661. <member name="M:WebSocketSharp.Server.WebSocketBehavior.OnError(WebSocketSharp.ErrorEventArgs)">
  6662. <summary>
  6663. Called when the <see cref="T:WebSocketSharp.WebSocket"/> used in a session gets an error.
  6664. </summary>
  6665. <param name="e">
  6666. A <see cref="T:WebSocketSharp.ErrorEventArgs"/> that represents the event data passed to
  6667. a <see cref="E:WebSocketSharp.WebSocket.OnError"/> event.
  6668. </param>
  6669. </member>
  6670. <member name="M:WebSocketSharp.Server.WebSocketBehavior.OnMessage(WebSocketSharp.MessageEventArgs)">
  6671. <summary>
  6672. Called when the <see cref="T:WebSocketSharp.WebSocket"/> used in a session receives a message.
  6673. </summary>
  6674. <param name="e">
  6675. A <see cref="T:WebSocketSharp.MessageEventArgs"/> that represents the event data passed to
  6676. a <see cref="E:WebSocketSharp.WebSocket.OnMessage"/> event.
  6677. </param>
  6678. </member>
  6679. <member name="M:WebSocketSharp.Server.WebSocketBehavior.OnOpen">
  6680. <summary>
  6681. Called when the WebSocket connection used in a session has been established.
  6682. </summary>
  6683. </member>
  6684. <member name="M:WebSocketSharp.Server.WebSocketBehavior.Send(System.Byte[])">
  6685. <summary>
  6686. Sends binary <paramref name="data"/> to the client on a session.
  6687. </summary>
  6688. <remarks>
  6689. This method is available after the WebSocket connection has been established.
  6690. </remarks>
  6691. <param name="data">
  6692. An array of <see cref="T:System.Byte"/> that represents the binary data to send.
  6693. </param>
  6694. </member>
  6695. <member name="M:WebSocketSharp.Server.WebSocketBehavior.Send(System.IO.FileInfo)">
  6696. <summary>
  6697. Sends the specified <paramref name="file"/> as binary data to the client on a session.
  6698. </summary>
  6699. <remarks>
  6700. This method is available after the WebSocket connection has been established.
  6701. </remarks>
  6702. <param name="file">
  6703. A <see cref="T:System.IO.FileInfo"/> that represents the file to send.
  6704. </param>
  6705. </member>
  6706. <member name="M:WebSocketSharp.Server.WebSocketBehavior.Send(System.String)">
  6707. <summary>
  6708. Sends text <paramref name="data"/> to the client on a session.
  6709. </summary>
  6710. <remarks>
  6711. This method is available after the WebSocket connection has been established.
  6712. </remarks>
  6713. <param name="data">
  6714. A <see cref="T:System.String"/> that represents the text data to send.
  6715. </param>
  6716. </member>
  6717. <member name="M:WebSocketSharp.Server.WebSocketBehavior.SendAsync(System.Byte[],System.Action{System.Boolean})">
  6718. <summary>
  6719. Sends binary <paramref name="data"/> asynchronously to the client on a session.
  6720. </summary>
  6721. <remarks>
  6722. <para>
  6723. This method is available after the WebSocket connection has been established.
  6724. </para>
  6725. <para>
  6726. This method doesn't wait for the send to be complete.
  6727. </para>
  6728. </remarks>
  6729. <param name="data">
  6730. An array of <see cref="T:System.Byte"/> that represents the binary data to send.
  6731. </param>
  6732. <param name="completed">
  6733. An <c>Action&lt;bool&gt;</c> delegate that references the method(s) called when
  6734. the send is complete. A <see cref="T:System.Boolean"/> passed to this delegate is <c>true</c>
  6735. if the send is complete successfully.
  6736. </param>
  6737. </member>
  6738. <member name="M:WebSocketSharp.Server.WebSocketBehavior.SendAsync(System.IO.FileInfo,System.Action{System.Boolean})">
  6739. <summary>
  6740. Sends the specified <paramref name="file"/> as binary data asynchronously to
  6741. the client on a session.
  6742. </summary>
  6743. <remarks>
  6744. <para>
  6745. This method is available after the WebSocket connection has been established.
  6746. </para>
  6747. <para>
  6748. This method doesn't wait for the send to be complete.
  6749. </para>
  6750. </remarks>
  6751. <param name="file">
  6752. A <see cref="T:System.IO.FileInfo"/> that represents the file to send.
  6753. </param>
  6754. <param name="completed">
  6755. An <c>Action&lt;bool&gt;</c> delegate that references the method(s) called when
  6756. the send is complete. A <see cref="T:System.Boolean"/> passed to this delegate is <c>true</c>
  6757. if the send is complete successfully.
  6758. </param>
  6759. </member>
  6760. <member name="M:WebSocketSharp.Server.WebSocketBehavior.SendAsync(System.String,System.Action{System.Boolean})">
  6761. <summary>
  6762. Sends text <paramref name="data"/> asynchronously to the client on a session.
  6763. </summary>
  6764. <remarks>
  6765. <para>
  6766. This method is available after the WebSocket connection has been established.
  6767. </para>
  6768. <para>
  6769. This method doesn't wait for the send to be complete.
  6770. </para>
  6771. </remarks>
  6772. <param name="data">
  6773. A <see cref="T:System.String"/> that represents the text data to send.
  6774. </param>
  6775. <param name="completed">
  6776. An <c>Action&lt;bool&gt;</c> delegate that references the method(s) called when
  6777. the send is complete. A <see cref="T:System.Boolean"/> passed to this delegate is <c>true</c>
  6778. if the send is complete successfully.
  6779. </param>
  6780. </member>
  6781. <member name="M:WebSocketSharp.Server.WebSocketBehavior.SendAsync(System.IO.Stream,System.Int32,System.Action{System.Boolean})">
  6782. <summary>
  6783. Sends binary data from the specified <see cref="T:System.IO.Stream"/> asynchronously to
  6784. the client on a session.
  6785. </summary>
  6786. <remarks>
  6787. <para>
  6788. This method is available after the WebSocket connection has been established.
  6789. </para>
  6790. <para>
  6791. This method doesn't wait for the send to be complete.
  6792. </para>
  6793. </remarks>
  6794. <param name="stream">
  6795. A <see cref="T:System.IO.Stream"/> from which contains the binary data to send.
  6796. </param>
  6797. <param name="length">
  6798. An <see cref="T:System.Int32"/> that represents the number of bytes to send.
  6799. </param>
  6800. <param name="completed">
  6801. An <c>Action&lt;bool&gt;</c> delegate that references the method(s) called when
  6802. the send is complete. A <see cref="T:System.Boolean"/> passed to this delegate is <c>true</c>
  6803. if the send is complete successfully.
  6804. </param>
  6805. </member>
  6806. <member name="T:WebSocketSharp.Server.WebSocketServer">
  6807. <summary>
  6808. Provides a WebSocket protocol server.
  6809. </summary>
  6810. <remarks>
  6811. This class can provide multiple WebSocket services.
  6812. </remarks>
  6813. </member>
  6814. <member name="M:WebSocketSharp.Server.WebSocketServer.#ctor">
  6815. <summary>
  6816. Initializes a new instance of the <see cref="T:WebSocketSharp.Server.WebSocketServer"/> class.
  6817. </summary>
  6818. <remarks>
  6819. The new instance listens for incoming handshake requests on
  6820. <see cref="F:System.Net.IPAddress.Any"/> and port 80.
  6821. </remarks>
  6822. </member>
  6823. <member name="M:WebSocketSharp.Server.WebSocketServer.#ctor(System.Int32)">
  6824. <summary>
  6825. Initializes a new instance of the <see cref="T:WebSocketSharp.Server.WebSocketServer"/> class
  6826. with the specified <paramref name="port"/>.
  6827. </summary>
  6828. <remarks>
  6829. <para>
  6830. The new instance listens for incoming handshake requests on
  6831. <see cref="F:System.Net.IPAddress.Any"/> and <paramref name="port"/>.
  6832. </para>
  6833. <para>
  6834. It provides secure connections if <paramref name="port"/> is 443.
  6835. </para>
  6836. </remarks>
  6837. <param name="port">
  6838. An <see cref="T:System.Int32"/> that represents the number of the port
  6839. on which to listen.
  6840. </param>
  6841. <exception cref="T:System.ArgumentOutOfRangeException">
  6842. <paramref name="port"/> is less than 1 or greater than 65535.
  6843. </exception>
  6844. </member>
  6845. <member name="M:WebSocketSharp.Server.WebSocketServer.#ctor(System.String)">
  6846. <summary>
  6847. Initializes a new instance of the <see cref="T:WebSocketSharp.Server.WebSocketServer"/> class
  6848. with the specified <paramref name="url"/>.
  6849. </summary>
  6850. <remarks>
  6851. <para>
  6852. The new instance listens for incoming handshake requests on
  6853. the IP address of the host of <paramref name="url"/> and
  6854. the port of <paramref name="url"/>.
  6855. </para>
  6856. <para>
  6857. Either port 80 or 443 is used if <paramref name="url"/> includes
  6858. no port. Port 443 is used if the scheme of <paramref name="url"/>
  6859. is wss; otherwise, port 80 is used.
  6860. </para>
  6861. <para>
  6862. The new instance provides secure connections if the scheme of
  6863. <paramref name="url"/> is wss.
  6864. </para>
  6865. </remarks>
  6866. <param name="url">
  6867. A <see cref="T:System.String"/> that represents the WebSocket URL of the server.
  6868. </param>
  6869. <exception cref="T:System.ArgumentNullException">
  6870. <paramref name="url"/> is <see langword="null"/>.
  6871. </exception>
  6872. <exception cref="T:System.ArgumentException">
  6873. <para>
  6874. <paramref name="url"/> is an empty string.
  6875. </para>
  6876. <para>
  6877. -or-
  6878. </para>
  6879. <para>
  6880. <paramref name="url"/> is invalid.
  6881. </para>
  6882. </exception>
  6883. </member>
  6884. <member name="M:WebSocketSharp.Server.WebSocketServer.#ctor(System.Int32,System.Boolean)">
  6885. <summary>
  6886. Initializes a new instance of the <see cref="T:WebSocketSharp.Server.WebSocketServer"/> class
  6887. with the specified <paramref name="port"/> and <paramref name="secure"/>.
  6888. </summary>
  6889. <remarks>
  6890. The new instance listens for incoming handshake requests on
  6891. <see cref="F:System.Net.IPAddress.Any"/> and <paramref name="port"/>.
  6892. </remarks>
  6893. <param name="port">
  6894. An <see cref="T:System.Int32"/> that represents the number of the port
  6895. on which to listen.
  6896. </param>
  6897. <param name="secure">
  6898. A <see cref="T:System.Boolean"/>: <c>true</c> if the new instance provides
  6899. secure connections; otherwise, <c>false</c>.
  6900. </param>
  6901. <exception cref="T:System.ArgumentOutOfRangeException">
  6902. <paramref name="port"/> is less than 1 or greater than 65535.
  6903. </exception>
  6904. </member>
  6905. <member name="M:WebSocketSharp.Server.WebSocketServer.#ctor(System.Net.IPAddress,System.Int32)">
  6906. <summary>
  6907. Initializes a new instance of the <see cref="T:WebSocketSharp.Server.WebSocketServer"/> class
  6908. with the specified <paramref name="address"/> and <paramref name="port"/>.
  6909. </summary>
  6910. <remarks>
  6911. <para>
  6912. The new instance listens for incoming handshake requests on
  6913. <paramref name="address"/> and <paramref name="port"/>.
  6914. </para>
  6915. <para>
  6916. It provides secure connections if <paramref name="port"/> is 443.
  6917. </para>
  6918. </remarks>
  6919. <param name="address">
  6920. A <see cref="T:System.Net.IPAddress"/> that represents the local
  6921. IP address on which to listen.
  6922. </param>
  6923. <param name="port">
  6924. An <see cref="T:System.Int32"/> that represents the number of the port
  6925. on which to listen.
  6926. </param>
  6927. <exception cref="T:System.ArgumentNullException">
  6928. <paramref name="address"/> is <see langword="null"/>.
  6929. </exception>
  6930. <exception cref="T:System.ArgumentException">
  6931. <paramref name="address"/> is not a local IP address.
  6932. </exception>
  6933. <exception cref="T:System.ArgumentOutOfRangeException">
  6934. <paramref name="port"/> is less than 1 or greater than 65535.
  6935. </exception>
  6936. </member>
  6937. <member name="M:WebSocketSharp.Server.WebSocketServer.#ctor(System.Net.IPAddress,System.Int32,System.Boolean)">
  6938. <summary>
  6939. Initializes a new instance of the <see cref="T:WebSocketSharp.Server.WebSocketServer"/> class
  6940. with the specified <paramref name="address"/>, <paramref name="port"/>,
  6941. and <paramref name="secure"/>.
  6942. </summary>
  6943. <remarks>
  6944. The new instance listens for incoming handshake requests on
  6945. <paramref name="address"/> and <paramref name="port"/>.
  6946. </remarks>
  6947. <param name="address">
  6948. A <see cref="T:System.Net.IPAddress"/> that represents the local
  6949. IP address on which to listen.
  6950. </param>
  6951. <param name="port">
  6952. An <see cref="T:System.Int32"/> that represents the number of the port
  6953. on which to listen.
  6954. </param>
  6955. <param name="secure">
  6956. A <see cref="T:System.Boolean"/>: <c>true</c> if the new instance provides
  6957. secure connections; otherwise, <c>false</c>.
  6958. </param>
  6959. <exception cref="T:System.ArgumentNullException">
  6960. <paramref name="address"/> is <see langword="null"/>.
  6961. </exception>
  6962. <exception cref="T:System.ArgumentException">
  6963. <paramref name="address"/> is not a local IP address.
  6964. </exception>
  6965. <exception cref="T:System.ArgumentOutOfRangeException">
  6966. <paramref name="port"/> is less than 1 or greater than 65535.
  6967. </exception>
  6968. </member>
  6969. <member name="P:WebSocketSharp.Server.WebSocketServer.Address">
  6970. <summary>
  6971. Gets the IP address of the server.
  6972. </summary>
  6973. <value>
  6974. A <see cref="T:System.Net.IPAddress"/> that represents the local
  6975. IP address on which to listen for incoming handshake requests.
  6976. </value>
  6977. </member>
  6978. <member name="P:WebSocketSharp.Server.WebSocketServer.AllowForwardedRequest">
  6979. <summary>
  6980. Gets or sets a value indicating whether the server accepts every
  6981. handshake request without checking the request URI.
  6982. </summary>
  6983. <remarks>
  6984. The set operation does nothing if the server has already started or
  6985. it is shutting down.
  6986. </remarks>
  6987. <value>
  6988. <para>
  6989. <c>true</c> if the server accepts every handshake request without
  6990. checking the request URI; otherwise, <c>false</c>.
  6991. </para>
  6992. <para>
  6993. The default value is <c>false</c>.
  6994. </para>
  6995. </value>
  6996. </member>
  6997. <member name="P:WebSocketSharp.Server.WebSocketServer.AuthenticationSchemes">
  6998. <summary>
  6999. Gets or sets the scheme used to authenticate the clients.
  7000. </summary>
  7001. <remarks>
  7002. The set operation does nothing if the server has already started or
  7003. it is shutting down.
  7004. </remarks>
  7005. <value>
  7006. <para>
  7007. One of the <see cref="T:WebSocketSharp.Net.AuthenticationSchemes"/>
  7008. enum values.
  7009. </para>
  7010. <para>
  7011. It represents the scheme used to authenticate the clients.
  7012. </para>
  7013. <para>
  7014. The default value is
  7015. <see cref="F:WebSocketSharp.Net.AuthenticationSchemes.Anonymous"/>.
  7016. </para>
  7017. </value>
  7018. </member>
  7019. <member name="P:WebSocketSharp.Server.WebSocketServer.IsListening">
  7020. <summary>
  7021. Gets a value indicating whether the server has started.
  7022. </summary>
  7023. <value>
  7024. <c>true</c> if the server has started; otherwise, <c>false</c>.
  7025. </value>
  7026. </member>
  7027. <member name="P:WebSocketSharp.Server.WebSocketServer.IsSecure">
  7028. <summary>
  7029. Gets a value indicating whether the server provides
  7030. secure connections.
  7031. </summary>
  7032. <value>
  7033. <c>true</c> if the server provides secure connections;
  7034. otherwise, <c>false</c>.
  7035. </value>
  7036. </member>
  7037. <member name="P:WebSocketSharp.Server.WebSocketServer.KeepClean">
  7038. <summary>
  7039. Gets or sets a value indicating whether the server cleans up
  7040. the inactive sessions periodically.
  7041. </summary>
  7042. <remarks>
  7043. The set operation does nothing if the server has already started or
  7044. it is shutting down.
  7045. </remarks>
  7046. <value>
  7047. <para>
  7048. <c>true</c> if the server cleans up the inactive sessions every
  7049. 60 seconds; otherwise, <c>false</c>.
  7050. </para>
  7051. <para>
  7052. The default value is <c>true</c>.
  7053. </para>
  7054. </value>
  7055. </member>
  7056. <member name="P:WebSocketSharp.Server.WebSocketServer.Log">
  7057. <summary>
  7058. Gets the logging function for the server.
  7059. </summary>
  7060. <remarks>
  7061. The default logging level is <see cref="F:WebSocketSharp.LogLevel.Error"/>.
  7062. </remarks>
  7063. <value>
  7064. A <see cref="T:WebSocketSharp.Logger"/> that provides the logging function.
  7065. </value>
  7066. </member>
  7067. <member name="P:WebSocketSharp.Server.WebSocketServer.Port">
  7068. <summary>
  7069. Gets the port of the server.
  7070. </summary>
  7071. <value>
  7072. An <see cref="T:System.Int32"/> that represents the number of the port
  7073. on which to listen for incoming handshake requests.
  7074. </value>
  7075. </member>
  7076. <member name="P:WebSocketSharp.Server.WebSocketServer.Realm">
  7077. <summary>
  7078. Gets or sets the realm used for authentication.
  7079. </summary>
  7080. <remarks>
  7081. <para>
  7082. "SECRET AREA" is used as the realm if the value is
  7083. <see langword="null"/> or an empty string.
  7084. </para>
  7085. <para>
  7086. The set operation does nothing if the server has
  7087. already started or it is shutting down.
  7088. </para>
  7089. </remarks>
  7090. <value>
  7091. <para>
  7092. A <see cref="T:System.String"/> or <see langword="null"/> by default.
  7093. </para>
  7094. <para>
  7095. That string represents the name of the realm.
  7096. </para>
  7097. </value>
  7098. </member>
  7099. <member name="P:WebSocketSharp.Server.WebSocketServer.ReuseAddress">
  7100. <summary>
  7101. Gets or sets a value indicating whether the server is allowed to
  7102. be bound to an address that is already in use.
  7103. </summary>
  7104. <remarks>
  7105. <para>
  7106. You should set this property to <c>true</c> if you would
  7107. like to resolve to wait for socket in TIME_WAIT state.
  7108. </para>
  7109. <para>
  7110. The set operation does nothing if the server has already
  7111. started or it is shutting down.
  7112. </para>
  7113. </remarks>
  7114. <value>
  7115. <para>
  7116. <c>true</c> if the server is allowed to be bound to an address
  7117. that is already in use; otherwise, <c>false</c>.
  7118. </para>
  7119. <para>
  7120. The default value is <c>false</c>.
  7121. </para>
  7122. </value>
  7123. </member>
  7124. <member name="P:WebSocketSharp.Server.WebSocketServer.SslConfiguration">
  7125. <summary>
  7126. Gets the configuration for secure connections.
  7127. </summary>
  7128. <remarks>
  7129. This configuration will be referenced when attempts to start,
  7130. so it must be configured before the start method is called.
  7131. </remarks>
  7132. <value>
  7133. A <see cref="T:WebSocketSharp.Net.ServerSslConfiguration"/> that represents
  7134. the configuration used to provide secure connections.
  7135. </value>
  7136. <exception cref="T:System.InvalidOperationException">
  7137. This instance does not provide secure connections.
  7138. </exception>
  7139. </member>
  7140. <member name="P:WebSocketSharp.Server.WebSocketServer.UserCredentialsFinder">
  7141. <summary>
  7142. Gets or sets the delegate used to find the credentials
  7143. for an identity.
  7144. </summary>
  7145. <remarks>
  7146. <para>
  7147. No credentials are found if the method invoked by
  7148. the delegate returns <see langword="null"/> or
  7149. the value is <see langword="null"/>.
  7150. </para>
  7151. <para>
  7152. The set operation does nothing if the server has
  7153. already started or it is shutting down.
  7154. </para>
  7155. </remarks>
  7156. <value>
  7157. <para>
  7158. A <c>Func&lt;<see cref="T:System.Security.Principal.IIdentity"/>,
  7159. <see cref="T:WebSocketSharp.Net.NetworkCredential"/>&gt;</c> delegate or
  7160. <see langword="null"/> if not needed.
  7161. </para>
  7162. <para>
  7163. That delegate invokes the method called for finding
  7164. the credentials used to authenticate a client.
  7165. </para>
  7166. <para>
  7167. The default value is <see langword="null"/>.
  7168. </para>
  7169. </value>
  7170. </member>
  7171. <member name="P:WebSocketSharp.Server.WebSocketServer.WaitTime">
  7172. <summary>
  7173. Gets or sets the time to wait for the response to the WebSocket Ping or
  7174. Close.
  7175. </summary>
  7176. <remarks>
  7177. The set operation does nothing if the server has already started or
  7178. it is shutting down.
  7179. </remarks>
  7180. <value>
  7181. <para>
  7182. A <see cref="T:System.TimeSpan"/> to wait for the response.
  7183. </para>
  7184. <para>
  7185. The default value is the same as 1 second.
  7186. </para>
  7187. </value>
  7188. <exception cref="T:System.ArgumentOutOfRangeException">
  7189. The value specified for a set operation is zero or less.
  7190. </exception>
  7191. </member>
  7192. <member name="P:WebSocketSharp.Server.WebSocketServer.WebSocketServices">
  7193. <summary>
  7194. Gets the management function for the WebSocket services
  7195. provided by the server.
  7196. </summary>
  7197. <value>
  7198. A <see cref="T:WebSocketSharp.Server.WebSocketServiceManager"/> that manages
  7199. the WebSocket services provided by the server.
  7200. </value>
  7201. </member>
  7202. <member name="M:WebSocketSharp.Server.WebSocketServer.AddWebSocketService``1(System.String,System.Func{``0})">
  7203. <summary>
  7204. Adds a WebSocket service with the specified behavior,
  7205. <paramref name="path"/>, and <paramref name="creator"/>.
  7206. </summary>
  7207. <remarks>
  7208. <paramref name="path"/> is converted to a URL-decoded string and
  7209. '/' is trimmed from the end of the converted string if any.
  7210. </remarks>
  7211. <param name="path">
  7212. A <see cref="T:System.String"/> that represents an absolute path to
  7213. the service to add.
  7214. </param>
  7215. <param name="creator">
  7216. <para>
  7217. A <c>Func&lt;TBehavior&gt;</c> delegate.
  7218. </para>
  7219. <para>
  7220. It invokes the method called for creating a new session
  7221. instance for the service.
  7222. </para>
  7223. <para>
  7224. The method must create a new instance of the specified
  7225. behavior class and return it.
  7226. </para>
  7227. </param>
  7228. <typeparam name="TBehavior">
  7229. <para>
  7230. The type of the behavior for the service.
  7231. </para>
  7232. <para>
  7233. It must inherit the <see cref="T:WebSocketSharp.Server.WebSocketBehavior"/> class.
  7234. </para>
  7235. </typeparam>
  7236. <exception cref="T:System.ArgumentNullException">
  7237. <para>
  7238. <paramref name="path"/> is <see langword="null"/>.
  7239. </para>
  7240. <para>
  7241. -or-
  7242. </para>
  7243. <para>
  7244. <paramref name="creator"/> is <see langword="null"/>.
  7245. </para>
  7246. </exception>
  7247. <exception cref="T:System.ArgumentException">
  7248. <para>
  7249. <paramref name="path"/> is an empty string.
  7250. </para>
  7251. <para>
  7252. -or-
  7253. </para>
  7254. <para>
  7255. <paramref name="path"/> is not an absolute path.
  7256. </para>
  7257. <para>
  7258. -or-
  7259. </para>
  7260. <para>
  7261. <paramref name="path"/> includes either or both
  7262. query and fragment components.
  7263. </para>
  7264. <para>
  7265. -or-
  7266. </para>
  7267. <para>
  7268. <paramref name="path"/> is already in use.
  7269. </para>
  7270. </exception>
  7271. </member>
  7272. <member name="M:WebSocketSharp.Server.WebSocketServer.AddWebSocketService``1(System.String)">
  7273. <summary>
  7274. Adds a WebSocket service with the specified behavior and
  7275. <paramref name="path"/>.
  7276. </summary>
  7277. <remarks>
  7278. <paramref name="path"/> is converted to a URL-decoded string and
  7279. '/' is trimmed from the end of the converted string if any.
  7280. </remarks>
  7281. <param name="path">
  7282. A <see cref="T:System.String"/> that represents an absolute path to
  7283. the service to add.
  7284. </param>
  7285. <typeparam name="TBehaviorWithNew">
  7286. <para>
  7287. The type of the behavior for the service.
  7288. </para>
  7289. <para>
  7290. It must inherit the <see cref="T:WebSocketSharp.Server.WebSocketBehavior"/> class and
  7291. have a public parameterless constructor.
  7292. </para>
  7293. </typeparam>
  7294. <exception cref="T:System.ArgumentNullException">
  7295. <paramref name="path"/> is <see langword="null"/>.
  7296. </exception>
  7297. <exception cref="T:System.ArgumentException">
  7298. <para>
  7299. <paramref name="path"/> is an empty string.
  7300. </para>
  7301. <para>
  7302. -or-
  7303. </para>
  7304. <para>
  7305. <paramref name="path"/> is not an absolute path.
  7306. </para>
  7307. <para>
  7308. -or-
  7309. </para>
  7310. <para>
  7311. <paramref name="path"/> includes either or both
  7312. query and fragment components.
  7313. </para>
  7314. <para>
  7315. -or-
  7316. </para>
  7317. <para>
  7318. <paramref name="path"/> is already in use.
  7319. </para>
  7320. </exception>
  7321. </member>
  7322. <member name="M:WebSocketSharp.Server.WebSocketServer.AddWebSocketService``1(System.String,System.Action{``0})">
  7323. <summary>
  7324. Adds a WebSocket service with the specified behavior,
  7325. <paramref name="path"/>, and <paramref name="initializer"/>.
  7326. </summary>
  7327. <remarks>
  7328. <paramref name="path"/> is converted to a URL-decoded string and
  7329. '/' is trimmed from the end of the converted string if any.
  7330. </remarks>
  7331. <param name="path">
  7332. A <see cref="T:System.String"/> that represents an absolute path to
  7333. the service to add.
  7334. </param>
  7335. <param name="initializer">
  7336. <para>
  7337. An <c>Action&lt;TBehaviorWithNew&gt;</c> delegate or
  7338. <see langword="null"/> if not needed.
  7339. </para>
  7340. <para>
  7341. That delegate invokes the method called for initializing
  7342. a new session instance for the service.
  7343. </para>
  7344. </param>
  7345. <typeparam name="TBehaviorWithNew">
  7346. <para>
  7347. The type of the behavior for the service.
  7348. </para>
  7349. <para>
  7350. It must inherit the <see cref="T:WebSocketSharp.Server.WebSocketBehavior"/> class and
  7351. have a public parameterless constructor.
  7352. </para>
  7353. </typeparam>
  7354. <exception cref="T:System.ArgumentNullException">
  7355. <paramref name="path"/> is <see langword="null"/>.
  7356. </exception>
  7357. <exception cref="T:System.ArgumentException">
  7358. <para>
  7359. <paramref name="path"/> is an empty string.
  7360. </para>
  7361. <para>
  7362. -or-
  7363. </para>
  7364. <para>
  7365. <paramref name="path"/> is not an absolute path.
  7366. </para>
  7367. <para>
  7368. -or-
  7369. </para>
  7370. <para>
  7371. <paramref name="path"/> includes either or both
  7372. query and fragment components.
  7373. </para>
  7374. <para>
  7375. -or-
  7376. </para>
  7377. <para>
  7378. <paramref name="path"/> is already in use.
  7379. </para>
  7380. </exception>
  7381. </member>
  7382. <member name="M:WebSocketSharp.Server.WebSocketServer.RemoveWebSocketService(System.String)">
  7383. <summary>
  7384. Removes a WebSocket service with the specified <paramref name="path"/>.
  7385. </summary>
  7386. <remarks>
  7387. <para>
  7388. <paramref name="path"/> is converted to a URL-decoded string and
  7389. '/' is trimmed from the end of the converted string if any.
  7390. </para>
  7391. <para>
  7392. The service is stopped with close status 1001 (going away)
  7393. if it has already started.
  7394. </para>
  7395. </remarks>
  7396. <returns>
  7397. <c>true</c> if the service is successfully found and removed;
  7398. otherwise, <c>false</c>.
  7399. </returns>
  7400. <param name="path">
  7401. A <see cref="T:System.String"/> that represents an absolute path to
  7402. the service to remove.
  7403. </param>
  7404. <exception cref="T:System.ArgumentNullException">
  7405. <paramref name="path"/> is <see langword="null"/>.
  7406. </exception>
  7407. <exception cref="T:System.ArgumentException">
  7408. <para>
  7409. <paramref name="path"/> is an empty string.
  7410. </para>
  7411. <para>
  7412. -or-
  7413. </para>
  7414. <para>
  7415. <paramref name="path"/> is not an absolute path.
  7416. </para>
  7417. <para>
  7418. -or-
  7419. </para>
  7420. <para>
  7421. <paramref name="path"/> includes either or both
  7422. query and fragment components.
  7423. </para>
  7424. </exception>
  7425. </member>
  7426. <member name="M:WebSocketSharp.Server.WebSocketServer.Start">
  7427. <summary>
  7428. Starts receiving incoming handshake requests.
  7429. </summary>
  7430. <remarks>
  7431. This method does nothing if the server has already started or
  7432. it is shutting down.
  7433. </remarks>
  7434. <exception cref="T:System.InvalidOperationException">
  7435. <para>
  7436. There is no server certificate for secure connections.
  7437. </para>
  7438. <para>
  7439. -or-
  7440. </para>
  7441. <para>
  7442. The underlying <see cref="T:System.Net.Sockets.TcpListener"/> has failed to start.
  7443. </para>
  7444. </exception>
  7445. </member>
  7446. <member name="M:WebSocketSharp.Server.WebSocketServer.Stop">
  7447. <summary>
  7448. Stops receiving incoming handshake requests and closes
  7449. each connection.
  7450. </summary>
  7451. <remarks>
  7452. This method does nothing if the server is not started,
  7453. it is shutting down, or it has already stopped.
  7454. </remarks>
  7455. <exception cref="T:System.InvalidOperationException">
  7456. The underlying <see cref="T:System.Net.Sockets.TcpListener"/> has failed to stop.
  7457. </exception>
  7458. </member>
  7459. <member name="M:WebSocketSharp.Server.WebSocketServer.Stop(System.UInt16,System.String)">
  7460. <summary>
  7461. Stops receiving incoming handshake requests and closes each
  7462. connection with the specified <paramref name="code"/> and
  7463. <paramref name="reason"/>.
  7464. </summary>
  7465. <remarks>
  7466. This method does nothing if the server is not started,
  7467. it is shutting down, or it has already stopped.
  7468. </remarks>
  7469. <param name="code">
  7470. <para>
  7471. A <see cref="T:System.UInt16"/> that represents the status code
  7472. indicating the reason for the close.
  7473. </para>
  7474. <para>
  7475. The status codes are defined in
  7476. <see href="http://tools.ietf.org/html/rfc6455#section-7.4">
  7477. Section 7.4</see> of RFC 6455.
  7478. </para>
  7479. </param>
  7480. <param name="reason">
  7481. <para>
  7482. A <see cref="T:System.String"/> that represents the reason for the close.
  7483. </para>
  7484. <para>
  7485. The size must be 123 bytes or less in UTF-8.
  7486. </para>
  7487. </param>
  7488. <exception cref="T:System.ArgumentOutOfRangeException">
  7489. <para>
  7490. <paramref name="code"/> is less than 1000 or greater than 4999.
  7491. </para>
  7492. <para>
  7493. -or-
  7494. </para>
  7495. <para>
  7496. The size of <paramref name="reason"/> is greater than 123 bytes.
  7497. </para>
  7498. </exception>
  7499. <exception cref="T:System.ArgumentException">
  7500. <para>
  7501. <paramref name="code"/> is 1010 (mandatory extension).
  7502. </para>
  7503. <para>
  7504. -or-
  7505. </para>
  7506. <para>
  7507. <paramref name="code"/> is 1005 (no status) and
  7508. there is <paramref name="reason"/>.
  7509. </para>
  7510. <para>
  7511. -or-
  7512. </para>
  7513. <para>
  7514. <paramref name="reason"/> could not be UTF-8-encoded.
  7515. </para>
  7516. </exception>
  7517. <exception cref="T:System.InvalidOperationException">
  7518. The underlying <see cref="T:System.Net.Sockets.TcpListener"/> has failed to stop.
  7519. </exception>
  7520. </member>
  7521. <member name="M:WebSocketSharp.Server.WebSocketServer.Stop(WebSocketSharp.CloseStatusCode,System.String)">
  7522. <summary>
  7523. Stops receiving incoming handshake requests and closes each
  7524. connection with the specified <paramref name="code"/> and
  7525. <paramref name="reason"/>.
  7526. </summary>
  7527. <remarks>
  7528. This method does nothing if the server is not started,
  7529. it is shutting down, or it has already stopped.
  7530. </remarks>
  7531. <param name="code">
  7532. <para>
  7533. One of the <see cref="T:WebSocketSharp.CloseStatusCode"/> enum values.
  7534. </para>
  7535. <para>
  7536. It represents the status code indicating the reason for the close.
  7537. </para>
  7538. </param>
  7539. <param name="reason">
  7540. <para>
  7541. A <see cref="T:System.String"/> that represents the reason for the close.
  7542. </para>
  7543. <para>
  7544. The size must be 123 bytes or less in UTF-8.
  7545. </para>
  7546. </param>
  7547. <exception cref="T:System.ArgumentException">
  7548. <para>
  7549. <paramref name="code"/> is
  7550. <see cref="F:WebSocketSharp.CloseStatusCode.MandatoryExtension"/>.
  7551. </para>
  7552. <para>
  7553. -or-
  7554. </para>
  7555. <para>
  7556. <paramref name="code"/> is
  7557. <see cref="F:WebSocketSharp.CloseStatusCode.NoStatus"/> and
  7558. there is <paramref name="reason"/>.
  7559. </para>
  7560. <para>
  7561. -or-
  7562. </para>
  7563. <para>
  7564. <paramref name="reason"/> could not be UTF-8-encoded.
  7565. </para>
  7566. </exception>
  7567. <exception cref="T:System.ArgumentOutOfRangeException">
  7568. The size of <paramref name="reason"/> is greater than 123 bytes.
  7569. </exception>
  7570. <exception cref="T:System.InvalidOperationException">
  7571. The underlying <see cref="T:System.Net.Sockets.TcpListener"/> has failed to stop.
  7572. </exception>
  7573. </member>
  7574. <member name="T:WebSocketSharp.Server.WebSocketServiceHost">
  7575. <summary>
  7576. Exposes the methods and properties used to access the information in
  7577. a WebSocket service provided by the <see cref="T:WebSocketSharp.Server.WebSocketServer"/> or
  7578. <see cref="T:WebSocketSharp.Server.HttpServer"/>.
  7579. </summary>
  7580. <remarks>
  7581. This class is an abstract class.
  7582. </remarks>
  7583. </member>
  7584. <member name="M:WebSocketSharp.Server.WebSocketServiceHost.#ctor(System.String,WebSocketSharp.Logger)">
  7585. <summary>
  7586. Initializes a new instance of the <see cref="T:WebSocketSharp.Server.WebSocketServiceHost"/> class
  7587. with the specified <paramref name="path"/> and <paramref name="log"/>.
  7588. </summary>
  7589. <param name="path">
  7590. A <see cref="T:System.String"/> that represents the absolute path to the service.
  7591. </param>
  7592. <param name="log">
  7593. A <see cref="T:WebSocketSharp.Logger"/> that represents the logging function for the service.
  7594. </param>
  7595. </member>
  7596. <member name="P:WebSocketSharp.Server.WebSocketServiceHost.Log">
  7597. <summary>
  7598. Gets the logging function for the service.
  7599. </summary>
  7600. <value>
  7601. A <see cref="T:WebSocketSharp.Logger"/> that provides the logging function.
  7602. </value>
  7603. </member>
  7604. <member name="P:WebSocketSharp.Server.WebSocketServiceHost.KeepClean">
  7605. <summary>
  7606. Gets or sets a value indicating whether the service cleans up
  7607. the inactive sessions periodically.
  7608. </summary>
  7609. <remarks>
  7610. The set operation does nothing if the service has already started or
  7611. it is shutting down.
  7612. </remarks>
  7613. <value>
  7614. <c>true</c> if the service cleans up the inactive sessions every
  7615. 60 seconds; otherwise, <c>false</c>.
  7616. </value>
  7617. </member>
  7618. <member name="P:WebSocketSharp.Server.WebSocketServiceHost.Path">
  7619. <summary>
  7620. Gets the path to the service.
  7621. </summary>
  7622. <value>
  7623. A <see cref="T:System.String"/> that represents the absolute path to
  7624. the service.
  7625. </value>
  7626. </member>
  7627. <member name="P:WebSocketSharp.Server.WebSocketServiceHost.Sessions">
  7628. <summary>
  7629. Gets the management function for the sessions in the service.
  7630. </summary>
  7631. <value>
  7632. A <see cref="T:WebSocketSharp.Server.WebSocketSessionManager"/> that manages the sessions in
  7633. the service.
  7634. </value>
  7635. </member>
  7636. <member name="P:WebSocketSharp.Server.WebSocketServiceHost.BehaviorType">
  7637. <summary>
  7638. Gets the <see cref="T:System.Type"/> of the behavior of the service.
  7639. </summary>
  7640. <value>
  7641. A <see cref="T:System.Type"/> that represents the type of the behavior of
  7642. the service.
  7643. </value>
  7644. </member>
  7645. <member name="P:WebSocketSharp.Server.WebSocketServiceHost.WaitTime">
  7646. <summary>
  7647. Gets or sets the time to wait for the response to the WebSocket Ping or
  7648. Close.
  7649. </summary>
  7650. <remarks>
  7651. The set operation does nothing if the service has already started or
  7652. it is shutting down.
  7653. </remarks>
  7654. <value>
  7655. A <see cref="T:System.TimeSpan"/> to wait for the response.
  7656. </value>
  7657. <exception cref="T:System.ArgumentOutOfRangeException">
  7658. The value specified for a set operation is zero or less.
  7659. </exception>
  7660. </member>
  7661. <member name="M:WebSocketSharp.Server.WebSocketServiceHost.CreateSession">
  7662. <summary>
  7663. Creates a new session for the service.
  7664. </summary>
  7665. <returns>
  7666. A <see cref="T:WebSocketSharp.Server.WebSocketBehavior"/> instance that represents
  7667. the new session.
  7668. </returns>
  7669. </member>
  7670. <member name="T:WebSocketSharp.Server.WebSocketServiceManager">
  7671. <summary>
  7672. Provides the management function for the WebSocket services.
  7673. </summary>
  7674. <remarks>
  7675. This class manages the WebSocket services provided by
  7676. the <see cref="T:WebSocketSharp.Server.WebSocketServer"/> or <see cref="T:WebSocketSharp.Server.HttpServer"/>.
  7677. </remarks>
  7678. </member>
  7679. <member name="P:WebSocketSharp.Server.WebSocketServiceManager.Count">
  7680. <summary>
  7681. Gets the number of the WebSocket services.
  7682. </summary>
  7683. <value>
  7684. An <see cref="T:System.Int32"/> that represents the number of the services.
  7685. </value>
  7686. </member>
  7687. <member name="P:WebSocketSharp.Server.WebSocketServiceManager.Hosts">
  7688. <summary>
  7689. Gets the host instances for the WebSocket services.
  7690. </summary>
  7691. <value>
  7692. <para>
  7693. An <c>IEnumerable&lt;WebSocketServiceHost&gt;</c> instance.
  7694. </para>
  7695. <para>
  7696. It provides an enumerator which supports the iteration over
  7697. the collection of the host instances.
  7698. </para>
  7699. </value>
  7700. </member>
  7701. <member name="P:WebSocketSharp.Server.WebSocketServiceManager.Item(System.String)">
  7702. <summary>
  7703. Gets the host instance for a WebSocket service with
  7704. the specified <paramref name="path"/>.
  7705. </summary>
  7706. <remarks>
  7707. <paramref name="path"/> is converted to a URL-decoded string and
  7708. / is trimmed from the end of the converted string if any.
  7709. </remarks>
  7710. <value>
  7711. <para>
  7712. A <see cref="T:WebSocketSharp.Server.WebSocketServiceHost"/> instance or
  7713. <see langword="null"/> if not found.
  7714. </para>
  7715. <para>
  7716. That host instance provides the function to access
  7717. the information in the service.
  7718. </para>
  7719. </value>
  7720. <param name="path">
  7721. A <see cref="T:System.String"/> that represents an absolute path to
  7722. the service to find.
  7723. </param>
  7724. <exception cref="T:System.ArgumentNullException">
  7725. <paramref name="path"/> is <see langword="null"/>.
  7726. </exception>
  7727. <exception cref="T:System.ArgumentException">
  7728. <para>
  7729. <paramref name="path"/> is empty.
  7730. </para>
  7731. <para>
  7732. -or-
  7733. </para>
  7734. <para>
  7735. <paramref name="path"/> is not an absolute path.
  7736. </para>
  7737. <para>
  7738. -or-
  7739. </para>
  7740. <para>
  7741. <paramref name="path"/> includes either or both
  7742. query and fragment components.
  7743. </para>
  7744. </exception>
  7745. </member>
  7746. <member name="P:WebSocketSharp.Server.WebSocketServiceManager.KeepClean">
  7747. <summary>
  7748. Gets or sets a value indicating whether the inactive sessions in
  7749. the WebSocket services are cleaned up periodically.
  7750. </summary>
  7751. <remarks>
  7752. The set operation does nothing if the server has already started or
  7753. it is shutting down.
  7754. </remarks>
  7755. <value>
  7756. <c>true</c> if the inactive sessions are cleaned up every 60 seconds;
  7757. otherwise, <c>false</c>.
  7758. </value>
  7759. </member>
  7760. <member name="P:WebSocketSharp.Server.WebSocketServiceManager.Paths">
  7761. <summary>
  7762. Gets the paths for the WebSocket services.
  7763. </summary>
  7764. <value>
  7765. <para>
  7766. An <c>IEnumerable&lt;string&gt;</c> instance.
  7767. </para>
  7768. <para>
  7769. It provides an enumerator which supports the iteration over
  7770. the collection of the paths.
  7771. </para>
  7772. </value>
  7773. </member>
  7774. <member name="P:WebSocketSharp.Server.WebSocketServiceManager.SessionCount">
  7775. <summary>
  7776. Gets the total number of the sessions in the WebSocket services.
  7777. </summary>
  7778. <value>
  7779. An <see cref="T:System.Int32"/> that represents the total number of
  7780. the sessions in the services.
  7781. </value>
  7782. </member>
  7783. <member name="P:WebSocketSharp.Server.WebSocketServiceManager.WaitTime">
  7784. <summary>
  7785. Gets or sets the time to wait for the response to the WebSocket Ping or
  7786. Close.
  7787. </summary>
  7788. <remarks>
  7789. The set operation does nothing if the server has already started or
  7790. it is shutting down.
  7791. </remarks>
  7792. <value>
  7793. A <see cref="T:System.TimeSpan"/> to wait for the response.
  7794. </value>
  7795. <exception cref="T:System.ArgumentOutOfRangeException">
  7796. The value specified for a set operation is zero or less.
  7797. </exception>
  7798. </member>
  7799. <member name="M:WebSocketSharp.Server.WebSocketServiceManager.AddService``1(System.String,System.Action{``0})">
  7800. <summary>
  7801. Adds a WebSocket service with the specified behavior,
  7802. <paramref name="path"/>, and <paramref name="initializer"/>.
  7803. </summary>
  7804. <remarks>
  7805. <paramref name="path"/> is converted to a URL-decoded string and
  7806. / is trimmed from the end of the converted string if any.
  7807. </remarks>
  7808. <param name="path">
  7809. A <see cref="T:System.String"/> that represents an absolute path to
  7810. the service to add.
  7811. </param>
  7812. <param name="initializer">
  7813. <para>
  7814. An <c>Action&lt;TBehavior&gt;</c> delegate or
  7815. <see langword="null"/> if not needed.
  7816. </para>
  7817. <para>
  7818. That delegate invokes the method called for initializing
  7819. a new session instance for the service.
  7820. </para>
  7821. </param>
  7822. <typeparam name="TBehavior">
  7823. The type of the behavior for the service. It must inherit
  7824. the <see cref="T:WebSocketSharp.Server.WebSocketBehavior"/> class and it must have
  7825. a public parameterless constructor.
  7826. </typeparam>
  7827. <exception cref="T:System.ArgumentNullException">
  7828. <paramref name="path"/> is <see langword="null"/>.
  7829. </exception>
  7830. <exception cref="T:System.ArgumentException">
  7831. <para>
  7832. <paramref name="path"/> is empty.
  7833. </para>
  7834. <para>
  7835. -or-
  7836. </para>
  7837. <para>
  7838. <paramref name="path"/> is not an absolute path.
  7839. </para>
  7840. <para>
  7841. -or-
  7842. </para>
  7843. <para>
  7844. <paramref name="path"/> includes either or both
  7845. query and fragment components.
  7846. </para>
  7847. <para>
  7848. -or-
  7849. </para>
  7850. <para>
  7851. <paramref name="path"/> is already in use.
  7852. </para>
  7853. </exception>
  7854. </member>
  7855. <member name="M:WebSocketSharp.Server.WebSocketServiceManager.Broadcast(System.Byte[])">
  7856. <summary>
  7857. Sends <paramref name="data"/> to every client in the WebSocket services.
  7858. </summary>
  7859. <param name="data">
  7860. An array of <see cref="T:System.Byte"/> that represents the binary data to send.
  7861. </param>
  7862. <exception cref="T:System.InvalidOperationException">
  7863. The current state of the manager is not Start.
  7864. </exception>
  7865. <exception cref="T:System.ArgumentNullException">
  7866. <paramref name="data"/> is <see langword="null"/>.
  7867. </exception>
  7868. </member>
  7869. <member name="M:WebSocketSharp.Server.WebSocketServiceManager.Broadcast(System.String)">
  7870. <summary>
  7871. Sends <paramref name="data"/> to every client in the WebSocket services.
  7872. </summary>
  7873. <param name="data">
  7874. A <see cref="T:System.String"/> that represents the text data to send.
  7875. </param>
  7876. <exception cref="T:System.InvalidOperationException">
  7877. The current state of the manager is not Start.
  7878. </exception>
  7879. <exception cref="T:System.ArgumentNullException">
  7880. <paramref name="data"/> is <see langword="null"/>.
  7881. </exception>
  7882. <exception cref="T:System.ArgumentException">
  7883. <paramref name="data"/> could not be UTF-8-encoded.
  7884. </exception>
  7885. </member>
  7886. <member name="M:WebSocketSharp.Server.WebSocketServiceManager.BroadcastAsync(System.Byte[],System.Action)">
  7887. <summary>
  7888. Sends <paramref name="data"/> asynchronously to every client in
  7889. the WebSocket services.
  7890. </summary>
  7891. <remarks>
  7892. This method does not wait for the send to be complete.
  7893. </remarks>
  7894. <param name="data">
  7895. An array of <see cref="T:System.Byte"/> that represents the binary data to send.
  7896. </param>
  7897. <param name="completed">
  7898. <para>
  7899. An <see cref="T:System.Action"/> delegate or <see langword="null"/>
  7900. if not needed.
  7901. </para>
  7902. <para>
  7903. The delegate invokes the method called when the send is complete.
  7904. </para>
  7905. </param>
  7906. <exception cref="T:System.InvalidOperationException">
  7907. The current state of the manager is not Start.
  7908. </exception>
  7909. <exception cref="T:System.ArgumentNullException">
  7910. <paramref name="data"/> is <see langword="null"/>.
  7911. </exception>
  7912. </member>
  7913. <member name="M:WebSocketSharp.Server.WebSocketServiceManager.BroadcastAsync(System.String,System.Action)">
  7914. <summary>
  7915. Sends <paramref name="data"/> asynchronously to every client in
  7916. the WebSocket services.
  7917. </summary>
  7918. <remarks>
  7919. This method does not wait for the send to be complete.
  7920. </remarks>
  7921. <param name="data">
  7922. A <see cref="T:System.String"/> that represents the text data to send.
  7923. </param>
  7924. <param name="completed">
  7925. <para>
  7926. An <see cref="T:System.Action"/> delegate or <see langword="null"/>
  7927. if not needed.
  7928. </para>
  7929. <para>
  7930. The delegate invokes the method called when the send is complete.
  7931. </para>
  7932. </param>
  7933. <exception cref="T:System.InvalidOperationException">
  7934. The current state of the manager is not Start.
  7935. </exception>
  7936. <exception cref="T:System.ArgumentNullException">
  7937. <paramref name="data"/> is <see langword="null"/>.
  7938. </exception>
  7939. <exception cref="T:System.ArgumentException">
  7940. <paramref name="data"/> could not be UTF-8-encoded.
  7941. </exception>
  7942. </member>
  7943. <member name="M:WebSocketSharp.Server.WebSocketServiceManager.BroadcastAsync(System.IO.Stream,System.Int32,System.Action)">
  7944. <summary>
  7945. Sends the data from <paramref name="stream"/> asynchronously to
  7946. every client in the WebSocket services.
  7947. </summary>
  7948. <remarks>
  7949. <para>
  7950. The data is sent as the binary data.
  7951. </para>
  7952. <para>
  7953. This method does not wait for the send to be complete.
  7954. </para>
  7955. </remarks>
  7956. <param name="stream">
  7957. A <see cref="T:System.IO.Stream"/> instance from which to read the data to send.
  7958. </param>
  7959. <param name="length">
  7960. An <see cref="T:System.Int32"/> that specifies the number of bytes to send.
  7961. </param>
  7962. <param name="completed">
  7963. <para>
  7964. An <see cref="T:System.Action"/> delegate or <see langword="null"/>
  7965. if not needed.
  7966. </para>
  7967. <para>
  7968. The delegate invokes the method called when the send is complete.
  7969. </para>
  7970. </param>
  7971. <exception cref="T:System.InvalidOperationException">
  7972. The current state of the manager is not Start.
  7973. </exception>
  7974. <exception cref="T:System.ArgumentNullException">
  7975. <paramref name="stream"/> is <see langword="null"/>.
  7976. </exception>
  7977. <exception cref="T:System.ArgumentException">
  7978. <para>
  7979. <paramref name="stream"/> cannot be read.
  7980. </para>
  7981. <para>
  7982. -or-
  7983. </para>
  7984. <para>
  7985. <paramref name="length"/> is less than 1.
  7986. </para>
  7987. <para>
  7988. -or-
  7989. </para>
  7990. <para>
  7991. No data could be read from <paramref name="stream"/>.
  7992. </para>
  7993. </exception>
  7994. </member>
  7995. <member name="M:WebSocketSharp.Server.WebSocketServiceManager.Broadping">
  7996. <summary>
  7997. Sends a ping to every client in the WebSocket services.
  7998. </summary>
  7999. <returns>
  8000. <para>
  8001. A <c>Dictionary&lt;string, Dictionary&lt;string, bool&gt;&gt;</c>.
  8002. </para>
  8003. <para>
  8004. It represents a collection of pairs of a service path and another
  8005. collection of pairs of a session ID and a value indicating whether
  8006. a pong has been received from the client within a time.
  8007. </para>
  8008. </returns>
  8009. <exception cref="T:System.InvalidOperationException">
  8010. The current state of the manager is not Start.
  8011. </exception>
  8012. </member>
  8013. <member name="M:WebSocketSharp.Server.WebSocketServiceManager.Broadping(System.String)">
  8014. <summary>
  8015. Sends a ping with <paramref name="message"/> to every client in
  8016. the WebSocket services.
  8017. </summary>
  8018. <returns>
  8019. <para>
  8020. A <c>Dictionary&lt;string, Dictionary&lt;string, bool&gt;&gt;</c>.
  8021. </para>
  8022. <para>
  8023. It represents a collection of pairs of a service path and another
  8024. collection of pairs of a session ID and a value indicating whether
  8025. a pong has been received from the client within a time.
  8026. </para>
  8027. </returns>
  8028. <param name="message">
  8029. <para>
  8030. A <see cref="T:System.String"/> that represents the message to send.
  8031. </para>
  8032. <para>
  8033. The size must be 125 bytes or less in UTF-8.
  8034. </para>
  8035. </param>
  8036. <exception cref="T:System.InvalidOperationException">
  8037. The current state of the manager is not Start.
  8038. </exception>
  8039. <exception cref="T:System.ArgumentException">
  8040. <paramref name="message"/> could not be UTF-8-encoded.
  8041. </exception>
  8042. <exception cref="T:System.ArgumentOutOfRangeException">
  8043. The size of <paramref name="message"/> is greater than 125 bytes.
  8044. </exception>
  8045. </member>
  8046. <member name="M:WebSocketSharp.Server.WebSocketServiceManager.Clear">
  8047. <summary>
  8048. Removes all WebSocket services managed by the manager.
  8049. </summary>
  8050. <remarks>
  8051. A service is stopped with close status 1001 (going away)
  8052. if it has already started.
  8053. </remarks>
  8054. </member>
  8055. <member name="M:WebSocketSharp.Server.WebSocketServiceManager.RemoveService(System.String)">
  8056. <summary>
  8057. Removes a WebSocket service with the specified <paramref name="path"/>.
  8058. </summary>
  8059. <remarks>
  8060. <para>
  8061. <paramref name="path"/> is converted to a URL-decoded string and
  8062. / is trimmed from the end of the converted string if any.
  8063. </para>
  8064. <para>
  8065. The service is stopped with close status 1001 (going away)
  8066. if it has already started.
  8067. </para>
  8068. </remarks>
  8069. <returns>
  8070. <c>true</c> if the service is successfully found and removed;
  8071. otherwise, <c>false</c>.
  8072. </returns>
  8073. <param name="path">
  8074. A <see cref="T:System.String"/> that represents an absolute path to
  8075. the service to remove.
  8076. </param>
  8077. <exception cref="T:System.ArgumentNullException">
  8078. <paramref name="path"/> is <see langword="null"/>.
  8079. </exception>
  8080. <exception cref="T:System.ArgumentException">
  8081. <para>
  8082. <paramref name="path"/> is empty.
  8083. </para>
  8084. <para>
  8085. -or-
  8086. </para>
  8087. <para>
  8088. <paramref name="path"/> is not an absolute path.
  8089. </para>
  8090. <para>
  8091. -or-
  8092. </para>
  8093. <para>
  8094. <paramref name="path"/> includes either or both
  8095. query and fragment components.
  8096. </para>
  8097. </exception>
  8098. </member>
  8099. <member name="M:WebSocketSharp.Server.WebSocketServiceManager.TryGetServiceHost(System.String,WebSocketSharp.Server.WebSocketServiceHost@)">
  8100. <summary>
  8101. Tries to get the host instance for a WebSocket service with
  8102. the specified <paramref name="path"/>.
  8103. </summary>
  8104. <remarks>
  8105. <paramref name="path"/> is converted to a URL-decoded string and
  8106. / is trimmed from the end of the converted string if any.
  8107. </remarks>
  8108. <returns>
  8109. <c>true</c> if the service is successfully found;
  8110. otherwise, <c>false</c>.
  8111. </returns>
  8112. <param name="path">
  8113. A <see cref="T:System.String"/> that represents an absolute path to
  8114. the service to find.
  8115. </param>
  8116. <param name="host">
  8117. <para>
  8118. When this method returns, a <see cref="T:WebSocketSharp.Server.WebSocketServiceHost"/>
  8119. instance or <see langword="null"/> if not found.
  8120. </para>
  8121. <para>
  8122. That host instance provides the function to access
  8123. the information in the service.
  8124. </para>
  8125. </param>
  8126. <exception cref="T:System.ArgumentNullException">
  8127. <paramref name="path"/> is <see langword="null"/>.
  8128. </exception>
  8129. <exception cref="T:System.ArgumentException">
  8130. <para>
  8131. <paramref name="path"/> is empty.
  8132. </para>
  8133. <para>
  8134. -or-
  8135. </para>
  8136. <para>
  8137. <paramref name="path"/> is not an absolute path.
  8138. </para>
  8139. <para>
  8140. -or-
  8141. </para>
  8142. <para>
  8143. <paramref name="path"/> includes either or both
  8144. query and fragment components.
  8145. </para>
  8146. </exception>
  8147. </member>
  8148. <member name="T:WebSocketSharp.Server.WebSocketSessionManager">
  8149. <summary>
  8150. Provides the management function for the sessions in a WebSocket service.
  8151. </summary>
  8152. <remarks>
  8153. This class manages the sessions in a WebSocket service provided by
  8154. the <see cref="T:WebSocketSharp.Server.WebSocketServer"/> or <see cref="T:WebSocketSharp.Server.HttpServer"/>.
  8155. </remarks>
  8156. </member>
  8157. <member name="P:WebSocketSharp.Server.WebSocketSessionManager.ActiveIDs">
  8158. <summary>
  8159. Gets the IDs for the active sessions in the WebSocket service.
  8160. </summary>
  8161. <value>
  8162. <para>
  8163. An <c>IEnumerable&lt;string&gt;</c> instance.
  8164. </para>
  8165. <para>
  8166. It provides an enumerator which supports the iteration over
  8167. the collection of the IDs for the active sessions.
  8168. </para>
  8169. </value>
  8170. </member>
  8171. <member name="P:WebSocketSharp.Server.WebSocketSessionManager.Count">
  8172. <summary>
  8173. Gets the number of the sessions in the WebSocket service.
  8174. </summary>
  8175. <value>
  8176. An <see cref="T:System.Int32"/> that represents the number of the sessions.
  8177. </value>
  8178. </member>
  8179. <member name="P:WebSocketSharp.Server.WebSocketSessionManager.IDs">
  8180. <summary>
  8181. Gets the IDs for the sessions in the WebSocket service.
  8182. </summary>
  8183. <value>
  8184. <para>
  8185. An <c>IEnumerable&lt;string&gt;</c> instance.
  8186. </para>
  8187. <para>
  8188. It provides an enumerator which supports the iteration over
  8189. the collection of the IDs for the sessions.
  8190. </para>
  8191. </value>
  8192. </member>
  8193. <member name="P:WebSocketSharp.Server.WebSocketSessionManager.InactiveIDs">
  8194. <summary>
  8195. Gets the IDs for the inactive sessions in the WebSocket service.
  8196. </summary>
  8197. <value>
  8198. <para>
  8199. An <c>IEnumerable&lt;string&gt;</c> instance.
  8200. </para>
  8201. <para>
  8202. It provides an enumerator which supports the iteration over
  8203. the collection of the IDs for the inactive sessions.
  8204. </para>
  8205. </value>
  8206. </member>
  8207. <member name="P:WebSocketSharp.Server.WebSocketSessionManager.Item(System.String)">
  8208. <summary>
  8209. Gets the session instance with <paramref name="id"/>.
  8210. </summary>
  8211. <value>
  8212. <para>
  8213. A <see cref="T:WebSocketSharp.Server.IWebSocketSession"/> instance or <see langword="null"/>
  8214. if not found.
  8215. </para>
  8216. <para>
  8217. The session instance provides the function to access the information
  8218. in the session.
  8219. </para>
  8220. </value>
  8221. <param name="id">
  8222. A <see cref="T:System.String"/> that represents the ID of the session to find.
  8223. </param>
  8224. <exception cref="T:System.ArgumentNullException">
  8225. <paramref name="id"/> is <see langword="null"/>.
  8226. </exception>
  8227. <exception cref="T:System.ArgumentException">
  8228. <paramref name="id"/> is an empty string.
  8229. </exception>
  8230. </member>
  8231. <member name="P:WebSocketSharp.Server.WebSocketSessionManager.KeepClean">
  8232. <summary>
  8233. Gets or sets a value indicating whether the inactive sessions in
  8234. the WebSocket service are cleaned up periodically.
  8235. </summary>
  8236. <remarks>
  8237. The set operation does nothing if the service has already started or
  8238. it is shutting down.
  8239. </remarks>
  8240. <value>
  8241. <c>true</c> if the inactive sessions are cleaned up every 60 seconds;
  8242. otherwise, <c>false</c>.
  8243. </value>
  8244. </member>
  8245. <member name="P:WebSocketSharp.Server.WebSocketSessionManager.Sessions">
  8246. <summary>
  8247. Gets the session instances in the WebSocket service.
  8248. </summary>
  8249. <value>
  8250. <para>
  8251. An <c>IEnumerable&lt;IWebSocketSession&gt;</c> instance.
  8252. </para>
  8253. <para>
  8254. It provides an enumerator which supports the iteration over
  8255. the collection of the session instances.
  8256. </para>
  8257. </value>
  8258. </member>
  8259. <member name="P:WebSocketSharp.Server.WebSocketSessionManager.WaitTime">
  8260. <summary>
  8261. Gets or sets the time to wait for the response to the WebSocket Ping or
  8262. Close.
  8263. </summary>
  8264. <remarks>
  8265. The set operation does nothing if the service has already started or
  8266. it is shutting down.
  8267. </remarks>
  8268. <value>
  8269. A <see cref="T:System.TimeSpan"/> to wait for the response.
  8270. </value>
  8271. <exception cref="T:System.ArgumentOutOfRangeException">
  8272. The value specified for a set operation is zero or less.
  8273. </exception>
  8274. </member>
  8275. <member name="M:WebSocketSharp.Server.WebSocketSessionManager.Broadcast(System.Byte[])">
  8276. <summary>
  8277. Sends <paramref name="data"/> to every client in the WebSocket service.
  8278. </summary>
  8279. <param name="data">
  8280. An array of <see cref="T:System.Byte"/> that represents the binary data to send.
  8281. </param>
  8282. <exception cref="T:System.InvalidOperationException">
  8283. The current state of the manager is not Start.
  8284. </exception>
  8285. <exception cref="T:System.ArgumentNullException">
  8286. <paramref name="data"/> is <see langword="null"/>.
  8287. </exception>
  8288. </member>
  8289. <member name="M:WebSocketSharp.Server.WebSocketSessionManager.Broadcast(System.String)">
  8290. <summary>
  8291. Sends <paramref name="data"/> to every client in the WebSocket service.
  8292. </summary>
  8293. <param name="data">
  8294. A <see cref="T:System.String"/> that represents the text data to send.
  8295. </param>
  8296. <exception cref="T:System.InvalidOperationException">
  8297. The current state of the manager is not Start.
  8298. </exception>
  8299. <exception cref="T:System.ArgumentNullException">
  8300. <paramref name="data"/> is <see langword="null"/>.
  8301. </exception>
  8302. <exception cref="T:System.ArgumentException">
  8303. <paramref name="data"/> could not be UTF-8-encoded.
  8304. </exception>
  8305. </member>
  8306. <member name="M:WebSocketSharp.Server.WebSocketSessionManager.Broadcast(System.IO.Stream,System.Int32)">
  8307. <summary>
  8308. Sends the data from <paramref name="stream"/> to every client in
  8309. the WebSocket service.
  8310. </summary>
  8311. <remarks>
  8312. The data is sent as the binary data.
  8313. </remarks>
  8314. <param name="stream">
  8315. A <see cref="T:System.IO.Stream"/> instance from which to read the data to send.
  8316. </param>
  8317. <param name="length">
  8318. An <see cref="T:System.Int32"/> that specifies the number of bytes to send.
  8319. </param>
  8320. <exception cref="T:System.InvalidOperationException">
  8321. The current state of the manager is not Start.
  8322. </exception>
  8323. <exception cref="T:System.ArgumentNullException">
  8324. <paramref name="stream"/> is <see langword="null"/>.
  8325. </exception>
  8326. <exception cref="T:System.ArgumentException">
  8327. <para>
  8328. <paramref name="stream"/> cannot be read.
  8329. </para>
  8330. <para>
  8331. -or-
  8332. </para>
  8333. <para>
  8334. <paramref name="length"/> is less than 1.
  8335. </para>
  8336. <para>
  8337. -or-
  8338. </para>
  8339. <para>
  8340. No data could be read from <paramref name="stream"/>.
  8341. </para>
  8342. </exception>
  8343. </member>
  8344. <member name="M:WebSocketSharp.Server.WebSocketSessionManager.BroadcastAsync(System.Byte[],System.Action)">
  8345. <summary>
  8346. Sends <paramref name="data"/> asynchronously to every client in
  8347. the WebSocket service.
  8348. </summary>
  8349. <remarks>
  8350. This method does not wait for the send to be complete.
  8351. </remarks>
  8352. <param name="data">
  8353. An array of <see cref="T:System.Byte"/> that represents the binary data to send.
  8354. </param>
  8355. <param name="completed">
  8356. <para>
  8357. An <see cref="T:System.Action"/> delegate or <see langword="null"/>
  8358. if not needed.
  8359. </para>
  8360. <para>
  8361. The delegate invokes the method called when the send is complete.
  8362. </para>
  8363. </param>
  8364. <exception cref="T:System.InvalidOperationException">
  8365. The current state of the manager is not Start.
  8366. </exception>
  8367. <exception cref="T:System.ArgumentNullException">
  8368. <paramref name="data"/> is <see langword="null"/>.
  8369. </exception>
  8370. </member>
  8371. <member name="M:WebSocketSharp.Server.WebSocketSessionManager.BroadcastAsync(System.String,System.Action)">
  8372. <summary>
  8373. Sends <paramref name="data"/> asynchronously to every client in
  8374. the WebSocket service.
  8375. </summary>
  8376. <remarks>
  8377. This method does not wait for the send to be complete.
  8378. </remarks>
  8379. <param name="data">
  8380. A <see cref="T:System.String"/> that represents the text data to send.
  8381. </param>
  8382. <param name="completed">
  8383. <para>
  8384. An <see cref="T:System.Action"/> delegate or <see langword="null"/>
  8385. if not needed.
  8386. </para>
  8387. <para>
  8388. The delegate invokes the method called when the send is complete.
  8389. </para>
  8390. </param>
  8391. <exception cref="T:System.InvalidOperationException">
  8392. The current state of the manager is not Start.
  8393. </exception>
  8394. <exception cref="T:System.ArgumentNullException">
  8395. <paramref name="data"/> is <see langword="null"/>.
  8396. </exception>
  8397. <exception cref="T:System.ArgumentException">
  8398. <paramref name="data"/> could not be UTF-8-encoded.
  8399. </exception>
  8400. </member>
  8401. <member name="M:WebSocketSharp.Server.WebSocketSessionManager.BroadcastAsync(System.IO.Stream,System.Int32,System.Action)">
  8402. <summary>
  8403. Sends the data from <paramref name="stream"/> asynchronously to
  8404. every client in the WebSocket service.
  8405. </summary>
  8406. <remarks>
  8407. <para>
  8408. The data is sent as the binary data.
  8409. </para>
  8410. <para>
  8411. This method does not wait for the send to be complete.
  8412. </para>
  8413. </remarks>
  8414. <param name="stream">
  8415. A <see cref="T:System.IO.Stream"/> instance from which to read the data to send.
  8416. </param>
  8417. <param name="length">
  8418. An <see cref="T:System.Int32"/> that specifies the number of bytes to send.
  8419. </param>
  8420. <param name="completed">
  8421. <para>
  8422. An <see cref="T:System.Action"/> delegate or <see langword="null"/>
  8423. if not needed.
  8424. </para>
  8425. <para>
  8426. The delegate invokes the method called when the send is complete.
  8427. </para>
  8428. </param>
  8429. <exception cref="T:System.InvalidOperationException">
  8430. The current state of the manager is not Start.
  8431. </exception>
  8432. <exception cref="T:System.ArgumentNullException">
  8433. <paramref name="stream"/> is <see langword="null"/>.
  8434. </exception>
  8435. <exception cref="T:System.ArgumentException">
  8436. <para>
  8437. <paramref name="stream"/> cannot be read.
  8438. </para>
  8439. <para>
  8440. -or-
  8441. </para>
  8442. <para>
  8443. <paramref name="length"/> is less than 1.
  8444. </para>
  8445. <para>
  8446. -or-
  8447. </para>
  8448. <para>
  8449. No data could be read from <paramref name="stream"/>.
  8450. </para>
  8451. </exception>
  8452. </member>
  8453. <member name="M:WebSocketSharp.Server.WebSocketSessionManager.Broadping">
  8454. <summary>
  8455. Sends a ping to every client in the WebSocket service.
  8456. </summary>
  8457. <returns>
  8458. <para>
  8459. A <c>Dictionary&lt;string, bool&gt;</c>.
  8460. </para>
  8461. <para>
  8462. It represents a collection of pairs of a session ID and
  8463. a value indicating whether a pong has been received from
  8464. the client within a time.
  8465. </para>
  8466. </returns>
  8467. <exception cref="T:System.InvalidOperationException">
  8468. The current state of the manager is not Start.
  8469. </exception>
  8470. </member>
  8471. <member name="M:WebSocketSharp.Server.WebSocketSessionManager.Broadping(System.String)">
  8472. <summary>
  8473. Sends a ping with <paramref name="message"/> to every client in
  8474. the WebSocket service.
  8475. </summary>
  8476. <returns>
  8477. <para>
  8478. A <c>Dictionary&lt;string, bool&gt;</c>.
  8479. </para>
  8480. <para>
  8481. It represents a collection of pairs of a session ID and
  8482. a value indicating whether a pong has been received from
  8483. the client within a time.
  8484. </para>
  8485. </returns>
  8486. <param name="message">
  8487. <para>
  8488. A <see cref="T:System.String"/> that represents the message to send.
  8489. </para>
  8490. <para>
  8491. The size must be 125 bytes or less in UTF-8.
  8492. </para>
  8493. </param>
  8494. <exception cref="T:System.InvalidOperationException">
  8495. The current state of the manager is not Start.
  8496. </exception>
  8497. <exception cref="T:System.ArgumentException">
  8498. <paramref name="message"/> could not be UTF-8-encoded.
  8499. </exception>
  8500. <exception cref="T:System.ArgumentOutOfRangeException">
  8501. The size of <paramref name="message"/> is greater than 125 bytes.
  8502. </exception>
  8503. </member>
  8504. <member name="M:WebSocketSharp.Server.WebSocketSessionManager.CloseSession(System.String)">
  8505. <summary>
  8506. Closes the specified session.
  8507. </summary>
  8508. <param name="id">
  8509. A <see cref="T:System.String"/> that represents the ID of the session to close.
  8510. </param>
  8511. <exception cref="T:System.ArgumentNullException">
  8512. <paramref name="id"/> is <see langword="null"/>.
  8513. </exception>
  8514. <exception cref="T:System.ArgumentException">
  8515. <paramref name="id"/> is an empty string.
  8516. </exception>
  8517. <exception cref="T:System.InvalidOperationException">
  8518. The session could not be found.
  8519. </exception>
  8520. </member>
  8521. <member name="M:WebSocketSharp.Server.WebSocketSessionManager.CloseSession(System.String,System.UInt16,System.String)">
  8522. <summary>
  8523. Closes the specified session with <paramref name="code"/> and
  8524. <paramref name="reason"/>.
  8525. </summary>
  8526. <param name="id">
  8527. A <see cref="T:System.String"/> that represents the ID of the session to close.
  8528. </param>
  8529. <param name="code">
  8530. <para>
  8531. A <see cref="T:System.UInt16"/> that represents the status code indicating
  8532. the reason for the close.
  8533. </para>
  8534. <para>
  8535. The status codes are defined in
  8536. <see href="http://tools.ietf.org/html/rfc6455#section-7.4">
  8537. Section 7.4</see> of RFC 6455.
  8538. </para>
  8539. </param>
  8540. <param name="reason">
  8541. <para>
  8542. A <see cref="T:System.String"/> that represents the reason for the close.
  8543. </para>
  8544. <para>
  8545. The size must be 123 bytes or less in UTF-8.
  8546. </para>
  8547. </param>
  8548. <exception cref="T:System.ArgumentNullException">
  8549. <paramref name="id"/> is <see langword="null"/>.
  8550. </exception>
  8551. <exception cref="T:System.ArgumentException">
  8552. <para>
  8553. <paramref name="id"/> is an empty string.
  8554. </para>
  8555. <para>
  8556. -or-
  8557. </para>
  8558. <para>
  8559. <paramref name="code"/> is 1010 (mandatory extension).
  8560. </para>
  8561. <para>
  8562. -or-
  8563. </para>
  8564. <para>
  8565. <paramref name="code"/> is 1005 (no status) and there is
  8566. <paramref name="reason"/>.
  8567. </para>
  8568. <para>
  8569. -or-
  8570. </para>
  8571. <para>
  8572. <paramref name="reason"/> could not be UTF-8-encoded.
  8573. </para>
  8574. </exception>
  8575. <exception cref="T:System.InvalidOperationException">
  8576. The session could not be found.
  8577. </exception>
  8578. <exception cref="T:System.ArgumentOutOfRangeException">
  8579. <para>
  8580. <paramref name="code"/> is less than 1000 or greater than 4999.
  8581. </para>
  8582. <para>
  8583. -or-
  8584. </para>
  8585. <para>
  8586. The size of <paramref name="reason"/> is greater than 123 bytes.
  8587. </para>
  8588. </exception>
  8589. </member>
  8590. <member name="M:WebSocketSharp.Server.WebSocketSessionManager.CloseSession(System.String,WebSocketSharp.CloseStatusCode,System.String)">
  8591. <summary>
  8592. Closes the specified session with <paramref name="code"/> and
  8593. <paramref name="reason"/>.
  8594. </summary>
  8595. <param name="id">
  8596. A <see cref="T:System.String"/> that represents the ID of the session to close.
  8597. </param>
  8598. <param name="code">
  8599. <para>
  8600. One of the <see cref="T:WebSocketSharp.CloseStatusCode"/> enum values.
  8601. </para>
  8602. <para>
  8603. It represents the status code indicating the reason for the close.
  8604. </para>
  8605. </param>
  8606. <param name="reason">
  8607. <para>
  8608. A <see cref="T:System.String"/> that represents the reason for the close.
  8609. </para>
  8610. <para>
  8611. The size must be 123 bytes or less in UTF-8.
  8612. </para>
  8613. </param>
  8614. <exception cref="T:System.ArgumentNullException">
  8615. <paramref name="id"/> is <see langword="null"/>.
  8616. </exception>
  8617. <exception cref="T:System.ArgumentException">
  8618. <para>
  8619. <paramref name="id"/> is an empty string.
  8620. </para>
  8621. <para>
  8622. -or-
  8623. </para>
  8624. <para>
  8625. <paramref name="code"/> is
  8626. <see cref="F:WebSocketSharp.CloseStatusCode.MandatoryExtension"/>.
  8627. </para>
  8628. <para>
  8629. -or-
  8630. </para>
  8631. <para>
  8632. <paramref name="code"/> is
  8633. <see cref="F:WebSocketSharp.CloseStatusCode.NoStatus"/> and there is
  8634. <paramref name="reason"/>.
  8635. </para>
  8636. <para>
  8637. -or-
  8638. </para>
  8639. <para>
  8640. <paramref name="reason"/> could not be UTF-8-encoded.
  8641. </para>
  8642. </exception>
  8643. <exception cref="T:System.InvalidOperationException">
  8644. The session could not be found.
  8645. </exception>
  8646. <exception cref="T:System.ArgumentOutOfRangeException">
  8647. The size of <paramref name="reason"/> is greater than 123 bytes.
  8648. </exception>
  8649. </member>
  8650. <member name="M:WebSocketSharp.Server.WebSocketSessionManager.PingTo(System.String)">
  8651. <summary>
  8652. Sends a ping to the client using the specified session.
  8653. </summary>
  8654. <returns>
  8655. <c>true</c> if the send has done with no error and a pong has been
  8656. received from the client within a time; otherwise, <c>false</c>.
  8657. </returns>
  8658. <param name="id">
  8659. A <see cref="T:System.String"/> that represents the ID of the session.
  8660. </param>
  8661. <exception cref="T:System.ArgumentNullException">
  8662. <paramref name="id"/> is <see langword="null"/>.
  8663. </exception>
  8664. <exception cref="T:System.ArgumentException">
  8665. <paramref name="id"/> is an empty string.
  8666. </exception>
  8667. <exception cref="T:System.InvalidOperationException">
  8668. The session could not be found.
  8669. </exception>
  8670. </member>
  8671. <member name="M:WebSocketSharp.Server.WebSocketSessionManager.PingTo(System.String,System.String)">
  8672. <summary>
  8673. Sends a ping with <paramref name="message"/> to the client using
  8674. the specified session.
  8675. </summary>
  8676. <returns>
  8677. <c>true</c> if the send has done with no error and a pong has been
  8678. received from the client within a time; otherwise, <c>false</c>.
  8679. </returns>
  8680. <param name="message">
  8681. <para>
  8682. A <see cref="T:System.String"/> that represents the message to send.
  8683. </para>
  8684. <para>
  8685. The size must be 125 bytes or less in UTF-8.
  8686. </para>
  8687. </param>
  8688. <param name="id">
  8689. A <see cref="T:System.String"/> that represents the ID of the session.
  8690. </param>
  8691. <exception cref="T:System.ArgumentNullException">
  8692. <paramref name="id"/> is <see langword="null"/>.
  8693. </exception>
  8694. <exception cref="T:System.ArgumentException">
  8695. <para>
  8696. <paramref name="id"/> is an empty string.
  8697. </para>
  8698. <para>
  8699. -or-
  8700. </para>
  8701. <para>
  8702. <paramref name="message"/> could not be UTF-8-encoded.
  8703. </para>
  8704. </exception>
  8705. <exception cref="T:System.InvalidOperationException">
  8706. The session could not be found.
  8707. </exception>
  8708. <exception cref="T:System.ArgumentOutOfRangeException">
  8709. The size of <paramref name="message"/> is greater than 125 bytes.
  8710. </exception>
  8711. </member>
  8712. <member name="M:WebSocketSharp.Server.WebSocketSessionManager.SendTo(System.Byte[],System.String)">
  8713. <summary>
  8714. Sends <paramref name="data"/> to the client using the specified session.
  8715. </summary>
  8716. <param name="data">
  8717. An array of <see cref="T:System.Byte"/> that represents the binary data to send.
  8718. </param>
  8719. <param name="id">
  8720. A <see cref="T:System.String"/> that represents the ID of the session.
  8721. </param>
  8722. <exception cref="T:System.ArgumentNullException">
  8723. <para>
  8724. <paramref name="id"/> is <see langword="null"/>.
  8725. </para>
  8726. <para>
  8727. -or-
  8728. </para>
  8729. <para>
  8730. <paramref name="data"/> is <see langword="null"/>.
  8731. </para>
  8732. </exception>
  8733. <exception cref="T:System.ArgumentException">
  8734. <paramref name="id"/> is an empty string.
  8735. </exception>
  8736. <exception cref="T:System.InvalidOperationException">
  8737. <para>
  8738. The session could not be found.
  8739. </para>
  8740. <para>
  8741. -or-
  8742. </para>
  8743. <para>
  8744. The current state of the WebSocket connection is not Open.
  8745. </para>
  8746. </exception>
  8747. </member>
  8748. <member name="M:WebSocketSharp.Server.WebSocketSessionManager.SendTo(System.String,System.String)">
  8749. <summary>
  8750. Sends <paramref name="data"/> to the client using the specified session.
  8751. </summary>
  8752. <param name="data">
  8753. A <see cref="T:System.String"/> that represents the text data to send.
  8754. </param>
  8755. <param name="id">
  8756. A <see cref="T:System.String"/> that represents the ID of the session.
  8757. </param>
  8758. <exception cref="T:System.ArgumentNullException">
  8759. <para>
  8760. <paramref name="id"/> is <see langword="null"/>.
  8761. </para>
  8762. <para>
  8763. -or-
  8764. </para>
  8765. <para>
  8766. <paramref name="data"/> is <see langword="null"/>.
  8767. </para>
  8768. </exception>
  8769. <exception cref="T:System.ArgumentException">
  8770. <para>
  8771. <paramref name="id"/> is an empty string.
  8772. </para>
  8773. <para>
  8774. -or-
  8775. </para>
  8776. <para>
  8777. <paramref name="data"/> could not be UTF-8-encoded.
  8778. </para>
  8779. </exception>
  8780. <exception cref="T:System.InvalidOperationException">
  8781. <para>
  8782. The session could not be found.
  8783. </para>
  8784. <para>
  8785. -or-
  8786. </para>
  8787. <para>
  8788. The current state of the WebSocket connection is not Open.
  8789. </para>
  8790. </exception>
  8791. </member>
  8792. <member name="M:WebSocketSharp.Server.WebSocketSessionManager.SendTo(System.IO.Stream,System.Int32,System.String)">
  8793. <summary>
  8794. Sends the data from <paramref name="stream"/> to the client using
  8795. the specified session.
  8796. </summary>
  8797. <remarks>
  8798. The data is sent as the binary data.
  8799. </remarks>
  8800. <param name="stream">
  8801. A <see cref="T:System.IO.Stream"/> instance from which to read the data to send.
  8802. </param>
  8803. <param name="length">
  8804. An <see cref="T:System.Int32"/> that specifies the number of bytes to send.
  8805. </param>
  8806. <param name="id">
  8807. A <see cref="T:System.String"/> that represents the ID of the session.
  8808. </param>
  8809. <exception cref="T:System.ArgumentNullException">
  8810. <para>
  8811. <paramref name="id"/> is <see langword="null"/>.
  8812. </para>
  8813. <para>
  8814. -or-
  8815. </para>
  8816. <para>
  8817. <paramref name="stream"/> is <see langword="null"/>.
  8818. </para>
  8819. </exception>
  8820. <exception cref="T:System.ArgumentException">
  8821. <para>
  8822. <paramref name="id"/> is an empty string.
  8823. </para>
  8824. <para>
  8825. -or-
  8826. </para>
  8827. <para>
  8828. <paramref name="stream"/> cannot be read.
  8829. </para>
  8830. <para>
  8831. -or-
  8832. </para>
  8833. <para>
  8834. <paramref name="length"/> is less than 1.
  8835. </para>
  8836. <para>
  8837. -or-
  8838. </para>
  8839. <para>
  8840. No data could be read from <paramref name="stream"/>.
  8841. </para>
  8842. </exception>
  8843. <exception cref="T:System.InvalidOperationException">
  8844. <para>
  8845. The session could not be found.
  8846. </para>
  8847. <para>
  8848. -or-
  8849. </para>
  8850. <para>
  8851. The current state of the WebSocket connection is not Open.
  8852. </para>
  8853. </exception>
  8854. </member>
  8855. <member name="M:WebSocketSharp.Server.WebSocketSessionManager.SendToAsync(System.Byte[],System.String,System.Action{System.Boolean})">
  8856. <summary>
  8857. Sends <paramref name="data"/> asynchronously to the client using
  8858. the specified session.
  8859. </summary>
  8860. <remarks>
  8861. This method does not wait for the send to be complete.
  8862. </remarks>
  8863. <param name="data">
  8864. An array of <see cref="T:System.Byte"/> that represents the binary data to send.
  8865. </param>
  8866. <param name="id">
  8867. A <see cref="T:System.String"/> that represents the ID of the session.
  8868. </param>
  8869. <param name="completed">
  8870. <para>
  8871. An <c>Action&lt;bool&gt;</c> delegate or <see langword="null"/>
  8872. if not needed.
  8873. </para>
  8874. <para>
  8875. The delegate invokes the method called when the send is complete.
  8876. </para>
  8877. <para>
  8878. <c>true</c> is passed to the method if the send has done with
  8879. no error; otherwise, <c>false</c>.
  8880. </para>
  8881. </param>
  8882. <exception cref="T:System.ArgumentNullException">
  8883. <para>
  8884. <paramref name="id"/> is <see langword="null"/>.
  8885. </para>
  8886. <para>
  8887. -or-
  8888. </para>
  8889. <para>
  8890. <paramref name="data"/> is <see langword="null"/>.
  8891. </para>
  8892. </exception>
  8893. <exception cref="T:System.ArgumentException">
  8894. <paramref name="id"/> is an empty string.
  8895. </exception>
  8896. <exception cref="T:System.InvalidOperationException">
  8897. <para>
  8898. The session could not be found.
  8899. </para>
  8900. <para>
  8901. -or-
  8902. </para>
  8903. <para>
  8904. The current state of the WebSocket connection is not Open.
  8905. </para>
  8906. </exception>
  8907. </member>
  8908. <member name="M:WebSocketSharp.Server.WebSocketSessionManager.SendToAsync(System.String,System.String,System.Action{System.Boolean})">
  8909. <summary>
  8910. Sends <paramref name="data"/> asynchronously to the client using
  8911. the specified session.
  8912. </summary>
  8913. <remarks>
  8914. This method does not wait for the send to be complete.
  8915. </remarks>
  8916. <param name="data">
  8917. A <see cref="T:System.String"/> that represents the text data to send.
  8918. </param>
  8919. <param name="id">
  8920. A <see cref="T:System.String"/> that represents the ID of the session.
  8921. </param>
  8922. <param name="completed">
  8923. <para>
  8924. An <c>Action&lt;bool&gt;</c> delegate or <see langword="null"/>
  8925. if not needed.
  8926. </para>
  8927. <para>
  8928. The delegate invokes the method called when the send is complete.
  8929. </para>
  8930. <para>
  8931. <c>true</c> is passed to the method if the send has done with
  8932. no error; otherwise, <c>false</c>.
  8933. </para>
  8934. </param>
  8935. <exception cref="T:System.ArgumentNullException">
  8936. <para>
  8937. <paramref name="id"/> is <see langword="null"/>.
  8938. </para>
  8939. <para>
  8940. -or-
  8941. </para>
  8942. <para>
  8943. <paramref name="data"/> is <see langword="null"/>.
  8944. </para>
  8945. </exception>
  8946. <exception cref="T:System.ArgumentException">
  8947. <para>
  8948. <paramref name="id"/> is an empty string.
  8949. </para>
  8950. <para>
  8951. -or-
  8952. </para>
  8953. <para>
  8954. <paramref name="data"/> could not be UTF-8-encoded.
  8955. </para>
  8956. </exception>
  8957. <exception cref="T:System.InvalidOperationException">
  8958. <para>
  8959. The session could not be found.
  8960. </para>
  8961. <para>
  8962. -or-
  8963. </para>
  8964. <para>
  8965. The current state of the WebSocket connection is not Open.
  8966. </para>
  8967. </exception>
  8968. </member>
  8969. <member name="M:WebSocketSharp.Server.WebSocketSessionManager.SendToAsync(System.IO.Stream,System.Int32,System.String,System.Action{System.Boolean})">
  8970. <summary>
  8971. Sends the data from <paramref name="stream"/> asynchronously to
  8972. the client using the specified session.
  8973. </summary>
  8974. <remarks>
  8975. <para>
  8976. The data is sent as the binary data.
  8977. </para>
  8978. <para>
  8979. This method does not wait for the send to be complete.
  8980. </para>
  8981. </remarks>
  8982. <param name="stream">
  8983. A <see cref="T:System.IO.Stream"/> instance from which to read the data to send.
  8984. </param>
  8985. <param name="length">
  8986. An <see cref="T:System.Int32"/> that specifies the number of bytes to send.
  8987. </param>
  8988. <param name="id">
  8989. A <see cref="T:System.String"/> that represents the ID of the session.
  8990. </param>
  8991. <param name="completed">
  8992. <para>
  8993. An <c>Action&lt;bool&gt;</c> delegate or <see langword="null"/>
  8994. if not needed.
  8995. </para>
  8996. <para>
  8997. The delegate invokes the method called when the send is complete.
  8998. </para>
  8999. <para>
  9000. <c>true</c> is passed to the method if the send has done with
  9001. no error; otherwise, <c>false</c>.
  9002. </para>
  9003. </param>
  9004. <exception cref="T:System.ArgumentNullException">
  9005. <para>
  9006. <paramref name="id"/> is <see langword="null"/>.
  9007. </para>
  9008. <para>
  9009. -or-
  9010. </para>
  9011. <para>
  9012. <paramref name="stream"/> is <see langword="null"/>.
  9013. </para>
  9014. </exception>
  9015. <exception cref="T:System.ArgumentException">
  9016. <para>
  9017. <paramref name="id"/> is an empty string.
  9018. </para>
  9019. <para>
  9020. -or-
  9021. </para>
  9022. <para>
  9023. <paramref name="stream"/> cannot be read.
  9024. </para>
  9025. <para>
  9026. -or-
  9027. </para>
  9028. <para>
  9029. <paramref name="length"/> is less than 1.
  9030. </para>
  9031. <para>
  9032. -or-
  9033. </para>
  9034. <para>
  9035. No data could be read from <paramref name="stream"/>.
  9036. </para>
  9037. </exception>
  9038. <exception cref="T:System.InvalidOperationException">
  9039. <para>
  9040. The session could not be found.
  9041. </para>
  9042. <para>
  9043. -or-
  9044. </para>
  9045. <para>
  9046. The current state of the WebSocket connection is not Open.
  9047. </para>
  9048. </exception>
  9049. </member>
  9050. <member name="M:WebSocketSharp.Server.WebSocketSessionManager.Sweep">
  9051. <summary>
  9052. Cleans up the inactive sessions in the WebSocket service.
  9053. </summary>
  9054. </member>
  9055. <member name="M:WebSocketSharp.Server.WebSocketSessionManager.TryGetSession(System.String,WebSocketSharp.Server.IWebSocketSession@)">
  9056. <summary>
  9057. Tries to get the session instance with <paramref name="id"/>.
  9058. </summary>
  9059. <returns>
  9060. <c>true</c> if the session is successfully found; otherwise,
  9061. <c>false</c>.
  9062. </returns>
  9063. <param name="id">
  9064. A <see cref="T:System.String"/> that represents the ID of the session to find.
  9065. </param>
  9066. <param name="session">
  9067. <para>
  9068. When this method returns, a <see cref="T:WebSocketSharp.Server.IWebSocketSession"/>
  9069. instance or <see langword="null"/> if not found.
  9070. </para>
  9071. <para>
  9072. The session instance provides the function to access
  9073. the information in the session.
  9074. </para>
  9075. </param>
  9076. <exception cref="T:System.ArgumentNullException">
  9077. <paramref name="id"/> is <see langword="null"/>.
  9078. </exception>
  9079. <exception cref="T:System.ArgumentException">
  9080. <paramref name="id"/> is an empty string.
  9081. </exception>
  9082. </member>
  9083. <member name="T:WebSocketSharp.WebSocket">
  9084. <summary>
  9085. Implements the WebSocket interface.
  9086. </summary>
  9087. <remarks>
  9088. The WebSocket class provides a set of methods and properties for two-way communication using
  9089. the WebSocket protocol (<see href="http://tools.ietf.org/html/rfc6455">RFC 6455</see>).
  9090. </remarks>
  9091. </member>
  9092. <member name="F:WebSocketSharp.WebSocket.EmptyBytes">
  9093. <summary>
  9094. Represents the empty array of <see cref="T:System.Byte"/> used internally.
  9095. </summary>
  9096. </member>
  9097. <member name="F:WebSocketSharp.WebSocket.FragmentLength">
  9098. <summary>
  9099. Represents the length used to determine whether the data should be fragmented in sending.
  9100. </summary>
  9101. <remarks>
  9102. <para>
  9103. The data will be fragmented if that length is greater than the value of this field.
  9104. </para>
  9105. <para>
  9106. If you would like to change the value, you must set it to a value between <c>125</c> and
  9107. <c>Int32.MaxValue - 14</c> inclusive.
  9108. </para>
  9109. </remarks>
  9110. </member>
  9111. <member name="F:WebSocketSharp.WebSocket.RandomNumber">
  9112. <summary>
  9113. Represents the random number generator used internally.
  9114. </summary>
  9115. </member>
  9116. <member name="M:WebSocketSharp.WebSocket.#ctor(System.String,System.String[])">
  9117. <summary>
  9118. Initializes a new instance of the <see cref="T:WebSocketSharp.WebSocket"/> class with
  9119. <paramref name="url"/> and <paramref name="protocols"/>.
  9120. </summary>
  9121. <param name="url">
  9122. A <see cref="T:System.String"/> that specifies the URL of the WebSocket
  9123. server to connect.
  9124. </param>
  9125. <param name="protocols">
  9126. <para>
  9127. An array of <see cref="T:System.String"/> that specifies the names of
  9128. the subprotocols if necessary.
  9129. </para>
  9130. <para>
  9131. Each value of the array must be a token defined in
  9132. <see href="http://tools.ietf.org/html/rfc2616#section-2.2">
  9133. RFC 2616</see>.
  9134. </para>
  9135. </param>
  9136. <exception cref="T:System.ArgumentNullException">
  9137. <paramref name="url"/> is <see langword="null"/>.
  9138. </exception>
  9139. <exception cref="T:System.ArgumentException">
  9140. <para>
  9141. <paramref name="url"/> is an empty string.
  9142. </para>
  9143. <para>
  9144. -or-
  9145. </para>
  9146. <para>
  9147. <paramref name="url"/> is an invalid WebSocket URL string.
  9148. </para>
  9149. <para>
  9150. -or-
  9151. </para>
  9152. <para>
  9153. <paramref name="protocols"/> contains a value that is not a token.
  9154. </para>
  9155. <para>
  9156. -or-
  9157. </para>
  9158. <para>
  9159. <paramref name="protocols"/> contains a value twice.
  9160. </para>
  9161. </exception>
  9162. </member>
  9163. <member name="P:WebSocketSharp.WebSocket.Compression">
  9164. <summary>
  9165. Gets or sets the compression method used to compress a message.
  9166. </summary>
  9167. <remarks>
  9168. The set operation does nothing if the connection has already been
  9169. established or it is closing.
  9170. </remarks>
  9171. <value>
  9172. <para>
  9173. One of the <see cref="T:WebSocketSharp.CompressionMethod"/> enum values.
  9174. </para>
  9175. <para>
  9176. It represents the compression method used to compress a message.
  9177. </para>
  9178. <para>
  9179. The default value is <see cref="F:WebSocketSharp.CompressionMethod.None"/>.
  9180. </para>
  9181. </value>
  9182. <exception cref="T:System.InvalidOperationException">
  9183. The set operation cannot be used by servers.
  9184. </exception>
  9185. </member>
  9186. <member name="P:WebSocketSharp.WebSocket.Cookies">
  9187. <summary>
  9188. Gets the HTTP cookies included in the WebSocket handshake request and response.
  9189. </summary>
  9190. <value>
  9191. An <see cref="T:System.Collections.Generic.IEnumerable{WebSocketSharp.Net.Cookie}"/>
  9192. instance that provides an enumerator which supports the iteration over the collection of
  9193. the cookies.
  9194. </value>
  9195. </member>
  9196. <member name="P:WebSocketSharp.WebSocket.Credentials">
  9197. <summary>
  9198. Gets the credentials for the HTTP authentication (Basic/Digest).
  9199. </summary>
  9200. <value>
  9201. A <see cref="T:WebSocketSharp.Net.NetworkCredential"/> that represents the credentials for
  9202. the authentication. The default value is <see langword="null"/>.
  9203. </value>
  9204. </member>
  9205. <member name="P:WebSocketSharp.WebSocket.EmitOnPing">
  9206. <summary>
  9207. Gets or sets a value indicating whether the <see cref="T:WebSocketSharp.WebSocket"/> emits
  9208. a <see cref="E:WebSocketSharp.WebSocket.OnMessage"/> event when receives a ping.
  9209. </summary>
  9210. <value>
  9211. <c>true</c> if the <see cref="T:WebSocketSharp.WebSocket"/> emits a <see cref="E:WebSocketSharp.WebSocket.OnMessage"/> event
  9212. when receives a ping; otherwise, <c>false</c>. The default value is <c>false</c>.
  9213. </value>
  9214. </member>
  9215. <member name="P:WebSocketSharp.WebSocket.EnableRedirection">
  9216. <summary>
  9217. Gets or sets a value indicating whether the URL redirection for
  9218. the handshake request is allowed.
  9219. </summary>
  9220. <remarks>
  9221. The set operation does nothing if the connection has already been
  9222. established or it is closing.
  9223. </remarks>
  9224. <value>
  9225. <para>
  9226. <c>true</c> if the URL redirection for the handshake request is
  9227. allowed; otherwise, <c>false</c>.
  9228. </para>
  9229. <para>
  9230. The default value is <c>false</c>.
  9231. </para>
  9232. </value>
  9233. <exception cref="T:System.InvalidOperationException">
  9234. The set operation cannot be used by servers.
  9235. </exception>
  9236. </member>
  9237. <member name="P:WebSocketSharp.WebSocket.Extensions">
  9238. <summary>
  9239. Gets the WebSocket extensions selected by the server.
  9240. </summary>
  9241. <value>
  9242. A <see cref="T:System.String"/> that represents the extensions if any.
  9243. The default value is <see cref="F:System.String.Empty"/>.
  9244. </value>
  9245. </member>
  9246. <member name="P:WebSocketSharp.WebSocket.IsAlive">
  9247. <summary>
  9248. Gets a value indicating whether the WebSocket connection is alive.
  9249. </summary>
  9250. <value>
  9251. <c>true</c> if the connection is alive; otherwise, <c>false</c>.
  9252. </value>
  9253. </member>
  9254. <member name="P:WebSocketSharp.WebSocket.IsSecure">
  9255. <summary>
  9256. Gets a value indicating whether the WebSocket connection is secure.
  9257. </summary>
  9258. <value>
  9259. <c>true</c> if the connection is secure; otherwise, <c>false</c>.
  9260. </value>
  9261. </member>
  9262. <member name="P:WebSocketSharp.WebSocket.Log">
  9263. <summary>
  9264. Gets the logging functions.
  9265. </summary>
  9266. <remarks>
  9267. The default logging level is <see cref="F:WebSocketSharp.LogLevel.Error"/>. If you would like to change it,
  9268. you should set this <c>Log.Level</c> property to any of the <see cref="T:WebSocketSharp.LogLevel"/> enum
  9269. values.
  9270. </remarks>
  9271. <value>
  9272. A <see cref="T:WebSocketSharp.Logger"/> that provides the logging functions.
  9273. </value>
  9274. </member>
  9275. <member name="P:WebSocketSharp.WebSocket.Origin">
  9276. <summary>
  9277. Gets or sets the value of the HTTP Origin header to send with
  9278. the handshake request.
  9279. </summary>
  9280. <remarks>
  9281. <para>
  9282. The HTTP Origin header is defined in
  9283. <see href="http://tools.ietf.org/html/rfc6454#section-7">
  9284. Section 7 of RFC 6454</see>.
  9285. </para>
  9286. <para>
  9287. This instance sends the Origin header if this property has any.
  9288. </para>
  9289. <para>
  9290. The set operation does nothing if the connection has already been
  9291. established or it is closing.
  9292. </para>
  9293. </remarks>
  9294. <value>
  9295. <para>
  9296. A <see cref="T:System.String"/> that represents the value of the Origin
  9297. header to send.
  9298. </para>
  9299. <para>
  9300. The syntax is &lt;scheme&gt;://&lt;host&gt;[:&lt;port&gt;].
  9301. </para>
  9302. <para>
  9303. The default value is <see langword="null"/>.
  9304. </para>
  9305. </value>
  9306. <exception cref="T:System.InvalidOperationException">
  9307. The set operation is not available if this instance is not a client.
  9308. </exception>
  9309. <exception cref="T:System.ArgumentException">
  9310. <para>
  9311. The value specified for a set operation is not an absolute URI string.
  9312. </para>
  9313. <para>
  9314. -or-
  9315. </para>
  9316. <para>
  9317. The value specified for a set operation includes the path segments.
  9318. </para>
  9319. </exception>
  9320. </member>
  9321. <member name="P:WebSocketSharp.WebSocket.Protocol">
  9322. <summary>
  9323. Gets the WebSocket subprotocol selected by the server.
  9324. </summary>
  9325. <value>
  9326. A <see cref="T:System.String"/> that represents the subprotocol if any.
  9327. The default value is <see cref="F:System.String.Empty"/>.
  9328. </value>
  9329. </member>
  9330. <member name="P:WebSocketSharp.WebSocket.ReadyState">
  9331. <summary>
  9332. Gets the state of the WebSocket connection.
  9333. </summary>
  9334. <value>
  9335. One of the <see cref="T:WebSocketSharp.WebSocketState"/> enum values that indicates
  9336. the current state of the connection. The default value is
  9337. <see cref="F:WebSocketSharp.WebSocketState.Connecting"/>.
  9338. </value>
  9339. </member>
  9340. <member name="P:WebSocketSharp.WebSocket.SslConfiguration">
  9341. <summary>
  9342. Gets the configuration for secure connection.
  9343. </summary>
  9344. <remarks>
  9345. This configuration will be referenced when attempts to connect,
  9346. so it must be configured before any connect method is called.
  9347. </remarks>
  9348. <value>
  9349. A <see cref="T:WebSocketSharp.Net.ClientSslConfiguration"/> that represents
  9350. the configuration used to establish a secure connection.
  9351. </value>
  9352. <exception cref="T:System.InvalidOperationException">
  9353. <para>
  9354. This instance is not a client.
  9355. </para>
  9356. <para>
  9357. This instance does not use a secure connection.
  9358. </para>
  9359. </exception>
  9360. </member>
  9361. <member name="P:WebSocketSharp.WebSocket.Url">
  9362. <summary>
  9363. Gets the WebSocket URL used to connect, or accepted.
  9364. </summary>
  9365. <value>
  9366. A <see cref="T:System.Uri"/> that represents the URL used to connect, or accepted.
  9367. </value>
  9368. </member>
  9369. <member name="P:WebSocketSharp.WebSocket.WaitTime">
  9370. <summary>
  9371. Gets or sets the time to wait for the response to the ping or close.
  9372. </summary>
  9373. <remarks>
  9374. The set operation does nothing if the connection has already been
  9375. established or it is closing.
  9376. </remarks>
  9377. <value>
  9378. <para>
  9379. A <see cref="T:System.TimeSpan"/> to wait for the response.
  9380. </para>
  9381. <para>
  9382. The default value is the same as 5 seconds if the instance is
  9383. a client.
  9384. </para>
  9385. </value>
  9386. <exception cref="T:System.ArgumentOutOfRangeException">
  9387. The value specified for a set operation is zero or less.
  9388. </exception>
  9389. </member>
  9390. <member name="E:WebSocketSharp.WebSocket.OnClose">
  9391. <summary>
  9392. Occurs when the WebSocket connection has been closed.
  9393. </summary>
  9394. </member>
  9395. <member name="E:WebSocketSharp.WebSocket.OnError">
  9396. <summary>
  9397. Occurs when the <see cref="T:WebSocketSharp.WebSocket"/> gets an error.
  9398. </summary>
  9399. </member>
  9400. <member name="E:WebSocketSharp.WebSocket.OnMessage">
  9401. <summary>
  9402. Occurs when the <see cref="T:WebSocketSharp.WebSocket"/> receives a message.
  9403. </summary>
  9404. </member>
  9405. <member name="E:WebSocketSharp.WebSocket.OnOpen">
  9406. <summary>
  9407. Occurs when the WebSocket connection has been established.
  9408. </summary>
  9409. </member>
  9410. <member name="M:WebSocketSharp.WebSocket.Accept">
  9411. <summary>
  9412. Accepts the WebSocket handshake request.
  9413. </summary>
  9414. <remarks>
  9415. This method is not available in a client.
  9416. </remarks>
  9417. </member>
  9418. <member name="M:WebSocketSharp.WebSocket.AcceptAsync">
  9419. <summary>
  9420. Accepts the WebSocket handshake request asynchronously.
  9421. </summary>
  9422. <remarks>
  9423. <para>
  9424. This method does not wait for the accept to be complete.
  9425. </para>
  9426. <para>
  9427. This method is not available in a client.
  9428. </para>
  9429. </remarks>
  9430. </member>
  9431. <member name="M:WebSocketSharp.WebSocket.Close">
  9432. <summary>
  9433. Closes the connection.
  9434. </summary>
  9435. <remarks>
  9436. This method does nothing if the current state of the connection is
  9437. Closing or Closed.
  9438. </remarks>
  9439. </member>
  9440. <member name="M:WebSocketSharp.WebSocket.Close(System.UInt16)">
  9441. <summary>
  9442. Closes the connection with the specified <paramref name="code"/>.
  9443. </summary>
  9444. <remarks>
  9445. This method does nothing if the current state of the connection is
  9446. Closing or Closed.
  9447. </remarks>
  9448. <param name="code">
  9449. <para>
  9450. A <see cref="T:System.UInt16"/> that represents the status code
  9451. indicating the reason for the close.
  9452. </para>
  9453. <para>
  9454. The status codes are defined in
  9455. <see href="http://tools.ietf.org/html/rfc6455#section-7.4">
  9456. Section 7.4</see> of RFC 6455.
  9457. </para>
  9458. </param>
  9459. <exception cref="T:System.ArgumentOutOfRangeException">
  9460. <paramref name="code"/> is less than 1000 or greater than 4999.
  9461. </exception>
  9462. <exception cref="T:System.ArgumentException">
  9463. <para>
  9464. <paramref name="code"/> is 1011 (server error).
  9465. It cannot be used by clients.
  9466. </para>
  9467. <para>
  9468. -or-
  9469. </para>
  9470. <para>
  9471. <paramref name="code"/> is 1010 (mandatory extension).
  9472. It cannot be used by servers.
  9473. </para>
  9474. </exception>
  9475. </member>
  9476. <member name="M:WebSocketSharp.WebSocket.Close(WebSocketSharp.CloseStatusCode)">
  9477. <summary>
  9478. Closes the connection with the specified <paramref name="code"/>.
  9479. </summary>
  9480. <remarks>
  9481. This method does nothing if the current state of the connection is
  9482. Closing or Closed.
  9483. </remarks>
  9484. <param name="code">
  9485. <para>
  9486. One of the <see cref="T:WebSocketSharp.CloseStatusCode"/> enum values.
  9487. </para>
  9488. <para>
  9489. It represents the status code indicating the reason for the close.
  9490. </para>
  9491. </param>
  9492. <exception cref="T:System.ArgumentException">
  9493. <para>
  9494. <paramref name="code"/> is
  9495. <see cref="F:WebSocketSharp.CloseStatusCode.ServerError"/>.
  9496. It cannot be used by clients.
  9497. </para>
  9498. <para>
  9499. -or-
  9500. </para>
  9501. <para>
  9502. <paramref name="code"/> is
  9503. <see cref="F:WebSocketSharp.CloseStatusCode.MandatoryExtension"/>.
  9504. It cannot be used by servers.
  9505. </para>
  9506. </exception>
  9507. </member>
  9508. <member name="M:WebSocketSharp.WebSocket.Close(System.UInt16,System.String)">
  9509. <summary>
  9510. Closes the connection with the specified <paramref name="code"/> and
  9511. <paramref name="reason"/>.
  9512. </summary>
  9513. <remarks>
  9514. This method does nothing if the current state of the connection is
  9515. Closing or Closed.
  9516. </remarks>
  9517. <param name="code">
  9518. <para>
  9519. A <see cref="T:System.UInt16"/> that represents the status code
  9520. indicating the reason for the close.
  9521. </para>
  9522. <para>
  9523. The status codes are defined in
  9524. <see href="http://tools.ietf.org/html/rfc6455#section-7.4">
  9525. Section 7.4</see> of RFC 6455.
  9526. </para>
  9527. </param>
  9528. <param name="reason">
  9529. <para>
  9530. A <see cref="T:System.String"/> that represents the reason for the close.
  9531. </para>
  9532. <para>
  9533. The size must be 123 bytes or less in UTF-8.
  9534. </para>
  9535. </param>
  9536. <exception cref="T:System.ArgumentOutOfRangeException">
  9537. <para>
  9538. <paramref name="code"/> is less than 1000 or greater than 4999.
  9539. </para>
  9540. <para>
  9541. -or-
  9542. </para>
  9543. <para>
  9544. The size of <paramref name="reason"/> is greater than 123 bytes.
  9545. </para>
  9546. </exception>
  9547. <exception cref="T:System.ArgumentException">
  9548. <para>
  9549. <paramref name="code"/> is 1011 (server error).
  9550. It cannot be used by clients.
  9551. </para>
  9552. <para>
  9553. -or-
  9554. </para>
  9555. <para>
  9556. <paramref name="code"/> is 1010 (mandatory extension).
  9557. It cannot be used by servers.
  9558. </para>
  9559. <para>
  9560. -or-
  9561. </para>
  9562. <para>
  9563. <paramref name="code"/> is 1005 (no status) and
  9564. there is <paramref name="reason"/>.
  9565. </para>
  9566. <para>
  9567. -or-
  9568. </para>
  9569. <para>
  9570. <paramref name="reason"/> could not be UTF-8-encoded.
  9571. </para>
  9572. </exception>
  9573. </member>
  9574. <member name="M:WebSocketSharp.WebSocket.Close(WebSocketSharp.CloseStatusCode,System.String)">
  9575. <summary>
  9576. Closes the connection with the specified <paramref name="code"/> and
  9577. <paramref name="reason"/>.
  9578. </summary>
  9579. <remarks>
  9580. This method does nothing if the current state of the connection is
  9581. Closing or Closed.
  9582. </remarks>
  9583. <param name="code">
  9584. <para>
  9585. One of the <see cref="T:WebSocketSharp.CloseStatusCode"/> enum values.
  9586. </para>
  9587. <para>
  9588. It represents the status code indicating the reason for the close.
  9589. </para>
  9590. </param>
  9591. <param name="reason">
  9592. <para>
  9593. A <see cref="T:System.String"/> that represents the reason for the close.
  9594. </para>
  9595. <para>
  9596. The size must be 123 bytes or less in UTF-8.
  9597. </para>
  9598. </param>
  9599. <exception cref="T:System.ArgumentException">
  9600. <para>
  9601. <paramref name="code"/> is
  9602. <see cref="F:WebSocketSharp.CloseStatusCode.ServerError"/>.
  9603. It cannot be used by clients.
  9604. </para>
  9605. <para>
  9606. -or-
  9607. </para>
  9608. <para>
  9609. <paramref name="code"/> is
  9610. <see cref="F:WebSocketSharp.CloseStatusCode.MandatoryExtension"/>.
  9611. It cannot be used by servers.
  9612. </para>
  9613. <para>
  9614. -or-
  9615. </para>
  9616. <para>
  9617. <paramref name="code"/> is
  9618. <see cref="F:WebSocketSharp.CloseStatusCode.NoStatus"/> and
  9619. there is <paramref name="reason"/>.
  9620. </para>
  9621. <para>
  9622. -or-
  9623. </para>
  9624. <para>
  9625. <paramref name="reason"/> could not be UTF-8-encoded.
  9626. </para>
  9627. </exception>
  9628. <exception cref="T:System.ArgumentOutOfRangeException">
  9629. The size of <paramref name="reason"/> is greater than 123 bytes.
  9630. </exception>
  9631. </member>
  9632. <member name="M:WebSocketSharp.WebSocket.CloseAsync">
  9633. <summary>
  9634. Closes the connection asynchronously.
  9635. </summary>
  9636. <remarks>
  9637. <para>
  9638. This method does not wait for the close to be complete.
  9639. </para>
  9640. <para>
  9641. And this method does nothing if the current state of
  9642. the connection is Closing or Closed.
  9643. </para>
  9644. </remarks>
  9645. </member>
  9646. <member name="M:WebSocketSharp.WebSocket.CloseAsync(System.UInt16)">
  9647. <summary>
  9648. Closes the connection asynchronously with the specified
  9649. <paramref name="code"/>.
  9650. </summary>
  9651. <remarks>
  9652. <para>
  9653. This method does not wait for the close to be complete.
  9654. </para>
  9655. <para>
  9656. And this method does nothing if the current state of
  9657. the connection is Closing or Closed.
  9658. </para>
  9659. </remarks>
  9660. <param name="code">
  9661. <para>
  9662. A <see cref="T:System.UInt16"/> that represents the status code
  9663. indicating the reason for the close.
  9664. </para>
  9665. <para>
  9666. The status codes are defined in
  9667. <see href="http://tools.ietf.org/html/rfc6455#section-7.4">
  9668. Section 7.4</see> of RFC 6455.
  9669. </para>
  9670. </param>
  9671. <exception cref="T:System.ArgumentOutOfRangeException">
  9672. <paramref name="code"/> is less than 1000 or greater than 4999.
  9673. </exception>
  9674. <exception cref="T:System.ArgumentException">
  9675. <para>
  9676. <paramref name="code"/> is 1011 (server error).
  9677. It cannot be used by clients.
  9678. </para>
  9679. <para>
  9680. -or-
  9681. </para>
  9682. <para>
  9683. <paramref name="code"/> is 1010 (mandatory extension).
  9684. It cannot be used by servers.
  9685. </para>
  9686. </exception>
  9687. </member>
  9688. <member name="M:WebSocketSharp.WebSocket.CloseAsync(WebSocketSharp.CloseStatusCode)">
  9689. <summary>
  9690. Closes the connection asynchronously with the specified
  9691. <paramref name="code"/>.
  9692. </summary>
  9693. <remarks>
  9694. <para>
  9695. This method does not wait for the close to be complete.
  9696. </para>
  9697. <para>
  9698. And this method does nothing if the current state of
  9699. the connection is Closing or Closed.
  9700. </para>
  9701. </remarks>
  9702. <param name="code">
  9703. <para>
  9704. One of the <see cref="T:WebSocketSharp.CloseStatusCode"/> enum values.
  9705. </para>
  9706. <para>
  9707. It represents the status code indicating the reason for the close.
  9708. </para>
  9709. </param>
  9710. <exception cref="T:System.ArgumentException">
  9711. <para>
  9712. <paramref name="code"/> is
  9713. <see cref="F:WebSocketSharp.CloseStatusCode.ServerError"/>.
  9714. It cannot be used by clients.
  9715. </para>
  9716. <para>
  9717. -or-
  9718. </para>
  9719. <para>
  9720. <paramref name="code"/> is
  9721. <see cref="F:WebSocketSharp.CloseStatusCode.MandatoryExtension"/>.
  9722. It cannot be used by servers.
  9723. </para>
  9724. </exception>
  9725. </member>
  9726. <member name="M:WebSocketSharp.WebSocket.CloseAsync(System.UInt16,System.String)">
  9727. <summary>
  9728. Closes the connection asynchronously with the specified
  9729. <paramref name="code"/> and <paramref name="reason"/>.
  9730. </summary>
  9731. <remarks>
  9732. <para>
  9733. This method does not wait for the close to be complete.
  9734. </para>
  9735. <para>
  9736. And this method does nothing if the current state of
  9737. the connection is Closing or Closed.
  9738. </para>
  9739. </remarks>
  9740. <param name="code">
  9741. <para>
  9742. A <see cref="T:System.UInt16"/> that represents the status code
  9743. indicating the reason for the close.
  9744. </para>
  9745. <para>
  9746. The status codes are defined in
  9747. <see href="http://tools.ietf.org/html/rfc6455#section-7.4">
  9748. Section 7.4</see> of RFC 6455.
  9749. </para>
  9750. </param>
  9751. <param name="reason">
  9752. <para>
  9753. A <see cref="T:System.String"/> that represents the reason for the close.
  9754. </para>
  9755. <para>
  9756. The size must be 123 bytes or less in UTF-8.
  9757. </para>
  9758. </param>
  9759. <exception cref="T:System.ArgumentOutOfRangeException">
  9760. <para>
  9761. <paramref name="code"/> is less than 1000 or greater than 4999.
  9762. </para>
  9763. <para>
  9764. -or-
  9765. </para>
  9766. <para>
  9767. The size of <paramref name="reason"/> is greater than 123 bytes.
  9768. </para>
  9769. </exception>
  9770. <exception cref="T:System.ArgumentException">
  9771. <para>
  9772. <paramref name="code"/> is 1011 (server error).
  9773. It cannot be used by clients.
  9774. </para>
  9775. <para>
  9776. -or-
  9777. </para>
  9778. <para>
  9779. <paramref name="code"/> is 1010 (mandatory extension).
  9780. It cannot be used by servers.
  9781. </para>
  9782. <para>
  9783. -or-
  9784. </para>
  9785. <para>
  9786. <paramref name="code"/> is 1005 (no status) and
  9787. there is <paramref name="reason"/>.
  9788. </para>
  9789. <para>
  9790. -or-
  9791. </para>
  9792. <para>
  9793. <paramref name="reason"/> could not be UTF-8-encoded.
  9794. </para>
  9795. </exception>
  9796. </member>
  9797. <member name="M:WebSocketSharp.WebSocket.CloseAsync(WebSocketSharp.CloseStatusCode,System.String)">
  9798. <summary>
  9799. Closes the connection asynchronously with the specified
  9800. <paramref name="code"/> and <paramref name="reason"/>.
  9801. </summary>
  9802. <remarks>
  9803. <para>
  9804. This method does not wait for the close to be complete.
  9805. </para>
  9806. <para>
  9807. And this method does nothing if the current state of
  9808. the connection is Closing or Closed.
  9809. </para>
  9810. </remarks>
  9811. <param name="code">
  9812. <para>
  9813. One of the <see cref="T:WebSocketSharp.CloseStatusCode"/> enum values.
  9814. </para>
  9815. <para>
  9816. It represents the status code indicating the reason for the close.
  9817. </para>
  9818. </param>
  9819. <param name="reason">
  9820. <para>
  9821. A <see cref="T:System.String"/> that represents the reason for the close.
  9822. </para>
  9823. <para>
  9824. The size must be 123 bytes or less in UTF-8.
  9825. </para>
  9826. </param>
  9827. <exception cref="T:System.ArgumentException">
  9828. <para>
  9829. <paramref name="code"/> is
  9830. <see cref="F:WebSocketSharp.CloseStatusCode.ServerError"/>.
  9831. It cannot be used by clients.
  9832. </para>
  9833. <para>
  9834. -or-
  9835. </para>
  9836. <para>
  9837. <paramref name="code"/> is
  9838. <see cref="F:WebSocketSharp.CloseStatusCode.MandatoryExtension"/>.
  9839. It cannot be used by servers.
  9840. </para>
  9841. <para>
  9842. -or-
  9843. </para>
  9844. <para>
  9845. <paramref name="code"/> is
  9846. <see cref="F:WebSocketSharp.CloseStatusCode.NoStatus"/> and
  9847. there is <paramref name="reason"/>.
  9848. </para>
  9849. <para>
  9850. -or-
  9851. </para>
  9852. <para>
  9853. <paramref name="reason"/> could not be UTF-8-encoded.
  9854. </para>
  9855. </exception>
  9856. <exception cref="T:System.ArgumentOutOfRangeException">
  9857. The size of <paramref name="reason"/> is greater than 123 bytes.
  9858. </exception>
  9859. </member>
  9860. <member name="M:WebSocketSharp.WebSocket.Connect">
  9861. <summary>
  9862. Establishes a WebSocket connection.
  9863. </summary>
  9864. <remarks>
  9865. This method is not available in a server.
  9866. </remarks>
  9867. </member>
  9868. <member name="M:WebSocketSharp.WebSocket.ConnectAsync">
  9869. <summary>
  9870. Establishes a WebSocket connection asynchronously.
  9871. </summary>
  9872. <remarks>
  9873. <para>
  9874. This method does not wait for the connect to be complete.
  9875. </para>
  9876. <para>
  9877. This method is not available in a server.
  9878. </para>
  9879. </remarks>
  9880. </member>
  9881. <member name="M:WebSocketSharp.WebSocket.Ping">
  9882. <summary>
  9883. Sends a ping using the WebSocket connection.
  9884. </summary>
  9885. <returns>
  9886. <c>true</c> if the send has done with no error and a pong has been
  9887. received within a time; otherwise, <c>false</c>.
  9888. </returns>
  9889. </member>
  9890. <member name="M:WebSocketSharp.WebSocket.Ping(System.String)">
  9891. <summary>
  9892. Sends a ping with <paramref name="message"/> using the WebSocket
  9893. connection.
  9894. </summary>
  9895. <returns>
  9896. <c>true</c> if the send has done with no error and a pong has been
  9897. received within a time; otherwise, <c>false</c>.
  9898. </returns>
  9899. <param name="message">
  9900. <para>
  9901. A <see cref="T:System.String"/> that represents the message to send.
  9902. </para>
  9903. <para>
  9904. The size must be 125 bytes or less in UTF-8.
  9905. </para>
  9906. </param>
  9907. <exception cref="T:System.ArgumentException">
  9908. <paramref name="message"/> could not be UTF-8-encoded.
  9909. </exception>
  9910. <exception cref="T:System.ArgumentOutOfRangeException">
  9911. The size of <paramref name="message"/> is greater than 125 bytes.
  9912. </exception>
  9913. </member>
  9914. <member name="M:WebSocketSharp.WebSocket.Send(System.Byte[])">
  9915. <summary>
  9916. Sends <paramref name="data"/> using the WebSocket connection.
  9917. </summary>
  9918. <param name="data">
  9919. An array of <see cref="T:System.Byte"/> that represents the binary data to send.
  9920. </param>
  9921. <exception cref="T:System.InvalidOperationException">
  9922. The current state of the connection is not Open.
  9923. </exception>
  9924. <exception cref="T:System.ArgumentNullException">
  9925. <paramref name="data"/> is <see langword="null"/>.
  9926. </exception>
  9927. </member>
  9928. <member name="M:WebSocketSharp.WebSocket.Send(System.IO.FileInfo)">
  9929. <summary>
  9930. Sends the specified file using the WebSocket connection.
  9931. </summary>
  9932. <remarks>
  9933. The file is sent as the binary data.
  9934. </remarks>
  9935. <param name="fileInfo">
  9936. A <see cref="T:System.IO.FileInfo"/> that specifies the file to send.
  9937. </param>
  9938. <exception cref="T:System.InvalidOperationException">
  9939. The current state of the connection is not Open.
  9940. </exception>
  9941. <exception cref="T:System.ArgumentNullException">
  9942. <paramref name="fileInfo"/> is <see langword="null"/>.
  9943. </exception>
  9944. <exception cref="T:System.ArgumentException">
  9945. <para>
  9946. The file does not exist.
  9947. </para>
  9948. <para>
  9949. -or-
  9950. </para>
  9951. <para>
  9952. The file could not be opened.
  9953. </para>
  9954. </exception>
  9955. </member>
  9956. <member name="M:WebSocketSharp.WebSocket.Send(System.String)">
  9957. <summary>
  9958. Sends <paramref name="data"/> using the WebSocket connection.
  9959. </summary>
  9960. <param name="data">
  9961. A <see cref="T:System.String"/> that represents the text data to send.
  9962. </param>
  9963. <exception cref="T:System.InvalidOperationException">
  9964. The current state of the connection is not Open.
  9965. </exception>
  9966. <exception cref="T:System.ArgumentNullException">
  9967. <paramref name="data"/> is <see langword="null"/>.
  9968. </exception>
  9969. <exception cref="T:System.ArgumentException">
  9970. <paramref name="data"/> could not be UTF-8-encoded.
  9971. </exception>
  9972. </member>
  9973. <member name="M:WebSocketSharp.WebSocket.Send(System.IO.Stream,System.Int32)">
  9974. <summary>
  9975. Sends the data from <paramref name="stream"/> using the WebSocket
  9976. connection.
  9977. </summary>
  9978. <remarks>
  9979. The data is sent as the binary data.
  9980. </remarks>
  9981. <param name="stream">
  9982. A <see cref="T:System.IO.Stream"/> instance from which to read the data to send.
  9983. </param>
  9984. <param name="length">
  9985. An <see cref="T:System.Int32"/> that specifies the number of bytes to send.
  9986. </param>
  9987. <exception cref="T:System.InvalidOperationException">
  9988. The current state of the connection is not Open.
  9989. </exception>
  9990. <exception cref="T:System.ArgumentNullException">
  9991. <paramref name="stream"/> is <see langword="null"/>.
  9992. </exception>
  9993. <exception cref="T:System.ArgumentException">
  9994. <para>
  9995. <paramref name="stream"/> cannot be read.
  9996. </para>
  9997. <para>
  9998. -or-
  9999. </para>
  10000. <para>
  10001. <paramref name="length"/> is less than 1.
  10002. </para>
  10003. <para>
  10004. -or-
  10005. </para>
  10006. <para>
  10007. No data could be read from <paramref name="stream"/>.
  10008. </para>
  10009. </exception>
  10010. </member>
  10011. <member name="M:WebSocketSharp.WebSocket.SendAsync(System.Byte[],System.Action{System.Boolean})">
  10012. <summary>
  10013. Sends <paramref name="data"/> asynchronously using the WebSocket
  10014. connection.
  10015. </summary>
  10016. <remarks>
  10017. This method does not wait for the send to be complete.
  10018. </remarks>
  10019. <param name="data">
  10020. An array of <see cref="T:System.Byte"/> that represents the binary data to send.
  10021. </param>
  10022. <param name="completed">
  10023. <para>
  10024. An <c>Action&lt;bool&gt;</c> delegate or <see langword="null"/>
  10025. if not needed.
  10026. </para>
  10027. <para>
  10028. The delegate invokes the method called when the send is complete.
  10029. </para>
  10030. <para>
  10031. <c>true</c> is passed to the method if the send has done with
  10032. no error; otherwise, <c>false</c>.
  10033. </para>
  10034. </param>
  10035. <exception cref="T:System.InvalidOperationException">
  10036. The current state of the connection is not Open.
  10037. </exception>
  10038. <exception cref="T:System.ArgumentNullException">
  10039. <paramref name="data"/> is <see langword="null"/>.
  10040. </exception>
  10041. </member>
  10042. <member name="M:WebSocketSharp.WebSocket.SendAsync(System.IO.FileInfo,System.Action{System.Boolean})">
  10043. <summary>
  10044. Sends the specified file asynchronously using the WebSocket connection.
  10045. </summary>
  10046. <remarks>
  10047. <para>
  10048. The file is sent as the binary data.
  10049. </para>
  10050. <para>
  10051. This method does not wait for the send to be complete.
  10052. </para>
  10053. </remarks>
  10054. <param name="fileInfo">
  10055. A <see cref="T:System.IO.FileInfo"/> that specifies the file to send.
  10056. </param>
  10057. <param name="completed">
  10058. <para>
  10059. An <c>Action&lt;bool&gt;</c> delegate or <see langword="null"/>
  10060. if not needed.
  10061. </para>
  10062. <para>
  10063. The delegate invokes the method called when the send is complete.
  10064. </para>
  10065. <para>
  10066. <c>true</c> is passed to the method if the send has done with
  10067. no error; otherwise, <c>false</c>.
  10068. </para>
  10069. </param>
  10070. <exception cref="T:System.InvalidOperationException">
  10071. The current state of the connection is not Open.
  10072. </exception>
  10073. <exception cref="T:System.ArgumentNullException">
  10074. <paramref name="fileInfo"/> is <see langword="null"/>.
  10075. </exception>
  10076. <exception cref="T:System.ArgumentException">
  10077. <para>
  10078. The file does not exist.
  10079. </para>
  10080. <para>
  10081. -or-
  10082. </para>
  10083. <para>
  10084. The file could not be opened.
  10085. </para>
  10086. </exception>
  10087. </member>
  10088. <member name="M:WebSocketSharp.WebSocket.SendAsync(System.String,System.Action{System.Boolean})">
  10089. <summary>
  10090. Sends <paramref name="data"/> asynchronously using the WebSocket
  10091. connection.
  10092. </summary>
  10093. <remarks>
  10094. This method does not wait for the send to be complete.
  10095. </remarks>
  10096. <param name="data">
  10097. A <see cref="T:System.String"/> that represents the text data to send.
  10098. </param>
  10099. <param name="completed">
  10100. <para>
  10101. An <c>Action&lt;bool&gt;</c> delegate or <see langword="null"/>
  10102. if not needed.
  10103. </para>
  10104. <para>
  10105. The delegate invokes the method called when the send is complete.
  10106. </para>
  10107. <para>
  10108. <c>true</c> is passed to the method if the send has done with
  10109. no error; otherwise, <c>false</c>.
  10110. </para>
  10111. </param>
  10112. <exception cref="T:System.InvalidOperationException">
  10113. The current state of the connection is not Open.
  10114. </exception>
  10115. <exception cref="T:System.ArgumentNullException">
  10116. <paramref name="data"/> is <see langword="null"/>.
  10117. </exception>
  10118. <exception cref="T:System.ArgumentException">
  10119. <paramref name="data"/> could not be UTF-8-encoded.
  10120. </exception>
  10121. </member>
  10122. <member name="M:WebSocketSharp.WebSocket.SendAsync(System.IO.Stream,System.Int32,System.Action{System.Boolean})">
  10123. <summary>
  10124. Sends the data from <paramref name="stream"/> asynchronously using
  10125. the WebSocket connection.
  10126. </summary>
  10127. <remarks>
  10128. <para>
  10129. The data is sent as the binary data.
  10130. </para>
  10131. <para>
  10132. This method does not wait for the send to be complete.
  10133. </para>
  10134. </remarks>
  10135. <param name="stream">
  10136. A <see cref="T:System.IO.Stream"/> instance from which to read the data to send.
  10137. </param>
  10138. <param name="length">
  10139. An <see cref="T:System.Int32"/> that specifies the number of bytes to send.
  10140. </param>
  10141. <param name="completed">
  10142. <para>
  10143. An <c>Action&lt;bool&gt;</c> delegate or <see langword="null"/>
  10144. if not needed.
  10145. </para>
  10146. <para>
  10147. The delegate invokes the method called when the send is complete.
  10148. </para>
  10149. <para>
  10150. <c>true</c> is passed to the method if the send has done with
  10151. no error; otherwise, <c>false</c>.
  10152. </para>
  10153. </param>
  10154. <exception cref="T:System.InvalidOperationException">
  10155. The current state of the connection is not Open.
  10156. </exception>
  10157. <exception cref="T:System.ArgumentNullException">
  10158. <paramref name="stream"/> is <see langword="null"/>.
  10159. </exception>
  10160. <exception cref="T:System.ArgumentException">
  10161. <para>
  10162. <paramref name="stream"/> cannot be read.
  10163. </para>
  10164. <para>
  10165. -or-
  10166. </para>
  10167. <para>
  10168. <paramref name="length"/> is less than 1.
  10169. </para>
  10170. <para>
  10171. -or-
  10172. </para>
  10173. <para>
  10174. No data could be read from <paramref name="stream"/>.
  10175. </para>
  10176. </exception>
  10177. </member>
  10178. <member name="M:WebSocketSharp.WebSocket.SetCookie(WebSocketSharp.Net.Cookie)">
  10179. <summary>
  10180. Sets an HTTP <paramref name="cookie"/> to send with
  10181. the WebSocket handshake request to the server.
  10182. </summary>
  10183. <remarks>
  10184. This method is not available in a server.
  10185. </remarks>
  10186. <param name="cookie">
  10187. A <see cref="T:WebSocketSharp.Net.Cookie"/> that represents a cookie to send.
  10188. </param>
  10189. </member>
  10190. <member name="M:WebSocketSharp.WebSocket.SetCredentials(System.String,System.String,System.Boolean)">
  10191. <summary>
  10192. Sets a pair of <paramref name="username"/> and <paramref name="password"/> for
  10193. the HTTP authentication (Basic/Digest).
  10194. </summary>
  10195. <remarks>
  10196. This method is not available in a server.
  10197. </remarks>
  10198. <param name="username">
  10199. <para>
  10200. A <see cref="T:System.String"/> that represents the user name used to authenticate.
  10201. </para>
  10202. <para>
  10203. If <paramref name="username"/> is <see langword="null"/> or empty,
  10204. the credentials will be initialized and not be sent.
  10205. </para>
  10206. </param>
  10207. <param name="password">
  10208. A <see cref="T:System.String"/> that represents the password for
  10209. <paramref name="username"/> used to authenticate.
  10210. </param>
  10211. <param name="preAuth">
  10212. <c>true</c> if the <see cref="T:WebSocketSharp.WebSocket"/> sends the credentials for
  10213. the Basic authentication with the first handshake request to the server;
  10214. otherwise, <c>false</c>.
  10215. </param>
  10216. </member>
  10217. <member name="M:WebSocketSharp.WebSocket.SetProxy(System.String,System.String,System.String)">
  10218. <summary>
  10219. Sets the HTTP proxy server URL to connect through, and if necessary,
  10220. a pair of <paramref name="username"/> and <paramref name="password"/> for
  10221. the proxy server authentication (Basic/Digest).
  10222. </summary>
  10223. <remarks>
  10224. This method is not available in a server.
  10225. </remarks>
  10226. <param name="url">
  10227. <para>
  10228. A <see cref="T:System.String"/> that represents the HTTP proxy server URL to
  10229. connect through. The syntax must be http://&lt;host&gt;[:&lt;port&gt;].
  10230. </para>
  10231. <para>
  10232. If <paramref name="url"/> is <see langword="null"/> or empty,
  10233. the url and credentials for the proxy will be initialized,
  10234. and the <see cref="T:WebSocketSharp.WebSocket"/> will not use the proxy to
  10235. connect through.
  10236. </para>
  10237. </param>
  10238. <param name="username">
  10239. <para>
  10240. A <see cref="T:System.String"/> that represents the user name used to authenticate.
  10241. </para>
  10242. <para>
  10243. If <paramref name="username"/> is <see langword="null"/> or empty,
  10244. the credentials for the proxy will be initialized and not be sent.
  10245. </para>
  10246. </param>
  10247. <param name="password">
  10248. A <see cref="T:System.String"/> that represents the password for
  10249. <paramref name="username"/> used to authenticate.
  10250. </param>
  10251. </member>
  10252. <member name="M:WebSocketSharp.WebSocket.System#IDisposable#Dispose">
  10253. <summary>
  10254. Closes the connection and releases all associated resources.
  10255. </summary>
  10256. <remarks>
  10257. <para>
  10258. This method closes the connection with close status 1001 (going away).
  10259. </para>
  10260. <para>
  10261. And this method does nothing if the current state of the connection is
  10262. Closing or Closed.
  10263. </para>
  10264. </remarks>
  10265. </member>
  10266. <member name="T:WebSocketSharp.WebSocketException">
  10267. <summary>
  10268. The exception that is thrown when a fatal error occurs in
  10269. the WebSocket communication.
  10270. </summary>
  10271. </member>
  10272. <member name="P:WebSocketSharp.WebSocketException.Code">
  10273. <summary>
  10274. Gets the status code indicating the cause of the exception.
  10275. </summary>
  10276. <value>
  10277. One of the <see cref="T:WebSocketSharp.CloseStatusCode"/> enum values that represents
  10278. the status code indicating the cause of the exception.
  10279. </value>
  10280. </member>
  10281. <member name="F:WebSocketSharp.WebSocketFrame.EmptyPingBytes">
  10282. <summary>
  10283. Represents the ping frame without the payload data as an array of <see cref="T:System.Byte"/>.
  10284. </summary>
  10285. <remarks>
  10286. The value of this field is created from a non masked frame, so it can only be used to
  10287. send a ping from a server.
  10288. </remarks>
  10289. </member>
  10290. <member name="T:WebSocketSharp.WebSocketState">
  10291. <summary>
  10292. Indicates the state of a WebSocket connection.
  10293. </summary>
  10294. <remarks>
  10295. The values of this enumeration are defined in
  10296. <see href="http://www.w3.org/TR/websockets/#dom-websocket-readystate">
  10297. The WebSocket API</see>.
  10298. </remarks>
  10299. </member>
  10300. <member name="F:WebSocketSharp.WebSocketState.Connecting">
  10301. <summary>
  10302. Equivalent to numeric value 0. Indicates that the connection has not
  10303. yet been established.
  10304. </summary>
  10305. </member>
  10306. <member name="F:WebSocketSharp.WebSocketState.Open">
  10307. <summary>
  10308. Equivalent to numeric value 1. Indicates that the connection has
  10309. been established, and the communication is possible.
  10310. </summary>
  10311. </member>
  10312. <member name="F:WebSocketSharp.WebSocketState.Closing">
  10313. <summary>
  10314. Equivalent to numeric value 2. Indicates that the connection is
  10315. going through the closing handshake, or the close method has
  10316. been invoked.
  10317. </summary>
  10318. </member>
  10319. <member name="F:WebSocketSharp.WebSocketState.Closed">
  10320. <summary>
  10321. Equivalent to numeric value 3. Indicates that the connection has
  10322. been closed or could not be established.
  10323. </summary>
  10324. </member>
  10325. </members>
  10326. </doc>