websocket-sharp.xml 359 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>websocket-sharp</name>
  5. </assembly>
  6. <members>
  7. <member name="T:WebSocketSharp.Ext">
  8. <summary>
  9. Provides a set of static methods for websocket-sharp.
  10. </summary>
  11. </member>
  12. <member name="M:WebSocketSharp.Ext.EqualsWith(System.Int32,System.Char,System.Action{System.Int32})">
  13. <summary>
  14. Determines whether the specified <see cref="T:System.Int32"/> equals the specified <see cref="T:System.Char"/>,
  15. and invokes the specified <c>Action&lt;int&gt;</c> delegate at the same time.
  16. </summary>
  17. <returns>
  18. <c>true</c> if <paramref name="value"/> equals <paramref name="c"/>;
  19. otherwise, <c>false</c>.
  20. </returns>
  21. <param name="value">
  22. An <see cref="T:System.Int32"/> to compare.
  23. </param>
  24. <param name="c">
  25. A <see cref="T:System.Char"/> to compare.
  26. </param>
  27. <param name="action">
  28. An <c>Action&lt;int&gt;</c> delegate that references the method(s) called
  29. at the same time as comparing. An <see cref="T:System.Int32"/> parameter to pass to
  30. the method(s) is <paramref name="value"/>.
  31. </param>
  32. </member>
  33. <member name="M:WebSocketSharp.Ext.GetAbsolutePath(System.Uri)">
  34. <summary>
  35. Gets the absolute path from the specified <see cref="T:System.Uri"/>.
  36. </summary>
  37. <returns>
  38. A <see cref="T:System.String"/> that represents the absolute path if it's successfully found;
  39. otherwise, <see langword="null"/>.
  40. </returns>
  41. <param name="uri">
  42. A <see cref="T:System.Uri"/> that represents the URI to get the absolute path from.
  43. </param>
  44. </member>
  45. <member name="M:WebSocketSharp.Ext.GetName(System.String,System.Char)">
  46. <summary>
  47. Gets the name from the specified <see cref="T:System.String"/> that contains a pair of name and
  48. value separated by a separator character.
  49. </summary>
  50. <returns>
  51. A <see cref="T:System.String"/> that represents the name if any; otherwise, <c>null</c>.
  52. </returns>
  53. <param name="nameAndValue">
  54. A <see cref="T:System.String"/> that contains a pair of name and value separated by
  55. a separator character.
  56. </param>
  57. <param name="separator">
  58. A <see cref="T:System.Char"/> that represents the separator character.
  59. </param>
  60. </member>
  61. <member name="M:WebSocketSharp.Ext.GetValue(System.String,System.Char)">
  62. <summary>
  63. Gets the value from the specified <see cref="T:System.String"/> that contains a pair of name and
  64. value separated by a separator character.
  65. </summary>
  66. <returns>
  67. A <see cref="T:System.String"/> that represents the value if any; otherwise, <c>null</c>.
  68. </returns>
  69. <param name="nameAndValue">
  70. A <see cref="T:System.String"/> that contains a pair of name and value separated by
  71. a separator character.
  72. </param>
  73. <param name="separator">
  74. A <see cref="T:System.Char"/> that represents the separator character.
  75. </param>
  76. </member>
  77. <member name="M:WebSocketSharp.Ext.TryCreateWebSocketUri(System.String,System.Uri@,System.String@)">
  78. <summary>
  79. Tries to create a <see cref="T:System.Uri"/> for WebSocket with
  80. the specified <paramref name="uriString"/>.
  81. </summary>
  82. <returns>
  83. <c>true</c> if a <see cref="T:System.Uri"/> is successfully created; otherwise, <c>false</c>.
  84. </returns>
  85. <param name="uriString">
  86. A <see cref="T:System.String"/> that represents a WebSocket URL to try.
  87. </param>
  88. <param name="result">
  89. When this method returns, a <see cref="T:System.Uri"/> that represents a WebSocket URL,
  90. or <see langword="null"/> if <paramref name="uriString"/> is invalid.
  91. </param>
  92. <param name="message">
  93. When this method returns, a <see cref="T:System.String"/> that represents an error message,
  94. or <see cref="F:System.String.Empty"/> if <paramref name="uriString"/> is valid.
  95. </param>
  96. </member>
  97. <member name="M:WebSocketSharp.Ext.Contains(System.String,System.Char[])">
  98. <summary>
  99. Determines whether the specified <see cref="T:System.String"/> contains any of characters in
  100. the specified array of <see cref="T:System.Char"/>.
  101. </summary>
  102. <returns>
  103. <c>true</c> if <paramref name="value"/> contains any of <paramref name="chars"/>;
  104. otherwise, <c>false</c>.
  105. </returns>
  106. <param name="value">
  107. A <see cref="T:System.String"/> to test.
  108. </param>
  109. <param name="chars">
  110. An array of <see cref="T:System.Char"/> that contains characters to find.
  111. </param>
  112. </member>
  113. <member name="M:WebSocketSharp.Ext.Contains(System.Collections.Specialized.NameValueCollection,System.String)">
  114. <summary>
  115. Determines whether the specified <see cref="T:System.Collections.Specialized.NameValueCollection"/> contains
  116. the entry with the specified <paramref name="name"/>.
  117. </summary>
  118. <returns>
  119. <c>true</c> if <paramref name="collection"/> contains the entry with
  120. <paramref name="name"/>; otherwise, <c>false</c>.
  121. </returns>
  122. <param name="collection">
  123. A <see cref="T:System.Collections.Specialized.NameValueCollection"/> to test.
  124. </param>
  125. <param name="name">
  126. A <see cref="T:System.String"/> that represents the key of the entry to find.
  127. </param>
  128. </member>
  129. <member name="M:WebSocketSharp.Ext.Contains(System.Collections.Specialized.NameValueCollection,System.String,System.String)">
  130. <summary>
  131. Determines whether the specified <see cref="T:System.Collections.Specialized.NameValueCollection"/> contains the entry with
  132. the specified both <paramref name="name"/> and <paramref name="value"/>.
  133. </summary>
  134. <returns>
  135. <c>true</c> if <paramref name="collection"/> contains the entry with both
  136. <paramref name="name"/> and <paramref name="value"/>; otherwise, <c>false</c>.
  137. </returns>
  138. <param name="collection">
  139. A <see cref="T:System.Collections.Specialized.NameValueCollection"/> to test.
  140. </param>
  141. <param name="name">
  142. A <see cref="T:System.String"/> that represents the key of the entry to find.
  143. </param>
  144. <param name="value">
  145. A <see cref="T:System.String"/> that represents the value of the entry to find.
  146. </param>
  147. </member>
  148. <member name="M:WebSocketSharp.Ext.Emit(System.EventHandler,System.Object,System.EventArgs)">
  149. <summary>
  150. Emits the specified <see cref="T:System.EventHandler"/> delegate if it isn't <see langword="null"/>.
  151. </summary>
  152. <param name="eventHandler">
  153. A <see cref="T:System.EventHandler"/> to emit.
  154. </param>
  155. <param name="sender">
  156. An <see cref="T:System.Object"/> from which emits this <paramref name="eventHandler"/>.
  157. </param>
  158. <param name="e">
  159. A <see cref="T:System.EventArgs"/> that contains no event data.
  160. </param>
  161. </member>
  162. <member name="M:WebSocketSharp.Ext.Emit``1(System.EventHandler{``0},System.Object,``0)">
  163. <summary>
  164. Emits the specified <c>EventHandler&lt;TEventArgs&gt;</c> delegate if it isn't
  165. <see langword="null"/>.
  166. </summary>
  167. <param name="eventHandler">
  168. An <c>EventHandler&lt;TEventArgs&gt;</c> to emit.
  169. </param>
  170. <param name="sender">
  171. An <see cref="T:System.Object"/> from which emits this <paramref name="eventHandler"/>.
  172. </param>
  173. <param name="e">
  174. A <c>TEventArgs</c> that represents the event data.
  175. </param>
  176. <typeparam name="TEventArgs">
  177. The type of the event data generated by the event.
  178. </typeparam>
  179. </member>
  180. <member name="M:WebSocketSharp.Ext.GetCookies(System.Collections.Specialized.NameValueCollection,System.Boolean)">
  181. <summary>
  182. Gets the collection of the HTTP cookies from the specified HTTP <paramref name="headers"/>.
  183. </summary>
  184. <returns>
  185. A <see cref="T:WebSocketSharp.Net.CookieCollection"/> that receives a collection of the HTTP cookies.
  186. </returns>
  187. <param name="headers">
  188. A <see cref="T:System.Collections.Specialized.NameValueCollection"/> that contains a collection of the HTTP headers.
  189. </param>
  190. <param name="response">
  191. <c>true</c> if <paramref name="headers"/> is a collection of the response headers;
  192. otherwise, <c>false</c>.
  193. </param>
  194. </member>
  195. <member name="M:WebSocketSharp.Ext.GetDescription(WebSocketSharp.Net.HttpStatusCode)">
  196. <summary>
  197. Gets the description of the specified HTTP status <paramref name="code"/>.
  198. </summary>
  199. <returns>
  200. A <see cref="T:System.String"/> that represents the description of the HTTP status code.
  201. </returns>
  202. <param name="code">
  203. One of <see cref="T:WebSocketSharp.Net.HttpStatusCode"/> enum values, indicates the HTTP status code.
  204. </param>
  205. </member>
  206. <member name="M:WebSocketSharp.Ext.GetStatusDescription(System.Int32)">
  207. <summary>
  208. Gets the description of the specified HTTP status <paramref name="code"/>.
  209. </summary>
  210. <returns>
  211. A <see cref="T:System.String"/> that represents the description of the HTTP status code.
  212. </returns>
  213. <param name="code">
  214. An <see cref="T:System.Int32"/> that represents the HTTP status code.
  215. </param>
  216. </member>
  217. <member name="M:WebSocketSharp.Ext.IsCloseStatusCode(System.UInt16)">
  218. <summary>
  219. Determines whether the specified <see cref="T:System.UInt16"/> is in the allowable range of
  220. the WebSocket close status code.
  221. </summary>
  222. <remarks>
  223. Not allowable ranges are the following:
  224. <list type="bullet">
  225. <item>
  226. <term>
  227. Numbers in the range 0-999 are not used.
  228. </term>
  229. </item>
  230. <item>
  231. <term>
  232. Numbers greater than 4999 are out of the reserved close status code ranges.
  233. </term>
  234. </item>
  235. </list>
  236. </remarks>
  237. <returns>
  238. <c>true</c> if <paramref name="value"/> is in the allowable range of the WebSocket
  239. close status code; otherwise, <c>false</c>.
  240. </returns>
  241. <param name="value">
  242. A <see cref="T:System.UInt16"/> to test.
  243. </param>
  244. </member>
  245. <member name="M:WebSocketSharp.Ext.IsEnclosedIn(System.String,System.Char)">
  246. <summary>
  247. Determines whether the specified <see cref="T:System.String"/> is enclosed in the specified
  248. <see cref="T:System.Char"/>.
  249. </summary>
  250. <returns>
  251. <c>true</c> if <paramref name="value"/> is enclosed in <paramref name="c"/>;
  252. otherwise, <c>false</c>.
  253. </returns>
  254. <param name="value">
  255. A <see cref="T:System.String"/> to test.
  256. </param>
  257. <param name="c">
  258. A <see cref="T:System.Char"/> that represents the character to find.
  259. </param>
  260. </member>
  261. <member name="M:WebSocketSharp.Ext.IsHostOrder(WebSocketSharp.ByteOrder)">
  262. <summary>
  263. Determines whether the specified <see cref="T:WebSocketSharp.ByteOrder"/> is host (this computer
  264. architecture) byte order.
  265. </summary>
  266. <returns>
  267. <c>true</c> if <paramref name="order"/> is host byte order; otherwise, <c>false</c>.
  268. </returns>
  269. <param name="order">
  270. One of the <see cref="T:WebSocketSharp.ByteOrder"/> enum values, to test.
  271. </param>
  272. </member>
  273. <member name="M:WebSocketSharp.Ext.IsLocal(System.Net.IPAddress)">
  274. <summary>
  275. Determines whether the specified <see cref="T:System.Net.IPAddress"/> represents
  276. a local IP address.
  277. </summary>
  278. <remarks>
  279. This local means NOT REMOTE for the current host.
  280. </remarks>
  281. <returns>
  282. <c>true</c> if <paramref name="address"/> represents a local IP address;
  283. otherwise, <c>false</c>.
  284. </returns>
  285. <param name="address">
  286. A <see cref="T:System.Net.IPAddress"/> to test.
  287. </param>
  288. </member>
  289. <member name="M:WebSocketSharp.Ext.IsNullOrEmpty(System.String)">
  290. <summary>
  291. Determines whether the specified <see cref="T:System.String"/> is <see langword="null"/> or empty.
  292. </summary>
  293. <returns>
  294. <c>true</c> if <paramref name="value"/> is <see langword="null"/> or empty;
  295. otherwise, <c>false</c>.
  296. </returns>
  297. <param name="value">
  298. A <see cref="T:System.String"/> to test.
  299. </param>
  300. </member>
  301. <member name="M:WebSocketSharp.Ext.IsPredefinedScheme(System.String)">
  302. <summary>
  303. Determines whether the specified <see cref="T:System.String"/> is a predefined scheme.
  304. </summary>
  305. <returns>
  306. <c>true</c> if <paramref name="value"/> is a predefined scheme; otherwise, <c>false</c>.
  307. </returns>
  308. <param name="value">
  309. A <see cref="T:System.String"/> to test.
  310. </param>
  311. </member>
  312. <member name="M:WebSocketSharp.Ext.IsUpgradeTo(WebSocketSharp.Net.HttpListenerRequest,System.String)">
  313. <summary>
  314. Determines whether the specified <see cref="T:WebSocketSharp.Net.HttpListenerRequest"/> is
  315. an HTTP Upgrade request to switch to the specified <paramref name="protocol"/>.
  316. </summary>
  317. <returns>
  318. <c>true</c> if <paramref name="request"/> is an HTTP Upgrade request to switch to
  319. <paramref name="protocol"/>; otherwise, <c>false</c>.
  320. </returns>
  321. <param name="request">
  322. A <see cref="T:WebSocketSharp.Net.HttpListenerRequest"/> that represents the HTTP request.
  323. </param>
  324. <param name="protocol">
  325. A <see cref="T:System.String"/> that represents the protocol name.
  326. </param>
  327. <exception cref="T:System.ArgumentNullException">
  328. <para>
  329. <paramref name="request"/> is <see langword="null"/>.
  330. </para>
  331. <para>
  332. -or-
  333. </para>
  334. <para>
  335. <paramref name="protocol"/> is <see langword="null"/>.
  336. </para>
  337. </exception>
  338. <exception cref="T:System.ArgumentException">
  339. <paramref name="protocol"/> is empty.
  340. </exception>
  341. </member>
  342. <member name="M:WebSocketSharp.Ext.MaybeUri(System.String)">
  343. <summary>
  344. Determines whether the specified <see cref="T:System.String"/> is a URI string.
  345. </summary>
  346. <returns>
  347. <c>true</c> if <paramref name="value"/> may be a URI string; otherwise, <c>false</c>.
  348. </returns>
  349. <param name="value">
  350. A <see cref="T:System.String"/> to test.
  351. </param>
  352. </member>
  353. <member name="M:WebSocketSharp.Ext.SubArray``1(``0[],System.Int32,System.Int32)">
  354. <summary>
  355. Retrieves a sub-array from the specified <paramref name="array"/>. A sub-array starts at
  356. the specified element position in <paramref name="array"/>.
  357. </summary>
  358. <returns>
  359. An array of T that receives a sub-array, or an empty array of T if any problems with
  360. the parameters.
  361. </returns>
  362. <param name="array">
  363. An array of T from which to retrieve a sub-array.
  364. </param>
  365. <param name="startIndex">
  366. An <see cref="T:System.Int32"/> that represents the zero-based starting position of
  367. a sub-array in <paramref name="array"/>.
  368. </param>
  369. <param name="length">
  370. An <see cref="T:System.Int32"/> that represents the number of elements to retrieve.
  371. </param>
  372. <typeparam name="T">
  373. The type of elements in <paramref name="array"/>.
  374. </typeparam>
  375. </member>
  376. <member name="M:WebSocketSharp.Ext.SubArray``1(``0[],System.Int64,System.Int64)">
  377. <summary>
  378. Retrieves a sub-array from the specified <paramref name="array"/>. A sub-array starts at
  379. the specified element position in <paramref name="array"/>.
  380. </summary>
  381. <returns>
  382. An array of T that receives a sub-array, or an empty array of T if any problems with
  383. the parameters.
  384. </returns>
  385. <param name="array">
  386. An array of T from which to retrieve a sub-array.
  387. </param>
  388. <param name="startIndex">
  389. A <see cref="T:System.Int64"/> that represents the zero-based starting position of
  390. a sub-array in <paramref name="array"/>.
  391. </param>
  392. <param name="length">
  393. A <see cref="T:System.Int64"/> that represents the number of elements to retrieve.
  394. </param>
  395. <typeparam name="T">
  396. The type of elements in <paramref name="array"/>.
  397. </typeparam>
  398. </member>
  399. <member name="M:WebSocketSharp.Ext.Times(System.Int32,System.Action)">
  400. <summary>
  401. Executes the specified <see cref="T:System.Action"/> delegate <paramref name="n"/> times.
  402. </summary>
  403. <param name="n">
  404. An <see cref="T:System.Int32"/> is the number of times to execute.
  405. </param>
  406. <param name="action">
  407. An <see cref="T:System.Action"/> delegate that references the method(s) to execute.
  408. </param>
  409. </member>
  410. <member name="M:WebSocketSharp.Ext.Times(System.Int64,System.Action)">
  411. <summary>
  412. Executes the specified <see cref="T:System.Action"/> delegate <paramref name="n"/> times.
  413. </summary>
  414. <param name="n">
  415. A <see cref="T:System.Int64"/> is the number of times to execute.
  416. </param>
  417. <param name="action">
  418. An <see cref="T:System.Action"/> delegate that references the method(s) to execute.
  419. </param>
  420. </member>
  421. <member name="M:WebSocketSharp.Ext.Times(System.UInt32,System.Action)">
  422. <summary>
  423. Executes the specified <see cref="T:System.Action"/> delegate <paramref name="n"/> times.
  424. </summary>
  425. <param name="n">
  426. A <see cref="T:System.UInt32"/> is the number of times to execute.
  427. </param>
  428. <param name="action">
  429. An <see cref="T:System.Action"/> delegate that references the method(s) to execute.
  430. </param>
  431. </member>
  432. <member name="M:WebSocketSharp.Ext.Times(System.UInt64,System.Action)">
  433. <summary>
  434. Executes the specified <see cref="T:System.Action"/> delegate <paramref name="n"/> times.
  435. </summary>
  436. <param name="n">
  437. A <see cref="T:System.UInt64"/> is the number of times to execute.
  438. </param>
  439. <param name="action">
  440. An <see cref="T:System.Action"/> delegate that references the method(s) to execute.
  441. </param>
  442. </member>
  443. <member name="M:WebSocketSharp.Ext.Times(System.Int32,System.Action{System.Int32})">
  444. <summary>
  445. Executes the specified <c>Action&lt;int&gt;</c> delegate <paramref name="n"/> times.
  446. </summary>
  447. <param name="n">
  448. An <see cref="T:System.Int32"/> is the number of times to execute.
  449. </param>
  450. <param name="action">
  451. An <c>Action&lt;int&gt;</c> delegate that references the method(s) to execute.
  452. An <see cref="T:System.Int32"/> parameter to pass to the method(s) is the zero-based count of
  453. iteration.
  454. </param>
  455. </member>
  456. <member name="M:WebSocketSharp.Ext.Times(System.Int64,System.Action{System.Int64})">
  457. <summary>
  458. Executes the specified <c>Action&lt;long&gt;</c> delegate <paramref name="n"/> times.
  459. </summary>
  460. <param name="n">
  461. A <see cref="T:System.Int64"/> is the number of times to execute.
  462. </param>
  463. <param name="action">
  464. An <c>Action&lt;long&gt;</c> delegate that references the method(s) to execute.
  465. A <see cref="T:System.Int64"/> parameter to pass to the method(s) is the zero-based count of
  466. iteration.
  467. </param>
  468. </member>
  469. <member name="M:WebSocketSharp.Ext.Times(System.UInt32,System.Action{System.UInt32})">
  470. <summary>
  471. Executes the specified <c>Action&lt;uint&gt;</c> delegate <paramref name="n"/> times.
  472. </summary>
  473. <param name="n">
  474. A <see cref="T:System.UInt32"/> is the number of times to execute.
  475. </param>
  476. <param name="action">
  477. An <c>Action&lt;uint&gt;</c> delegate that references the method(s) to execute.
  478. A <see cref="T:System.UInt32"/> parameter to pass to the method(s) is the zero-based count of
  479. iteration.
  480. </param>
  481. </member>
  482. <member name="M:WebSocketSharp.Ext.Times(System.UInt64,System.Action{System.UInt64})">
  483. <summary>
  484. Executes the specified <c>Action&lt;ulong&gt;</c> delegate <paramref name="n"/> times.
  485. </summary>
  486. <param name="n">
  487. A <see cref="T:System.UInt64"/> is the number of times to execute.
  488. </param>
  489. <param name="action">
  490. An <c>Action&lt;ulong&gt;</c> delegate that references the method(s) to execute.
  491. A <see cref="T:System.UInt64"/> parameter to pass to this method(s) is the zero-based count of
  492. iteration.
  493. </param>
  494. </member>
  495. <member name="M:WebSocketSharp.Ext.To``1(System.Byte[],WebSocketSharp.ByteOrder)">
  496. <summary>
  497. Converts the specified array of <see cref="T:System.Byte"/> to the specified type data.
  498. </summary>
  499. <returns>
  500. A T converted from <paramref name="source"/>, or a default value of
  501. T if <paramref name="source"/> is an empty array of <see cref="T:System.Byte"/> or
  502. if the type of T isn't <see cref="T:System.Boolean"/>, <see cref="T:System.Char"/>, <see cref="T:System.Double"/>,
  503. <see cref="T:System.Single"/>, <see cref="T:System.Int32"/>, <see cref="T:System.Int64"/>, <see cref="T:System.Int16"/>,
  504. <see cref="T:System.UInt32"/>, <see cref="T:System.UInt64"/>, or <see cref="T:System.UInt16"/>.
  505. </returns>
  506. <param name="source">
  507. An array of <see cref="T:System.Byte"/> to convert.
  508. </param>
  509. <param name="sourceOrder">
  510. One of the <see cref="T:WebSocketSharp.ByteOrder"/> enum values, specifies the byte order of
  511. <paramref name="source"/>.
  512. </param>
  513. <typeparam name="T">
  514. The type of the return. The T must be a value type.
  515. </typeparam>
  516. <exception cref="T:System.ArgumentNullException">
  517. <paramref name="source"/> is <see langword="null"/>.
  518. </exception>
  519. </member>
  520. <member name="M:WebSocketSharp.Ext.ToByteArray``1(``0,WebSocketSharp.ByteOrder)">
  521. <summary>
  522. Converts the specified <paramref name="value"/> to an array of <see cref="T:System.Byte"/>.
  523. </summary>
  524. <returns>
  525. An array of <see cref="T:System.Byte"/> converted from <paramref name="value"/>.
  526. </returns>
  527. <param name="value">
  528. A T to convert.
  529. </param>
  530. <param name="order">
  531. One of the <see cref="T:WebSocketSharp.ByteOrder"/> enum values, specifies the byte order of the return.
  532. </param>
  533. <typeparam name="T">
  534. The type of <paramref name="value"/>. The T must be a value type.
  535. </typeparam>
  536. </member>
  537. <member name="M:WebSocketSharp.Ext.ToHostOrder(System.Byte[],WebSocketSharp.ByteOrder)">
  538. <summary>
  539. Converts the order of the specified array of <see cref="T:System.Byte"/> to the host byte order.
  540. </summary>
  541. <returns>
  542. An array of <see cref="T:System.Byte"/> converted from <paramref name="source"/>.
  543. </returns>
  544. <param name="source">
  545. An array of <see cref="T:System.Byte"/> to convert.
  546. </param>
  547. <param name="sourceOrder">
  548. One of the <see cref="T:WebSocketSharp.ByteOrder"/> enum values, specifies the byte order of
  549. <paramref name="source"/>.
  550. </param>
  551. <exception cref="T:System.ArgumentNullException">
  552. <paramref name="source"/> is <see langword="null"/>.
  553. </exception>
  554. </member>
  555. <member name="M:WebSocketSharp.Ext.ToString``1(``0[],System.String)">
  556. <summary>
  557. Converts the specified <paramref name="array"/> to a <see cref="T:System.String"/> that
  558. concatenates the each element of <paramref name="array"/> across the specified
  559. <paramref name="separator"/>.
  560. </summary>
  561. <returns>
  562. A <see cref="T:System.String"/> converted from <paramref name="array"/>,
  563. or <see cref="F:System.String.Empty"/> if <paramref name="array"/> is empty.
  564. </returns>
  565. <param name="array">
  566. An array of T to convert.
  567. </param>
  568. <param name="separator">
  569. A <see cref="T:System.String"/> that represents the separator string.
  570. </param>
  571. <typeparam name="T">
  572. The type of elements in <paramref name="array"/>.
  573. </typeparam>
  574. <exception cref="T:System.ArgumentNullException">
  575. <paramref name="array"/> is <see langword="null"/>.
  576. </exception>
  577. </member>
  578. <member name="M:WebSocketSharp.Ext.ToUri(System.String)">
  579. <summary>
  580. Converts the specified <see cref="T:System.String"/> to a <see cref="T:System.Uri"/>.
  581. </summary>
  582. <returns>
  583. A <see cref="T:System.Uri"/> converted from <paramref name="uriString"/>,
  584. or <see langword="null"/> if <paramref name="uriString"/> isn't successfully converted.
  585. </returns>
  586. <param name="uriString">
  587. A <see cref="T:System.String"/> to convert.
  588. </param>
  589. </member>
  590. <member name="M:WebSocketSharp.Ext.UrlDecode(System.String)">
  591. <summary>
  592. URL-decodes the specified <see cref="T:System.String"/>.
  593. </summary>
  594. <returns>
  595. A <see cref="T:System.String"/> that receives the decoded string,
  596. or the <paramref name="value"/> if it's <see langword="null"/> or empty.
  597. </returns>
  598. <param name="value">
  599. A <see cref="T:System.String"/> to decode.
  600. </param>
  601. </member>
  602. <member name="M:WebSocketSharp.Ext.UrlEncode(System.String)">
  603. <summary>
  604. URL-encodes the specified <see cref="T:System.String"/>.
  605. </summary>
  606. <returns>
  607. A <see cref="T:System.String"/> that receives the encoded string,
  608. or <paramref name="value"/> if it's <see langword="null"/> or empty.
  609. </returns>
  610. <param name="value">
  611. A <see cref="T:System.String"/> to encode.
  612. </param>
  613. </member>
  614. <member name="M:WebSocketSharp.Ext.WriteContent(WebSocketSharp.Net.HttpListenerResponse,System.Byte[])">
  615. <summary>
  616. Writes and sends the specified <paramref name="content"/> data with the specified
  617. <see cref="T:WebSocketSharp.Net.HttpListenerResponse"/>.
  618. </summary>
  619. <param name="response">
  620. A <see cref="T:WebSocketSharp.Net.HttpListenerResponse"/> that represents the HTTP response used to
  621. send the content data.
  622. </param>
  623. <param name="content">
  624. An array of <see cref="T:System.Byte"/> that represents the content data to send.
  625. </param>
  626. <exception cref="T:System.ArgumentNullException">
  627. <para>
  628. <paramref name="response"/> is <see langword="null"/>.
  629. </para>
  630. <para>
  631. -or-
  632. </para>
  633. <para>
  634. <paramref name="content"/> is <see langword="null"/>.
  635. </para>
  636. </exception>
  637. </member>
  638. <member name="T:WebSocketSharp.MessageEventArgs">
  639. <summary>
  640. Represents the event data for the <see cref="E:WebSocketSharp.WebSocket.OnMessage"/> event.
  641. </summary>
  642. <remarks>
  643. <para>
  644. A <see cref="E:WebSocketSharp.WebSocket.OnMessage"/> event occurs when the <see cref="T:WebSocketSharp.WebSocket"/> receives
  645. a text or binary message, or a ping if the <see cref="P:WebSocketSharp.WebSocket.EmitOnPing"/> property is
  646. set to <c>true</c>.
  647. </para>
  648. <para>
  649. If you would like to get the message data, you should access the <see cref="P:WebSocketSharp.MessageEventArgs.Data"/> or
  650. <see cref="P:WebSocketSharp.MessageEventArgs.RawData"/> property.
  651. </para>
  652. </remarks>
  653. </member>
  654. <member name="P:WebSocketSharp.MessageEventArgs.Data">
  655. <summary>
  656. Gets the message data as a <see cref="T:System.String"/>.
  657. </summary>
  658. <value>
  659. A <see cref="T:System.String"/> that represents the message data,
  660. or <see langword="null"/> if the message data cannot be decoded to a string.
  661. </value>
  662. </member>
  663. <member name="P:WebSocketSharp.MessageEventArgs.IsBinary">
  664. <summary>
  665. Gets a value indicating whether the message type is binary.
  666. </summary>
  667. <value>
  668. <c>true</c> if the message type is binary; otherwise, <c>false</c>.
  669. </value>
  670. </member>
  671. <member name="P:WebSocketSharp.MessageEventArgs.IsPing">
  672. <summary>
  673. Gets a value indicating whether the message type is ping.
  674. </summary>
  675. <value>
  676. <c>true</c> if the message type is ping; otherwise, <c>false</c>.
  677. </value>
  678. </member>
  679. <member name="P:WebSocketSharp.MessageEventArgs.IsText">
  680. <summary>
  681. Gets a value indicating whether the message type is text.
  682. </summary>
  683. <value>
  684. <c>true</c> if the message type is text; otherwise, <c>false</c>.
  685. </value>
  686. </member>
  687. <member name="P:WebSocketSharp.MessageEventArgs.RawData">
  688. <summary>
  689. Gets the message data as an array of <see cref="T:System.Byte"/>.
  690. </summary>
  691. <value>
  692. An array of <see cref="T:System.Byte"/> that represents the message data.
  693. </value>
  694. </member>
  695. <member name="P:WebSocketSharp.MessageEventArgs.Type">
  696. <summary>
  697. Gets the message type.
  698. </summary>
  699. <value>
  700. <see cref="F:WebSocketSharp.Opcode.Text"/>, <see cref="F:WebSocketSharp.Opcode.Binary"/>, or <see cref="F:WebSocketSharp.Opcode.Ping"/>.
  701. </value>
  702. </member>
  703. <member name="T:WebSocketSharp.CloseEventArgs">
  704. <summary>
  705. Represents the event data for the <see cref="E:WebSocketSharp.WebSocket.OnClose"/> event.
  706. </summary>
  707. <remarks>
  708. <para>
  709. A <see cref="E:WebSocketSharp.WebSocket.OnClose"/> event occurs when the WebSocket connection
  710. has been closed.
  711. </para>
  712. <para>
  713. If you would like to get the reason for the close, you should access
  714. the <see cref="P:WebSocketSharp.CloseEventArgs.Code"/> or <see cref="P:WebSocketSharp.CloseEventArgs.Reason"/> property.
  715. </para>
  716. </remarks>
  717. </member>
  718. <member name="P:WebSocketSharp.CloseEventArgs.Code">
  719. <summary>
  720. Gets the status code for the close.
  721. </summary>
  722. <value>
  723. A <see cref="T:System.UInt16"/> that represents the status code for the close if any.
  724. </value>
  725. </member>
  726. <member name="P:WebSocketSharp.CloseEventArgs.Reason">
  727. <summary>
  728. Gets the reason for the close.
  729. </summary>
  730. <value>
  731. A <see cref="T:System.String"/> that represents the reason for the close if any.
  732. </value>
  733. </member>
  734. <member name="P:WebSocketSharp.CloseEventArgs.WasClean">
  735. <summary>
  736. Gets a value indicating whether the connection has been closed cleanly.
  737. </summary>
  738. <value>
  739. <c>true</c> if the connection has been closed cleanly; otherwise, <c>false</c>.
  740. </value>
  741. </member>
  742. <member name="T:WebSocketSharp.ByteOrder">
  743. <summary>
  744. Specifies the byte order.
  745. </summary>
  746. </member>
  747. <member name="F:WebSocketSharp.ByteOrder.Little">
  748. <summary>
  749. Specifies Little-endian.
  750. </summary>
  751. </member>
  752. <member name="F:WebSocketSharp.ByteOrder.Big">
  753. <summary>
  754. Specifies Big-endian.
  755. </summary>
  756. </member>
  757. <member name="T:WebSocketSharp.ErrorEventArgs">
  758. <summary>
  759. Represents the event data for the <see cref="E:WebSocketSharp.WebSocket.OnError"/> event.
  760. </summary>
  761. <remarks>
  762. <para>
  763. A <see cref="E:WebSocketSharp.WebSocket.OnError"/> event occurs when the <see cref="T:WebSocketSharp.WebSocket"/> gets
  764. an error.
  765. </para>
  766. <para>
  767. If you would like to get the error message, you should access
  768. the <see cref="P:WebSocketSharp.ErrorEventArgs.Message"/> property.
  769. </para>
  770. <para>
  771. And if the error is due to an exception, you can get the exception by accessing
  772. the <see cref="P:WebSocketSharp.ErrorEventArgs.Exception"/> property.
  773. </para>
  774. </remarks>
  775. </member>
  776. <member name="P:WebSocketSharp.ErrorEventArgs.Exception">
  777. <summary>
  778. Gets the exception that caused the error.
  779. </summary>
  780. <value>
  781. An <see cref="T:System.Exception"/> instance that represents the cause of the error,
  782. or <see langword="null"/> if the error isn't due to an exception.
  783. </value>
  784. </member>
  785. <member name="P:WebSocketSharp.ErrorEventArgs.Message">
  786. <summary>
  787. Gets the error message.
  788. </summary>
  789. <value>
  790. A <see cref="T:System.String"/> that represents the error message.
  791. </value>
  792. </member>
  793. <member name="T:WebSocketSharp.WebSocket">
  794. <summary>
  795. Implements the WebSocket interface.
  796. </summary>
  797. <remarks>
  798. The WebSocket class provides a set of methods and properties for two-way communication using
  799. the WebSocket protocol (<see href="http://tools.ietf.org/html/rfc6455">RFC 6455</see>).
  800. </remarks>
  801. </member>
  802. <member name="F:WebSocketSharp.WebSocket.EmptyBytes">
  803. <summary>
  804. Represents the empty array of <see cref="T:System.Byte"/> used internally.
  805. </summary>
  806. </member>
  807. <member name="F:WebSocketSharp.WebSocket.FragmentLength">
  808. <summary>
  809. Represents the length used to determine whether the data should be fragmented in sending.
  810. </summary>
  811. <remarks>
  812. <para>
  813. The data will be fragmented if that length is greater than the value of this field.
  814. </para>
  815. <para>
  816. If you would like to change the value, you must set it to a value between <c>125</c> and
  817. <c>Int32.MaxValue - 14</c> inclusive.
  818. </para>
  819. </remarks>
  820. </member>
  821. <member name="F:WebSocketSharp.WebSocket.RandomNumber">
  822. <summary>
  823. Represents the random number generator used internally.
  824. </summary>
  825. </member>
  826. <member name="M:WebSocketSharp.WebSocket.#ctor(System.String,System.String[])">
  827. <summary>
  828. Initializes a new instance of the <see cref="T:WebSocketSharp.WebSocket"/> class with
  829. the specified WebSocket URL and subprotocols.
  830. </summary>
  831. <param name="url">
  832. A <see cref="T:System.String"/> that represents the WebSocket URL to connect.
  833. </param>
  834. <param name="protocols">
  835. An array of <see cref="T:System.String"/> that contains the WebSocket subprotocols if any.
  836. Each value of <paramref name="protocols"/> must be a token defined in
  837. <see href="http://tools.ietf.org/html/rfc2616#section-2.2">RFC 2616</see>.
  838. </param>
  839. <exception cref="T:System.ArgumentNullException">
  840. <paramref name="url"/> is <see langword="null"/>.
  841. </exception>
  842. <exception cref="T:System.ArgumentException">
  843. <para>
  844. <paramref name="url"/> is invalid.
  845. </para>
  846. <para>
  847. -or-
  848. </para>
  849. <para>
  850. <paramref name="protocols"/> is invalid.
  851. </para>
  852. </exception>
  853. </member>
  854. <member name="M:WebSocketSharp.WebSocket.Accept">
  855. <summary>
  856. Accepts the WebSocket handshake request.
  857. </summary>
  858. <remarks>
  859. This method isn't available in a client.
  860. </remarks>
  861. </member>
  862. <member name="M:WebSocketSharp.WebSocket.AcceptAsync">
  863. <summary>
  864. Accepts the WebSocket handshake request asynchronously.
  865. </summary>
  866. <remarks>
  867. <para>
  868. This method doesn't wait for the accept to be complete.
  869. </para>
  870. <para>
  871. This method isn't available in a client.
  872. </para>
  873. </remarks>
  874. </member>
  875. <member name="M:WebSocketSharp.WebSocket.Close">
  876. <summary>
  877. Closes the WebSocket connection, and releases all associated resources.
  878. </summary>
  879. </member>
  880. <member name="M:WebSocketSharp.WebSocket.Close(System.UInt16)">
  881. <summary>
  882. Closes the WebSocket connection with the specified <see cref="T:System.UInt16"/>,
  883. and releases all associated resources.
  884. </summary>
  885. <remarks>
  886. This method emits a <see cref="E:WebSocketSharp.WebSocket.OnError"/> event if <paramref name="code"/> isn't in
  887. the allowable range of the close status code.
  888. </remarks>
  889. <param name="code">
  890. A <see cref="T:System.UInt16"/> that represents the status code indicating the reason for the close.
  891. </param>
  892. </member>
  893. <member name="M:WebSocketSharp.WebSocket.Close(WebSocketSharp.CloseStatusCode)">
  894. <summary>
  895. Closes the WebSocket connection with the specified <see cref="T:WebSocketSharp.CloseStatusCode"/>,
  896. and releases all associated resources.
  897. </summary>
  898. <param name="code">
  899. One of the <see cref="T:WebSocketSharp.CloseStatusCode"/> enum values, represents the status code indicating
  900. the reason for the close.
  901. </param>
  902. </member>
  903. <member name="M:WebSocketSharp.WebSocket.Close(System.UInt16,System.String)">
  904. <summary>
  905. Closes the WebSocket connection with the specified <see cref="T:System.UInt16"/> and
  906. <see cref="T:System.String"/>, and releases all associated resources.
  907. </summary>
  908. <remarks>
  909. This method emits a <see cref="E:WebSocketSharp.WebSocket.OnError"/> event if <paramref name="code"/> isn't in
  910. the allowable range of the close status code or the size of <paramref name="reason"/> is
  911. greater than 123 bytes.
  912. </remarks>
  913. <param name="code">
  914. A <see cref="T:System.UInt16"/> that represents the status code indicating the reason for the close.
  915. </param>
  916. <param name="reason">
  917. A <see cref="T:System.String"/> that represents the reason for the close.
  918. </param>
  919. </member>
  920. <member name="M:WebSocketSharp.WebSocket.Close(WebSocketSharp.CloseStatusCode,System.String)">
  921. <summary>
  922. Closes the WebSocket connection with the specified <see cref="T:WebSocketSharp.CloseStatusCode"/> and
  923. <see cref="T:System.String"/>, and releases all associated resources.
  924. </summary>
  925. <remarks>
  926. This method emits a <see cref="E:WebSocketSharp.WebSocket.OnError"/> event if the size of <paramref name="reason"/> is
  927. greater than 123 bytes.
  928. </remarks>
  929. <param name="code">
  930. One of the <see cref="T:WebSocketSharp.CloseStatusCode"/> enum values, represents the status code indicating
  931. the reason for the close.
  932. </param>
  933. <param name="reason">
  934. A <see cref="T:System.String"/> that represents the reason for the close.
  935. </param>
  936. </member>
  937. <member name="M:WebSocketSharp.WebSocket.CloseAsync">
  938. <summary>
  939. Closes the WebSocket connection asynchronously, and releases all associated resources.
  940. </summary>
  941. <remarks>
  942. This method doesn't wait for the close to be complete.
  943. </remarks>
  944. </member>
  945. <member name="M:WebSocketSharp.WebSocket.CloseAsync(System.UInt16)">
  946. <summary>
  947. Closes the WebSocket connection asynchronously with the specified <see cref="T:System.UInt16"/>,
  948. and releases all associated resources.
  949. </summary>
  950. <remarks>
  951. <para>
  952. This method doesn't wait for the close to be complete.
  953. </para>
  954. <para>
  955. This method emits a <see cref="E:WebSocketSharp.WebSocket.OnError"/> event if <paramref name="code"/> isn't in
  956. the allowable range of the close status code.
  957. </para>
  958. </remarks>
  959. <param name="code">
  960. A <see cref="T:System.UInt16"/> that represents the status code indicating the reason for the close.
  961. </param>
  962. </member>
  963. <member name="M:WebSocketSharp.WebSocket.CloseAsync(WebSocketSharp.CloseStatusCode)">
  964. <summary>
  965. Closes the WebSocket connection asynchronously with the specified
  966. <see cref="T:WebSocketSharp.CloseStatusCode"/>, and releases all associated resources.
  967. </summary>
  968. <remarks>
  969. This method doesn't wait for the close to be complete.
  970. </remarks>
  971. <param name="code">
  972. One of the <see cref="T:WebSocketSharp.CloseStatusCode"/> enum values, represents the status code indicating
  973. the reason for the close.
  974. </param>
  975. </member>
  976. <member name="M:WebSocketSharp.WebSocket.CloseAsync(System.UInt16,System.String)">
  977. <summary>
  978. Closes the WebSocket connection asynchronously with the specified <see cref="T:System.UInt16"/> and
  979. <see cref="T:System.String"/>, and releases all associated resources.
  980. </summary>
  981. <remarks>
  982. <para>
  983. This method doesn't wait for the close to be complete.
  984. </para>
  985. <para>
  986. This method emits a <see cref="E:WebSocketSharp.WebSocket.OnError"/> event if <paramref name="code"/> isn't in
  987. the allowable range of the close status code or the size of <paramref name="reason"/> is
  988. greater than 123 bytes.
  989. </para>
  990. </remarks>
  991. <param name="code">
  992. A <see cref="T:System.UInt16"/> that represents the status code indicating the reason for the close.
  993. </param>
  994. <param name="reason">
  995. A <see cref="T:System.String"/> that represents the reason for the close.
  996. </param>
  997. </member>
  998. <member name="M:WebSocketSharp.WebSocket.CloseAsync(WebSocketSharp.CloseStatusCode,System.String)">
  999. <summary>
  1000. Closes the WebSocket connection asynchronously with the specified
  1001. <see cref="T:WebSocketSharp.CloseStatusCode"/> and <see cref="T:System.String"/>, and releases
  1002. all associated resources.
  1003. </summary>
  1004. <remarks>
  1005. <para>
  1006. This method doesn't wait for the close to be complete.
  1007. </para>
  1008. <para>
  1009. This method emits a <see cref="E:WebSocketSharp.WebSocket.OnError"/> event if the size of
  1010. <paramref name="reason"/> is greater than 123 bytes.
  1011. </para>
  1012. </remarks>
  1013. <param name="code">
  1014. One of the <see cref="T:WebSocketSharp.CloseStatusCode"/> enum values, represents the status code indicating
  1015. the reason for the close.
  1016. </param>
  1017. <param name="reason">
  1018. A <see cref="T:System.String"/> that represents the reason for the close.
  1019. </param>
  1020. </member>
  1021. <member name="M:WebSocketSharp.WebSocket.Connect">
  1022. <summary>
  1023. Establishes a WebSocket connection.
  1024. </summary>
  1025. <remarks>
  1026. This method isn't available in a server.
  1027. </remarks>
  1028. </member>
  1029. <member name="M:WebSocketSharp.WebSocket.ConnectAsync">
  1030. <summary>
  1031. Establishes a WebSocket connection asynchronously.
  1032. </summary>
  1033. <remarks>
  1034. <para>
  1035. This method doesn't wait for the connect to be complete.
  1036. </para>
  1037. <para>
  1038. This method isn't available in a server.
  1039. </para>
  1040. </remarks>
  1041. </member>
  1042. <member name="M:WebSocketSharp.WebSocket.Ping">
  1043. <summary>
  1044. Sends a ping using the WebSocket connection.
  1045. </summary>
  1046. <returns>
  1047. <c>true</c> if the <see cref="T:WebSocketSharp.WebSocket"/> receives a pong to this ping in a time;
  1048. otherwise, <c>false</c>.
  1049. </returns>
  1050. </member>
  1051. <member name="M:WebSocketSharp.WebSocket.Ping(System.String)">
  1052. <summary>
  1053. Sends a ping with the specified <paramref name="message"/> using the WebSocket connection.
  1054. </summary>
  1055. <returns>
  1056. <c>true</c> if the <see cref="T:WebSocketSharp.WebSocket"/> receives a pong to this ping in a time;
  1057. otherwise, <c>false</c>.
  1058. </returns>
  1059. <param name="message">
  1060. A <see cref="T:System.String"/> that represents the message to send.
  1061. </param>
  1062. </member>
  1063. <member name="M:WebSocketSharp.WebSocket.Send(System.Byte[])">
  1064. <summary>
  1065. Sends binary <paramref name="data"/> using the WebSocket connection.
  1066. </summary>
  1067. <param name="data">
  1068. An array of <see cref="T:System.Byte"/> that represents the binary data to send.
  1069. </param>
  1070. </member>
  1071. <member name="M:WebSocketSharp.WebSocket.Send(System.IO.FileInfo)">
  1072. <summary>
  1073. Sends the specified <paramref name="file"/> as binary data using the WebSocket connection.
  1074. </summary>
  1075. <param name="file">
  1076. A <see cref="T:System.IO.FileInfo"/> that represents the file to send.
  1077. </param>
  1078. </member>
  1079. <member name="M:WebSocketSharp.WebSocket.Send(System.String)">
  1080. <summary>
  1081. Sends text <paramref name="data"/> using the WebSocket connection.
  1082. </summary>
  1083. <param name="data">
  1084. A <see cref="T:System.String"/> that represents the text data to send.
  1085. </param>
  1086. </member>
  1087. <member name="M:WebSocketSharp.WebSocket.SendAsync(System.Byte[],System.Action{System.Boolean})">
  1088. <summary>
  1089. Sends binary <paramref name="data"/> asynchronously using the WebSocket connection.
  1090. </summary>
  1091. <remarks>
  1092. This method doesn't wait for the send to be complete.
  1093. </remarks>
  1094. <param name="data">
  1095. An array of <see cref="T:System.Byte"/> that represents the binary data to send.
  1096. </param>
  1097. <param name="completed">
  1098. An <c>Action&lt;bool&gt;</c> delegate that references the method(s) called when
  1099. the send is complete. A <see cref="T:System.Boolean"/> passed to this delegate is <c>true</c>
  1100. if the send is complete successfully.
  1101. </param>
  1102. </member>
  1103. <member name="M:WebSocketSharp.WebSocket.SendAsync(System.IO.FileInfo,System.Action{System.Boolean})">
  1104. <summary>
  1105. Sends the specified <paramref name="file"/> as binary data asynchronously using
  1106. the WebSocket connection.
  1107. </summary>
  1108. <remarks>
  1109. This method doesn't wait for the send to be complete.
  1110. </remarks>
  1111. <param name="file">
  1112. A <see cref="T:System.IO.FileInfo"/> that represents the file to send.
  1113. </param>
  1114. <param name="completed">
  1115. An <c>Action&lt;bool&gt;</c> delegate that references the method(s) called when
  1116. the send is complete. A <see cref="T:System.Boolean"/> passed to this delegate is <c>true</c>
  1117. if the send is complete successfully.
  1118. </param>
  1119. </member>
  1120. <member name="M:WebSocketSharp.WebSocket.SendAsync(System.String,System.Action{System.Boolean})">
  1121. <summary>
  1122. Sends text <paramref name="data"/> asynchronously using the WebSocket connection.
  1123. </summary>
  1124. <remarks>
  1125. This method doesn't wait for the send to be complete.
  1126. </remarks>
  1127. <param name="data">
  1128. A <see cref="T:System.String"/> that represents the text data to send.
  1129. </param>
  1130. <param name="completed">
  1131. An <c>Action&lt;bool&gt;</c> delegate that references the method(s) called when
  1132. the send is complete. A <see cref="T:System.Boolean"/> passed to this delegate is <c>true</c>
  1133. if the send is complete successfully.
  1134. </param>
  1135. </member>
  1136. <member name="M:WebSocketSharp.WebSocket.SendAsync(System.IO.Stream,System.Int32,System.Action{System.Boolean})">
  1137. <summary>
  1138. Sends binary data from the specified <see cref="T:System.IO.Stream"/> asynchronously using
  1139. the WebSocket connection.
  1140. </summary>
  1141. <remarks>
  1142. This method doesn't wait for the send to be complete.
  1143. </remarks>
  1144. <param name="stream">
  1145. A <see cref="T:System.IO.Stream"/> from which contains the binary data to send.
  1146. </param>
  1147. <param name="length">
  1148. An <see cref="T:System.Int32"/> that represents the number of bytes to send.
  1149. </param>
  1150. <param name="completed">
  1151. An <c>Action&lt;bool&gt;</c> delegate that references the method(s) called when
  1152. the send is complete. A <see cref="T:System.Boolean"/> passed to this delegate is <c>true</c>
  1153. if the send is complete successfully.
  1154. </param>
  1155. </member>
  1156. <member name="M:WebSocketSharp.WebSocket.SetCookie(WebSocketSharp.Net.Cookie)">
  1157. <summary>
  1158. Sets an HTTP <paramref name="cookie"/> to send with
  1159. the WebSocket handshake request to the server.
  1160. </summary>
  1161. <param name="cookie">
  1162. A <see cref="T:WebSocketSharp.Net.Cookie"/> that represents the cookie to send.
  1163. </param>
  1164. </member>
  1165. <member name="M:WebSocketSharp.WebSocket.SetCredentials(System.String,System.String,System.Boolean)">
  1166. <summary>
  1167. Sets a pair of <paramref name="username"/> and <paramref name="password"/> for
  1168. the HTTP authentication (Basic/Digest).
  1169. </summary>
  1170. <param name="username">
  1171. A <see cref="T:System.String"/> that represents the user name used to authenticate.
  1172. </param>
  1173. <param name="password">
  1174. A <see cref="T:System.String"/> that represents the password for <paramref name="username"/>
  1175. used to authenticate.
  1176. </param>
  1177. <param name="preAuth">
  1178. <c>true</c> if the <see cref="T:WebSocketSharp.WebSocket"/> sends the Basic authentication credentials with
  1179. the first handshake request to the server; otherwise, <c>false</c>.
  1180. </param>
  1181. </member>
  1182. <member name="M:WebSocketSharp.WebSocket.SetProxy(System.String,System.String,System.String)">
  1183. <summary>
  1184. Sets an HTTP proxy server URL to connect through, and if necessary,
  1185. a pair of <paramref name="username"/> and <paramref name="password"/> for
  1186. the proxy server authentication (Basic/Digest).
  1187. </summary>
  1188. <param name="url">
  1189. A <see cref="T:System.String"/> that represents the proxy server URL to connect through.
  1190. </param>
  1191. <param name="username">
  1192. A <see cref="T:System.String"/> that represents the user name used to authenticate.
  1193. </param>
  1194. <param name="password">
  1195. A <see cref="T:System.String"/> that represents the password for <paramref name="username"/>
  1196. used to authenticate.
  1197. </param>
  1198. </member>
  1199. <member name="M:WebSocketSharp.WebSocket.System#IDisposable#Dispose">
  1200. <summary>
  1201. Closes the WebSocket connection, and releases all associated resources.
  1202. </summary>
  1203. <remarks>
  1204. This method closes the connection with <see cref="F:WebSocketSharp.CloseStatusCode.Away"/>.
  1205. </remarks>
  1206. </member>
  1207. <member name="P:WebSocketSharp.WebSocket.Compression">
  1208. <summary>
  1209. Gets or sets the compression method used to compress a message on the WebSocket connection.
  1210. </summary>
  1211. <value>
  1212. One of the <see cref="T:WebSocketSharp.CompressionMethod"/> enum values, specifies the compression method
  1213. used to compress a message. The default value is <see cref="F:WebSocketSharp.CompressionMethod.None"/>.
  1214. </value>
  1215. </member>
  1216. <member name="P:WebSocketSharp.WebSocket.Cookies">
  1217. <summary>
  1218. Gets the HTTP cookies included in the WebSocket handshake request and response.
  1219. </summary>
  1220. <value>
  1221. An <see cref="T:System.Collections.Generic.IEnumerable{WebSocketSharp.Net.Cookie}"/>
  1222. instance that provides an enumerator which supports the iteration over the collection of
  1223. the cookies.
  1224. </value>
  1225. </member>
  1226. <member name="P:WebSocketSharp.WebSocket.Credentials">
  1227. <summary>
  1228. Gets the credentials for the HTTP authentication (Basic/Digest).
  1229. </summary>
  1230. <value>
  1231. A <see cref="T:WebSocketSharp.Net.NetworkCredential"/> that represents the credentials for
  1232. the authentication. The default value is <see langword="null"/>.
  1233. </value>
  1234. </member>
  1235. <member name="P:WebSocketSharp.WebSocket.EmitOnPing">
  1236. <summary>
  1237. Gets or sets a value indicating whether the <see cref="T:WebSocketSharp.WebSocket"/> emits
  1238. a <see cref="E:WebSocketSharp.WebSocket.OnMessage"/> event when receives a ping.
  1239. </summary>
  1240. <value>
  1241. <c>true</c> if the <see cref="T:WebSocketSharp.WebSocket"/> emits a <see cref="E:WebSocketSharp.WebSocket.OnMessage"/> event
  1242. when receives a ping; otherwise, <c>false</c>. The default value is <c>false</c>.
  1243. </value>
  1244. </member>
  1245. <member name="P:WebSocketSharp.WebSocket.EnableRedirection">
  1246. <summary>
  1247. Gets or sets a value indicating whether the <see cref="T:WebSocketSharp.WebSocket"/> redirects
  1248. the handshake request to the new URL located in the handshake response.
  1249. </summary>
  1250. <value>
  1251. <c>true</c> if the <see cref="T:WebSocketSharp.WebSocket"/> redirects the handshake request to
  1252. the new URL; otherwise, <c>false</c>. The default value is <c>false</c>.
  1253. </value>
  1254. </member>
  1255. <member name="P:WebSocketSharp.WebSocket.Extensions">
  1256. <summary>
  1257. Gets the WebSocket extensions selected by the server.
  1258. </summary>
  1259. <value>
  1260. A <see cref="T:System.String"/> that represents the extensions if any.
  1261. The default value is <see cref="F:System.String.Empty"/>.
  1262. </value>
  1263. </member>
  1264. <member name="P:WebSocketSharp.WebSocket.IsAlive">
  1265. <summary>
  1266. Gets a value indicating whether the WebSocket connection is alive.
  1267. </summary>
  1268. <value>
  1269. <c>true</c> if the connection is alive; otherwise, <c>false</c>.
  1270. </value>
  1271. </member>
  1272. <member name="P:WebSocketSharp.WebSocket.IsSecure">
  1273. <summary>
  1274. Gets a value indicating whether the WebSocket connection is secure.
  1275. </summary>
  1276. <value>
  1277. <c>true</c> if the connection is secure; otherwise, <c>false</c>.
  1278. </value>
  1279. </member>
  1280. <member name="P:WebSocketSharp.WebSocket.Log">
  1281. <summary>
  1282. Gets the logging functions.
  1283. </summary>
  1284. <remarks>
  1285. The default logging level is <see cref="F:WebSocketSharp.LogLevel.Error"/>. If you would like to change it,
  1286. you should set this <c>Log.Level</c> property to any of the <see cref="T:WebSocketSharp.LogLevel"/> enum
  1287. values.
  1288. </remarks>
  1289. <value>
  1290. A <see cref="T:WebSocketSharp.Logger"/> that provides the logging functions.
  1291. </value>
  1292. </member>
  1293. <member name="P:WebSocketSharp.WebSocket.Origin">
  1294. <summary>
  1295. Gets or sets the value of the HTTP Origin header to send with
  1296. the WebSocket handshake request to the server.
  1297. </summary>
  1298. <remarks>
  1299. The <see cref="T:WebSocketSharp.WebSocket"/> sends the Origin header if this property has any.
  1300. </remarks>
  1301. <value>
  1302. <para>
  1303. A <see cref="T:System.String"/> that represents the value of
  1304. the <see href="http://tools.ietf.org/html/rfc6454#section-7">Origin</see> header to send.
  1305. The default value is <see langword="null"/>.
  1306. </para>
  1307. <para>
  1308. The Origin header has the following syntax:
  1309. <c>&lt;scheme&gt;://&lt;host&gt;[:&lt;port&gt;]</c>
  1310. </para>
  1311. </value>
  1312. </member>
  1313. <member name="P:WebSocketSharp.WebSocket.Protocol">
  1314. <summary>
  1315. Gets the WebSocket subprotocol selected by the server.
  1316. </summary>
  1317. <value>
  1318. A <see cref="T:System.String"/> that represents the subprotocol if any.
  1319. The default value is <see cref="F:System.String.Empty"/>.
  1320. </value>
  1321. </member>
  1322. <member name="P:WebSocketSharp.WebSocket.ReadyState">
  1323. <summary>
  1324. Gets the state of the WebSocket connection.
  1325. </summary>
  1326. <value>
  1327. One of the <see cref="T:WebSocketSharp.WebSocketState"/> enum values, indicates the state of the connection.
  1328. The default value is <see cref="F:WebSocketSharp.WebSocketState.Connecting"/>.
  1329. </value>
  1330. </member>
  1331. <member name="P:WebSocketSharp.WebSocket.SslConfiguration">
  1332. <summary>
  1333. Gets or sets the SSL configuration used to authenticate the server and
  1334. optionally the client for secure connection.
  1335. </summary>
  1336. <value>
  1337. A <see cref="T:WebSocketSharp.Net.ClientSslConfiguration"/> that represents the configuration used
  1338. to authenticate the server and optionally the client for secure connection,
  1339. or <see langword="null"/> if the <see cref="T:WebSocketSharp.WebSocket"/> is used in a server.
  1340. </value>
  1341. </member>
  1342. <member name="P:WebSocketSharp.WebSocket.Url">
  1343. <summary>
  1344. Gets the WebSocket URL used to connect, or accepted.
  1345. </summary>
  1346. <value>
  1347. A <see cref="T:System.Uri"/> that represents the URL used to connect, or accepted.
  1348. </value>
  1349. </member>
  1350. <member name="P:WebSocketSharp.WebSocket.WaitTime">
  1351. <summary>
  1352. Gets or sets the wait time for the response to the Ping or Close.
  1353. </summary>
  1354. <value>
  1355. A <see cref="T:System.TimeSpan"/> that represents the wait time. The default value is the same as
  1356. 5 seconds, or 1 second if the <see cref="T:WebSocketSharp.WebSocket"/> is used in a server.
  1357. </value>
  1358. </member>
  1359. <member name="E:WebSocketSharp.WebSocket.OnClose">
  1360. <summary>
  1361. Occurs when the WebSocket connection has been closed.
  1362. </summary>
  1363. </member>
  1364. <member name="E:WebSocketSharp.WebSocket.OnError">
  1365. <summary>
  1366. Occurs when the <see cref="T:WebSocketSharp.WebSocket"/> gets an error.
  1367. </summary>
  1368. </member>
  1369. <member name="E:WebSocketSharp.WebSocket.OnMessage">
  1370. <summary>
  1371. Occurs when the <see cref="T:WebSocketSharp.WebSocket"/> receives a message.
  1372. </summary>
  1373. </member>
  1374. <member name="E:WebSocketSharp.WebSocket.OnOpen">
  1375. <summary>
  1376. Occurs when the WebSocket connection has been established.
  1377. </summary>
  1378. </member>
  1379. <member name="T:WebSocketSharp.Server.WebSocketServer">
  1380. <summary>
  1381. Provides a WebSocket protocol server.
  1382. </summary>
  1383. <remarks>
  1384. The WebSocketServer class can provide multiple WebSocket services.
  1385. </remarks>
  1386. </member>
  1387. <member name="M:WebSocketSharp.Server.WebSocketServer.#ctor">
  1388. <summary>
  1389. Initializes a new instance of the <see cref="T:WebSocketSharp.Server.WebSocketServer"/> class.
  1390. </summary>
  1391. <remarks>
  1392. An instance initialized by this constructor listens for the incoming connection requests on
  1393. port 80.
  1394. </remarks>
  1395. </member>
  1396. <member name="M:WebSocketSharp.Server.WebSocketServer.#ctor(System.Int32)">
  1397. <summary>
  1398. Initializes a new instance of the <see cref="T:WebSocketSharp.Server.WebSocketServer"/> class with
  1399. the specified <paramref name="port"/>.
  1400. </summary>
  1401. <remarks>
  1402. <para>
  1403. An instance initialized by this constructor listens for the incoming connection requests
  1404. on <paramref name="port"/>.
  1405. </para>
  1406. <para>
  1407. If <paramref name="port"/> is 443, that instance provides a secure connection.
  1408. </para>
  1409. </remarks>
  1410. <param name="port">
  1411. An <see cref="T:System.Int32"/> that represents the port number on which to listen.
  1412. </param>
  1413. <exception cref="T:System.ArgumentOutOfRangeException">
  1414. <paramref name="port"/> isn't between 1 and 65535 inclusive.
  1415. </exception>
  1416. </member>
  1417. <member name="M:WebSocketSharp.Server.WebSocketServer.#ctor(System.String)">
  1418. <summary>
  1419. Initializes a new instance of the <see cref="T:WebSocketSharp.Server.WebSocketServer"/> class with
  1420. the specified WebSocket URL.
  1421. </summary>
  1422. <remarks>
  1423. <para>
  1424. An instance initialized by this constructor listens for the incoming connection requests
  1425. on the host name and port in <paramref name="url"/>.
  1426. </para>
  1427. <para>
  1428. If <paramref name="url"/> doesn't include a port, either port 80 or 443 is used on
  1429. which to listen. It's determined by the scheme (ws or wss) in <paramref name="url"/>.
  1430. (Port 80 if the scheme is ws.)
  1431. </para>
  1432. </remarks>
  1433. <param name="url">
  1434. A <see cref="T:System.String"/> that represents the WebSocket URL of the server.
  1435. </param>
  1436. <exception cref="T:System.ArgumentNullException">
  1437. <paramref name="url"/> is <see langword="null"/>.
  1438. </exception>
  1439. <exception cref="T:System.ArgumentException">
  1440. <para>
  1441. <paramref name="url"/> is empty.
  1442. </para>
  1443. <para>
  1444. -or-
  1445. </para>
  1446. <para>
  1447. <paramref name="url"/> is invalid.
  1448. </para>
  1449. </exception>
  1450. </member>
  1451. <member name="M:WebSocketSharp.Server.WebSocketServer.#ctor(System.Int32,System.Boolean)">
  1452. <summary>
  1453. Initializes a new instance of the <see cref="T:WebSocketSharp.Server.WebSocketServer"/> class with
  1454. the specified <paramref name="port"/> and <paramref name="secure"/>.
  1455. </summary>
  1456. <remarks>
  1457. An instance initialized by this constructor listens for the incoming connection requests on
  1458. <paramref name="port"/>.
  1459. </remarks>
  1460. <param name="port">
  1461. An <see cref="T:System.Int32"/> that represents the port number on which to listen.
  1462. </param>
  1463. <param name="secure">
  1464. A <see cref="T:System.Boolean"/> that indicates providing a secure connection or not.
  1465. (<c>true</c> indicates providing a secure connection.)
  1466. </param>
  1467. <exception cref="T:System.ArgumentOutOfRangeException">
  1468. <paramref name="port"/> isn't between 1 and 65535 inclusive.
  1469. </exception>
  1470. </member>
  1471. <member name="M:WebSocketSharp.Server.WebSocketServer.#ctor(System.Net.IPAddress,System.Int32)">
  1472. <summary>
  1473. Initializes a new instance of the <see cref="T:WebSocketSharp.Server.WebSocketServer"/> class with
  1474. the specified <paramref name="address"/> and <paramref name="port"/>.
  1475. </summary>
  1476. <remarks>
  1477. <para>
  1478. An instance initialized by this constructor listens for the incoming connection requests
  1479. on <paramref name="address"/> and <paramref name="port"/>.
  1480. </para>
  1481. <para>
  1482. If <paramref name="port"/> is 443, that instance provides a secure connection.
  1483. </para>
  1484. </remarks>
  1485. <param name="address">
  1486. A <see cref="T:System.Net.IPAddress"/> that represents the local IP address of the server.
  1487. </param>
  1488. <param name="port">
  1489. An <see cref="T:System.Int32"/> that represents the port number on which to listen.
  1490. </param>
  1491. <exception cref="T:System.ArgumentNullException">
  1492. <paramref name="address"/> is <see langword="null"/>.
  1493. </exception>
  1494. <exception cref="T:System.ArgumentException">
  1495. <paramref name="address"/> isn't a local IP address.
  1496. </exception>
  1497. <exception cref="T:System.ArgumentOutOfRangeException">
  1498. <paramref name="port"/> isn't between 1 and 65535 inclusive.
  1499. </exception>
  1500. </member>
  1501. <member name="M:WebSocketSharp.Server.WebSocketServer.#ctor(System.Net.IPAddress,System.Int32,System.Boolean)">
  1502. <summary>
  1503. Initializes a new instance of the <see cref="T:WebSocketSharp.Server.WebSocketServer"/> class with
  1504. the specified <paramref name="address"/>, <paramref name="port"/>,
  1505. and <paramref name="secure"/>.
  1506. </summary>
  1507. <remarks>
  1508. An instance initialized by this constructor listens for the incoming connection requests on
  1509. <paramref name="address"/> and <paramref name="port"/>.
  1510. </remarks>
  1511. <param name="address">
  1512. A <see cref="T:System.Net.IPAddress"/> that represents the local IP address of the server.
  1513. </param>
  1514. <param name="port">
  1515. An <see cref="T:System.Int32"/> that represents the port number on which to listen.
  1516. </param>
  1517. <param name="secure">
  1518. A <see cref="T:System.Boolean"/> that indicates providing a secure connection or not.
  1519. (<c>true</c> indicates providing a secure connection.)
  1520. </param>
  1521. <exception cref="T:System.ArgumentNullException">
  1522. <paramref name="address"/> is <see langword="null"/>.
  1523. </exception>
  1524. <exception cref="T:System.ArgumentException">
  1525. <paramref name="address"/> isn't a local IP address.
  1526. </exception>
  1527. <exception cref="T:System.ArgumentOutOfRangeException">
  1528. <paramref name="port"/> isn't between 1 and 65535 inclusive.
  1529. </exception>
  1530. </member>
  1531. <member name="M:WebSocketSharp.Server.WebSocketServer.AddWebSocketService``1(System.String,System.Func{``0})">
  1532. <summary>
  1533. Adds a WebSocket service with the specified behavior, <paramref name="path"/>,
  1534. and <paramref name="initializer"/>.
  1535. </summary>
  1536. <remarks>
  1537. <para>
  1538. This method converts <paramref name="path"/> to URL-decoded string,
  1539. and removes <c>'/'</c> from tail end of <paramref name="path"/>.
  1540. </para>
  1541. <para>
  1542. <paramref name="initializer"/> returns an initialized specified typed
  1543. <see cref="T:WebSocketSharp.Server.WebSocketBehavior"/> instance.
  1544. </para>
  1545. </remarks>
  1546. <param name="path">
  1547. A <see cref="T:System.String"/> that represents the absolute path to the service to add.
  1548. </param>
  1549. <param name="initializer">
  1550. A <c>Func&lt;T&gt;</c> delegate that references the method used to initialize
  1551. a new specified typed <see cref="T:WebSocketSharp.Server.WebSocketBehavior"/> instance (a new
  1552. <see cref="T:WebSocketSharp.Server.IWebSocketSession"/> instance).
  1553. </param>
  1554. <typeparam name="TBehavior">
  1555. The type of the behavior of the service to add. The TBehavior must inherit
  1556. the <see cref="T:WebSocketSharp.Server.WebSocketBehavior"/> class.
  1557. </typeparam>
  1558. </member>
  1559. <member name="M:WebSocketSharp.Server.WebSocketServer.AddWebSocketService``1(System.String)">
  1560. <summary>
  1561. Adds a WebSocket service with the specified behavior and <paramref name="path"/>.
  1562. </summary>
  1563. <remarks>
  1564. This method converts <paramref name="path"/> to URL-decoded string,
  1565. and removes <c>'/'</c> from tail end of <paramref name="path"/>.
  1566. </remarks>
  1567. <param name="path">
  1568. A <see cref="T:System.String"/> that represents the absolute path to the service to add.
  1569. </param>
  1570. <typeparam name="TBehaviorWithNew">
  1571. The type of the behavior of the service to add. The TBehaviorWithNew must inherit
  1572. the <see cref="T:WebSocketSharp.Server.WebSocketBehavior"/> class, and must have a public parameterless
  1573. constructor.
  1574. </typeparam>
  1575. </member>
  1576. <member name="M:WebSocketSharp.Server.WebSocketServer.RemoveWebSocketService(System.String)">
  1577. <summary>
  1578. Removes the WebSocket service with the specified <paramref name="path"/>.
  1579. </summary>
  1580. <remarks>
  1581. This method converts <paramref name="path"/> to URL-decoded string,
  1582. and removes <c>'/'</c> from tail end of <paramref name="path"/>.
  1583. </remarks>
  1584. <returns>
  1585. <c>true</c> if the service is successfully found and removed; otherwise, <c>false</c>.
  1586. </returns>
  1587. <param name="path">
  1588. A <see cref="T:System.String"/> that represents the absolute path to the service to find.
  1589. </param>
  1590. </member>
  1591. <member name="M:WebSocketSharp.Server.WebSocketServer.Start">
  1592. <summary>
  1593. Starts receiving the WebSocket connection requests.
  1594. </summary>
  1595. </member>
  1596. <member name="M:WebSocketSharp.Server.WebSocketServer.Stop">
  1597. <summary>
  1598. Stops receiving the WebSocket connection requests.
  1599. </summary>
  1600. </member>
  1601. <member name="M:WebSocketSharp.Server.WebSocketServer.Stop(System.UInt16,System.String)">
  1602. <summary>
  1603. Stops receiving the WebSocket connection requests with
  1604. the specified <see cref="T:System.UInt16"/> and <see cref="T:System.String"/>.
  1605. </summary>
  1606. <param name="code">
  1607. A <see cref="T:System.UInt16"/> that represents the status code indicating the reason for the stop.
  1608. </param>
  1609. <param name="reason">
  1610. A <see cref="T:System.String"/> that represents the reason for the stop.
  1611. </param>
  1612. </member>
  1613. <member name="M:WebSocketSharp.Server.WebSocketServer.Stop(WebSocketSharp.CloseStatusCode,System.String)">
  1614. <summary>
  1615. Stops receiving the WebSocket connection requests with
  1616. the specified <see cref="T:WebSocketSharp.CloseStatusCode"/> and <see cref="T:System.String"/>.
  1617. </summary>
  1618. <param name="code">
  1619. One of the <see cref="T:WebSocketSharp.CloseStatusCode"/> enum values, represents the status code indicating
  1620. the reason for the stop.
  1621. </param>
  1622. <param name="reason">
  1623. A <see cref="T:System.String"/> that represents the reason for the stop.
  1624. </param>
  1625. </member>
  1626. <member name="P:WebSocketSharp.Server.WebSocketServer.Address">
  1627. <summary>
  1628. Gets the local IP address of the server.
  1629. </summary>
  1630. <value>
  1631. A <see cref="T:System.Net.IPAddress"/> that represents the local IP address of the server.
  1632. </value>
  1633. </member>
  1634. <member name="P:WebSocketSharp.Server.WebSocketServer.AuthenticationSchemes">
  1635. <summary>
  1636. Gets or sets the scheme used to authenticate the clients.
  1637. </summary>
  1638. <value>
  1639. One of the <see cref="T:WebSocketSharp.Net.AuthenticationSchemes"/> enum values,
  1640. indicates the scheme used to authenticate the clients. The default value is
  1641. <see cref="F:WebSocketSharp.Net.AuthenticationSchemes.Anonymous"/>.
  1642. </value>
  1643. </member>
  1644. <member name="P:WebSocketSharp.Server.WebSocketServer.IsListening">
  1645. <summary>
  1646. Gets a value indicating whether the server has started.
  1647. </summary>
  1648. <value>
  1649. <c>true</c> if the server has started; otherwise, <c>false</c>.
  1650. </value>
  1651. </member>
  1652. <member name="P:WebSocketSharp.Server.WebSocketServer.IsSecure">
  1653. <summary>
  1654. Gets a value indicating whether the server provides a secure connection.
  1655. </summary>
  1656. <value>
  1657. <c>true</c> if the server provides a secure connection; otherwise, <c>false</c>.
  1658. </value>
  1659. </member>
  1660. <member name="P:WebSocketSharp.Server.WebSocketServer.KeepClean">
  1661. <summary>
  1662. Gets or sets a value indicating whether the server cleans up
  1663. the inactive sessions periodically.
  1664. </summary>
  1665. <value>
  1666. <c>true</c> if the server cleans up the inactive sessions every 60 seconds;
  1667. otherwise, <c>false</c>. The default value is <c>true</c>.
  1668. </value>
  1669. </member>
  1670. <member name="P:WebSocketSharp.Server.WebSocketServer.Log">
  1671. <summary>
  1672. Gets the logging functions.
  1673. </summary>
  1674. <remarks>
  1675. The default logging level is <see cref="F:WebSocketSharp.LogLevel.Error"/>. If you would like to change it,
  1676. you should set the <c>Log.Level</c> property to any of the <see cref="T:WebSocketSharp.LogLevel"/> enum
  1677. values.
  1678. </remarks>
  1679. <value>
  1680. A <see cref="T:WebSocketSharp.Logger"/> that provides the logging functions.
  1681. </value>
  1682. </member>
  1683. <member name="P:WebSocketSharp.Server.WebSocketServer.Port">
  1684. <summary>
  1685. Gets the port on which to listen for incoming connection requests.
  1686. </summary>
  1687. <value>
  1688. An <see cref="T:System.Int32"/> that represents the port number on which to listen.
  1689. </value>
  1690. </member>
  1691. <member name="P:WebSocketSharp.Server.WebSocketServer.Realm">
  1692. <summary>
  1693. Gets or sets the name of the realm associated with the server.
  1694. </summary>
  1695. <remarks>
  1696. If this property is <see langword="null"/> or empty, <c>"SECRET AREA"</c> will be used as
  1697. the name of the realm.
  1698. </remarks>
  1699. <value>
  1700. A <see cref="T:System.String"/> that represents the name of the realm. The default value is
  1701. <see langword="null"/>.
  1702. </value>
  1703. </member>
  1704. <member name="P:WebSocketSharp.Server.WebSocketServer.ReuseAddress">
  1705. <summary>
  1706. Gets or sets a value indicating whether the server is allowed to be bound to
  1707. an address that is already in use.
  1708. </summary>
  1709. <remarks>
  1710. If you would like to resolve to wait for socket in <c>TIME_WAIT</c> state,
  1711. you should set this property to <c>true</c>.
  1712. </remarks>
  1713. <value>
  1714. <c>true</c> if the server is allowed to be bound to an address that is already in use;
  1715. otherwise, <c>false</c>. The default value is <c>false</c>.
  1716. </value>
  1717. </member>
  1718. <member name="P:WebSocketSharp.Server.WebSocketServer.SslConfiguration">
  1719. <summary>
  1720. Gets or sets the SSL configuration used to authenticate the server and
  1721. optionally the client for secure connection.
  1722. </summary>
  1723. <value>
  1724. A <see cref="T:WebSocketSharp.Net.ServerSslConfiguration"/> that represents the configuration used to
  1725. authenticate the server and optionally the client for secure connection.
  1726. </value>
  1727. </member>
  1728. <member name="P:WebSocketSharp.Server.WebSocketServer.UserCredentialsFinder">
  1729. <summary>
  1730. Gets or sets the delegate called to find the credentials for an identity used to
  1731. authenticate a client.
  1732. </summary>
  1733. <value>
  1734. A <c>Func&lt;<see cref="T:System.Security.Principal.IIdentity"/>, <see cref="T:WebSocketSharp.Net.NetworkCredential"/>&gt;</c> delegate
  1735. that references the method(s) used to find the credentials. The default value is
  1736. <see langword="null"/>.
  1737. </value>
  1738. </member>
  1739. <member name="P:WebSocketSharp.Server.WebSocketServer.WaitTime">
  1740. <summary>
  1741. Gets or sets the wait time for the response to the WebSocket Ping or Close.
  1742. </summary>
  1743. <value>
  1744. A <see cref="T:System.TimeSpan"/> that represents the wait time. The default value is
  1745. the same as 1 second.
  1746. </value>
  1747. </member>
  1748. <member name="P:WebSocketSharp.Server.WebSocketServer.WebSocketServices">
  1749. <summary>
  1750. Gets the access to the WebSocket services provided by the server.
  1751. </summary>
  1752. <value>
  1753. A <see cref="T:WebSocketSharp.Server.WebSocketServiceManager"/> that manages the WebSocket services.
  1754. </value>
  1755. </member>
  1756. <member name="T:WebSocketSharp.Net.AuthenticationSchemes">
  1757. <summary>
  1758. Specifies the scheme for authentication.
  1759. </summary>
  1760. </member>
  1761. <member name="F:WebSocketSharp.Net.AuthenticationSchemes.None">
  1762. <summary>
  1763. No authentication is allowed.
  1764. </summary>
  1765. </member>
  1766. <member name="F:WebSocketSharp.Net.AuthenticationSchemes.Digest">
  1767. <summary>
  1768. Specifies digest authentication.
  1769. </summary>
  1770. </member>
  1771. <member name="F:WebSocketSharp.Net.AuthenticationSchemes.Basic">
  1772. <summary>
  1773. Specifies basic authentication.
  1774. </summary>
  1775. </member>
  1776. <member name="F:WebSocketSharp.Net.AuthenticationSchemes.Anonymous">
  1777. <summary>
  1778. Specifies anonymous authentication.
  1779. </summary>
  1780. </member>
  1781. <member name="T:WebSocketSharp.Net.Cookie">
  1782. <summary>
  1783. Provides a set of methods and properties used to manage an HTTP Cookie.
  1784. </summary>
  1785. <remarks>
  1786. <para>
  1787. The Cookie class supports the following cookie formats:
  1788. <see href="http://web.archive.org/web/20020803110822/http://wp.netscape.com/newsref/std/cookie_spec.html">Netscape specification</see>,
  1789. <see href="http://www.ietf.org/rfc/rfc2109.txt">RFC 2109</see>, and
  1790. <see href="http://www.ietf.org/rfc/rfc2965.txt">RFC 2965</see>
  1791. </para>
  1792. <para>
  1793. The Cookie class cannot be inherited.
  1794. </para>
  1795. </remarks>
  1796. </member>
  1797. <member name="M:WebSocketSharp.Net.Cookie.#ctor">
  1798. <summary>
  1799. Initializes a new instance of the <see cref="T:WebSocketSharp.Net.Cookie"/> class.
  1800. </summary>
  1801. </member>
  1802. <member name="M:WebSocketSharp.Net.Cookie.#ctor(System.String,System.String)">
  1803. <summary>
  1804. Initializes a new instance of the <see cref="T:WebSocketSharp.Net.Cookie"/> class with the specified
  1805. <paramref name="name"/> and <paramref name="value"/>.
  1806. </summary>
  1807. <param name="name">
  1808. A <see cref="T:System.String"/> that represents the Name of the cookie.
  1809. </param>
  1810. <param name="value">
  1811. A <see cref="T:System.String"/> that represents the Value of the cookie.
  1812. </param>
  1813. <exception cref="T:WebSocketSharp.Net.CookieException">
  1814. <para>
  1815. <paramref name="name"/> is <see langword="null"/> or empty.
  1816. </para>
  1817. <para>
  1818. - or -
  1819. </para>
  1820. <para>
  1821. <paramref name="name"/> contains an invalid character.
  1822. </para>
  1823. <para>
  1824. - or -
  1825. </para>
  1826. <para>
  1827. <paramref name="value"/> is <see langword="null"/>.
  1828. </para>
  1829. <para>
  1830. - or -
  1831. </para>
  1832. <para>
  1833. <paramref name="value"/> contains a string not enclosed in double quotes
  1834. that contains an invalid character.
  1835. </para>
  1836. </exception>
  1837. </member>
  1838. <member name="M:WebSocketSharp.Net.Cookie.#ctor(System.String,System.String,System.String)">
  1839. <summary>
  1840. Initializes a new instance of the <see cref="T:WebSocketSharp.Net.Cookie"/> class with the specified
  1841. <paramref name="name"/>, <paramref name="value"/>, and <paramref name="path"/>.
  1842. </summary>
  1843. <param name="name">
  1844. A <see cref="T:System.String"/> that represents the Name of the cookie.
  1845. </param>
  1846. <param name="value">
  1847. A <see cref="T:System.String"/> that represents the Value of the cookie.
  1848. </param>
  1849. <param name="path">
  1850. A <see cref="T:System.String"/> that represents the value of the Path attribute of the cookie.
  1851. </param>
  1852. <exception cref="T:WebSocketSharp.Net.CookieException">
  1853. <para>
  1854. <paramref name="name"/> is <see langword="null"/> or empty.
  1855. </para>
  1856. <para>
  1857. - or -
  1858. </para>
  1859. <para>
  1860. <paramref name="name"/> contains an invalid character.
  1861. </para>
  1862. <para>
  1863. - or -
  1864. </para>
  1865. <para>
  1866. <paramref name="value"/> is <see langword="null"/>.
  1867. </para>
  1868. <para>
  1869. - or -
  1870. </para>
  1871. <para>
  1872. <paramref name="value"/> contains a string not enclosed in double quotes
  1873. that contains an invalid character.
  1874. </para>
  1875. </exception>
  1876. </member>
  1877. <member name="M:WebSocketSharp.Net.Cookie.#ctor(System.String,System.String,System.String,System.String)">
  1878. <summary>
  1879. Initializes a new instance of the <see cref="T:WebSocketSharp.Net.Cookie"/> class with the specified
  1880. <paramref name="name"/>, <paramref name="value"/>, <paramref name="path"/>, and
  1881. <paramref name="domain"/>.
  1882. </summary>
  1883. <param name="name">
  1884. A <see cref="T:System.String"/> that represents the Name of the cookie.
  1885. </param>
  1886. <param name="value">
  1887. A <see cref="T:System.String"/> that represents the Value of the cookie.
  1888. </param>
  1889. <param name="path">
  1890. A <see cref="T:System.String"/> that represents the value of the Path attribute of the cookie.
  1891. </param>
  1892. <param name="domain">
  1893. A <see cref="T:System.String"/> that represents the value of the Domain attribute of the cookie.
  1894. </param>
  1895. <exception cref="T:WebSocketSharp.Net.CookieException">
  1896. <para>
  1897. <paramref name="name"/> is <see langword="null"/> or empty.
  1898. </para>
  1899. <para>
  1900. - or -
  1901. </para>
  1902. <para>
  1903. <paramref name="name"/> contains an invalid character.
  1904. </para>
  1905. <para>
  1906. - or -
  1907. </para>
  1908. <para>
  1909. <paramref name="value"/> is <see langword="null"/>.
  1910. </para>
  1911. <para>
  1912. - or -
  1913. </para>
  1914. <para>
  1915. <paramref name="value"/> contains a string not enclosed in double quotes
  1916. that contains an invalid character.
  1917. </para>
  1918. </exception>
  1919. </member>
  1920. <member name="M:WebSocketSharp.Net.Cookie.Equals(System.Object)">
  1921. <summary>
  1922. Determines whether the specified <see cref="T:System.Object"/> is equal to the current
  1923. <see cref="T:WebSocketSharp.Net.Cookie"/>.
  1924. </summary>
  1925. <param name="comparand">
  1926. An <see cref="T:System.Object"/> to compare with the current <see cref="T:WebSocketSharp.Net.Cookie"/>.
  1927. </param>
  1928. <returns>
  1929. <c>true</c> if <paramref name="comparand"/> is equal to the current <see cref="T:WebSocketSharp.Net.Cookie"/>;
  1930. otherwise, <c>false</c>.
  1931. </returns>
  1932. </member>
  1933. <member name="M:WebSocketSharp.Net.Cookie.GetHashCode">
  1934. <summary>
  1935. Serves as a hash function for a <see cref="T:WebSocketSharp.Net.Cookie"/> object.
  1936. </summary>
  1937. <returns>
  1938. An <see cref="T:System.Int32"/> that represents the hash code for the current <see cref="T:WebSocketSharp.Net.Cookie"/>.
  1939. </returns>
  1940. </member>
  1941. <member name="M:WebSocketSharp.Net.Cookie.ToString">
  1942. <summary>
  1943. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:WebSocketSharp.Net.Cookie"/>.
  1944. </summary>
  1945. <remarks>
  1946. This method returns a <see cref="T:System.String"/> to use to send an HTTP Cookie to
  1947. an origin server.
  1948. </remarks>
  1949. <returns>
  1950. A <see cref="T:System.String"/> that represents the current <see cref="T:WebSocketSharp.Net.Cookie"/>.
  1951. </returns>
  1952. </member>
  1953. <member name="P:WebSocketSharp.Net.Cookie.Comment">
  1954. <summary>
  1955. Gets or sets the value of the Comment attribute of the cookie.
  1956. </summary>
  1957. <value>
  1958. A <see cref="T:System.String"/> that represents the comment to document intended use of the cookie.
  1959. </value>
  1960. </member>
  1961. <member name="P:WebSocketSharp.Net.Cookie.CommentUri">
  1962. <summary>
  1963. Gets or sets the value of the CommentURL attribute of the cookie.
  1964. </summary>
  1965. <value>
  1966. A <see cref="T:System.Uri"/> that represents the URI that provides the comment to document intended
  1967. use of the cookie.
  1968. </value>
  1969. </member>
  1970. <member name="P:WebSocketSharp.Net.Cookie.Discard">
  1971. <summary>
  1972. Gets or sets a value indicating whether the client discards the cookie unconditionally
  1973. when the client terminates.
  1974. </summary>
  1975. <value>
  1976. <c>true</c> if the client discards the cookie unconditionally when the client terminates;
  1977. otherwise, <c>false</c>. The default value is <c>false</c>.
  1978. </value>
  1979. </member>
  1980. <member name="P:WebSocketSharp.Net.Cookie.Domain">
  1981. <summary>
  1982. Gets or sets the value of the Domain attribute of the cookie.
  1983. </summary>
  1984. <value>
  1985. A <see cref="T:System.String"/> that represents the URI for which the cookie is valid.
  1986. </value>
  1987. </member>
  1988. <member name="P:WebSocketSharp.Net.Cookie.Expired">
  1989. <summary>
  1990. Gets or sets a value indicating whether the cookie has expired.
  1991. </summary>
  1992. <value>
  1993. <c>true</c> if the cookie has expired; otherwise, <c>false</c>.
  1994. The default value is <c>false</c>.
  1995. </value>
  1996. </member>
  1997. <member name="P:WebSocketSharp.Net.Cookie.Expires">
  1998. <summary>
  1999. Gets or sets the value of the Expires attribute of the cookie.
  2000. </summary>
  2001. <value>
  2002. A <see cref="T:System.DateTime"/> that represents the date and time at which the cookie expires.
  2003. The default value is <see cref="F:System.DateTime.MinValue"/>.
  2004. </value>
  2005. </member>
  2006. <member name="P:WebSocketSharp.Net.Cookie.HttpOnly">
  2007. <summary>
  2008. Gets or sets a value indicating whether non-HTTP APIs can access the cookie.
  2009. </summary>
  2010. <value>
  2011. <c>true</c> if non-HTTP APIs cannot access the cookie; otherwise, <c>false</c>.
  2012. The default value is <c>false</c>.
  2013. </value>
  2014. </member>
  2015. <member name="P:WebSocketSharp.Net.Cookie.Name">
  2016. <summary>
  2017. Gets or sets the Name of the cookie.
  2018. </summary>
  2019. <value>
  2020. A <see cref="T:System.String"/> that represents the Name of the cookie.
  2021. </value>
  2022. <exception cref="T:WebSocketSharp.Net.CookieException">
  2023. <para>
  2024. The value specified for a set operation is <see langword="null"/> or empty.
  2025. </para>
  2026. <para>
  2027. - or -
  2028. </para>
  2029. <para>
  2030. The value specified for a set operation contains an invalid character.
  2031. </para>
  2032. </exception>
  2033. </member>
  2034. <member name="P:WebSocketSharp.Net.Cookie.Path">
  2035. <summary>
  2036. Gets or sets the value of the Path attribute of the cookie.
  2037. </summary>
  2038. <value>
  2039. A <see cref="T:System.String"/> that represents the subset of URI on the origin server
  2040. to which the cookie applies.
  2041. </value>
  2042. </member>
  2043. <member name="P:WebSocketSharp.Net.Cookie.Port">
  2044. <summary>
  2045. Gets or sets the value of the Port attribute of the cookie.
  2046. </summary>
  2047. <value>
  2048. A <see cref="T:System.String"/> that represents the list of TCP ports to which the cookie applies.
  2049. </value>
  2050. <exception cref="T:WebSocketSharp.Net.CookieException">
  2051. The value specified for a set operation isn't enclosed in double quotes or
  2052. couldn't be parsed.
  2053. </exception>
  2054. </member>
  2055. <member name="P:WebSocketSharp.Net.Cookie.Secure">
  2056. <summary>
  2057. Gets or sets a value indicating whether the security level of the cookie is secure.
  2058. </summary>
  2059. <remarks>
  2060. When this property is <c>true</c>, the cookie may be included in the HTTP request
  2061. only if the request is transmitted over the HTTPS.
  2062. </remarks>
  2063. <value>
  2064. <c>true</c> if the security level of the cookie is secure; otherwise, <c>false</c>.
  2065. The default value is <c>false</c>.
  2066. </value>
  2067. </member>
  2068. <member name="P:WebSocketSharp.Net.Cookie.TimeStamp">
  2069. <summary>
  2070. Gets the time when the cookie was issued.
  2071. </summary>
  2072. <value>
  2073. A <see cref="T:System.DateTime"/> that represents the time when the cookie was issued.
  2074. </value>
  2075. </member>
  2076. <member name="P:WebSocketSharp.Net.Cookie.Value">
  2077. <summary>
  2078. Gets or sets the Value of the cookie.
  2079. </summary>
  2080. <value>
  2081. A <see cref="T:System.String"/> that represents the Value of the cookie.
  2082. </value>
  2083. <exception cref="T:WebSocketSharp.Net.CookieException">
  2084. <para>
  2085. The value specified for a set operation is <see langword="null"/>.
  2086. </para>
  2087. <para>
  2088. - or -
  2089. </para>
  2090. <para>
  2091. The value specified for a set operation contains a string not enclosed in double quotes
  2092. that contains an invalid character.
  2093. </para>
  2094. </exception>
  2095. </member>
  2096. <member name="P:WebSocketSharp.Net.Cookie.Version">
  2097. <summary>
  2098. Gets or sets the value of the Version attribute of the cookie.
  2099. </summary>
  2100. <value>
  2101. An <see cref="T:System.Int32"/> that represents the version of the HTTP state management
  2102. to which the cookie conforms.
  2103. </value>
  2104. <exception cref="T:System.ArgumentOutOfRangeException">
  2105. The value specified for a set operation isn't 0 or 1.
  2106. </exception>
  2107. </member>
  2108. <member name="T:WebSocketSharp.Net.CookieCollection">
  2109. <summary>
  2110. Provides a collection container for instances of the <see cref="T:WebSocketSharp.Net.Cookie"/> class.
  2111. </summary>
  2112. </member>
  2113. <member name="M:WebSocketSharp.Net.CookieCollection.#ctor">
  2114. <summary>
  2115. Initializes a new instance of the <see cref="T:WebSocketSharp.Net.CookieCollection"/> class.
  2116. </summary>
  2117. </member>
  2118. <member name="M:WebSocketSharp.Net.CookieCollection.Add(WebSocketSharp.Net.Cookie)">
  2119. <summary>
  2120. Adds the specified <paramref name="cookie"/> to the collection.
  2121. </summary>
  2122. <param name="cookie">
  2123. A <see cref="T:WebSocketSharp.Net.Cookie"/> to add.
  2124. </param>
  2125. <exception cref="T:System.ArgumentNullException">
  2126. <paramref name="cookie"/> is <see langword="null"/>.
  2127. </exception>
  2128. </member>
  2129. <member name="M:WebSocketSharp.Net.CookieCollection.Add(WebSocketSharp.Net.CookieCollection)">
  2130. <summary>
  2131. Adds the specified <paramref name="cookies"/> to the collection.
  2132. </summary>
  2133. <param name="cookies">
  2134. A <see cref="T:WebSocketSharp.Net.CookieCollection"/> that contains the cookies to add.
  2135. </param>
  2136. <exception cref="T:System.ArgumentNullException">
  2137. <paramref name="cookies"/> is <see langword="null"/>.
  2138. </exception>
  2139. </member>
  2140. <member name="M:WebSocketSharp.Net.CookieCollection.CopyTo(System.Array,System.Int32)">
  2141. <summary>
  2142. Copies the elements of the collection to the specified <see cref="T:System.Array"/>, starting at
  2143. the specified <paramref name="index"/> in the <paramref name="array"/>.
  2144. </summary>
  2145. <param name="array">
  2146. An <see cref="T:System.Array"/> that represents the destination of the elements copied from
  2147. the collection.
  2148. </param>
  2149. <param name="index">
  2150. An <see cref="T:System.Int32"/> that represents the zero-based index in <paramref name="array"/>
  2151. at which copying begins.
  2152. </param>
  2153. <exception cref="T:System.ArgumentNullException">
  2154. <paramref name="array"/> is <see langword="null"/>.
  2155. </exception>
  2156. <exception cref="T:System.ArgumentOutOfRangeException">
  2157. <paramref name="index"/> is less than zero.
  2158. </exception>
  2159. <exception cref="T:System.ArgumentException">
  2160. <para>
  2161. <paramref name="array"/> is multidimensional.
  2162. </para>
  2163. <para>
  2164. -or-
  2165. </para>
  2166. <para>
  2167. The number of elements in the collection is greater than the available space from
  2168. <paramref name="index"/> to the end of the destination <paramref name="array"/>.
  2169. </para>
  2170. </exception>
  2171. <exception cref="T:System.InvalidCastException">
  2172. The elements in the collection cannot be cast automatically to the type of the destination
  2173. <paramref name="array"/>.
  2174. </exception>
  2175. </member>
  2176. <member name="M:WebSocketSharp.Net.CookieCollection.CopyTo(WebSocketSharp.Net.Cookie[],System.Int32)">
  2177. <summary>
  2178. Copies the elements of the collection to the specified array of <see cref="T:WebSocketSharp.Net.Cookie"/>,
  2179. starting at the specified <paramref name="index"/> in the <paramref name="array"/>.
  2180. </summary>
  2181. <param name="array">
  2182. An array of <see cref="T:WebSocketSharp.Net.Cookie"/> that represents the destination of the elements
  2183. copied from the collection.
  2184. </param>
  2185. <param name="index">
  2186. An <see cref="T:System.Int32"/> that represents the zero-based index in <paramref name="array"/>
  2187. at which copying begins.
  2188. </param>
  2189. <exception cref="T:System.ArgumentNullException">
  2190. <paramref name="array"/> is <see langword="null"/>.
  2191. </exception>
  2192. <exception cref="T:System.ArgumentOutOfRangeException">
  2193. <paramref name="index"/> is less than zero.
  2194. </exception>
  2195. <exception cref="T:System.ArgumentException">
  2196. The number of elements in the collection is greater than the available space from
  2197. <paramref name="index"/> to the end of the destination <paramref name="array"/>.
  2198. </exception>
  2199. </member>
  2200. <member name="M:WebSocketSharp.Net.CookieCollection.GetEnumerator">
  2201. <summary>
  2202. Gets the enumerator used to iterate through the collection.
  2203. </summary>
  2204. <returns>
  2205. An <see cref="T:System.Collections.IEnumerator"/> instance used to iterate through the collection.
  2206. </returns>
  2207. </member>
  2208. <member name="P:WebSocketSharp.Net.CookieCollection.Count">
  2209. <summary>
  2210. Gets the number of cookies in the collection.
  2211. </summary>
  2212. <value>
  2213. An <see cref="T:System.Int32"/> that represents the number of cookies in the collection.
  2214. </value>
  2215. </member>
  2216. <member name="P:WebSocketSharp.Net.CookieCollection.IsReadOnly">
  2217. <summary>
  2218. Gets a value indicating whether the collection is read-only.
  2219. </summary>
  2220. <value>
  2221. <c>true</c> if the collection is read-only; otherwise, <c>false</c>.
  2222. The default value is <c>true</c>.
  2223. </value>
  2224. </member>
  2225. <member name="P:WebSocketSharp.Net.CookieCollection.IsSynchronized">
  2226. <summary>
  2227. Gets a value indicating whether the access to the collection is thread safe.
  2228. </summary>
  2229. <value>
  2230. <c>true</c> if the access to the collection is thread safe; otherwise, <c>false</c>.
  2231. The default value is <c>false</c>.
  2232. </value>
  2233. </member>
  2234. <member name="P:WebSocketSharp.Net.CookieCollection.Item(System.Int32)">
  2235. <summary>
  2236. Gets the <see cref="T:WebSocketSharp.Net.Cookie"/> at the specified <paramref name="index"/> from
  2237. the collection.
  2238. </summary>
  2239. <value>
  2240. A <see cref="T:WebSocketSharp.Net.Cookie"/> at the specified <paramref name="index"/> in the collection.
  2241. </value>
  2242. <param name="index">
  2243. An <see cref="T:System.Int32"/> that represents the zero-based index of the <see cref="T:WebSocketSharp.Net.Cookie"/>
  2244. to find.
  2245. </param>
  2246. <exception cref="T:System.ArgumentOutOfRangeException">
  2247. <paramref name="index"/> is out of allowable range of indexes for the collection.
  2248. </exception>
  2249. </member>
  2250. <member name="P:WebSocketSharp.Net.CookieCollection.Item(System.String)">
  2251. <summary>
  2252. Gets the <see cref="T:WebSocketSharp.Net.Cookie"/> with the specified <paramref name="name"/> from
  2253. the collection.
  2254. </summary>
  2255. <value>
  2256. A <see cref="T:WebSocketSharp.Net.Cookie"/> with the specified <paramref name="name"/> in the collection.
  2257. </value>
  2258. <param name="name">
  2259. A <see cref="T:System.String"/> that represents the name of the <see cref="T:WebSocketSharp.Net.Cookie"/> to find.
  2260. </param>
  2261. <exception cref="T:System.ArgumentNullException">
  2262. <paramref name="name"/> is <see langword="null"/>.
  2263. </exception>
  2264. </member>
  2265. <member name="P:WebSocketSharp.Net.CookieCollection.SyncRoot">
  2266. <summary>
  2267. Gets an object used to synchronize access to the collection.
  2268. </summary>
  2269. <value>
  2270. An <see cref="T:System.Object"/> used to synchronize access to the collection.
  2271. </value>
  2272. </member>
  2273. <member name="T:WebSocketSharp.Net.CookieException">
  2274. <summary>
  2275. The exception that is thrown when a <see cref="T:WebSocketSharp.Net.Cookie"/> gets an error.
  2276. </summary>
  2277. </member>
  2278. <member name="M:WebSocketSharp.Net.CookieException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  2279. <summary>
  2280. Initializes a new instance of the <see cref="T:WebSocketSharp.Net.CookieException"/> class from
  2281. the specified <see cref="T:System.Runtime.Serialization.SerializationInfo"/> and <see cref="T:System.Runtime.Serialization.StreamingContext"/>.
  2282. </summary>
  2283. <param name="serializationInfo">
  2284. A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that contains the serialized object data.
  2285. </param>
  2286. <param name="streamingContext">
  2287. A <see cref="T:System.Runtime.Serialization.StreamingContext"/> that specifies the source for the deserialization.
  2288. </param>
  2289. </member>
  2290. <member name="M:WebSocketSharp.Net.CookieException.#ctor">
  2291. <summary>
  2292. Initializes a new instance of the <see cref="T:WebSocketSharp.Net.CookieException"/> class.
  2293. </summary>
  2294. </member>
  2295. <member name="M:WebSocketSharp.Net.CookieException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  2296. <summary>
  2297. Populates the specified <see cref="T:System.Runtime.Serialization.SerializationInfo"/> with the data needed to serialize
  2298. the current <see cref="T:WebSocketSharp.Net.CookieException"/>.
  2299. </summary>
  2300. <param name="serializationInfo">
  2301. A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data.
  2302. </param>
  2303. <param name="streamingContext">
  2304. A <see cref="T:System.Runtime.Serialization.StreamingContext"/> that specifies the destination for the serialization.
  2305. </param>
  2306. </member>
  2307. <member name="M:WebSocketSharp.Net.CookieException.System#Runtime#Serialization#ISerializable#GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  2308. <summary>
  2309. Populates the specified <see cref="T:System.Runtime.Serialization.SerializationInfo"/> with the data needed to serialize
  2310. the current <see cref="T:WebSocketSharp.Net.CookieException"/>.
  2311. </summary>
  2312. <param name="serializationInfo">
  2313. A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data.
  2314. </param>
  2315. <param name="streamingContext">
  2316. A <see cref="T:System.Runtime.Serialization.StreamingContext"/> that specifies the destination for the serialization.
  2317. </param>
  2318. </member>
  2319. <member name="T:WebSocketSharp.Net.HttpListener">
  2320. <summary>
  2321. Provides a simple, programmatically controlled HTTP listener.
  2322. </summary>
  2323. </member>
  2324. <member name="M:WebSocketSharp.Net.HttpListener.#ctor">
  2325. <summary>
  2326. Initializes a new instance of the <see cref="T:WebSocketSharp.Net.HttpListener"/> class.
  2327. </summary>
  2328. </member>
  2329. <member name="M:WebSocketSharp.Net.HttpListener.Abort">
  2330. <summary>
  2331. Shuts down the listener immediately.
  2332. </summary>
  2333. </member>
  2334. <member name="M:WebSocketSharp.Net.HttpListener.BeginGetContext(System.AsyncCallback,System.Object)">
  2335. <summary>
  2336. Begins getting an incoming request asynchronously.
  2337. </summary>
  2338. <remarks>
  2339. This asynchronous operation must be completed by calling the <c>EndGetContext</c> method.
  2340. Typically, the method is invoked by the <paramref name="callback"/> delegate.
  2341. </remarks>
  2342. <returns>
  2343. An <see cref="T:System.IAsyncResult"/> that represents the status of the asynchronous operation.
  2344. </returns>
  2345. <param name="callback">
  2346. An <see cref="T:System.AsyncCallback"/> delegate that references the method to invoke when
  2347. the asynchronous operation completes.
  2348. </param>
  2349. <param name="state">
  2350. An <see cref="T:System.Object"/> that represents a user defined object to pass to
  2351. the <paramref name="callback"/> delegate.
  2352. </param>
  2353. <exception cref="T:System.InvalidOperationException">
  2354. <para>
  2355. This listener has no URI prefix on which listens.
  2356. </para>
  2357. <para>
  2358. -or-
  2359. </para>
  2360. <para>
  2361. This listener hasn't been started, or is currently stopped.
  2362. </para>
  2363. </exception>
  2364. <exception cref="T:System.ObjectDisposedException">
  2365. This listener has been closed.
  2366. </exception>
  2367. </member>
  2368. <member name="M:WebSocketSharp.Net.HttpListener.Close">
  2369. <summary>
  2370. Shuts down the listener.
  2371. </summary>
  2372. </member>
  2373. <member name="M:WebSocketSharp.Net.HttpListener.EndGetContext(System.IAsyncResult)">
  2374. <summary>
  2375. Ends an asynchronous operation to get an incoming request.
  2376. </summary>
  2377. <remarks>
  2378. This method completes an asynchronous operation started by calling
  2379. the <c>BeginGetContext</c> method.
  2380. </remarks>
  2381. <returns>
  2382. A <see cref="T:WebSocketSharp.Net.HttpListenerContext"/> that represents a request.
  2383. </returns>
  2384. <param name="asyncResult">
  2385. An <see cref="T:System.IAsyncResult"/> obtained by calling the <c>BeginGetContext</c> method.
  2386. </param>
  2387. <exception cref="T:System.ArgumentNullException">
  2388. <paramref name="asyncResult"/> is <see langword="null"/>.
  2389. </exception>
  2390. <exception cref="T:System.ArgumentException">
  2391. <paramref name="asyncResult"/> wasn't obtained by calling the <c>BeginGetContext</c> method.
  2392. </exception>
  2393. <exception cref="T:System.InvalidOperationException">
  2394. This method was already called for the specified <paramref name="asyncResult"/>.
  2395. </exception>
  2396. <exception cref="T:System.ObjectDisposedException">
  2397. This listener has been closed.
  2398. </exception>
  2399. </member>
  2400. <member name="M:WebSocketSharp.Net.HttpListener.GetContext">
  2401. <summary>
  2402. Gets an incoming request.
  2403. </summary>
  2404. <remarks>
  2405. This method waits for an incoming request, and returns when a request is received.
  2406. </remarks>
  2407. <returns>
  2408. A <see cref="T:WebSocketSharp.Net.HttpListenerContext"/> that represents a request.
  2409. </returns>
  2410. <exception cref="T:System.InvalidOperationException">
  2411. <para>
  2412. This listener has no URI prefix on which listens.
  2413. </para>
  2414. <para>
  2415. -or-
  2416. </para>
  2417. <para>
  2418. This listener hasn't been started, or is currently stopped.
  2419. </para>
  2420. </exception>
  2421. <exception cref="T:System.ObjectDisposedException">
  2422. This listener has been closed.
  2423. </exception>
  2424. </member>
  2425. <member name="M:WebSocketSharp.Net.HttpListener.Start">
  2426. <summary>
  2427. Starts receiving incoming requests.
  2428. </summary>
  2429. <exception cref="T:System.ObjectDisposedException">
  2430. This listener has been closed.
  2431. </exception>
  2432. </member>
  2433. <member name="M:WebSocketSharp.Net.HttpListener.Stop">
  2434. <summary>
  2435. Stops receiving incoming requests.
  2436. </summary>
  2437. <exception cref="T:System.ObjectDisposedException">
  2438. This listener has been closed.
  2439. </exception>
  2440. </member>
  2441. <member name="M:WebSocketSharp.Net.HttpListener.System#IDisposable#Dispose">
  2442. <summary>
  2443. Releases all resources used by the listener.
  2444. </summary>
  2445. </member>
  2446. <member name="P:WebSocketSharp.Net.HttpListener.AuthenticationSchemes">
  2447. <summary>
  2448. Gets or sets the scheme used to authenticate the clients.
  2449. </summary>
  2450. <value>
  2451. One of the <see cref="T:WebSocketSharp.Net.AuthenticationSchemes"/> enum values,
  2452. represents the scheme used to authenticate the clients. The default value is
  2453. <see cref="F:WebSocketSharp.Net.AuthenticationSchemes.Anonymous"/>.
  2454. </value>
  2455. <exception cref="T:System.ObjectDisposedException">
  2456. This listener has been closed.
  2457. </exception>
  2458. </member>
  2459. <member name="P:WebSocketSharp.Net.HttpListener.AuthenticationSchemeSelector">
  2460. <summary>
  2461. Gets or sets the delegate called to select the scheme used to authenticate the clients.
  2462. </summary>
  2463. <remarks>
  2464. If you set this property, the listener uses the authentication scheme selected by
  2465. the delegate for each request. Or if you don't set, the listener uses the value of
  2466. the <see cref="P:WebSocketSharp.Net.HttpListener.AuthenticationSchemes"/> property as the authentication
  2467. scheme for all requests.
  2468. </remarks>
  2469. <value>
  2470. A <c>Func&lt;<see cref="T:WebSocketSharp.Net.HttpListenerRequest"/>, <see cref="P:WebSocketSharp.Net.HttpListener.AuthenticationSchemes"/>&gt;</c>
  2471. delegate that references the method used to select an authentication scheme. The default
  2472. value is <see langword="null"/>.
  2473. </value>
  2474. <exception cref="T:System.ObjectDisposedException">
  2475. This listener has been closed.
  2476. </exception>
  2477. </member>
  2478. <member name="P:WebSocketSharp.Net.HttpListener.CertificateFolderPath">
  2479. <summary>
  2480. Gets or sets the path to the folder in which stores the certificate files used to
  2481. authenticate the server on the secure connection.
  2482. </summary>
  2483. <remarks>
  2484. <para>
  2485. This property represents the path to the folder in which stores the certificate files
  2486. associated with each port number of added URI prefixes. A set of the certificate files
  2487. is a pair of the <c>'port number'.cer</c> (DER) and <c>'port number'.key</c>
  2488. (DER, RSA Private Key).
  2489. </para>
  2490. <para>
  2491. If this property is <see langword="null"/> or empty, the result of
  2492. <c>System.Environment.GetFolderPath
  2493. (<see cref="F:System.Environment.SpecialFolder.ApplicationData"/>)</c> is used as the default path.
  2494. </para>
  2495. </remarks>
  2496. <value>
  2497. A <see cref="T:System.String"/> that represents the path to the folder in which stores
  2498. the certificate files. The default value is <see langword="null"/>.
  2499. </value>
  2500. <exception cref="T:System.ObjectDisposedException">
  2501. This listener has been closed.
  2502. </exception>
  2503. </member>
  2504. <member name="P:WebSocketSharp.Net.HttpListener.IgnoreWriteExceptions">
  2505. <summary>
  2506. Gets or sets a value indicating whether the listener returns exceptions that occur when
  2507. sending the response to the client.
  2508. </summary>
  2509. <value>
  2510. <c>true</c> if the listener shouldn't return those exceptions; otherwise, <c>false</c>.
  2511. The default value is <c>false</c>.
  2512. </value>
  2513. <exception cref="T:System.ObjectDisposedException">
  2514. This listener has been closed.
  2515. </exception>
  2516. </member>
  2517. <member name="P:WebSocketSharp.Net.HttpListener.IsListening">
  2518. <summary>
  2519. Gets a value indicating whether the listener has been started.
  2520. </summary>
  2521. <value>
  2522. <c>true</c> if the listener has been started; otherwise, <c>false</c>.
  2523. </value>
  2524. </member>
  2525. <member name="P:WebSocketSharp.Net.HttpListener.IsSupported">
  2526. <summary>
  2527. Gets a value indicating whether the listener can be used with the current operating system.
  2528. </summary>
  2529. <value>
  2530. <c>true</c>.
  2531. </value>
  2532. </member>
  2533. <member name="P:WebSocketSharp.Net.HttpListener.Log">
  2534. <summary>
  2535. Gets the logging functions.
  2536. </summary>
  2537. <remarks>
  2538. The default logging level is <see cref="F:WebSocketSharp.LogLevel.Error"/>. If you would like to change it,
  2539. you should set the <c>Log.Level</c> property to any of the <see cref="T:WebSocketSharp.LogLevel"/> enum
  2540. values.
  2541. </remarks>
  2542. <value>
  2543. A <see cref="T:WebSocketSharp.Logger"/> that provides the logging functions.
  2544. </value>
  2545. </member>
  2546. <member name="P:WebSocketSharp.Net.HttpListener.Prefixes">
  2547. <summary>
  2548. Gets the URI prefixes handled by the listener.
  2549. </summary>
  2550. <value>
  2551. A <see cref="T:WebSocketSharp.Net.HttpListenerPrefixCollection"/> that contains the URI prefixes.
  2552. </value>
  2553. <exception cref="T:System.ObjectDisposedException">
  2554. This listener has been closed.
  2555. </exception>
  2556. </member>
  2557. <member name="P:WebSocketSharp.Net.HttpListener.Realm">
  2558. <summary>
  2559. Gets or sets the name of the realm associated with the listener.
  2560. </summary>
  2561. <remarks>
  2562. If this property is <see langword="null"/> or empty, <c>"SECRET AREA"</c> will be used as
  2563. the name of the realm.
  2564. </remarks>
  2565. <value>
  2566. A <see cref="T:System.String"/> that represents the name of the realm. The default value is
  2567. <see langword="null"/>.
  2568. </value>
  2569. <exception cref="T:System.ObjectDisposedException">
  2570. This listener has been closed.
  2571. </exception>
  2572. </member>
  2573. <member name="P:WebSocketSharp.Net.HttpListener.SslConfiguration">
  2574. <summary>
  2575. Gets or sets the SSL configuration used to authenticate the server and
  2576. optionally the client for secure connection.
  2577. </summary>
  2578. <value>
  2579. A <see cref="T:WebSocketSharp.Net.ServerSslConfiguration"/> that represents the configuration used to
  2580. authenticate the server and optionally the client for secure connection.
  2581. </value>
  2582. <exception cref="T:System.ObjectDisposedException">
  2583. This listener has been closed.
  2584. </exception>
  2585. </member>
  2586. <member name="P:WebSocketSharp.Net.HttpListener.UnsafeConnectionNtlmAuthentication">
  2587. <summary>
  2588. Gets or sets a value indicating whether, when NTLM authentication is used,
  2589. the authentication information of first request is used to authenticate
  2590. additional requests on the same connection.
  2591. </summary>
  2592. <remarks>
  2593. This property isn't currently supported and always throws
  2594. a <see cref="T:System.NotSupportedException"/>.
  2595. </remarks>
  2596. <value>
  2597. <c>true</c> if the authentication information of first request is used;
  2598. otherwise, <c>false</c>.
  2599. </value>
  2600. <exception cref="T:System.NotSupportedException">
  2601. Any use of this property.
  2602. </exception>
  2603. </member>
  2604. <member name="P:WebSocketSharp.Net.HttpListener.UserCredentialsFinder">
  2605. <summary>
  2606. Gets or sets the delegate called to find the credentials for an identity used to
  2607. authenticate a client.
  2608. </summary>
  2609. <value>
  2610. A <c>Func&lt;<see cref="T:System.Security.Principal.IIdentity"/>, <see cref="T:WebSocketSharp.Net.NetworkCredential"/>&gt;</c> delegate
  2611. that references the method used to find the credentials. The default value is
  2612. <see langword="null"/>.
  2613. </value>
  2614. <exception cref="T:System.ObjectDisposedException">
  2615. This listener has been closed.
  2616. </exception>
  2617. </member>
  2618. <member name="T:WebSocketSharp.Net.HttpListenerContext">
  2619. <summary>
  2620. Provides the access to the HTTP request and response objects used by
  2621. the <see cref="T:WebSocketSharp.Net.HttpListener"/>.
  2622. </summary>
  2623. <remarks>
  2624. This class cannot be inherited.
  2625. </remarks>
  2626. </member>
  2627. <member name="M:WebSocketSharp.Net.HttpListenerContext.AcceptWebSocket(System.String)">
  2628. <summary>
  2629. Accepts a WebSocket handshake request.
  2630. </summary>
  2631. <returns>
  2632. A <see cref="T:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext"/> that represents
  2633. the WebSocket handshake request.
  2634. </returns>
  2635. <param name="protocol">
  2636. A <see cref="T:System.String"/> that represents the subprotocol supported on
  2637. this WebSocket connection.
  2638. </param>
  2639. <exception cref="T:System.ArgumentException">
  2640. <para>
  2641. <paramref name="protocol"/> is empty.
  2642. </para>
  2643. <para>
  2644. -or-
  2645. </para>
  2646. <para>
  2647. <paramref name="protocol"/> contains an invalid character.
  2648. </para>
  2649. </exception>
  2650. <exception cref="T:System.InvalidOperationException">
  2651. This method has already been called.
  2652. </exception>
  2653. </member>
  2654. <member name="P:WebSocketSharp.Net.HttpListenerContext.Request">
  2655. <summary>
  2656. Gets the HTTP request object that represents a client request.
  2657. </summary>
  2658. <value>
  2659. A <see cref="T:WebSocketSharp.Net.HttpListenerRequest"/> that represents the client request.
  2660. </value>
  2661. </member>
  2662. <member name="P:WebSocketSharp.Net.HttpListenerContext.Response">
  2663. <summary>
  2664. Gets the HTTP response object used to send a response to the client.
  2665. </summary>
  2666. <value>
  2667. A <see cref="T:WebSocketSharp.Net.HttpListenerResponse"/> that represents a response to the client request.
  2668. </value>
  2669. </member>
  2670. <member name="P:WebSocketSharp.Net.HttpListenerContext.User">
  2671. <summary>
  2672. Gets the client information (identity, authentication, and security roles).
  2673. </summary>
  2674. <value>
  2675. A <see cref="T:System.Security.Principal.IPrincipal"/> instance that represents the client information.
  2676. </value>
  2677. </member>
  2678. <member name="T:WebSocketSharp.Net.HttpListenerException">
  2679. <summary>
  2680. The exception that is thrown when a <see cref="T:WebSocketSharp.Net.HttpListener"/> gets an error
  2681. processing an HTTP request.
  2682. </summary>
  2683. </member>
  2684. <member name="M:WebSocketSharp.Net.HttpListenerException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  2685. <summary>
  2686. Initializes a new instance of the <see cref="T:WebSocketSharp.Net.HttpListenerException"/> class from
  2687. the specified <see cref="T:System.Runtime.Serialization.SerializationInfo"/> and <see cref="T:System.Runtime.Serialization.StreamingContext"/>.
  2688. </summary>
  2689. <param name="serializationInfo">
  2690. A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that contains the serialized object data.
  2691. </param>
  2692. <param name="streamingContext">
  2693. A <see cref="T:System.Runtime.Serialization.StreamingContext"/> that specifies the source for the deserialization.
  2694. </param>
  2695. </member>
  2696. <member name="M:WebSocketSharp.Net.HttpListenerException.#ctor">
  2697. <summary>
  2698. Initializes a new instance of the <see cref="T:WebSocketSharp.Net.HttpListenerException"/> class.
  2699. </summary>
  2700. </member>
  2701. <member name="M:WebSocketSharp.Net.HttpListenerException.#ctor(System.Int32)">
  2702. <summary>
  2703. Initializes a new instance of the <see cref="T:WebSocketSharp.Net.HttpListenerException"/> class
  2704. with the specified <paramref name="errorCode"/>.
  2705. </summary>
  2706. <param name="errorCode">
  2707. An <see cref="T:System.Int32"/> that identifies the error.
  2708. </param>
  2709. </member>
  2710. <member name="M:WebSocketSharp.Net.HttpListenerException.#ctor(System.Int32,System.String)">
  2711. <summary>
  2712. Initializes a new instance of the <see cref="T:WebSocketSharp.Net.HttpListenerException"/> class
  2713. with the specified <paramref name="errorCode"/> and <paramref name="message"/>.
  2714. </summary>
  2715. <param name="errorCode">
  2716. An <see cref="T:System.Int32"/> that identifies the error.
  2717. </param>
  2718. <param name="message">
  2719. A <see cref="T:System.String"/> that describes the error.
  2720. </param>
  2721. </member>
  2722. <member name="P:WebSocketSharp.Net.HttpListenerException.ErrorCode">
  2723. <summary>
  2724. Gets the error code that identifies the error that occurred.
  2725. </summary>
  2726. <value>
  2727. An <see cref="T:System.Int32"/> that identifies the error.
  2728. </value>
  2729. </member>
  2730. <member name="T:WebSocketSharp.Net.HttpListenerPrefixCollection">
  2731. <summary>
  2732. Provides the collection used to store the URI prefixes for the <see cref="T:WebSocketSharp.Net.HttpListener"/>.
  2733. </summary>
  2734. <remarks>
  2735. The <see cref="T:WebSocketSharp.Net.HttpListener"/> responds to the request which has a requested URI that
  2736. the prefixes most closely match.
  2737. </remarks>
  2738. </member>
  2739. <member name="M:WebSocketSharp.Net.HttpListenerPrefixCollection.Add(System.String)">
  2740. <summary>
  2741. Adds the specified <paramref name="uriPrefix"/> to the collection.
  2742. </summary>
  2743. <param name="uriPrefix">
  2744. A <see cref="T:System.String"/> that represents the URI prefix to add. The prefix must be
  2745. a well-formed URI prefix with http or https scheme, and must end with a <c>'/'</c>.
  2746. </param>
  2747. <exception cref="T:System.ArgumentNullException">
  2748. <paramref name="uriPrefix"/> is <see langword="null"/>.
  2749. </exception>
  2750. <exception cref="T:System.ArgumentException">
  2751. <paramref name="uriPrefix"/> is invalid.
  2752. </exception>
  2753. <exception cref="T:System.ObjectDisposedException">
  2754. The <see cref="T:WebSocketSharp.Net.HttpListener"/> associated with this collection is closed.
  2755. </exception>
  2756. </member>
  2757. <member name="M:WebSocketSharp.Net.HttpListenerPrefixCollection.Clear">
  2758. <summary>
  2759. Removes all URI prefixes from the collection.
  2760. </summary>
  2761. <exception cref="T:System.ObjectDisposedException">
  2762. The <see cref="T:WebSocketSharp.Net.HttpListener"/> associated with this collection is closed.
  2763. </exception>
  2764. </member>
  2765. <member name="M:WebSocketSharp.Net.HttpListenerPrefixCollection.Contains(System.String)">
  2766. <summary>
  2767. Returns a value indicating whether the collection contains the specified
  2768. <paramref name="uriPrefix"/>.
  2769. </summary>
  2770. <returns>
  2771. <c>true</c> if the collection contains <paramref name="uriPrefix"/>;
  2772. otherwise, <c>false</c>.
  2773. </returns>
  2774. <param name="uriPrefix">
  2775. A <see cref="T:System.String"/> that represents the URI prefix to test.
  2776. </param>
  2777. <exception cref="T:System.ArgumentNullException">
  2778. <paramref name="uriPrefix"/> is <see langword="null"/>.
  2779. </exception>
  2780. <exception cref="T:System.ObjectDisposedException">
  2781. The <see cref="T:WebSocketSharp.Net.HttpListener"/> associated with this collection is closed.
  2782. </exception>
  2783. </member>
  2784. <member name="M:WebSocketSharp.Net.HttpListenerPrefixCollection.CopyTo(System.Array,System.Int32)">
  2785. <summary>
  2786. Copies the contents of the collection to the specified <see cref="T:System.Array"/>.
  2787. </summary>
  2788. <param name="array">
  2789. An <see cref="T:System.Array"/> that receives the URI prefix strings in the collection.
  2790. </param>
  2791. <param name="offset">
  2792. An <see cref="T:System.Int32"/> that represents the zero-based index in <paramref name="array"/>
  2793. at which copying begins.
  2794. </param>
  2795. <exception cref="T:System.ObjectDisposedException">
  2796. The <see cref="T:WebSocketSharp.Net.HttpListener"/> associated with this collection is closed.
  2797. </exception>
  2798. </member>
  2799. <member name="M:WebSocketSharp.Net.HttpListenerPrefixCollection.CopyTo(System.String[],System.Int32)">
  2800. <summary>
  2801. Copies the contents of the collection to the specified array of <see cref="T:System.String"/>.
  2802. </summary>
  2803. <param name="array">
  2804. An array of <see cref="T:System.String"/> that receives the URI prefix strings in the collection.
  2805. </param>
  2806. <param name="offset">
  2807. An <see cref="T:System.Int32"/> that represents the zero-based index in <paramref name="array"/>
  2808. at which copying begins.
  2809. </param>
  2810. <exception cref="T:System.ObjectDisposedException">
  2811. The <see cref="T:WebSocketSharp.Net.HttpListener"/> associated with this collection is closed.
  2812. </exception>
  2813. </member>
  2814. <member name="M:WebSocketSharp.Net.HttpListenerPrefixCollection.GetEnumerator">
  2815. <summary>
  2816. Gets the enumerator used to iterate through the <see cref="T:WebSocketSharp.Net.HttpListenerPrefixCollection"/>.
  2817. </summary>
  2818. <returns>
  2819. An <see cref="T:System.Collections.Generic.IEnumerator{string}"/> instance used to iterate
  2820. through the collection.
  2821. </returns>
  2822. </member>
  2823. <member name="M:WebSocketSharp.Net.HttpListenerPrefixCollection.Remove(System.String)">
  2824. <summary>
  2825. Removes the specified <paramref name="uriPrefix"/> from the collection.
  2826. </summary>
  2827. <returns>
  2828. <c>true</c> if <paramref name="uriPrefix"/> is successfully found and removed;
  2829. otherwise, <c>false</c>.
  2830. </returns>
  2831. <param name="uriPrefix">
  2832. A <see cref="T:System.String"/> that represents the URI prefix to remove.
  2833. </param>
  2834. <exception cref="T:System.ArgumentNullException">
  2835. <paramref name="uriPrefix"/> is <see langword="null"/>.
  2836. </exception>
  2837. <exception cref="T:System.ObjectDisposedException">
  2838. The <see cref="T:WebSocketSharp.Net.HttpListener"/> associated with this collection is closed.
  2839. </exception>
  2840. </member>
  2841. <member name="M:WebSocketSharp.Net.HttpListenerPrefixCollection.System#Collections#IEnumerable#GetEnumerator">
  2842. <summary>
  2843. Gets the enumerator used to iterate through the <see cref="T:WebSocketSharp.Net.HttpListenerPrefixCollection"/>.
  2844. </summary>
  2845. <returns>
  2846. An <see cref="T:System.Collections.IEnumerator"/> instance used to iterate through the collection.
  2847. </returns>
  2848. </member>
  2849. <member name="P:WebSocketSharp.Net.HttpListenerPrefixCollection.Count">
  2850. <summary>
  2851. Gets the number of prefixes in the collection.
  2852. </summary>
  2853. <value>
  2854. An <see cref="T:System.Int32"/> that represents the number of prefixes.
  2855. </value>
  2856. </member>
  2857. <member name="P:WebSocketSharp.Net.HttpListenerPrefixCollection.IsReadOnly">
  2858. <summary>
  2859. Gets a value indicating whether the access to the collection is read-only.
  2860. </summary>
  2861. <value>
  2862. Always returns <c>false</c>.
  2863. </value>
  2864. </member>
  2865. <member name="P:WebSocketSharp.Net.HttpListenerPrefixCollection.IsSynchronized">
  2866. <summary>
  2867. Gets a value indicating whether the access to the collection is synchronized.
  2868. </summary>
  2869. <value>
  2870. Always returns <c>false</c>.
  2871. </value>
  2872. </member>
  2873. <member name="T:WebSocketSharp.Net.HttpListenerRequest">
  2874. <summary>
  2875. Provides the access to a request to the <see cref="T:WebSocketSharp.Net.HttpListener"/>.
  2876. </summary>
  2877. <remarks>
  2878. The HttpListenerRequest class cannot be inherited.
  2879. </remarks>
  2880. </member>
  2881. <member name="M:WebSocketSharp.Net.HttpListenerRequest.BeginGetClientCertificate(System.AsyncCallback,System.Object)">
  2882. <summary>
  2883. Begins getting the client's X.509 v.3 certificate asynchronously.
  2884. </summary>
  2885. <remarks>
  2886. This asynchronous operation must be completed by calling
  2887. the <see cref="M:WebSocketSharp.Net.HttpListenerRequest.EndGetClientCertificate(System.IAsyncResult)"/> method. Typically,
  2888. that method is invoked by the <paramref name="requestCallback"/> delegate.
  2889. </remarks>
  2890. <returns>
  2891. An <see cref="T:System.IAsyncResult"/> that contains the status of the asynchronous operation.
  2892. </returns>
  2893. <param name="requestCallback">
  2894. An <see cref="T:System.AsyncCallback"/> delegate that references the method(s) called when
  2895. the asynchronous operation completes.
  2896. </param>
  2897. <param name="state">
  2898. An <see cref="T:System.Object"/> that contains a user defined object to pass to
  2899. the <paramref name="requestCallback"/> delegate.
  2900. </param>
  2901. <exception cref="T:System.NotImplementedException">
  2902. This method isn't implemented.
  2903. </exception>
  2904. </member>
  2905. <member name="M:WebSocketSharp.Net.HttpListenerRequest.EndGetClientCertificate(System.IAsyncResult)">
  2906. <summary>
  2907. Ends an asynchronous operation to get the client's X.509 v.3 certificate.
  2908. </summary>
  2909. <remarks>
  2910. This method completes an asynchronous operation started by calling
  2911. the <see cref="M:WebSocketSharp.Net.HttpListenerRequest.BeginGetClientCertificate(System.AsyncCallback,System.Object)"/> method.
  2912. </remarks>
  2913. <returns>
  2914. A <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2"/> that contains the client's X.509 v.3 certificate.
  2915. </returns>
  2916. <param name="asyncResult">
  2917. An <see cref="T:System.IAsyncResult"/> obtained by calling
  2918. the <see cref="M:WebSocketSharp.Net.HttpListenerRequest.BeginGetClientCertificate(System.AsyncCallback,System.Object)"/> method.
  2919. </param>
  2920. <exception cref="T:System.NotImplementedException">
  2921. This method isn't implemented.
  2922. </exception>
  2923. </member>
  2924. <member name="M:WebSocketSharp.Net.HttpListenerRequest.GetClientCertificate">
  2925. <summary>
  2926. Gets the client's X.509 v.3 certificate.
  2927. </summary>
  2928. <returns>
  2929. A <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2"/> that contains the client's X.509 v.3 certificate.
  2930. </returns>
  2931. <exception cref="T:System.NotImplementedException">
  2932. This method isn't implemented.
  2933. </exception>
  2934. </member>
  2935. <member name="M:WebSocketSharp.Net.HttpListenerRequest.ToString">
  2936. <summary>
  2937. Returns a <see cref="T:System.String"/> that represents
  2938. the current <see cref="T:WebSocketSharp.Net.HttpListenerRequest"/>.
  2939. </summary>
  2940. <returns>
  2941. A <see cref="T:System.String"/> that represents the current <see cref="T:WebSocketSharp.Net.HttpListenerRequest"/>.
  2942. </returns>
  2943. </member>
  2944. <member name="P:WebSocketSharp.Net.HttpListenerRequest.AcceptTypes">
  2945. <summary>
  2946. Gets the media types which are acceptable for the response.
  2947. </summary>
  2948. <value>
  2949. An array of <see cref="T:System.String"/> that contains the media type names in
  2950. the Accept request-header, or <see langword="null"/> if the request didn't include
  2951. the Accept header.
  2952. </value>
  2953. </member>
  2954. <member name="P:WebSocketSharp.Net.HttpListenerRequest.ClientCertificateError">
  2955. <summary>
  2956. Gets an error code that identifies a problem with the client's certificate.
  2957. </summary>
  2958. <value>
  2959. Always returns <c>0</c>.
  2960. </value>
  2961. </member>
  2962. <member name="P:WebSocketSharp.Net.HttpListenerRequest.ContentEncoding">
  2963. <summary>
  2964. Gets the encoding for the entity body data included in the request.
  2965. </summary>
  2966. <value>
  2967. A <see cref="T:System.Text.Encoding"/> that represents the encoding for the entity body data,
  2968. or <see cref="P:System.Text.Encoding.Default"/> if the request didn't include the information about
  2969. the encoding.
  2970. </value>
  2971. </member>
  2972. <member name="P:WebSocketSharp.Net.HttpListenerRequest.ContentLength64">
  2973. <summary>
  2974. Gets the number of bytes in the entity body data included in the request.
  2975. </summary>
  2976. <value>
  2977. A <see cref="T:System.Int64"/> that represents the value of the Content-Length entity-header,
  2978. or <c>-1</c> if the value isn't known.
  2979. </value>
  2980. </member>
  2981. <member name="P:WebSocketSharp.Net.HttpListenerRequest.ContentType">
  2982. <summary>
  2983. Gets the media type of the entity body included in the request.
  2984. </summary>
  2985. <value>
  2986. A <see cref="T:System.String"/> that represents the value of the Content-Type entity-header.
  2987. </value>
  2988. </member>
  2989. <member name="P:WebSocketSharp.Net.HttpListenerRequest.Cookies">
  2990. <summary>
  2991. Gets the cookies included in the request.
  2992. </summary>
  2993. <value>
  2994. A <see cref="T:WebSocketSharp.Net.CookieCollection"/> that contains the cookies included in the request.
  2995. </value>
  2996. </member>
  2997. <member name="P:WebSocketSharp.Net.HttpListenerRequest.HasEntityBody">
  2998. <summary>
  2999. Gets a value indicating whether the request has the entity body.
  3000. </summary>
  3001. <value>
  3002. <c>true</c> if the request has the entity body; otherwise, <c>false</c>.
  3003. </value>
  3004. </member>
  3005. <member name="P:WebSocketSharp.Net.HttpListenerRequest.Headers">
  3006. <summary>
  3007. Gets the HTTP headers used in the request.
  3008. </summary>
  3009. <value>
  3010. A <see cref="T:System.Collections.Specialized.NameValueCollection"/> that contains the HTTP headers used in the request.
  3011. </value>
  3012. </member>
  3013. <member name="P:WebSocketSharp.Net.HttpListenerRequest.HttpMethod">
  3014. <summary>
  3015. Gets the HTTP method used in the request.
  3016. </summary>
  3017. <value>
  3018. A <see cref="T:System.String"/> that represents the HTTP method used in the request.
  3019. </value>
  3020. </member>
  3021. <member name="P:WebSocketSharp.Net.HttpListenerRequest.InputStream">
  3022. <summary>
  3023. Gets a <see cref="T:System.IO.Stream"/> that contains the entity body data included in the request.
  3024. </summary>
  3025. <value>
  3026. A <see cref="T:System.IO.Stream"/> that contains the entity body data included in the request.
  3027. </value>
  3028. </member>
  3029. <member name="P:WebSocketSharp.Net.HttpListenerRequest.IsAuthenticated">
  3030. <summary>
  3031. Gets a value indicating whether the client that sent the request is authenticated.
  3032. </summary>
  3033. <value>
  3034. <c>true</c> if the client is authenticated; otherwise, <c>false</c>.
  3035. </value>
  3036. </member>
  3037. <member name="P:WebSocketSharp.Net.HttpListenerRequest.IsLocal">
  3038. <summary>
  3039. Gets a value indicating whether the request is sent from the local computer.
  3040. </summary>
  3041. <value>
  3042. <c>true</c> if the request is sent from the local computer; otherwise, <c>false</c>.
  3043. </value>
  3044. </member>
  3045. <member name="P:WebSocketSharp.Net.HttpListenerRequest.IsSecureConnection">
  3046. <summary>
  3047. Gets a value indicating whether the HTTP connection is secured using the SSL protocol.
  3048. </summary>
  3049. <value>
  3050. <c>true</c> if the HTTP connection is secured; otherwise, <c>false</c>.
  3051. </value>
  3052. </member>
  3053. <member name="P:WebSocketSharp.Net.HttpListenerRequest.IsWebSocketRequest">
  3054. <summary>
  3055. Gets a value indicating whether the request is a WebSocket connection request.
  3056. </summary>
  3057. <value>
  3058. <c>true</c> if the request is a WebSocket connection request; otherwise, <c>false</c>.
  3059. </value>
  3060. </member>
  3061. <member name="P:WebSocketSharp.Net.HttpListenerRequest.KeepAlive">
  3062. <summary>
  3063. Gets a value indicating whether the client requests a persistent connection.
  3064. </summary>
  3065. <value>
  3066. <c>true</c> if the client requests a persistent connection; otherwise, <c>false</c>.
  3067. </value>
  3068. </member>
  3069. <member name="P:WebSocketSharp.Net.HttpListenerRequest.LocalEndPoint">
  3070. <summary>
  3071. Gets the server endpoint as an IP address and a port number.
  3072. </summary>
  3073. <value>
  3074. A <see cref="T:System.Net.IPEndPoint"/> that represents the server endpoint.
  3075. </value>
  3076. </member>
  3077. <member name="P:WebSocketSharp.Net.HttpListenerRequest.ProtocolVersion">
  3078. <summary>
  3079. Gets the HTTP version used in the request.
  3080. </summary>
  3081. <value>
  3082. A <see cref="T:System.Version"/> that represents the HTTP version used in the request.
  3083. </value>
  3084. </member>
  3085. <member name="P:WebSocketSharp.Net.HttpListenerRequest.QueryString">
  3086. <summary>
  3087. Gets the query string included in the request.
  3088. </summary>
  3089. <value>
  3090. A <see cref="T:System.Collections.Specialized.NameValueCollection"/> that contains the query string parameters.
  3091. </value>
  3092. </member>
  3093. <member name="P:WebSocketSharp.Net.HttpListenerRequest.RawUrl">
  3094. <summary>
  3095. Gets the raw URL (without the scheme, host, and port) requested by the client.
  3096. </summary>
  3097. <value>
  3098. A <see cref="T:System.String"/> that represents the raw URL requested by the client.
  3099. </value>
  3100. </member>
  3101. <member name="P:WebSocketSharp.Net.HttpListenerRequest.RemoteEndPoint">
  3102. <summary>
  3103. Gets the client endpoint as an IP address and a port number.
  3104. </summary>
  3105. <value>
  3106. A <see cref="T:System.Net.IPEndPoint"/> that represents the client endpoint.
  3107. </value>
  3108. </member>
  3109. <member name="P:WebSocketSharp.Net.HttpListenerRequest.RequestTraceIdentifier">
  3110. <summary>
  3111. Gets the request identifier of a incoming HTTP request.
  3112. </summary>
  3113. <value>
  3114. A <see cref="T:System.Guid"/> that represents the identifier of a request.
  3115. </value>
  3116. </member>
  3117. <member name="P:WebSocketSharp.Net.HttpListenerRequest.Url">
  3118. <summary>
  3119. Gets the URL requested by the client.
  3120. </summary>
  3121. <value>
  3122. A <see cref="T:System.Uri"/> that represents the URL requested by the client.
  3123. </value>
  3124. </member>
  3125. <member name="P:WebSocketSharp.Net.HttpListenerRequest.UrlReferrer">
  3126. <summary>
  3127. Gets the URL of the resource from which the requested URL was obtained.
  3128. </summary>
  3129. <value>
  3130. A <see cref="T:System.Uri"/> that represents the value of the Referer request-header,
  3131. or <see langword="null"/> if the request didn't include an Referer header.
  3132. </value>
  3133. </member>
  3134. <member name="P:WebSocketSharp.Net.HttpListenerRequest.UserAgent">
  3135. <summary>
  3136. Gets the information about the user agent originating the request.
  3137. </summary>
  3138. <value>
  3139. A <see cref="T:System.String"/> that represents the value of the User-Agent request-header.
  3140. </value>
  3141. </member>
  3142. <member name="P:WebSocketSharp.Net.HttpListenerRequest.UserHostAddress">
  3143. <summary>
  3144. Gets the server endpoint as an IP address and a port number.
  3145. </summary>
  3146. <value>
  3147. A <see cref="T:System.String"/> that represents the server endpoint.
  3148. </value>
  3149. </member>
  3150. <member name="P:WebSocketSharp.Net.HttpListenerRequest.UserHostName">
  3151. <summary>
  3152. Gets the internet host name and port number (if present) specified by the client.
  3153. </summary>
  3154. <value>
  3155. A <see cref="T:System.String"/> that represents the value of the Host request-header.
  3156. </value>
  3157. </member>
  3158. <member name="P:WebSocketSharp.Net.HttpListenerRequest.UserLanguages">
  3159. <summary>
  3160. Gets the natural languages which are preferred for the response.
  3161. </summary>
  3162. <value>
  3163. An array of <see cref="T:System.String"/> that contains the natural language names in
  3164. the Accept-Language request-header, or <see langword="null"/> if the request
  3165. didn't include an Accept-Language header.
  3166. </value>
  3167. </member>
  3168. <member name="T:WebSocketSharp.Net.HttpListenerResponse">
  3169. <summary>
  3170. Provides the access to a response to a request received by the <see cref="T:WebSocketSharp.Net.HttpListener"/>.
  3171. </summary>
  3172. <remarks>
  3173. The HttpListenerResponse class cannot be inherited.
  3174. </remarks>
  3175. </member>
  3176. <member name="M:WebSocketSharp.Net.HttpListenerResponse.Abort">
  3177. <summary>
  3178. Closes the connection to the client without returning a response.
  3179. </summary>
  3180. </member>
  3181. <member name="M:WebSocketSharp.Net.HttpListenerResponse.AddHeader(System.String,System.String)">
  3182. <summary>
  3183. Adds an HTTP header with the specified <paramref name="name"/> and
  3184. <paramref name="value"/> to the headers for the response.
  3185. </summary>
  3186. <param name="name">
  3187. A <see cref="T:System.String"/> that represents the name of the header to add.
  3188. </param>
  3189. <param name="value">
  3190. A <see cref="T:System.String"/> that represents the value of the header to add.
  3191. </param>
  3192. <exception cref="T:System.ArgumentNullException">
  3193. <paramref name="name"/> is <see langword="null"/> or empty.
  3194. </exception>
  3195. <exception cref="T:System.ArgumentException">
  3196. <para>
  3197. <paramref name="name"/> or <paramref name="value"/> contains invalid characters.
  3198. </para>
  3199. <para>
  3200. -or-
  3201. </para>
  3202. <para>
  3203. <paramref name="name"/> is a restricted header name.
  3204. </para>
  3205. </exception>
  3206. <exception cref="T:System.ArgumentOutOfRangeException">
  3207. The length of <paramref name="value"/> is greater than 65,535 characters.
  3208. </exception>
  3209. <exception cref="T:System.InvalidOperationException">
  3210. The header cannot be allowed to add to the current headers.
  3211. </exception>
  3212. </member>
  3213. <member name="M:WebSocketSharp.Net.HttpListenerResponse.AppendCookie(WebSocketSharp.Net.Cookie)">
  3214. <summary>
  3215. Appends the specified <paramref name="cookie"/> to the cookies sent with the response.
  3216. </summary>
  3217. <param name="cookie">
  3218. A <see cref="T:WebSocketSharp.Net.Cookie"/> to append.
  3219. </param>
  3220. <exception cref="T:System.ArgumentNullException">
  3221. <paramref name="cookie"/> is <see langword="null"/>.
  3222. </exception>
  3223. </member>
  3224. <member name="M:WebSocketSharp.Net.HttpListenerResponse.AppendHeader(System.String,System.String)">
  3225. <summary>
  3226. Appends a <paramref name="value"/> to the specified HTTP header sent with the response.
  3227. </summary>
  3228. <param name="name">
  3229. A <see cref="T:System.String"/> that represents the name of the header to append
  3230. <paramref name="value"/> to.
  3231. </param>
  3232. <param name="value">
  3233. A <see cref="T:System.String"/> that represents the value to append to the header.
  3234. </param>
  3235. <exception cref="T:System.ArgumentNullException">
  3236. <paramref name="name"/> is <see langword="null"/> or empty.
  3237. </exception>
  3238. <exception cref="T:System.ArgumentException">
  3239. <para>
  3240. <paramref name="name"/> or <paramref name="value"/> contains invalid characters.
  3241. </para>
  3242. <para>
  3243. -or-
  3244. </para>
  3245. <para>
  3246. <paramref name="name"/> is a restricted header name.
  3247. </para>
  3248. </exception>
  3249. <exception cref="T:System.ArgumentOutOfRangeException">
  3250. The length of <paramref name="value"/> is greater than 65,535 characters.
  3251. </exception>
  3252. <exception cref="T:System.InvalidOperationException">
  3253. The current headers cannot allow the header to append a value.
  3254. </exception>
  3255. </member>
  3256. <member name="M:WebSocketSharp.Net.HttpListenerResponse.Close">
  3257. <summary>
  3258. Returns the response to the client and releases the resources used by
  3259. this <see cref="T:WebSocketSharp.Net.HttpListenerResponse"/> instance.
  3260. </summary>
  3261. </member>
  3262. <member name="M:WebSocketSharp.Net.HttpListenerResponse.Close(System.Byte[],System.Boolean)">
  3263. <summary>
  3264. Returns the response with the specified array of <see cref="T:System.Byte"/> to the client and
  3265. releases the resources used by this <see cref="T:WebSocketSharp.Net.HttpListenerResponse"/> instance.
  3266. </summary>
  3267. <param name="responseEntity">
  3268. An array of <see cref="T:System.Byte"/> that contains the response entity body data.
  3269. </param>
  3270. <param name="willBlock">
  3271. <c>true</c> if this method blocks execution while flushing the stream to the client;
  3272. otherwise, <c>false</c>.
  3273. </param>
  3274. <exception cref="T:System.ArgumentNullException">
  3275. <paramref name="responseEntity"/> is <see langword="null"/>.
  3276. </exception>
  3277. <exception cref="T:System.ObjectDisposedException">
  3278. This object is closed.
  3279. </exception>
  3280. </member>
  3281. <member name="M:WebSocketSharp.Net.HttpListenerResponse.CopyFrom(WebSocketSharp.Net.HttpListenerResponse)">
  3282. <summary>
  3283. Copies some properties from the specified <see cref="T:WebSocketSharp.Net.HttpListenerResponse"/> to
  3284. this response.
  3285. </summary>
  3286. <param name="templateResponse">
  3287. A <see cref="T:WebSocketSharp.Net.HttpListenerResponse"/> to copy.
  3288. </param>
  3289. <exception cref="T:System.ArgumentNullException">
  3290. <paramref name="templateResponse"/> is <see langword="null"/>.
  3291. </exception>
  3292. </member>
  3293. <member name="M:WebSocketSharp.Net.HttpListenerResponse.Redirect(System.String)">
  3294. <summary>
  3295. Configures the response to redirect the client's request to
  3296. the specified <paramref name="url"/>.
  3297. </summary>
  3298. <remarks>
  3299. This method sets the <see cref="P:WebSocketSharp.Net.HttpListenerResponse.RedirectLocation"/> property to
  3300. <paramref name="url"/>, the <see cref="P:WebSocketSharp.Net.HttpListenerResponse.StatusCode"/> property to
  3301. <c>302</c>, and the <see cref="P:WebSocketSharp.Net.HttpListenerResponse.StatusDescription"/> property to
  3302. <c>"Found"</c>.
  3303. </remarks>
  3304. <param name="url">
  3305. A <see cref="T:System.String"/> that represents the URL to redirect the client's request to.
  3306. </param>
  3307. <exception cref="T:System.ArgumentNullException">
  3308. <paramref name="url"/> is <see langword="null"/>.
  3309. </exception>
  3310. <exception cref="T:System.ArgumentException">
  3311. <paramref name="url"/> isn't an absolute URL.
  3312. </exception>
  3313. <exception cref="T:System.InvalidOperationException">
  3314. The response has already been sent.
  3315. </exception>
  3316. <exception cref="T:System.ObjectDisposedException">
  3317. This object is closed.
  3318. </exception>
  3319. </member>
  3320. <member name="M:WebSocketSharp.Net.HttpListenerResponse.SetCookie(WebSocketSharp.Net.Cookie)">
  3321. <summary>
  3322. Adds or updates a <paramref name="cookie"/> in the cookies sent with the response.
  3323. </summary>
  3324. <param name="cookie">
  3325. A <see cref="T:WebSocketSharp.Net.Cookie"/> to set.
  3326. </param>
  3327. <exception cref="T:System.ArgumentNullException">
  3328. <paramref name="cookie"/> is <see langword="null"/>.
  3329. </exception>
  3330. <exception cref="T:System.ArgumentException">
  3331. <paramref name="cookie"/> already exists in the cookies and couldn't be replaced.
  3332. </exception>
  3333. </member>
  3334. <member name="M:WebSocketSharp.Net.HttpListenerResponse.System#IDisposable#Dispose">
  3335. <summary>
  3336. Releases all resources used by the <see cref="T:WebSocketSharp.Net.HttpListenerResponse"/>.
  3337. </summary>
  3338. </member>
  3339. <member name="P:WebSocketSharp.Net.HttpListenerResponse.ContentEncoding">
  3340. <summary>
  3341. Gets or sets the encoding for the entity body data included in the response.
  3342. </summary>
  3343. <value>
  3344. A <see cref="T:System.Text.Encoding"/> that represents the encoding for the entity body data,
  3345. or <see langword="null"/> if no encoding is specified.
  3346. </value>
  3347. <exception cref="T:System.ObjectDisposedException">
  3348. This object is closed.
  3349. </exception>
  3350. </member>
  3351. <member name="P:WebSocketSharp.Net.HttpListenerResponse.ContentLength64">
  3352. <summary>
  3353. Gets or sets the number of bytes in the entity body data included in the response.
  3354. </summary>
  3355. <value>
  3356. A <see cref="T:System.Int64"/> that represents the value of the Content-Length entity-header.
  3357. </value>
  3358. <exception cref="T:System.ArgumentOutOfRangeException">
  3359. The value specified for a set operation is less than zero.
  3360. </exception>
  3361. <exception cref="T:System.InvalidOperationException">
  3362. The response has already been sent.
  3363. </exception>
  3364. <exception cref="T:System.ObjectDisposedException">
  3365. This object is closed.
  3366. </exception>
  3367. </member>
  3368. <member name="P:WebSocketSharp.Net.HttpListenerResponse.ContentType">
  3369. <summary>
  3370. Gets or sets the media type of the entity body included in the response.
  3371. </summary>
  3372. <value>
  3373. A <see cref="T:System.String"/> that represents the media type of the entity body,
  3374. or <see langword="null"/> if no media type is specified. This value is
  3375. used for the value of the Content-Type entity-header.
  3376. </value>
  3377. <exception cref="T:System.ArgumentException">
  3378. The value specified for a set operation is empty.
  3379. </exception>
  3380. <exception cref="T:System.ObjectDisposedException">
  3381. This object is closed.
  3382. </exception>
  3383. </member>
  3384. <member name="P:WebSocketSharp.Net.HttpListenerResponse.Cookies">
  3385. <summary>
  3386. Gets or sets the cookies sent with the response.
  3387. </summary>
  3388. <value>
  3389. A <see cref="T:WebSocketSharp.Net.CookieCollection"/> that contains the cookies sent with the response.
  3390. </value>
  3391. </member>
  3392. <member name="P:WebSocketSharp.Net.HttpListenerResponse.Headers">
  3393. <summary>
  3394. Gets or sets the HTTP headers sent to the client.
  3395. </summary>
  3396. <value>
  3397. A <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/> that contains the headers sent to the client.
  3398. </value>
  3399. <exception cref="T:System.InvalidOperationException">
  3400. The value specified for a set operation isn't valid for a response.
  3401. </exception>
  3402. </member>
  3403. <member name="P:WebSocketSharp.Net.HttpListenerResponse.KeepAlive">
  3404. <summary>
  3405. Gets or sets a value indicating whether the server requests a persistent connection.
  3406. </summary>
  3407. <value>
  3408. <c>true</c> if the server requests a persistent connection; otherwise, <c>false</c>.
  3409. The default value is <c>true</c>.
  3410. </value>
  3411. <exception cref="T:System.InvalidOperationException">
  3412. The response has already been sent.
  3413. </exception>
  3414. <exception cref="T:System.ObjectDisposedException">
  3415. This object is closed.
  3416. </exception>
  3417. </member>
  3418. <member name="P:WebSocketSharp.Net.HttpListenerResponse.OutputStream">
  3419. <summary>
  3420. Gets a <see cref="T:System.IO.Stream"/> to use to write the entity body data.
  3421. </summary>
  3422. <value>
  3423. A <see cref="T:System.IO.Stream"/> to use to write the entity body data.
  3424. </value>
  3425. <exception cref="T:System.ObjectDisposedException">
  3426. This object is closed.
  3427. </exception>
  3428. </member>
  3429. <member name="P:WebSocketSharp.Net.HttpListenerResponse.ProtocolVersion">
  3430. <summary>
  3431. Gets or sets the HTTP version used in the response.
  3432. </summary>
  3433. <value>
  3434. A <see cref="T:System.Version"/> that represents the version used in the response.
  3435. </value>
  3436. <exception cref="T:System.ArgumentNullException">
  3437. The value specified for a set operation is <see langword="null"/>.
  3438. </exception>
  3439. <exception cref="T:System.ArgumentException">
  3440. The value specified for a set operation doesn't have its <c>Major</c> property set to 1 or
  3441. doesn't have its <c>Minor</c> property set to either 0 or 1.
  3442. </exception>
  3443. <exception cref="T:System.InvalidOperationException">
  3444. The response has already been sent.
  3445. </exception>
  3446. <exception cref="T:System.ObjectDisposedException">
  3447. This object is closed.
  3448. </exception>
  3449. </member>
  3450. <member name="P:WebSocketSharp.Net.HttpListenerResponse.RedirectLocation">
  3451. <summary>
  3452. Gets or sets the URL to which the client is redirected to locate a requested resource.
  3453. </summary>
  3454. <value>
  3455. A <see cref="T:System.String"/> that represents the value of the Location response-header,
  3456. or <see langword="null"/> if no redirect location is specified.
  3457. </value>
  3458. <exception cref="T:System.ArgumentException">
  3459. The value specified for a set operation isn't an absolute URL.
  3460. </exception>
  3461. <exception cref="T:System.ObjectDisposedException">
  3462. This object is closed.
  3463. </exception>
  3464. </member>
  3465. <member name="P:WebSocketSharp.Net.HttpListenerResponse.SendChunked">
  3466. <summary>
  3467. Gets or sets a value indicating whether the response uses the chunked transfer encoding.
  3468. </summary>
  3469. <value>
  3470. <c>true</c> if the response uses the chunked transfer encoding;
  3471. otherwise, <c>false</c>. The default value is <c>false</c>.
  3472. </value>
  3473. <exception cref="T:System.InvalidOperationException">
  3474. The response has already been sent.
  3475. </exception>
  3476. <exception cref="T:System.ObjectDisposedException">
  3477. This object is closed.
  3478. </exception>
  3479. </member>
  3480. <member name="P:WebSocketSharp.Net.HttpListenerResponse.StatusCode">
  3481. <summary>
  3482. Gets or sets the HTTP status code returned to the client.
  3483. </summary>
  3484. <value>
  3485. An <see cref="T:System.Int32"/> that represents the status code for the response to
  3486. the request. The default value is same as <see cref="F:WebSocketSharp.Net.HttpStatusCode.OK"/>.
  3487. </value>
  3488. <exception cref="T:System.InvalidOperationException">
  3489. The response has already been sent.
  3490. </exception>
  3491. <exception cref="T:System.ObjectDisposedException">
  3492. This object is closed.
  3493. </exception>
  3494. <exception cref="T:System.Net.ProtocolViolationException">
  3495. The value specified for a set operation is invalid. Valid values are
  3496. between 100 and 999 inclusive.
  3497. </exception>
  3498. </member>
  3499. <member name="P:WebSocketSharp.Net.HttpListenerResponse.StatusDescription">
  3500. <summary>
  3501. Gets or sets the description of the HTTP status code returned to the client.
  3502. </summary>
  3503. <value>
  3504. A <see cref="T:System.String"/> that represents the description of the status code. The default
  3505. value is the <see href="http://tools.ietf.org/html/rfc2616#section-10">RFC 2616</see>
  3506. description for the <see cref="P:WebSocketSharp.Net.HttpListenerResponse.StatusCode"/> property value,
  3507. or <see cref="F:System.String.Empty"/> if an RFC 2616 description doesn't exist.
  3508. </value>
  3509. <exception cref="T:System.ArgumentException">
  3510. The value specified for a set operation contains invalid characters.
  3511. </exception>
  3512. <exception cref="T:System.InvalidOperationException">
  3513. The response has already been sent.
  3514. </exception>
  3515. <exception cref="T:System.ObjectDisposedException">
  3516. This object is closed.
  3517. </exception>
  3518. </member>
  3519. <member name="M:WebSocketSharp.Net.HttpUtility.HtmlDecode(System.String)">
  3520. <summary>
  3521. Decodes an HTML-encoded <see cref="T:System.String"/> and returns the decoded <see cref="T:System.String"/>.
  3522. </summary>
  3523. <returns>
  3524. A <see cref="T:System.String"/> that represents the decoded string.
  3525. </returns>
  3526. <param name="s">
  3527. A <see cref="T:System.String"/> to decode.
  3528. </param>
  3529. </member>
  3530. <member name="M:WebSocketSharp.Net.HttpUtility.HtmlDecode(System.String,System.IO.TextWriter)">
  3531. <summary>
  3532. Decodes an HTML-encoded <see cref="T:System.String"/> and sends the decoded <see cref="T:System.String"/>
  3533. to the specified <see cref="T:System.IO.TextWriter"/>.
  3534. </summary>
  3535. <param name="s">
  3536. A <see cref="T:System.String"/> to decode.
  3537. </param>
  3538. <param name="output">
  3539. A <see cref="T:System.IO.TextWriter"/> that receives the decoded string.
  3540. </param>
  3541. </member>
  3542. <member name="M:WebSocketSharp.Net.HttpUtility.HtmlEncode(System.String)">
  3543. <summary>
  3544. HTML-encodes a <see cref="T:System.String"/> and returns the encoded <see cref="T:System.String"/>.
  3545. </summary>
  3546. <returns>
  3547. A <see cref="T:System.String"/> that represents the encoded string.
  3548. </returns>
  3549. <param name="s">
  3550. A <see cref="T:System.String"/> to encode.
  3551. </param>
  3552. </member>
  3553. <member name="M:WebSocketSharp.Net.HttpUtility.HtmlEncode(System.String,System.IO.TextWriter)">
  3554. <summary>
  3555. HTML-encodes a <see cref="T:System.String"/> and sends the encoded <see cref="T:System.String"/>
  3556. to the specified <see cref="T:System.IO.TextWriter"/>.
  3557. </summary>
  3558. <param name="s">
  3559. A <see cref="T:System.String"/> to encode.
  3560. </param>
  3561. <param name="output">
  3562. A <see cref="T:System.IO.TextWriter"/> that receives the encoded string.
  3563. </param>
  3564. </member>
  3565. <member name="T:WebSocketSharp.Net.WebHeaderCollection">
  3566. <summary>
  3567. Provides a collection of the HTTP headers associated with a request or response.
  3568. </summary>
  3569. </member>
  3570. <member name="M:WebSocketSharp.Net.WebHeaderCollection.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  3571. <summary>
  3572. Initializes a new instance of the <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/> class from
  3573. the specified <see cref="T:System.Runtime.Serialization.SerializationInfo"/> and <see cref="T:System.Runtime.Serialization.StreamingContext"/>.
  3574. </summary>
  3575. <param name="serializationInfo">
  3576. A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that contains the serialized object data.
  3577. </param>
  3578. <param name="streamingContext">
  3579. A <see cref="T:System.Runtime.Serialization.StreamingContext"/> that specifies the source for the deserialization.
  3580. </param>
  3581. <exception cref="T:System.ArgumentNullException">
  3582. <paramref name="serializationInfo"/> is <see langword="null"/>.
  3583. </exception>
  3584. <exception cref="T:System.ArgumentException">
  3585. An element with the specified name isn't found in <paramref name="serializationInfo"/>.
  3586. </exception>
  3587. </member>
  3588. <member name="M:WebSocketSharp.Net.WebHeaderCollection.#ctor">
  3589. <summary>
  3590. Initializes a new instance of the <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/> class.
  3591. </summary>
  3592. </member>
  3593. <member name="M:WebSocketSharp.Net.WebHeaderCollection.AddWithoutValidate(System.String,System.String)">
  3594. <summary>
  3595. Adds a header to the collection without checking if the header is on
  3596. the restricted header list.
  3597. </summary>
  3598. <param name="headerName">
  3599. A <see cref="T:System.String"/> that represents the name of the header to add.
  3600. </param>
  3601. <param name="headerValue">
  3602. A <see cref="T:System.String"/> that represents the value of the header to add.
  3603. </param>
  3604. <exception cref="T:System.ArgumentNullException">
  3605. <paramref name="headerName"/> is <see langword="null"/> or empty.
  3606. </exception>
  3607. <exception cref="T:System.ArgumentException">
  3608. <paramref name="headerName"/> or <paramref name="headerValue"/> contains invalid characters.
  3609. </exception>
  3610. <exception cref="T:System.ArgumentOutOfRangeException">
  3611. The length of <paramref name="headerValue"/> is greater than 65,535 characters.
  3612. </exception>
  3613. <exception cref="T:System.InvalidOperationException">
  3614. The current <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/> instance doesn't allow
  3615. the <paramref name="headerName"/>.
  3616. </exception>
  3617. </member>
  3618. <member name="M:WebSocketSharp.Net.WebHeaderCollection.Add(System.String)">
  3619. <summary>
  3620. Adds the specified <paramref name="header"/> to the collection.
  3621. </summary>
  3622. <param name="header">
  3623. A <see cref="T:System.String"/> that represents the header with the name and value separated by
  3624. a colon (<c>':'</c>).
  3625. </param>
  3626. <exception cref="T:System.ArgumentNullException">
  3627. <paramref name="header"/> is <see langword="null"/>, empty, or the name part of
  3628. <paramref name="header"/> is empty.
  3629. </exception>
  3630. <exception cref="T:System.ArgumentException">
  3631. <para>
  3632. <paramref name="header"/> doesn't contain a colon.
  3633. </para>
  3634. <para>
  3635. -or-
  3636. </para>
  3637. <para>
  3638. <paramref name="header"/> is a restricted header.
  3639. </para>
  3640. <para>
  3641. -or-
  3642. </para>
  3643. <para>
  3644. The name or value part of <paramref name="header"/> contains invalid characters.
  3645. </para>
  3646. </exception>
  3647. <exception cref="T:System.ArgumentOutOfRangeException">
  3648. The length of the value part of <paramref name="header"/> is greater than 65,535 characters.
  3649. </exception>
  3650. <exception cref="T:System.InvalidOperationException">
  3651. The current <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/> instance doesn't allow
  3652. the <paramref name="header"/>.
  3653. </exception>
  3654. </member>
  3655. <member name="M:WebSocketSharp.Net.WebHeaderCollection.Add(WebSocketSharp.Net.HttpRequestHeader,System.String)">
  3656. <summary>
  3657. Adds the specified request <paramref name="header"/> with
  3658. the specified <paramref name="value"/> to the collection.
  3659. </summary>
  3660. <param name="header">
  3661. One of the <see cref="T:WebSocketSharp.Net.HttpRequestHeader"/> enum values, represents
  3662. the request header to add.
  3663. </param>
  3664. <param name="value">
  3665. A <see cref="T:System.String"/> that represents the value of the header to add.
  3666. </param>
  3667. <exception cref="T:System.ArgumentException">
  3668. <para>
  3669. <paramref name="header"/> is a restricted header.
  3670. </para>
  3671. <para>
  3672. -or-
  3673. </para>
  3674. <para>
  3675. <paramref name="value"/> contains invalid characters.
  3676. </para>
  3677. </exception>
  3678. <exception cref="T:System.ArgumentOutOfRangeException">
  3679. The length of <paramref name="value"/> is greater than 65,535 characters.
  3680. </exception>
  3681. <exception cref="T:System.InvalidOperationException">
  3682. The current <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/> instance doesn't allow
  3683. the request <paramref name="header"/>.
  3684. </exception>
  3685. </member>
  3686. <member name="M:WebSocketSharp.Net.WebHeaderCollection.Add(WebSocketSharp.Net.HttpResponseHeader,System.String)">
  3687. <summary>
  3688. Adds the specified response <paramref name="header"/> with
  3689. the specified <paramref name="value"/> to the collection.
  3690. </summary>
  3691. <param name="header">
  3692. One of the <see cref="T:WebSocketSharp.Net.HttpResponseHeader"/> enum values, represents
  3693. the response header to add.
  3694. </param>
  3695. <param name="value">
  3696. A <see cref="T:System.String"/> that represents the value of the header to add.
  3697. </param>
  3698. <exception cref="T:System.ArgumentException">
  3699. <para>
  3700. <paramref name="header"/> is a restricted header.
  3701. </para>
  3702. <para>
  3703. -or-
  3704. </para>
  3705. <para>
  3706. <paramref name="value"/> contains invalid characters.
  3707. </para>
  3708. </exception>
  3709. <exception cref="T:System.ArgumentOutOfRangeException">
  3710. The length of <paramref name="value"/> is greater than 65,535 characters.
  3711. </exception>
  3712. <exception cref="T:System.InvalidOperationException">
  3713. The current <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/> instance doesn't allow
  3714. the response <paramref name="header"/>.
  3715. </exception>
  3716. </member>
  3717. <member name="M:WebSocketSharp.Net.WebHeaderCollection.Add(System.String,System.String)">
  3718. <summary>
  3719. Adds a header with the specified <paramref name="name"/> and
  3720. <paramref name="value"/> to the collection.
  3721. </summary>
  3722. <param name="name">
  3723. A <see cref="T:System.String"/> that represents the name of the header to add.
  3724. </param>
  3725. <param name="value">
  3726. A <see cref="T:System.String"/> that represents the value of the header to add.
  3727. </param>
  3728. <exception cref="T:System.ArgumentNullException">
  3729. <paramref name="name"/> is <see langword="null"/> or empty.
  3730. </exception>
  3731. <exception cref="T:System.ArgumentException">
  3732. <para>
  3733. <paramref name="name"/> or <paramref name="value"/> contains invalid characters.
  3734. </para>
  3735. <para>
  3736. -or-
  3737. </para>
  3738. <para>
  3739. <paramref name="name"/> is a restricted header name.
  3740. </para>
  3741. </exception>
  3742. <exception cref="T:System.ArgumentOutOfRangeException">
  3743. The length of <paramref name="value"/> is greater than 65,535 characters.
  3744. </exception>
  3745. <exception cref="T:System.InvalidOperationException">
  3746. The current <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/> instance doesn't allow
  3747. the header <paramref name="name"/>.
  3748. </exception>
  3749. </member>
  3750. <member name="M:WebSocketSharp.Net.WebHeaderCollection.Clear">
  3751. <summary>
  3752. Removes all headers from the collection.
  3753. </summary>
  3754. </member>
  3755. <member name="M:WebSocketSharp.Net.WebHeaderCollection.Get(System.Int32)">
  3756. <summary>
  3757. Get the value of the header at the specified <paramref name="index"/> in the collection.
  3758. </summary>
  3759. <returns>
  3760. A <see cref="T:System.String"/> that receives the value of the header.
  3761. </returns>
  3762. <param name="index">
  3763. An <see cref="T:System.Int32"/> that represents the zero-based index of the header to find.
  3764. </param>
  3765. <exception cref="T:System.ArgumentOutOfRangeException">
  3766. <paramref name="index"/> is out of allowable range of indexes for the collection.
  3767. </exception>
  3768. </member>
  3769. <member name="M:WebSocketSharp.Net.WebHeaderCollection.Get(System.String)">
  3770. <summary>
  3771. Get the value of the header with the specified <paramref name="name"/> in the collection.
  3772. </summary>
  3773. <returns>
  3774. A <see cref="T:System.String"/> that receives the value of the header if found;
  3775. otherwise, <see langword="null"/>.
  3776. </returns>
  3777. <param name="name">
  3778. A <see cref="T:System.String"/> that represents the name of the header to find.
  3779. </param>
  3780. </member>
  3781. <member name="M:WebSocketSharp.Net.WebHeaderCollection.GetEnumerator">
  3782. <summary>
  3783. Gets the enumerator used to iterate through the collection.
  3784. </summary>
  3785. <returns>
  3786. An <see cref="T:System.Collections.IEnumerator"/> instance used to iterate through the collection.
  3787. </returns>
  3788. </member>
  3789. <member name="M:WebSocketSharp.Net.WebHeaderCollection.GetKey(System.Int32)">
  3790. <summary>
  3791. Get the name of the header at the specified <paramref name="index"/> in the collection.
  3792. </summary>
  3793. <returns>
  3794. A <see cref="T:System.String"/> that receives the header name.
  3795. </returns>
  3796. <param name="index">
  3797. An <see cref="T:System.Int32"/> that represents the zero-based index of the header to find.
  3798. </param>
  3799. <exception cref="T:System.ArgumentOutOfRangeException">
  3800. <paramref name="index"/> is out of allowable range of indexes for the collection.
  3801. </exception>
  3802. </member>
  3803. <member name="M:WebSocketSharp.Net.WebHeaderCollection.GetValues(System.Int32)">
  3804. <summary>
  3805. Gets an array of header values stored in the specified <paramref name="index"/> position of
  3806. the collection.
  3807. </summary>
  3808. <returns>
  3809. An array of <see cref="T:System.String"/> that receives the header values if found;
  3810. otherwise, <see langword="null"/>.
  3811. </returns>
  3812. <param name="index">
  3813. An <see cref="T:System.Int32"/> that represents the zero-based index of the header to find.
  3814. </param>
  3815. <exception cref="T:System.ArgumentOutOfRangeException">
  3816. <paramref name="index"/> is out of allowable range of indexes for the collection.
  3817. </exception>
  3818. </member>
  3819. <member name="M:WebSocketSharp.Net.WebHeaderCollection.GetValues(System.String)">
  3820. <summary>
  3821. Gets an array of header values stored in the specified <paramref name="header"/>.
  3822. </summary>
  3823. <returns>
  3824. An array of <see cref="T:System.String"/> that receives the header values if found;
  3825. otherwise, <see langword="null"/>.
  3826. </returns>
  3827. <param name="header">
  3828. A <see cref="T:System.String"/> that represents the name of the header to find.
  3829. </param>
  3830. </member>
  3831. <member name="M:WebSocketSharp.Net.WebHeaderCollection.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  3832. <summary>
  3833. Populates the specified <see cref="T:System.Runtime.Serialization.SerializationInfo"/> with the data needed to serialize
  3834. the <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/>.
  3835. </summary>
  3836. <param name="serializationInfo">
  3837. A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data.
  3838. </param>
  3839. <param name="streamingContext">
  3840. A <see cref="T:System.Runtime.Serialization.StreamingContext"/> that specifies the destination for the serialization.
  3841. </param>
  3842. <exception cref="T:System.ArgumentNullException">
  3843. <paramref name="serializationInfo"/> is <see langword="null"/>.
  3844. </exception>
  3845. </member>
  3846. <member name="M:WebSocketSharp.Net.WebHeaderCollection.IsRestricted(System.String)">
  3847. <summary>
  3848. Determines whether the specified header can be set for the request.
  3849. </summary>
  3850. <returns>
  3851. <c>true</c> if the header is restricted; otherwise, <c>false</c>.
  3852. </returns>
  3853. <param name="headerName">
  3854. A <see cref="T:System.String"/> that represents the name of the header to test.
  3855. </param>
  3856. <exception cref="T:System.ArgumentNullException">
  3857. <paramref name="headerName"/> is <see langword="null"/> or empty.
  3858. </exception>
  3859. <exception cref="T:System.ArgumentException">
  3860. <paramref name="headerName"/> contains invalid characters.
  3861. </exception>
  3862. </member>
  3863. <member name="M:WebSocketSharp.Net.WebHeaderCollection.IsRestricted(System.String,System.Boolean)">
  3864. <summary>
  3865. Determines whether the specified header can be set for the request or the response.
  3866. </summary>
  3867. <returns>
  3868. <c>true</c> if the header is restricted; otherwise, <c>false</c>.
  3869. </returns>
  3870. <param name="headerName">
  3871. A <see cref="T:System.String"/> that represents the name of the header to test.
  3872. </param>
  3873. <param name="response">
  3874. <c>true</c> if does the test for the response; for the request, <c>false</c>.
  3875. </param>
  3876. <exception cref="T:System.ArgumentNullException">
  3877. <paramref name="headerName"/> is <see langword="null"/> or empty.
  3878. </exception>
  3879. <exception cref="T:System.ArgumentException">
  3880. <paramref name="headerName"/> contains invalid characters.
  3881. </exception>
  3882. </member>
  3883. <member name="M:WebSocketSharp.Net.WebHeaderCollection.OnDeserialization(System.Object)">
  3884. <summary>
  3885. Implements the <see cref="T:System.Runtime.Serialization.ISerializable"/> interface and raises the deserialization event
  3886. when the deserialization is complete.
  3887. </summary>
  3888. <param name="sender">
  3889. An <see cref="T:System.Object"/> that represents the source of the deserialization event.
  3890. </param>
  3891. </member>
  3892. <member name="M:WebSocketSharp.Net.WebHeaderCollection.Remove(WebSocketSharp.Net.HttpRequestHeader)">
  3893. <summary>
  3894. Removes the specified request <paramref name="header"/> from the collection.
  3895. </summary>
  3896. <param name="header">
  3897. One of the <see cref="T:WebSocketSharp.Net.HttpRequestHeader"/> enum values, represents
  3898. the request header to remove.
  3899. </param>
  3900. <exception cref="T:System.ArgumentException">
  3901. <paramref name="header"/> is a restricted header.
  3902. </exception>
  3903. <exception cref="T:System.InvalidOperationException">
  3904. The current <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/> instance doesn't allow
  3905. the request <paramref name="header"/>.
  3906. </exception>
  3907. </member>
  3908. <member name="M:WebSocketSharp.Net.WebHeaderCollection.Remove(WebSocketSharp.Net.HttpResponseHeader)">
  3909. <summary>
  3910. Removes the specified response <paramref name="header"/> from the collection.
  3911. </summary>
  3912. <param name="header">
  3913. One of the <see cref="T:WebSocketSharp.Net.HttpResponseHeader"/> enum values, represents
  3914. the response header to remove.
  3915. </param>
  3916. <exception cref="T:System.ArgumentException">
  3917. <paramref name="header"/> is a restricted header.
  3918. </exception>
  3919. <exception cref="T:System.InvalidOperationException">
  3920. The current <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/> instance doesn't allow
  3921. the response <paramref name="header"/>.
  3922. </exception>
  3923. </member>
  3924. <member name="M:WebSocketSharp.Net.WebHeaderCollection.Remove(System.String)">
  3925. <summary>
  3926. Removes the specified header from the collection.
  3927. </summary>
  3928. <param name="name">
  3929. A <see cref="T:System.String"/> that represents the name of the header to remove.
  3930. </param>
  3931. <exception cref="T:System.ArgumentNullException">
  3932. <paramref name="name"/> is <see langword="null"/> or empty.
  3933. </exception>
  3934. <exception cref="T:System.ArgumentException">
  3935. <para>
  3936. <paramref name="name"/> contains invalid characters.
  3937. </para>
  3938. <para>
  3939. -or-
  3940. </para>
  3941. <para>
  3942. <paramref name="name"/> is a restricted header name.
  3943. </para>
  3944. </exception>
  3945. <exception cref="T:System.InvalidOperationException">
  3946. The current <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/> instance doesn't allow
  3947. the header <paramref name="name"/>.
  3948. </exception>
  3949. </member>
  3950. <member name="M:WebSocketSharp.Net.WebHeaderCollection.Set(WebSocketSharp.Net.HttpRequestHeader,System.String)">
  3951. <summary>
  3952. Sets the specified request <paramref name="header"/> to the specified value.
  3953. </summary>
  3954. <param name="header">
  3955. One of the <see cref="T:WebSocketSharp.Net.HttpRequestHeader"/> enum values, represents
  3956. the request header to set.
  3957. </param>
  3958. <param name="value">
  3959. A <see cref="T:System.String"/> that represents the value of the request header to set.
  3960. </param>
  3961. <exception cref="T:System.ArgumentException">
  3962. <para>
  3963. <paramref name="header"/> is a restricted header.
  3964. </para>
  3965. <para>
  3966. -or-
  3967. </para>
  3968. <para>
  3969. <paramref name="value"/> contains invalid characters.
  3970. </para>
  3971. </exception>
  3972. <exception cref="T:System.ArgumentOutOfRangeException">
  3973. The length of <paramref name="value"/> is greater than 65,535 characters.
  3974. </exception>
  3975. <exception cref="T:System.InvalidOperationException">
  3976. The current <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/> instance doesn't allow
  3977. the request <paramref name="header"/>.
  3978. </exception>
  3979. </member>
  3980. <member name="M:WebSocketSharp.Net.WebHeaderCollection.Set(WebSocketSharp.Net.HttpResponseHeader,System.String)">
  3981. <summary>
  3982. Sets the specified response <paramref name="header"/> to the specified value.
  3983. </summary>
  3984. <param name="header">
  3985. One of the <see cref="T:WebSocketSharp.Net.HttpResponseHeader"/> enum values, represents
  3986. the response header to set.
  3987. </param>
  3988. <param name="value">
  3989. A <see cref="T:System.String"/> that represents the value of the response header to set.
  3990. </param>
  3991. <exception cref="T:System.ArgumentException">
  3992. <para>
  3993. <paramref name="header"/> is a restricted header.
  3994. </para>
  3995. <para>
  3996. -or-
  3997. </para>
  3998. <para>
  3999. <paramref name="value"/> contains invalid characters.
  4000. </para>
  4001. </exception>
  4002. <exception cref="T:System.ArgumentOutOfRangeException">
  4003. The length of <paramref name="value"/> is greater than 65,535 characters.
  4004. </exception>
  4005. <exception cref="T:System.InvalidOperationException">
  4006. The current <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/> instance doesn't allow
  4007. the response <paramref name="header"/>.
  4008. </exception>
  4009. </member>
  4010. <member name="M:WebSocketSharp.Net.WebHeaderCollection.Set(System.String,System.String)">
  4011. <summary>
  4012. Sets the specified header to the specified value.
  4013. </summary>
  4014. <param name="name">
  4015. A <see cref="T:System.String"/> that represents the name of the header to set.
  4016. </param>
  4017. <param name="value">
  4018. A <see cref="T:System.String"/> that represents the value of the header to set.
  4019. </param>
  4020. <exception cref="T:System.ArgumentNullException">
  4021. <paramref name="name"/> is <see langword="null"/> or empty.
  4022. </exception>
  4023. <exception cref="T:System.ArgumentException">
  4024. <para>
  4025. <paramref name="name"/> or <paramref name="value"/> contains invalid characters.
  4026. </para>
  4027. <para>
  4028. -or-
  4029. </para>
  4030. <para>
  4031. <paramref name="name"/> is a restricted header name.
  4032. </para>
  4033. </exception>
  4034. <exception cref="T:System.ArgumentOutOfRangeException">
  4035. The length of <paramref name="value"/> is greater than 65,535 characters.
  4036. </exception>
  4037. <exception cref="T:System.InvalidOperationException">
  4038. The current <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/> instance doesn't allow
  4039. the header <paramref name="name"/>.
  4040. </exception>
  4041. </member>
  4042. <member name="M:WebSocketSharp.Net.WebHeaderCollection.ToByteArray">
  4043. <summary>
  4044. Converts the current <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/> to an array of <see cref="T:System.Byte"/>.
  4045. </summary>
  4046. <returns>
  4047. An array of <see cref="T:System.Byte"/> that receives the converted current
  4048. <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/>.
  4049. </returns>
  4050. </member>
  4051. <member name="M:WebSocketSharp.Net.WebHeaderCollection.ToString">
  4052. <summary>
  4053. Returns a <see cref="T:System.String"/> that represents the current
  4054. <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/>.
  4055. </summary>
  4056. <returns>
  4057. A <see cref="T:System.String"/> that represents the current <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/>.
  4058. </returns>
  4059. </member>
  4060. <member name="M:WebSocketSharp.Net.WebHeaderCollection.System#Runtime#Serialization#ISerializable#GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  4061. <summary>
  4062. Populates the specified <see cref="T:System.Runtime.Serialization.SerializationInfo"/> with the data needed to serialize
  4063. the current <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/>.
  4064. </summary>
  4065. <param name="serializationInfo">
  4066. A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data.
  4067. </param>
  4068. <param name="streamingContext">
  4069. A <see cref="T:System.Runtime.Serialization.StreamingContext"/> that specifies the destination for the serialization.
  4070. </param>
  4071. <exception cref="T:System.ArgumentNullException">
  4072. <paramref name="serializationInfo"/> is <see langword="null"/>.
  4073. </exception>
  4074. </member>
  4075. <member name="P:WebSocketSharp.Net.WebHeaderCollection.AllKeys">
  4076. <summary>
  4077. Gets all header names in the collection.
  4078. </summary>
  4079. <value>
  4080. An array of <see cref="T:System.String"/> that contains all header names in the collection.
  4081. </value>
  4082. </member>
  4083. <member name="P:WebSocketSharp.Net.WebHeaderCollection.Count">
  4084. <summary>
  4085. Gets the number of headers in the collection.
  4086. </summary>
  4087. <value>
  4088. An <see cref="T:System.Int32"/> that represents the number of headers in the collection.
  4089. </value>
  4090. </member>
  4091. <member name="P:WebSocketSharp.Net.WebHeaderCollection.Item(WebSocketSharp.Net.HttpRequestHeader)">
  4092. <summary>
  4093. Gets or sets the specified request <paramref name="header"/> in the collection.
  4094. </summary>
  4095. <value>
  4096. A <see cref="T:System.String"/> that represents the value of the request <paramref name="header"/>.
  4097. </value>
  4098. <param name="header">
  4099. One of the <see cref="T:WebSocketSharp.Net.HttpRequestHeader"/> enum values, represents
  4100. the request header to get or set.
  4101. </param>
  4102. <exception cref="T:System.ArgumentException">
  4103. <para>
  4104. <paramref name="header"/> is a restricted header.
  4105. </para>
  4106. <para>
  4107. -or-
  4108. </para>
  4109. <para>
  4110. <paramref name="value"/> contains invalid characters.
  4111. </para>
  4112. </exception>
  4113. <exception cref="T:System.ArgumentOutOfRangeException">
  4114. The length of <paramref name="value"/> is greater than 65,535 characters.
  4115. </exception>
  4116. <exception cref="T:System.InvalidOperationException">
  4117. The current <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/> instance doesn't allow
  4118. the request <paramref name="header"/>.
  4119. </exception>
  4120. </member>
  4121. <member name="P:WebSocketSharp.Net.WebHeaderCollection.Item(WebSocketSharp.Net.HttpResponseHeader)">
  4122. <summary>
  4123. Gets or sets the specified response <paramref name="header"/> in the collection.
  4124. </summary>
  4125. <value>
  4126. A <see cref="T:System.String"/> that represents the value of the response <paramref name="header"/>.
  4127. </value>
  4128. <param name="header">
  4129. One of the <see cref="T:WebSocketSharp.Net.HttpResponseHeader"/> enum values, represents
  4130. the response header to get or set.
  4131. </param>
  4132. <exception cref="T:System.ArgumentException">
  4133. <para>
  4134. <paramref name="header"/> is a restricted header.
  4135. </para>
  4136. <para>
  4137. -or-
  4138. </para>
  4139. <para>
  4140. <paramref name="value"/> contains invalid characters.
  4141. </para>
  4142. </exception>
  4143. <exception cref="T:System.ArgumentOutOfRangeException">
  4144. The length of <paramref name="value"/> is greater than 65,535 characters.
  4145. </exception>
  4146. <exception cref="T:System.InvalidOperationException">
  4147. The current <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/> instance doesn't allow
  4148. the response <paramref name="header"/>.
  4149. </exception>
  4150. </member>
  4151. <member name="P:WebSocketSharp.Net.WebHeaderCollection.Keys">
  4152. <summary>
  4153. Gets a collection of header names in the collection.
  4154. </summary>
  4155. <value>
  4156. A <see cref="T:System.Collections.Specialized.NameObjectCollectionBase.KeysCollection"/> that contains
  4157. all header names in the collection.
  4158. </value>
  4159. </member>
  4160. <member name="T:WebSocketSharp.Server.HttpServer">
  4161. <summary>
  4162. Provides a simple HTTP server that allows to accept the WebSocket connection requests.
  4163. </summary>
  4164. <remarks>
  4165. The HttpServer class can provide multiple WebSocket services.
  4166. </remarks>
  4167. </member>
  4168. <member name="M:WebSocketSharp.Server.HttpServer.#ctor">
  4169. <summary>
  4170. Initializes a new instance of the <see cref="T:WebSocketSharp.Server.HttpServer"/> class.
  4171. </summary>
  4172. <remarks>
  4173. An instance initialized by this constructor listens for the incoming requests on port 80.
  4174. </remarks>
  4175. </member>
  4176. <member name="M:WebSocketSharp.Server.HttpServer.#ctor(System.Int32)">
  4177. <summary>
  4178. Initializes a new instance of the <see cref="T:WebSocketSharp.Server.HttpServer"/> class with
  4179. the specified <paramref name="port"/>.
  4180. </summary>
  4181. <remarks>
  4182. <para>
  4183. An instance initialized by this constructor listens for the incoming requests on
  4184. <paramref name="port"/>.
  4185. </para>
  4186. <para>
  4187. If <paramref name="port"/> is 443, that instance provides a secure connection.
  4188. </para>
  4189. </remarks>
  4190. <param name="port">
  4191. An <see cref="T:System.Int32"/> that represents the port number on which to listen.
  4192. </param>
  4193. <exception cref="T:System.ArgumentOutOfRangeException">
  4194. <paramref name="port"/> isn't between 1 and 65535 inclusive.
  4195. </exception>
  4196. </member>
  4197. <member name="M:WebSocketSharp.Server.HttpServer.#ctor(System.String)">
  4198. <summary>
  4199. Initializes a new instance of the <see cref="T:WebSocketSharp.Server.HttpServer"/> class with
  4200. the specified HTTP URL.
  4201. </summary>
  4202. <remarks>
  4203. <para>
  4204. An instance initialized by this constructor listens for the incoming requests on
  4205. the host name and port in <paramref name="url"/>.
  4206. </para>
  4207. <para>
  4208. If <paramref name="url"/> doesn't include a port, either port 80 or 443 is used on
  4209. which to listen. It's determined by the scheme (http or https) in <paramref name="url"/>.
  4210. (Port 80 if the scheme is http.)
  4211. </para>
  4212. </remarks>
  4213. <param name="url">
  4214. A <see cref="T:System.String"/> that represents the HTTP URL of the server.
  4215. </param>
  4216. <exception cref="T:System.ArgumentNullException">
  4217. <paramref name="url"/> is <see langword="null"/>.
  4218. </exception>
  4219. <exception cref="T:System.ArgumentException">
  4220. <para>
  4221. <paramref name="url"/> is empty.
  4222. </para>
  4223. <para>
  4224. -or-
  4225. </para>
  4226. <para>
  4227. <paramref name="url"/> is invalid.
  4228. </para>
  4229. </exception>
  4230. </member>
  4231. <member name="M:WebSocketSharp.Server.HttpServer.#ctor(System.Int32,System.Boolean)">
  4232. <summary>
  4233. Initializes a new instance of the <see cref="T:WebSocketSharp.Server.HttpServer"/> class with
  4234. the specified <paramref name="port"/> and <paramref name="secure"/>.
  4235. </summary>
  4236. <remarks>
  4237. An instance initialized by this constructor listens for the incoming requests on
  4238. <paramref name="port"/>.
  4239. </remarks>
  4240. <param name="port">
  4241. An <see cref="T:System.Int32"/> that represents the port number on which to listen.
  4242. </param>
  4243. <param name="secure">
  4244. A <see cref="T:System.Boolean"/> that indicates providing a secure connection or not.
  4245. (<c>true</c> indicates providing a secure connection.)
  4246. </param>
  4247. <exception cref="T:System.ArgumentOutOfRangeException">
  4248. <paramref name="port"/> isn't between 1 and 65535 inclusive.
  4249. </exception>
  4250. </member>
  4251. <member name="M:WebSocketSharp.Server.HttpServer.#ctor(System.Net.IPAddress,System.Int32)">
  4252. <summary>
  4253. Initializes a new instance of the <see cref="T:WebSocketSharp.Server.HttpServer"/> class with
  4254. the specified <paramref name="address"/> and <paramref name="port"/>.
  4255. </summary>
  4256. <remarks>
  4257. <para>
  4258. An instance initialized by this constructor listens for the incoming requests on
  4259. <paramref name="address"/> and <paramref name="port"/>.
  4260. </para>
  4261. <para>
  4262. If <paramref name="port"/> is 443, that instance provides a secure connection.
  4263. </para>
  4264. </remarks>
  4265. <param name="address">
  4266. A <see cref="T:System.Net.IPAddress"/> that represents the local IP address of the server.
  4267. </param>
  4268. <param name="port">
  4269. An <see cref="T:System.Int32"/> that represents the port number on which to listen.
  4270. </param>
  4271. <exception cref="T:System.ArgumentNullException">
  4272. <paramref name="address"/> is <see langword="null"/>.
  4273. </exception>
  4274. <exception cref="T:System.ArgumentException">
  4275. <paramref name="address"/> isn't a local IP address.
  4276. </exception>
  4277. <exception cref="T:System.ArgumentOutOfRangeException">
  4278. <paramref name="port"/> isn't between 1 and 65535 inclusive.
  4279. </exception>
  4280. </member>
  4281. <member name="M:WebSocketSharp.Server.HttpServer.#ctor(System.Net.IPAddress,System.Int32,System.Boolean)">
  4282. <summary>
  4283. Initializes a new instance of the <see cref="T:WebSocketSharp.Server.HttpServer"/> class with
  4284. the specified <paramref name="address"/>, <paramref name="port"/>,
  4285. and <paramref name="secure"/>.
  4286. </summary>
  4287. <remarks>
  4288. An instance initialized by this constructor listens for the incoming requests on
  4289. <paramref name="address"/> and <paramref name="port"/>.
  4290. </remarks>
  4291. <param name="address">
  4292. A <see cref="T:System.Net.IPAddress"/> that represents the local IP address of the server.
  4293. </param>
  4294. <param name="port">
  4295. An <see cref="T:System.Int32"/> that represents the port number on which to listen.
  4296. </param>
  4297. <param name="secure">
  4298. A <see cref="T:System.Boolean"/> that indicates providing a secure connection or not.
  4299. (<c>true</c> indicates providing a secure connection.)
  4300. </param>
  4301. <exception cref="T:System.ArgumentNullException">
  4302. <paramref name="address"/> is <see langword="null"/>.
  4303. </exception>
  4304. <exception cref="T:System.ArgumentException">
  4305. <paramref name="address"/> isn't a local IP address.
  4306. </exception>
  4307. <exception cref="T:System.ArgumentOutOfRangeException">
  4308. <paramref name="port"/> isn't between 1 and 65535 inclusive.
  4309. </exception>
  4310. </member>
  4311. <member name="M:WebSocketSharp.Server.HttpServer.AddWebSocketService``1(System.String,System.Func{``0})">
  4312. <summary>
  4313. Adds the WebSocket service with the specified behavior, <paramref name="path"/>,
  4314. and <paramref name="initializer"/>.
  4315. </summary>
  4316. <remarks>
  4317. <para>
  4318. This method converts <paramref name="path"/> to URL-decoded string,
  4319. and removes <c>'/'</c> from tail end of <paramref name="path"/>.
  4320. </para>
  4321. <para>
  4322. <paramref name="initializer"/> returns an initialized specified typed
  4323. <see cref="T:WebSocketSharp.Server.WebSocketBehavior"/> instance.
  4324. </para>
  4325. </remarks>
  4326. <param name="path">
  4327. A <see cref="T:System.String"/> that represents the absolute path to the service to add.
  4328. </param>
  4329. <param name="initializer">
  4330. A <c>Func&lt;T&gt;</c> delegate that references the method used to initialize
  4331. a new specified typed <see cref="T:WebSocketSharp.Server.WebSocketBehavior"/> instance (a new
  4332. <see cref="T:WebSocketSharp.Server.IWebSocketSession"/> instance).
  4333. </param>
  4334. <typeparam name="TBehavior">
  4335. The type of the behavior of the service to add. The TBehavior must inherit
  4336. the <see cref="T:WebSocketSharp.Server.WebSocketBehavior"/> class.
  4337. </typeparam>
  4338. </member>
  4339. <member name="M:WebSocketSharp.Server.HttpServer.AddWebSocketService``1(System.String)">
  4340. <summary>
  4341. Adds a WebSocket service with the specified behavior and <paramref name="path"/>.
  4342. </summary>
  4343. <remarks>
  4344. This method converts <paramref name="path"/> to URL-decoded string,
  4345. and removes <c>'/'</c> from tail end of <paramref name="path"/>.
  4346. </remarks>
  4347. <param name="path">
  4348. A <see cref="T:System.String"/> that represents the absolute path to the service to add.
  4349. </param>
  4350. <typeparam name="TBehaviorWithNew">
  4351. The type of the behavior of the service to add. The TBehaviorWithNew must inherit
  4352. the <see cref="T:WebSocketSharp.Server.WebSocketBehavior"/> class, and must have a public parameterless
  4353. constructor.
  4354. </typeparam>
  4355. </member>
  4356. <member name="M:WebSocketSharp.Server.HttpServer.GetFile(System.String)">
  4357. <summary>
  4358. Gets the contents of the file with the specified <paramref name="path"/>.
  4359. </summary>
  4360. <returns>
  4361. An array of <see cref="T:System.Byte"/> that receives the contents of the file,
  4362. or <see langword="null"/> if it doesn't exist.
  4363. </returns>
  4364. <param name="path">
  4365. A <see cref="T:System.String"/> that represents the virtual path to the file to find.
  4366. </param>
  4367. </member>
  4368. <member name="M:WebSocketSharp.Server.HttpServer.RemoveWebSocketService(System.String)">
  4369. <summary>
  4370. Removes the WebSocket service with the specified <paramref name="path"/>.
  4371. </summary>
  4372. <remarks>
  4373. This method converts <paramref name="path"/> to URL-decoded string,
  4374. and removes <c>'/'</c> from tail end of <paramref name="path"/>.
  4375. </remarks>
  4376. <returns>
  4377. <c>true</c> if the service is successfully found and removed; otherwise, <c>false</c>.
  4378. </returns>
  4379. <param name="path">
  4380. A <see cref="T:System.String"/> that represents the absolute path to the service to find.
  4381. </param>
  4382. </member>
  4383. <member name="M:WebSocketSharp.Server.HttpServer.Start">
  4384. <summary>
  4385. Starts receiving the HTTP requests.
  4386. </summary>
  4387. </member>
  4388. <member name="M:WebSocketSharp.Server.HttpServer.Stop">
  4389. <summary>
  4390. Stops receiving the HTTP requests.
  4391. </summary>
  4392. </member>
  4393. <member name="M:WebSocketSharp.Server.HttpServer.Stop(System.UInt16,System.String)">
  4394. <summary>
  4395. Stops receiving the HTTP requests with the specified <see cref="T:System.UInt16"/> and
  4396. <see cref="T:System.String"/> used to stop the WebSocket services.
  4397. </summary>
  4398. <param name="code">
  4399. A <see cref="T:System.UInt16"/> that represents the status code indicating the reason for the stop.
  4400. </param>
  4401. <param name="reason">
  4402. A <see cref="T:System.String"/> that represents the reason for the stop.
  4403. </param>
  4404. </member>
  4405. <member name="M:WebSocketSharp.Server.HttpServer.Stop(WebSocketSharp.CloseStatusCode,System.String)">
  4406. <summary>
  4407. Stops receiving the HTTP requests with the specified <see cref="T:WebSocketSharp.CloseStatusCode"/> and
  4408. <see cref="T:System.String"/> used to stop the WebSocket services.
  4409. </summary>
  4410. <param name="code">
  4411. One of the <see cref="T:WebSocketSharp.CloseStatusCode"/> enum values, represents the status code indicating
  4412. the reason for the stop.
  4413. </param>
  4414. <param name="reason">
  4415. A <see cref="T:System.String"/> that represents the reason for the stop.
  4416. </param>
  4417. </member>
  4418. <member name="P:WebSocketSharp.Server.HttpServer.Address">
  4419. <summary>
  4420. Gets the local IP address of the server.
  4421. </summary>
  4422. <value>
  4423. A <see cref="T:System.Net.IPAddress"/> that represents the local IP address of the server.
  4424. </value>
  4425. </member>
  4426. <member name="P:WebSocketSharp.Server.HttpServer.AuthenticationSchemes">
  4427. <summary>
  4428. Gets or sets the scheme used to authenticate the clients.
  4429. </summary>
  4430. <value>
  4431. One of the <see cref="T:WebSocketSharp.Net.AuthenticationSchemes"/> enum values,
  4432. indicates the scheme used to authenticate the clients. The default value is
  4433. <see cref="F:WebSocketSharp.Net.AuthenticationSchemes.Anonymous"/>.
  4434. </value>
  4435. </member>
  4436. <member name="P:WebSocketSharp.Server.HttpServer.IsListening">
  4437. <summary>
  4438. Gets a value indicating whether the server has started.
  4439. </summary>
  4440. <value>
  4441. <c>true</c> if the server has started; otherwise, <c>false</c>.
  4442. </value>
  4443. </member>
  4444. <member name="P:WebSocketSharp.Server.HttpServer.IsSecure">
  4445. <summary>
  4446. Gets a value indicating whether the server provides a secure connection.
  4447. </summary>
  4448. <value>
  4449. <c>true</c> if the server provides a secure connection; otherwise, <c>false</c>.
  4450. </value>
  4451. </member>
  4452. <member name="P:WebSocketSharp.Server.HttpServer.KeepClean">
  4453. <summary>
  4454. Gets or sets a value indicating whether the server cleans up
  4455. the inactive sessions in the WebSocket services periodically.
  4456. </summary>
  4457. <value>
  4458. <c>true</c> if the server cleans up the inactive sessions every 60 seconds;
  4459. otherwise, <c>false</c>. The default value is <c>true</c>.
  4460. </value>
  4461. </member>
  4462. <member name="P:WebSocketSharp.Server.HttpServer.Log">
  4463. <summary>
  4464. Gets the logging functions.
  4465. </summary>
  4466. <remarks>
  4467. The default logging level is <see cref="F:WebSocketSharp.LogLevel.Error"/>. If you would like to change it,
  4468. you should set the <c>Log.Level</c> property to any of the <see cref="T:WebSocketSharp.LogLevel"/> enum
  4469. values.
  4470. </remarks>
  4471. <value>
  4472. A <see cref="T:WebSocketSharp.Logger"/> that provides the logging functions.
  4473. </value>
  4474. </member>
  4475. <member name="P:WebSocketSharp.Server.HttpServer.Port">
  4476. <summary>
  4477. Gets the port on which to listen for incoming requests.
  4478. </summary>
  4479. <value>
  4480. An <see cref="T:System.Int32"/> that represents the port number on which to listen.
  4481. </value>
  4482. </member>
  4483. <member name="P:WebSocketSharp.Server.HttpServer.Realm">
  4484. <summary>
  4485. Gets or sets the name of the realm associated with the server.
  4486. </summary>
  4487. <remarks>
  4488. If this property is <see langword="null"/> or empty, <c>"SECRET AREA"</c> will be used as
  4489. the name of the realm.
  4490. </remarks>
  4491. <value>
  4492. A <see cref="T:System.String"/> that represents the name of the realm. The default value is
  4493. <see langword="null"/>.
  4494. </value>
  4495. </member>
  4496. <member name="P:WebSocketSharp.Server.HttpServer.ReuseAddress">
  4497. <summary>
  4498. Gets or sets a value indicating whether the server is allowed to be bound to
  4499. an address that is already in use.
  4500. </summary>
  4501. <remarks>
  4502. If you would like to resolve to wait for socket in <c>TIME_WAIT</c> state,
  4503. you should set this property to <c>true</c>.
  4504. </remarks>
  4505. <value>
  4506. <c>true</c> if the server is allowed to be bound to an address that is already in use;
  4507. otherwise, <c>false</c>. The default value is <c>false</c>.
  4508. </value>
  4509. </member>
  4510. <member name="P:WebSocketSharp.Server.HttpServer.RootPath">
  4511. <summary>
  4512. Gets or sets the document root path of the server.
  4513. </summary>
  4514. <value>
  4515. A <see cref="T:System.String"/> that represents the document root path of the server.
  4516. The default value is <c>"./Public"</c>.
  4517. </value>
  4518. </member>
  4519. <member name="P:WebSocketSharp.Server.HttpServer.SslConfiguration">
  4520. <summary>
  4521. Gets or sets the SSL configuration used to authenticate the server and
  4522. optionally the client for secure connection.
  4523. </summary>
  4524. <value>
  4525. A <see cref="T:WebSocketSharp.Net.ServerSslConfiguration"/> that represents the configuration used to
  4526. authenticate the server and optionally the client for secure connection.
  4527. </value>
  4528. </member>
  4529. <member name="P:WebSocketSharp.Server.HttpServer.UserCredentialsFinder">
  4530. <summary>
  4531. Gets or sets the delegate called to find the credentials for an identity used to
  4532. authenticate a client.
  4533. </summary>
  4534. <value>
  4535. A <c>Func&lt;<see cref="T:System.Security.Principal.IIdentity"/>, <see cref="T:WebSocketSharp.Net.NetworkCredential"/>&gt;</c> delegate
  4536. that references the method(s) used to find the credentials. The default value is
  4537. <see langword="null"/>.
  4538. </value>
  4539. </member>
  4540. <member name="P:WebSocketSharp.Server.HttpServer.WaitTime">
  4541. <summary>
  4542. Gets or sets the wait time for the response to the WebSocket Ping or Close.
  4543. </summary>
  4544. <value>
  4545. A <see cref="T:System.TimeSpan"/> that represents the wait time. The default value is
  4546. the same as 1 second.
  4547. </value>
  4548. </member>
  4549. <member name="P:WebSocketSharp.Server.HttpServer.WebSocketServices">
  4550. <summary>
  4551. Gets the access to the WebSocket services provided by the server.
  4552. </summary>
  4553. <value>
  4554. A <see cref="T:WebSocketSharp.Server.WebSocketServiceManager"/> that manages the WebSocket services.
  4555. </value>
  4556. </member>
  4557. <member name="E:WebSocketSharp.Server.HttpServer.OnConnect">
  4558. <summary>
  4559. Occurs when the server receives an HTTP CONNECT request.
  4560. </summary>
  4561. </member>
  4562. <member name="E:WebSocketSharp.Server.HttpServer.OnDelete">
  4563. <summary>
  4564. Occurs when the server receives an HTTP DELETE request.
  4565. </summary>
  4566. </member>
  4567. <member name="E:WebSocketSharp.Server.HttpServer.OnGet">
  4568. <summary>
  4569. Occurs when the server receives an HTTP GET request.
  4570. </summary>
  4571. </member>
  4572. <member name="E:WebSocketSharp.Server.HttpServer.OnHead">
  4573. <summary>
  4574. Occurs when the server receives an HTTP HEAD request.
  4575. </summary>
  4576. </member>
  4577. <member name="E:WebSocketSharp.Server.HttpServer.OnOptions">
  4578. <summary>
  4579. Occurs when the server receives an HTTP OPTIONS request.
  4580. </summary>
  4581. </member>
  4582. <member name="E:WebSocketSharp.Server.HttpServer.OnPatch">
  4583. <summary>
  4584. Occurs when the server receives an HTTP PATCH request.
  4585. </summary>
  4586. </member>
  4587. <member name="E:WebSocketSharp.Server.HttpServer.OnPost">
  4588. <summary>
  4589. Occurs when the server receives an HTTP POST request.
  4590. </summary>
  4591. </member>
  4592. <member name="E:WebSocketSharp.Server.HttpServer.OnPut">
  4593. <summary>
  4594. Occurs when the server receives an HTTP PUT request.
  4595. </summary>
  4596. </member>
  4597. <member name="E:WebSocketSharp.Server.HttpServer.OnTrace">
  4598. <summary>
  4599. Occurs when the server receives an HTTP TRACE request.
  4600. </summary>
  4601. </member>
  4602. <member name="T:WebSocketSharp.Net.HttpVersion">
  4603. <summary>
  4604. Provides the HTTP version numbers.
  4605. </summary>
  4606. </member>
  4607. <member name="F:WebSocketSharp.Net.HttpVersion.Version10">
  4608. <summary>
  4609. Provides a <see cref="T:System.Version"/> instance for the HTTP/1.0.
  4610. </summary>
  4611. </member>
  4612. <member name="F:WebSocketSharp.Net.HttpVersion.Version11">
  4613. <summary>
  4614. Provides a <see cref="T:System.Version"/> instance for the HTTP/1.1.
  4615. </summary>
  4616. </member>
  4617. <member name="M:WebSocketSharp.Net.HttpVersion.#ctor">
  4618. <summary>
  4619. Initializes a new instance of the <see cref="T:WebSocketSharp.Net.HttpVersion"/> class.
  4620. </summary>
  4621. </member>
  4622. <member name="T:WebSocketSharp.Net.HttpStatusCode">
  4623. <summary>
  4624. Contains the values of the HTTP status codes.
  4625. </summary>
  4626. <remarks>
  4627. The HttpStatusCode enumeration contains the values of the HTTP status codes defined in
  4628. <see href="http://tools.ietf.org/html/rfc2616#section-10">RFC 2616</see> for the HTTP/1.1.
  4629. </remarks>
  4630. </member>
  4631. <member name="F:WebSocketSharp.Net.HttpStatusCode.Continue">
  4632. <summary>
  4633. Equivalent to status code 100.
  4634. Indicates that the client should continue with its request.
  4635. </summary>
  4636. </member>
  4637. <member name="F:WebSocketSharp.Net.HttpStatusCode.SwitchingProtocols">
  4638. <summary>
  4639. Equivalent to status code 101.
  4640. Indicates that the server is switching the HTTP version or protocol on the connection.
  4641. </summary>
  4642. </member>
  4643. <member name="F:WebSocketSharp.Net.HttpStatusCode.OK">
  4644. <summary>
  4645. Equivalent to status code 200.
  4646. Indicates that the client's request has succeeded.
  4647. </summary>
  4648. </member>
  4649. <member name="F:WebSocketSharp.Net.HttpStatusCode.Created">
  4650. <summary>
  4651. Equivalent to status code 201.
  4652. Indicates that the client's request has been fulfilled and resulted in a new resource being
  4653. created.
  4654. </summary>
  4655. </member>
  4656. <member name="F:WebSocketSharp.Net.HttpStatusCode.Accepted">
  4657. <summary>
  4658. Equivalent to status code 202.
  4659. Indicates that the client's request has been accepted for processing, but the processing
  4660. hasn't been completed.
  4661. </summary>
  4662. </member>
  4663. <member name="F:WebSocketSharp.Net.HttpStatusCode.NonAuthoritativeInformation">
  4664. <summary>
  4665. Equivalent to status code 203.
  4666. Indicates that the returned metainformation is from a local or a third-party copy instead of
  4667. the origin server.
  4668. </summary>
  4669. </member>
  4670. <member name="F:WebSocketSharp.Net.HttpStatusCode.NoContent">
  4671. <summary>
  4672. Equivalent to status code 204.
  4673. Indicates that the server has fulfilled the client's request but doesn't need to return
  4674. an entity-body.
  4675. </summary>
  4676. </member>
  4677. <member name="F:WebSocketSharp.Net.HttpStatusCode.ResetContent">
  4678. <summary>
  4679. Equivalent to status code 205.
  4680. Indicates that the server has fulfilled the client's request, and the user agent should
  4681. reset the document view which caused the request to be sent.
  4682. </summary>
  4683. </member>
  4684. <member name="F:WebSocketSharp.Net.HttpStatusCode.PartialContent">
  4685. <summary>
  4686. Equivalent to status code 206.
  4687. Indicates that the server has fulfilled the partial GET request for the resource.
  4688. </summary>
  4689. </member>
  4690. <member name="F:WebSocketSharp.Net.HttpStatusCode.MultipleChoices">
  4691. <summary>
  4692. <para>
  4693. Equivalent to status code 300.
  4694. Indicates that the requested resource corresponds to any of multiple representations.
  4695. </para>
  4696. <para>
  4697. MultipleChoices is a synonym for Ambiguous.
  4698. </para>
  4699. </summary>
  4700. </member>
  4701. <member name="F:WebSocketSharp.Net.HttpStatusCode.Ambiguous">
  4702. <summary>
  4703. <para>
  4704. Equivalent to status code 300.
  4705. Indicates that the requested resource corresponds to any of multiple representations.
  4706. </para>
  4707. <para>
  4708. Ambiguous is a synonym for MultipleChoices.
  4709. </para>
  4710. </summary>
  4711. </member>
  4712. <member name="F:WebSocketSharp.Net.HttpStatusCode.MovedPermanently">
  4713. <summary>
  4714. <para>
  4715. Equivalent to status code 301.
  4716. Indicates that the requested resource has been assigned a new permanent URI and
  4717. any future references to this resource should use one of the returned URIs.
  4718. </para>
  4719. <para>
  4720. MovedPermanently is a synonym for Moved.
  4721. </para>
  4722. </summary>
  4723. </member>
  4724. <member name="F:WebSocketSharp.Net.HttpStatusCode.Moved">
  4725. <summary>
  4726. <para>
  4727. Equivalent to status code 301.
  4728. Indicates that the requested resource has been assigned a new permanent URI and
  4729. any future references to this resource should use one of the returned URIs.
  4730. </para>
  4731. <para>
  4732. Moved is a synonym for MovedPermanently.
  4733. </para>
  4734. </summary>
  4735. </member>
  4736. <member name="F:WebSocketSharp.Net.HttpStatusCode.Found">
  4737. <summary>
  4738. <para>
  4739. Equivalent to status code 302.
  4740. Indicates that the requested resource is located temporarily under a different URI.
  4741. </para>
  4742. <para>
  4743. Found is a synonym for Redirect.
  4744. </para>
  4745. </summary>
  4746. </member>
  4747. <member name="F:WebSocketSharp.Net.HttpStatusCode.Redirect">
  4748. <summary>
  4749. <para>
  4750. Equivalent to status code 302.
  4751. Indicates that the requested resource is located temporarily under a different URI.
  4752. </para>
  4753. <para>
  4754. Redirect is a synonym for Found.
  4755. </para>
  4756. </summary>
  4757. </member>
  4758. <member name="F:WebSocketSharp.Net.HttpStatusCode.SeeOther">
  4759. <summary>
  4760. <para>
  4761. Equivalent to status code 303.
  4762. Indicates that the response to the request can be found under a different URI and
  4763. should be retrieved using a GET method on that resource.
  4764. </para>
  4765. <para>
  4766. SeeOther is a synonym for RedirectMethod.
  4767. </para>
  4768. </summary>
  4769. </member>
  4770. <member name="F:WebSocketSharp.Net.HttpStatusCode.RedirectMethod">
  4771. <summary>
  4772. <para>
  4773. Equivalent to status code 303.
  4774. Indicates that the response to the request can be found under a different URI and
  4775. should be retrieved using a GET method on that resource.
  4776. </para>
  4777. <para>
  4778. RedirectMethod is a synonym for SeeOther.
  4779. </para>
  4780. </summary>
  4781. </member>
  4782. <member name="F:WebSocketSharp.Net.HttpStatusCode.NotModified">
  4783. <summary>
  4784. Equivalent to status code 304.
  4785. Indicates that the client has performed a conditional GET request and access is allowed,
  4786. but the document hasn't been modified.
  4787. </summary>
  4788. </member>
  4789. <member name="F:WebSocketSharp.Net.HttpStatusCode.UseProxy">
  4790. <summary>
  4791. Equivalent to status code 305.
  4792. Indicates that the requested resource must be accessed through the proxy given by
  4793. the Location field.
  4794. </summary>
  4795. </member>
  4796. <member name="F:WebSocketSharp.Net.HttpStatusCode.Unused">
  4797. <summary>
  4798. Equivalent to status code 306.
  4799. This status code was used in a previous version of the specification, is no longer used,
  4800. and is reserved for future use.
  4801. </summary>
  4802. </member>
  4803. <member name="F:WebSocketSharp.Net.HttpStatusCode.TemporaryRedirect">
  4804. <summary>
  4805. <para>
  4806. Equivalent to status code 307.
  4807. Indicates that the requested resource is located temporarily under a different URI.
  4808. </para>
  4809. <para>
  4810. TemporaryRedirect is a synonym for RedirectKeepVerb.
  4811. </para>
  4812. </summary>
  4813. </member>
  4814. <member name="F:WebSocketSharp.Net.HttpStatusCode.RedirectKeepVerb">
  4815. <summary>
  4816. <para>
  4817. Equivalent to status code 307.
  4818. Indicates that the requested resource is located temporarily under a different URI.
  4819. </para>
  4820. <para>
  4821. RedirectKeepVerb is a synonym for TemporaryRedirect.
  4822. </para>
  4823. </summary>
  4824. </member>
  4825. <member name="F:WebSocketSharp.Net.HttpStatusCode.BadRequest">
  4826. <summary>
  4827. Equivalent to status code 400.
  4828. Indicates that the client's request couldn't be understood by the server due to
  4829. malformed syntax.
  4830. </summary>
  4831. </member>
  4832. <member name="F:WebSocketSharp.Net.HttpStatusCode.Unauthorized">
  4833. <summary>
  4834. Equivalent to status code 401.
  4835. Indicates that the client's request requires user authentication.
  4836. </summary>
  4837. </member>
  4838. <member name="F:WebSocketSharp.Net.HttpStatusCode.PaymentRequired">
  4839. <summary>
  4840. Equivalent to status code 402.
  4841. This status code is reserved for future use.
  4842. </summary>
  4843. </member>
  4844. <member name="F:WebSocketSharp.Net.HttpStatusCode.Forbidden">
  4845. <summary>
  4846. Equivalent to status code 403.
  4847. Indicates that the server understood the client's request but is refusing to fulfill it.
  4848. </summary>
  4849. </member>
  4850. <member name="F:WebSocketSharp.Net.HttpStatusCode.NotFound">
  4851. <summary>
  4852. Equivalent to status code 404.
  4853. Indicates that the server hasn't found anything matching the request URI.
  4854. </summary>
  4855. </member>
  4856. <member name="F:WebSocketSharp.Net.HttpStatusCode.MethodNotAllowed">
  4857. <summary>
  4858. Equivalent to status code 405.
  4859. Indicates that the method specified in the request line isn't allowed for the resource
  4860. identified by the request URI.
  4861. </summary>
  4862. </member>
  4863. <member name="F:WebSocketSharp.Net.HttpStatusCode.NotAcceptable">
  4864. <summary>
  4865. Equivalent to status code 406.
  4866. Indicates that the server doesn't have the appropriate resource to respond to the Accept
  4867. headers in the client's request.
  4868. </summary>
  4869. </member>
  4870. <member name="F:WebSocketSharp.Net.HttpStatusCode.ProxyAuthenticationRequired">
  4871. <summary>
  4872. Equivalent to status code 407.
  4873. Indicates that the client must first authenticate itself with the proxy.
  4874. </summary>
  4875. </member>
  4876. <member name="F:WebSocketSharp.Net.HttpStatusCode.RequestTimeout">
  4877. <summary>
  4878. Equivalent to status code 408.
  4879. Indicates that the client didn't produce a request within the time that the server was
  4880. prepared to wait.
  4881. </summary>
  4882. </member>
  4883. <member name="F:WebSocketSharp.Net.HttpStatusCode.Conflict">
  4884. <summary>
  4885. Equivalent to status code 409.
  4886. Indicates that the client's request couldn't be completed due to a conflict on the server.
  4887. </summary>
  4888. </member>
  4889. <member name="F:WebSocketSharp.Net.HttpStatusCode.Gone">
  4890. <summary>
  4891. Equivalent to status code 410.
  4892. Indicates that the requested resource is no longer available at the server and
  4893. no forwarding address is known.
  4894. </summary>
  4895. </member>
  4896. <member name="F:WebSocketSharp.Net.HttpStatusCode.LengthRequired">
  4897. <summary>
  4898. Equivalent to status code 411.
  4899. Indicates that the server refuses to accept the client's request without a defined
  4900. Content-Length.
  4901. </summary>
  4902. </member>
  4903. <member name="F:WebSocketSharp.Net.HttpStatusCode.PreconditionFailed">
  4904. <summary>
  4905. Equivalent to status code 412.
  4906. Indicates that the precondition given in one or more of the request headers evaluated to
  4907. false when it was tested on the server.
  4908. </summary>
  4909. </member>
  4910. <member name="F:WebSocketSharp.Net.HttpStatusCode.RequestEntityTooLarge">
  4911. <summary>
  4912. Equivalent to status code 413.
  4913. Indicates that the entity of the client's request is larger than the server is willing or
  4914. able to process.
  4915. </summary>
  4916. </member>
  4917. <member name="F:WebSocketSharp.Net.HttpStatusCode.RequestUriTooLong">
  4918. <summary>
  4919. Equivalent to status code 414.
  4920. Indicates that the request URI is longer than the server is willing to interpret.
  4921. </summary>
  4922. </member>
  4923. <member name="F:WebSocketSharp.Net.HttpStatusCode.UnsupportedMediaType">
  4924. <summary>
  4925. Equivalent to status code 415.
  4926. Indicates that the entity of the client's request is in a format not supported by
  4927. the requested resource for the requested method.
  4928. </summary>
  4929. </member>
  4930. <member name="F:WebSocketSharp.Net.HttpStatusCode.RequestedRangeNotSatisfiable">
  4931. <summary>
  4932. Equivalent to status code 416.
  4933. Indicates that none of the range specifier values in a Range request header overlap
  4934. the current extent of the selected resource.
  4935. </summary>
  4936. </member>
  4937. <member name="F:WebSocketSharp.Net.HttpStatusCode.ExpectationFailed">
  4938. <summary>
  4939. Equivalent to status code 417.
  4940. Indicates that the expectation given in an Expect request header couldn't be met by
  4941. the server.
  4942. </summary>
  4943. </member>
  4944. <member name="F:WebSocketSharp.Net.HttpStatusCode.InternalServerError">
  4945. <summary>
  4946. Equivalent to status code 500.
  4947. Indicates that the server encountered an unexpected condition which prevented it from
  4948. fulfilling the client's request.
  4949. </summary>
  4950. </member>
  4951. <member name="F:WebSocketSharp.Net.HttpStatusCode.NotImplemented">
  4952. <summary>
  4953. Equivalent to status code 501.
  4954. Indicates that the server doesn't support the functionality required to fulfill the client's
  4955. request.
  4956. </summary>
  4957. </member>
  4958. <member name="F:WebSocketSharp.Net.HttpStatusCode.BadGateway">
  4959. <summary>
  4960. Equivalent to status code 502.
  4961. Indicates that a gateway or proxy server received an invalid response from the upstream
  4962. server.
  4963. </summary>
  4964. </member>
  4965. <member name="F:WebSocketSharp.Net.HttpStatusCode.ServiceUnavailable">
  4966. <summary>
  4967. Equivalent to status code 503.
  4968. Indicates that the server is currently unable to handle the client's request due to
  4969. a temporary overloading or maintenance of the server.
  4970. </summary>
  4971. </member>
  4972. <member name="F:WebSocketSharp.Net.HttpStatusCode.GatewayTimeout">
  4973. <summary>
  4974. Equivalent to status code 504.
  4975. Indicates that a gateway or proxy server didn't receive a timely response from the upstream
  4976. server or some other auxiliary server.
  4977. </summary>
  4978. </member>
  4979. <member name="F:WebSocketSharp.Net.HttpStatusCode.HttpVersionNotSupported">
  4980. <summary>
  4981. Equivalent to status code 505.
  4982. Indicates that the server doesn't support the HTTP version used in the client's request.
  4983. </summary>
  4984. </member>
  4985. <member name="T:WebSocketSharp.Server.WebSocketServiceHost">
  4986. <summary>
  4987. Exposes the methods and properties used to access the information in a WebSocket service
  4988. provided by the <see cref="T:WebSocketSharp.Server.WebSocketServer"/> or <see cref="T:WebSocketSharp.Server.HttpServer"/>.
  4989. </summary>
  4990. <remarks>
  4991. The WebSocketServiceHost class is an abstract class.
  4992. </remarks>
  4993. </member>
  4994. <member name="M:WebSocketSharp.Server.WebSocketServiceHost.#ctor">
  4995. <summary>
  4996. Initializes a new instance of the <see cref="T:WebSocketSharp.Server.WebSocketServiceHost"/> class.
  4997. </summary>
  4998. </member>
  4999. <member name="M:WebSocketSharp.Server.WebSocketServiceHost.CreateSession">
  5000. <summary>
  5001. Creates a new session in the WebSocket service.
  5002. </summary>
  5003. <returns>
  5004. A <see cref="T:WebSocketSharp.Server.WebSocketBehavior"/> instance that represents a new session.
  5005. </returns>
  5006. </member>
  5007. <member name="P:WebSocketSharp.Server.WebSocketServiceHost.KeepClean">
  5008. <summary>
  5009. Gets or sets a value indicating whether the WebSocket service cleans up
  5010. the inactive sessions periodically.
  5011. </summary>
  5012. <value>
  5013. <c>true</c> if the service cleans up the inactive sessions periodically;
  5014. otherwise, <c>false</c>.
  5015. </value>
  5016. </member>
  5017. <member name="P:WebSocketSharp.Server.WebSocketServiceHost.Path">
  5018. <summary>
  5019. Gets the path to the WebSocket service.
  5020. </summary>
  5021. <value>
  5022. A <see cref="T:System.String"/> that represents the absolute path to the service.
  5023. </value>
  5024. </member>
  5025. <member name="P:WebSocketSharp.Server.WebSocketServiceHost.Sessions">
  5026. <summary>
  5027. Gets the access to the sessions in the WebSocket service.
  5028. </summary>
  5029. <value>
  5030. A <see cref="T:WebSocketSharp.Server.WebSocketSessionManager"/> that manages the sessions in the service.
  5031. </value>
  5032. </member>
  5033. <member name="P:WebSocketSharp.Server.WebSocketServiceHost.Type">
  5034. <summary>
  5035. Gets the <see cref="T:System.Type"/> of the behavior of the WebSocket service.
  5036. </summary>
  5037. <value>
  5038. A <see cref="T:System.Type"/> that represents the type of the behavior of the service.
  5039. </value>
  5040. </member>
  5041. <member name="P:WebSocketSharp.Server.WebSocketServiceHost.WaitTime">
  5042. <summary>
  5043. Gets or sets the wait time for the response to the WebSocket Ping or Close.
  5044. </summary>
  5045. <value>
  5046. A <see cref="T:System.TimeSpan"/> that represents the wait time. The default value is
  5047. the same as 1 second.
  5048. </value>
  5049. </member>
  5050. <member name="T:WebSocketSharp.CloseStatusCode">
  5051. <summary>
  5052. Indicates the status code for the WebSocket connection close.
  5053. </summary>
  5054. <remarks>
  5055. <para>
  5056. The values of this enumeration are defined in
  5057. <see href="http://tools.ietf.org/html/rfc6455#section-7.4">Section 7.4</see> of RFC 6455.
  5058. </para>
  5059. <para>
  5060. "Reserved value" must not be set as a status code in a connection close frame by
  5061. an endpoint. It's designated for use in applications expecting a status code to
  5062. indicate that the connection was closed due to the system grounds.
  5063. </para>
  5064. </remarks>
  5065. </member>
  5066. <member name="F:WebSocketSharp.CloseStatusCode.Normal">
  5067. <summary>
  5068. Equivalent to close status 1000. Indicates normal close.
  5069. </summary>
  5070. </member>
  5071. <member name="F:WebSocketSharp.CloseStatusCode.Away">
  5072. <summary>
  5073. Equivalent to close status 1001. Indicates that an endpoint is going away.
  5074. </summary>
  5075. </member>
  5076. <member name="F:WebSocketSharp.CloseStatusCode.ProtocolError">
  5077. <summary>
  5078. Equivalent to close status 1002. Indicates that an endpoint is terminating
  5079. the connection due to a protocol error.
  5080. </summary>
  5081. </member>
  5082. <member name="F:WebSocketSharp.CloseStatusCode.UnsupportedData">
  5083. <summary>
  5084. Equivalent to close status 1003. Indicates that an endpoint is terminating
  5085. the connection because it has received a type of data that it cannot accept.
  5086. </summary>
  5087. </member>
  5088. <member name="F:WebSocketSharp.CloseStatusCode.Undefined">
  5089. <summary>
  5090. Equivalent to close status 1004. Still undefined. A Reserved value.
  5091. </summary>
  5092. </member>
  5093. <member name="F:WebSocketSharp.CloseStatusCode.NoStatus">
  5094. <summary>
  5095. Equivalent to close status 1005. Indicates that no status code was actually present.
  5096. A Reserved value.
  5097. </summary>
  5098. </member>
  5099. <member name="F:WebSocketSharp.CloseStatusCode.Abnormal">
  5100. <summary>
  5101. Equivalent to close status 1006. Indicates that the connection was closed abnormally.
  5102. A Reserved value.
  5103. </summary>
  5104. </member>
  5105. <member name="F:WebSocketSharp.CloseStatusCode.InvalidData">
  5106. <summary>
  5107. Equivalent to close status 1007. Indicates that an endpoint is terminating
  5108. the connection because it has received a message that contains data that
  5109. isn't consistent with the type of the message.
  5110. </summary>
  5111. </member>
  5112. <member name="F:WebSocketSharp.CloseStatusCode.PolicyViolation">
  5113. <summary>
  5114. Equivalent to close status 1008. Indicates that an endpoint is terminating
  5115. the connection because it has received a message that violates its policy.
  5116. </summary>
  5117. </member>
  5118. <member name="F:WebSocketSharp.CloseStatusCode.TooBig">
  5119. <summary>
  5120. Equivalent to close status 1009. Indicates that an endpoint is terminating
  5121. the connection because it has received a message that is too big to process.
  5122. </summary>
  5123. </member>
  5124. <member name="F:WebSocketSharp.CloseStatusCode.MandatoryExtension">
  5125. <summary>
  5126. Equivalent to close status 1010. Indicates that a client is terminating
  5127. the connection because it has expected the server to negotiate one or more extension,
  5128. but the server didn't return them in the handshake response.
  5129. </summary>
  5130. </member>
  5131. <member name="F:WebSocketSharp.CloseStatusCode.ServerError">
  5132. <summary>
  5133. Equivalent to close status 1011. Indicates that a server is terminating
  5134. the connection because it has encountered an unexpected condition that
  5135. prevented it from fulfilling the request.
  5136. </summary>
  5137. </member>
  5138. <member name="F:WebSocketSharp.CloseStatusCode.TlsHandshakeFailure">
  5139. <summary>
  5140. Equivalent to close status 1015. Indicates that the connection was closed
  5141. due to a failure to perform a TLS handshake. A Reserved value.
  5142. </summary>
  5143. </member>
  5144. <member name="T:WebSocketSharp.Fin">
  5145. <summary>
  5146. Indicates whether a WebSocket frame is the final frame of a message.
  5147. </summary>
  5148. <remarks>
  5149. The values of this enumeration are defined in
  5150. <see href="http://tools.ietf.org/html/rfc6455#section-5.2">Section 5.2</see> of RFC 6455.
  5151. </remarks>
  5152. </member>
  5153. <member name="F:WebSocketSharp.Fin.More">
  5154. <summary>
  5155. Equivalent to numeric value 0. Indicates more frames of a message follow.
  5156. </summary>
  5157. </member>
  5158. <member name="F:WebSocketSharp.Fin.Final">
  5159. <summary>
  5160. Equivalent to numeric value 1. Indicates the final frame of a message.
  5161. </summary>
  5162. </member>
  5163. <member name="T:WebSocketSharp.Mask">
  5164. <summary>
  5165. Indicates whether the payload data of a WebSocket frame is masked.
  5166. </summary>
  5167. <remarks>
  5168. The values of this enumeration are defined in
  5169. <see href="http://tools.ietf.org/html/rfc6455#section-5.2">Section 5.2</see> of RFC 6455.
  5170. </remarks>
  5171. </member>
  5172. <member name="F:WebSocketSharp.Mask.Off">
  5173. <summary>
  5174. Equivalent to numeric value 0. Indicates not masked.
  5175. </summary>
  5176. </member>
  5177. <member name="F:WebSocketSharp.Mask.On">
  5178. <summary>
  5179. Equivalent to numeric value 1. Indicates masked.
  5180. </summary>
  5181. </member>
  5182. <member name="T:WebSocketSharp.Opcode">
  5183. <summary>
  5184. Indicates the WebSocket frame type.
  5185. </summary>
  5186. <remarks>
  5187. The values of this enumeration are defined in
  5188. <see href="http://tools.ietf.org/html/rfc6455#section-5.2">Section 5.2</see> of RFC 6455.
  5189. </remarks>
  5190. </member>
  5191. <member name="F:WebSocketSharp.Opcode.Cont">
  5192. <summary>
  5193. Equivalent to numeric value 0. Indicates continuation frame.
  5194. </summary>
  5195. </member>
  5196. <member name="F:WebSocketSharp.Opcode.Text">
  5197. <summary>
  5198. Equivalent to numeric value 1. Indicates text frame.
  5199. </summary>
  5200. </member>
  5201. <member name="F:WebSocketSharp.Opcode.Binary">
  5202. <summary>
  5203. Equivalent to numeric value 2. Indicates binary frame.
  5204. </summary>
  5205. </member>
  5206. <member name="F:WebSocketSharp.Opcode.Close">
  5207. <summary>
  5208. Equivalent to numeric value 8. Indicates connection close frame.
  5209. </summary>
  5210. </member>
  5211. <member name="F:WebSocketSharp.Opcode.Ping">
  5212. <summary>
  5213. Equivalent to numeric value 9. Indicates ping frame.
  5214. </summary>
  5215. </member>
  5216. <member name="F:WebSocketSharp.Opcode.Pong">
  5217. <summary>
  5218. Equivalent to numeric value 10. Indicates pong frame.
  5219. </summary>
  5220. </member>
  5221. <member name="F:WebSocketSharp.PayloadData.Empty">
  5222. <summary>
  5223. Represents the empty payload data.
  5224. </summary>
  5225. </member>
  5226. <member name="F:WebSocketSharp.PayloadData.MaxLength">
  5227. <summary>
  5228. Represents the allowable max length.
  5229. </summary>
  5230. <remarks>
  5231. <para>
  5232. A <see cref="T:WebSocketSharp.WebSocketException"/> will occur if the payload data length is
  5233. greater than the value of this field.
  5234. </para>
  5235. <para>
  5236. If you would like to change the value, you must set it to a value between
  5237. <c>WebSocket.FragmentLength</c> and <c>Int64.MaxValue</c> inclusive.
  5238. </para>
  5239. </remarks>
  5240. </member>
  5241. <member name="T:WebSocketSharp.Rsv">
  5242. <summary>
  5243. Indicates whether each RSV (RSV1, RSV2, and RSV3) of a WebSocket frame is non-zero.
  5244. </summary>
  5245. <remarks>
  5246. The values of this enumeration are defined in
  5247. <see href="http://tools.ietf.org/html/rfc6455#section-5.2">Section 5.2</see> of RFC 6455.
  5248. </remarks>
  5249. </member>
  5250. <member name="F:WebSocketSharp.Rsv.Off">
  5251. <summary>
  5252. Equivalent to numeric value 0. Indicates zero.
  5253. </summary>
  5254. </member>
  5255. <member name="F:WebSocketSharp.Rsv.On">
  5256. <summary>
  5257. Equivalent to numeric value 1. Indicates non-zero.
  5258. </summary>
  5259. </member>
  5260. <member name="T:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext">
  5261. <summary>
  5262. Provides the properties used to access the information in
  5263. a WebSocket handshake request received by the <see cref="T:WebSocketSharp.Net.HttpListener"/>.
  5264. </summary>
  5265. </member>
  5266. <member name="T:WebSocketSharp.Net.WebSockets.WebSocketContext">
  5267. <summary>
  5268. Exposes the properties used to access the information in a WebSocket handshake request.
  5269. </summary>
  5270. <remarks>
  5271. This class is an abstract class.
  5272. </remarks>
  5273. </member>
  5274. <member name="M:WebSocketSharp.Net.WebSockets.WebSocketContext.#ctor">
  5275. <summary>
  5276. Initializes a new instance of the <see cref="T:WebSocketSharp.Net.WebSockets.WebSocketContext"/> class.
  5277. </summary>
  5278. </member>
  5279. <member name="P:WebSocketSharp.Net.WebSockets.WebSocketContext.CookieCollection">
  5280. <summary>
  5281. Gets the HTTP cookies included in the request.
  5282. </summary>
  5283. <value>
  5284. A <see cref="T:WebSocketSharp.Net.CookieCollection"/> that contains the cookies.
  5285. </value>
  5286. </member>
  5287. <member name="P:WebSocketSharp.Net.WebSockets.WebSocketContext.Headers">
  5288. <summary>
  5289. Gets the HTTP headers included in the request.
  5290. </summary>
  5291. <value>
  5292. A <see cref="T:System.Collections.Specialized.NameValueCollection"/> that contains the headers.
  5293. </value>
  5294. </member>
  5295. <member name="P:WebSocketSharp.Net.WebSockets.WebSocketContext.Host">
  5296. <summary>
  5297. Gets the value of the Host header included in the request.
  5298. </summary>
  5299. <value>
  5300. A <see cref="T:System.String"/> that represents the value of the Host header.
  5301. </value>
  5302. </member>
  5303. <member name="P:WebSocketSharp.Net.WebSockets.WebSocketContext.IsAuthenticated">
  5304. <summary>
  5305. Gets a value indicating whether the client is authenticated.
  5306. </summary>
  5307. <value>
  5308. <c>true</c> if the client is authenticated; otherwise, <c>false</c>.
  5309. </value>
  5310. </member>
  5311. <member name="P:WebSocketSharp.Net.WebSockets.WebSocketContext.IsLocal">
  5312. <summary>
  5313. Gets a value indicating whether the client connected from the local computer.
  5314. </summary>
  5315. <value>
  5316. <c>true</c> if the client connected from the local computer; otherwise, <c>false</c>.
  5317. </value>
  5318. </member>
  5319. <member name="P:WebSocketSharp.Net.WebSockets.WebSocketContext.IsSecureConnection">
  5320. <summary>
  5321. Gets a value indicating whether the WebSocket connection is secured.
  5322. </summary>
  5323. <value>
  5324. <c>true</c> if the connection is secured; otherwise, <c>false</c>.
  5325. </value>
  5326. </member>
  5327. <member name="P:WebSocketSharp.Net.WebSockets.WebSocketContext.IsWebSocketRequest">
  5328. <summary>
  5329. Gets a value indicating whether the request is a WebSocket handshake request.
  5330. </summary>
  5331. <value>
  5332. <c>true</c> if the request is a WebSocket handshake request; otherwise, <c>false</c>.
  5333. </value>
  5334. </member>
  5335. <member name="P:WebSocketSharp.Net.WebSockets.WebSocketContext.Origin">
  5336. <summary>
  5337. Gets the value of the Origin header included in the request.
  5338. </summary>
  5339. <value>
  5340. A <see cref="T:System.String"/> that represents the value of the Origin header.
  5341. </value>
  5342. </member>
  5343. <member name="P:WebSocketSharp.Net.WebSockets.WebSocketContext.QueryString">
  5344. <summary>
  5345. Gets the query string included in the request.
  5346. </summary>
  5347. <value>
  5348. A <see cref="T:System.Collections.Specialized.NameValueCollection"/> that contains the query string parameters.
  5349. </value>
  5350. </member>
  5351. <member name="P:WebSocketSharp.Net.WebSockets.WebSocketContext.RequestUri">
  5352. <summary>
  5353. Gets the URI requested by the client.
  5354. </summary>
  5355. <value>
  5356. A <see cref="T:System.Uri"/> that represents the requested URI.
  5357. </value>
  5358. </member>
  5359. <member name="P:WebSocketSharp.Net.WebSockets.WebSocketContext.SecWebSocketKey">
  5360. <summary>
  5361. Gets the value of the Sec-WebSocket-Key header included in the request.
  5362. </summary>
  5363. <remarks>
  5364. This property provides a part of the information used by the server to prove that
  5365. it received a valid WebSocket handshake request.
  5366. </remarks>
  5367. <value>
  5368. A <see cref="T:System.String"/> that represents the value of the Sec-WebSocket-Key header.
  5369. </value>
  5370. </member>
  5371. <member name="P:WebSocketSharp.Net.WebSockets.WebSocketContext.SecWebSocketProtocols">
  5372. <summary>
  5373. Gets the values of the Sec-WebSocket-Protocol header included in the request.
  5374. </summary>
  5375. <remarks>
  5376. This property represents the subprotocols requested by the client.
  5377. </remarks>
  5378. <value>
  5379. An <see cref="T:System.Collections.Generic.IEnumerable{string}"/> instance that provides
  5380. an enumerator which supports the iteration over the values of the Sec-WebSocket-Protocol
  5381. header.
  5382. </value>
  5383. </member>
  5384. <member name="P:WebSocketSharp.Net.WebSockets.WebSocketContext.SecWebSocketVersion">
  5385. <summary>
  5386. Gets the value of the Sec-WebSocket-Version header included in the request.
  5387. </summary>
  5388. <remarks>
  5389. This property represents the WebSocket protocol version.
  5390. </remarks>
  5391. <value>
  5392. A <see cref="T:System.String"/> that represents the value of the Sec-WebSocket-Version header.
  5393. </value>
  5394. </member>
  5395. <member name="P:WebSocketSharp.Net.WebSockets.WebSocketContext.ServerEndPoint">
  5396. <summary>
  5397. Gets the server endpoint as an IP address and a port number.
  5398. </summary>
  5399. <value>
  5400. A <see cref="T:System.Net.IPEndPoint"/> that represents the server endpoint.
  5401. </value>
  5402. </member>
  5403. <member name="P:WebSocketSharp.Net.WebSockets.WebSocketContext.User">
  5404. <summary>
  5405. Gets the client information (identity, authentication, and security roles).
  5406. </summary>
  5407. <value>
  5408. A <see cref="T:System.Security.Principal.IPrincipal"/> instance that represents the client information.
  5409. </value>
  5410. </member>
  5411. <member name="P:WebSocketSharp.Net.WebSockets.WebSocketContext.UserEndPoint">
  5412. <summary>
  5413. Gets the client endpoint as an IP address and a port number.
  5414. </summary>
  5415. <value>
  5416. A <see cref="T:System.Net.IPEndPoint"/> that represents the client endpoint.
  5417. </value>
  5418. </member>
  5419. <member name="P:WebSocketSharp.Net.WebSockets.WebSocketContext.WebSocket">
  5420. <summary>
  5421. Gets the <see cref="T:WebSocketSharp.WebSocket"/> instance used for
  5422. two-way communication between client and server.
  5423. </summary>
  5424. <value>
  5425. A <see cref="T:WebSocketSharp.WebSocket"/>.
  5426. </value>
  5427. </member>
  5428. <member name="M:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext.ToString">
  5429. <summary>
  5430. Returns a <see cref="T:System.String"/> that represents
  5431. the current <see cref="T:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext"/>.
  5432. </summary>
  5433. <returns>
  5434. A <see cref="T:System.String"/> that represents
  5435. the current <see cref="T:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext"/>.
  5436. </returns>
  5437. </member>
  5438. <member name="P:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext.CookieCollection">
  5439. <summary>
  5440. Gets the HTTP cookies included in the request.
  5441. </summary>
  5442. <value>
  5443. A <see cref="T:WebSocketSharp.Net.CookieCollection"/> that contains the cookies.
  5444. </value>
  5445. </member>
  5446. <member name="P:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext.Headers">
  5447. <summary>
  5448. Gets the HTTP headers included in the request.
  5449. </summary>
  5450. <value>
  5451. A <see cref="T:System.Collections.Specialized.NameValueCollection"/> that contains the headers.
  5452. </value>
  5453. </member>
  5454. <member name="P:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext.Host">
  5455. <summary>
  5456. Gets the value of the Host header included in the request.
  5457. </summary>
  5458. <value>
  5459. A <see cref="T:System.String"/> that represents the value of the Host header.
  5460. </value>
  5461. </member>
  5462. <member name="P:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext.IsAuthenticated">
  5463. <summary>
  5464. Gets a value indicating whether the client is authenticated.
  5465. </summary>
  5466. <value>
  5467. <c>true</c> if the client is authenticated; otherwise, <c>false</c>.
  5468. </value>
  5469. </member>
  5470. <member name="P:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext.IsLocal">
  5471. <summary>
  5472. Gets a value indicating whether the client connected from the local computer.
  5473. </summary>
  5474. <value>
  5475. <c>true</c> if the client connected from the local computer; otherwise, <c>false</c>.
  5476. </value>
  5477. </member>
  5478. <member name="P:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext.IsSecureConnection">
  5479. <summary>
  5480. Gets a value indicating whether the WebSocket connection is secured.
  5481. </summary>
  5482. <value>
  5483. <c>true</c> if the connection is secured; otherwise, <c>false</c>.
  5484. </value>
  5485. </member>
  5486. <member name="P:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext.IsWebSocketRequest">
  5487. <summary>
  5488. Gets a value indicating whether the request is a WebSocket handshake request.
  5489. </summary>
  5490. <value>
  5491. <c>true</c> if the request is a WebSocket handshake request; otherwise, <c>false</c>.
  5492. </value>
  5493. </member>
  5494. <member name="P:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext.Origin">
  5495. <summary>
  5496. Gets the value of the Origin header included in the request.
  5497. </summary>
  5498. <value>
  5499. A <see cref="T:System.String"/> that represents the value of the Origin header.
  5500. </value>
  5501. </member>
  5502. <member name="P:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext.QueryString">
  5503. <summary>
  5504. Gets the query string included in the request.
  5505. </summary>
  5506. <value>
  5507. A <see cref="T:System.Collections.Specialized.NameValueCollection"/> that contains the query string parameters.
  5508. </value>
  5509. </member>
  5510. <member name="P:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext.RequestUri">
  5511. <summary>
  5512. Gets the URI requested by the client.
  5513. </summary>
  5514. <value>
  5515. A <see cref="T:System.Uri"/> that represents the requested URI.
  5516. </value>
  5517. </member>
  5518. <member name="P:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext.SecWebSocketKey">
  5519. <summary>
  5520. Gets the value of the Sec-WebSocket-Key header included in the request.
  5521. </summary>
  5522. <remarks>
  5523. This property provides a part of the information used by the server to prove that
  5524. it received a valid WebSocket handshake request.
  5525. </remarks>
  5526. <value>
  5527. A <see cref="T:System.String"/> that represents the value of the Sec-WebSocket-Key header.
  5528. </value>
  5529. </member>
  5530. <member name="P:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext.SecWebSocketProtocols">
  5531. <summary>
  5532. Gets the values of the Sec-WebSocket-Protocol header included in the request.
  5533. </summary>
  5534. <remarks>
  5535. This property represents the subprotocols requested by the client.
  5536. </remarks>
  5537. <value>
  5538. An <see cref="T:System.Collections.Generic.IEnumerable{string}"/> instance that provides
  5539. an enumerator which supports the iteration over the values of the Sec-WebSocket-Protocol
  5540. header.
  5541. </value>
  5542. </member>
  5543. <member name="P:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext.SecWebSocketVersion">
  5544. <summary>
  5545. Gets the value of the Sec-WebSocket-Version header included in the request.
  5546. </summary>
  5547. <remarks>
  5548. This property represents the WebSocket protocol version.
  5549. </remarks>
  5550. <value>
  5551. A <see cref="T:System.String"/> that represents the value of the Sec-WebSocket-Version header.
  5552. </value>
  5553. </member>
  5554. <member name="P:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext.ServerEndPoint">
  5555. <summary>
  5556. Gets the server endpoint as an IP address and a port number.
  5557. </summary>
  5558. <value>
  5559. A <see cref="T:System.Net.IPEndPoint"/> that represents the server endpoint.
  5560. </value>
  5561. </member>
  5562. <member name="P:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext.User">
  5563. <summary>
  5564. Gets the client information (identity, authentication, and security roles).
  5565. </summary>
  5566. <value>
  5567. A <see cref="T:System.Security.Principal.IPrincipal"/> instance that represents the client information.
  5568. </value>
  5569. </member>
  5570. <member name="P:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext.UserEndPoint">
  5571. <summary>
  5572. Gets the client endpoint as an IP address and a port number.
  5573. </summary>
  5574. <value>
  5575. A <see cref="T:System.Net.IPEndPoint"/> that represents the client endpoint.
  5576. </value>
  5577. </member>
  5578. <member name="P:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext.WebSocket">
  5579. <summary>
  5580. Gets the <see cref="T:WebSocketSharp.WebSocket"/> instance used for
  5581. two-way communication between client and server.
  5582. </summary>
  5583. <value>
  5584. A <see cref="T:WebSocketSharp.WebSocket"/>.
  5585. </value>
  5586. </member>
  5587. <member name="T:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext">
  5588. <summary>
  5589. Provides the properties used to access the information in
  5590. a WebSocket handshake request received by the <see cref="T:System.Net.Sockets.TcpListener"/>.
  5591. </summary>
  5592. </member>
  5593. <member name="M:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext.ToString">
  5594. <summary>
  5595. Returns a <see cref="T:System.String"/> that represents
  5596. the current <see cref="T:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext"/>.
  5597. </summary>
  5598. <returns>
  5599. A <see cref="T:System.String"/> that represents
  5600. the current <see cref="T:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext"/>.
  5601. </returns>
  5602. </member>
  5603. <member name="P:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext.CookieCollection">
  5604. <summary>
  5605. Gets the HTTP cookies included in the request.
  5606. </summary>
  5607. <value>
  5608. A <see cref="T:WebSocketSharp.Net.CookieCollection"/> that contains the cookies.
  5609. </value>
  5610. </member>
  5611. <member name="P:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext.Headers">
  5612. <summary>
  5613. Gets the HTTP headers included in the request.
  5614. </summary>
  5615. <value>
  5616. A <see cref="T:System.Collections.Specialized.NameValueCollection"/> that contains the headers.
  5617. </value>
  5618. </member>
  5619. <member name="P:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext.Host">
  5620. <summary>
  5621. Gets the value of the Host header included in the request.
  5622. </summary>
  5623. <value>
  5624. A <see cref="T:System.String"/> that represents the value of the Host header.
  5625. </value>
  5626. </member>
  5627. <member name="P:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext.IsAuthenticated">
  5628. <summary>
  5629. Gets a value indicating whether the client is authenticated.
  5630. </summary>
  5631. <value>
  5632. <c>true</c> if the client is authenticated; otherwise, <c>false</c>.
  5633. </value>
  5634. </member>
  5635. <member name="P:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext.IsLocal">
  5636. <summary>
  5637. Gets a value indicating whether the client connected from the local computer.
  5638. </summary>
  5639. <value>
  5640. <c>true</c> if the client connected from the local computer; otherwise, <c>false</c>.
  5641. </value>
  5642. </member>
  5643. <member name="P:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext.IsSecureConnection">
  5644. <summary>
  5645. Gets a value indicating whether the WebSocket connection is secured.
  5646. </summary>
  5647. <value>
  5648. <c>true</c> if the connection is secured; otherwise, <c>false</c>.
  5649. </value>
  5650. </member>
  5651. <member name="P:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext.IsWebSocketRequest">
  5652. <summary>
  5653. Gets a value indicating whether the request is a WebSocket handshake request.
  5654. </summary>
  5655. <value>
  5656. <c>true</c> if the request is a WebSocket handshake request; otherwise, <c>false</c>.
  5657. </value>
  5658. </member>
  5659. <member name="P:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext.Origin">
  5660. <summary>
  5661. Gets the value of the Origin header included in the request.
  5662. </summary>
  5663. <value>
  5664. A <see cref="T:System.String"/> that represents the value of the Origin header.
  5665. </value>
  5666. </member>
  5667. <member name="P:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext.QueryString">
  5668. <summary>
  5669. Gets the query string included in the request.
  5670. </summary>
  5671. <value>
  5672. A <see cref="T:System.Collections.Specialized.NameValueCollection"/> that contains the query string parameters.
  5673. </value>
  5674. </member>
  5675. <member name="P:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext.RequestUri">
  5676. <summary>
  5677. Gets the URI requested by the client.
  5678. </summary>
  5679. <value>
  5680. A <see cref="T:System.Uri"/> that represents the requested URI.
  5681. </value>
  5682. </member>
  5683. <member name="P:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext.SecWebSocketKey">
  5684. <summary>
  5685. Gets the value of the Sec-WebSocket-Key header included in the request.
  5686. </summary>
  5687. <remarks>
  5688. This property provides a part of the information used by the server to prove that
  5689. it received a valid WebSocket handshake request.
  5690. </remarks>
  5691. <value>
  5692. A <see cref="T:System.String"/> that represents the value of the Sec-WebSocket-Key header.
  5693. </value>
  5694. </member>
  5695. <member name="P:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext.SecWebSocketProtocols">
  5696. <summary>
  5697. Gets the values of the Sec-WebSocket-Protocol header included in the request.
  5698. </summary>
  5699. <remarks>
  5700. This property represents the subprotocols requested by the client.
  5701. </remarks>
  5702. <value>
  5703. An <see cref="T:System.Collections.Generic.IEnumerable{string}"/> instance that provides
  5704. an enumerator which supports the iteration over the values of the Sec-WebSocket-Protocol
  5705. header.
  5706. </value>
  5707. </member>
  5708. <member name="P:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext.SecWebSocketVersion">
  5709. <summary>
  5710. Gets the value of the Sec-WebSocket-Version header included in the request.
  5711. </summary>
  5712. <remarks>
  5713. This property represents the WebSocket protocol version.
  5714. </remarks>
  5715. <value>
  5716. A <see cref="T:System.String"/> that represents the value of the Sec-WebSocket-Version header.
  5717. </value>
  5718. </member>
  5719. <member name="P:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext.ServerEndPoint">
  5720. <summary>
  5721. Gets the server endpoint as an IP address and a port number.
  5722. </summary>
  5723. <value>
  5724. A <see cref="T:System.Net.IPEndPoint"/> that represents the server endpoint.
  5725. </value>
  5726. </member>
  5727. <member name="P:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext.User">
  5728. <summary>
  5729. Gets the client information (identity, authentication, and security roles).
  5730. </summary>
  5731. <value>
  5732. A <see cref="T:System.Security.Principal.IPrincipal"/> instance that represents the client information.
  5733. </value>
  5734. </member>
  5735. <member name="P:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext.UserEndPoint">
  5736. <summary>
  5737. Gets the client endpoint as an IP address and a port number.
  5738. </summary>
  5739. <value>
  5740. A <see cref="T:System.Net.IPEndPoint"/> that represents the client endpoint.
  5741. </value>
  5742. </member>
  5743. <member name="P:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext.WebSocket">
  5744. <summary>
  5745. Gets the <see cref="T:WebSocketSharp.WebSocket"/> instance used for
  5746. two-way communication between client and server.
  5747. </summary>
  5748. <value>
  5749. A <see cref="T:WebSocketSharp.WebSocket"/>.
  5750. </value>
  5751. </member>
  5752. <member name="T:WebSocketSharp.Server.HttpRequestEventArgs">
  5753. <summary>
  5754. Represents the event data for the HTTP request event that the <see cref="T:WebSocketSharp.Server.HttpServer"/> emits.
  5755. </summary>
  5756. <remarks>
  5757. <para>
  5758. An HTTP request event occurs when the <see cref="T:WebSocketSharp.Server.HttpServer"/> receives an HTTP request.
  5759. </para>
  5760. <para>
  5761. If you would like to get the request data sent from a client,
  5762. you should access the <see cref="P:WebSocketSharp.Server.HttpRequestEventArgs.Request"/> property.
  5763. </para>
  5764. <para>
  5765. And if you would like to get the response data used to return a response,
  5766. you should access the <see cref="P:WebSocketSharp.Server.HttpRequestEventArgs.Response"/> property.
  5767. </para>
  5768. </remarks>
  5769. </member>
  5770. <member name="P:WebSocketSharp.Server.HttpRequestEventArgs.Request">
  5771. <summary>
  5772. Gets the HTTP request data sent from a client.
  5773. </summary>
  5774. <value>
  5775. A <see cref="T:WebSocketSharp.Net.HttpListenerRequest"/> that represents the request data.
  5776. </value>
  5777. </member>
  5778. <member name="P:WebSocketSharp.Server.HttpRequestEventArgs.Response">
  5779. <summary>
  5780. Gets the HTTP response data used to return a response to the client.
  5781. </summary>
  5782. <value>
  5783. A <see cref="T:WebSocketSharp.Net.HttpListenerResponse"/> that represents the response data.
  5784. </value>
  5785. </member>
  5786. <member name="T:WebSocketSharp.CompressionMethod">
  5787. <summary>
  5788. Specifies the compression method used to compress a message on the WebSocket connection.
  5789. </summary>
  5790. <remarks>
  5791. The compression methods are defined in
  5792. <see href="http://tools.ietf.org/html/draft-ietf-hybi-permessage-compression-19">
  5793. Compression Extensions for WebSocket</see>.
  5794. </remarks>
  5795. </member>
  5796. <member name="F:WebSocketSharp.CompressionMethod.None">
  5797. <summary>
  5798. Specifies non compression.
  5799. </summary>
  5800. </member>
  5801. <member name="F:WebSocketSharp.CompressionMethod.Deflate">
  5802. <summary>
  5803. Specifies DEFLATE.
  5804. </summary>
  5805. </member>
  5806. <member name="T:WebSocketSharp.WebSocketException">
  5807. <summary>
  5808. The exception that is thrown when a <see cref="T:WebSocketSharp.WebSocket"/> gets a fatal error.
  5809. </summary>
  5810. </member>
  5811. <member name="P:WebSocketSharp.WebSocketException.Code">
  5812. <summary>
  5813. Gets the status code indicating the cause of the exception.
  5814. </summary>
  5815. <value>
  5816. One of the <see cref="T:WebSocketSharp.CloseStatusCode"/> enum values, represents the status code
  5817. indicating the cause of the exception.
  5818. </value>
  5819. </member>
  5820. <member name="T:WebSocketSharp.LogData">
  5821. <summary>
  5822. Represents a log data used by the <see cref="T:WebSocketSharp.Logger"/> class.
  5823. </summary>
  5824. </member>
  5825. <member name="M:WebSocketSharp.LogData.ToString">
  5826. <summary>
  5827. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:WebSocketSharp.LogData"/>.
  5828. </summary>
  5829. <returns>
  5830. A <see cref="T:System.String"/> that represents the current <see cref="T:WebSocketSharp.LogData"/>.
  5831. </returns>
  5832. </member>
  5833. <member name="P:WebSocketSharp.LogData.Caller">
  5834. <summary>
  5835. Gets the information of the logging method caller.
  5836. </summary>
  5837. <value>
  5838. A <see cref="T:System.Diagnostics.StackFrame"/> that provides the information of the logging method caller.
  5839. </value>
  5840. </member>
  5841. <member name="P:WebSocketSharp.LogData.Date">
  5842. <summary>
  5843. Gets the date and time when the log data was created.
  5844. </summary>
  5845. <value>
  5846. A <see cref="T:System.DateTime"/> that represents the date and time when the log data was created.
  5847. </value>
  5848. </member>
  5849. <member name="P:WebSocketSharp.LogData.Level">
  5850. <summary>
  5851. Gets the logging level of the log data.
  5852. </summary>
  5853. <value>
  5854. One of the <see cref="T:WebSocketSharp.LogLevel"/> enum values, indicates the logging level of the log data.
  5855. </value>
  5856. </member>
  5857. <member name="P:WebSocketSharp.LogData.Message">
  5858. <summary>
  5859. Gets the message of the log data.
  5860. </summary>
  5861. <value>
  5862. A <see cref="T:System.String"/> that represents the message of the log data.
  5863. </value>
  5864. </member>
  5865. <member name="T:WebSocketSharp.LogLevel">
  5866. <summary>
  5867. Specifies the logging level.
  5868. </summary>
  5869. </member>
  5870. <member name="F:WebSocketSharp.LogLevel.Trace">
  5871. <summary>
  5872. Specifies the bottom logging level.
  5873. </summary>
  5874. </member>
  5875. <member name="F:WebSocketSharp.LogLevel.Debug">
  5876. <summary>
  5877. Specifies the 2nd logging level from the bottom.
  5878. </summary>
  5879. </member>
  5880. <member name="F:WebSocketSharp.LogLevel.Info">
  5881. <summary>
  5882. Specifies the 3rd logging level from the bottom.
  5883. </summary>
  5884. </member>
  5885. <member name="F:WebSocketSharp.LogLevel.Warn">
  5886. <summary>
  5887. Specifies the 3rd logging level from the top.
  5888. </summary>
  5889. </member>
  5890. <member name="F:WebSocketSharp.LogLevel.Error">
  5891. <summary>
  5892. Specifies the 2nd logging level from the top.
  5893. </summary>
  5894. </member>
  5895. <member name="F:WebSocketSharp.LogLevel.Fatal">
  5896. <summary>
  5897. Specifies the top logging level.
  5898. </summary>
  5899. </member>
  5900. <member name="T:WebSocketSharp.Logger">
  5901. <summary>
  5902. Provides a set of methods and properties for logging.
  5903. </summary>
  5904. <remarks>
  5905. <para>
  5906. If you output a log with lower than the value of the <see cref="P:WebSocketSharp.Logger.Level"/> property,
  5907. it cannot be outputted.
  5908. </para>
  5909. <para>
  5910. The default output action writes a log to the standard output stream and the log file
  5911. if the <see cref="P:WebSocketSharp.Logger.File"/> property has a valid path to it.
  5912. </para>
  5913. <para>
  5914. If you would like to use the custom output action, you should set
  5915. the <see cref="P:WebSocketSharp.Logger.Output"/> property to any <c>Action&lt;LogData, string&gt;</c>
  5916. delegate.
  5917. </para>
  5918. </remarks>
  5919. </member>
  5920. <member name="M:WebSocketSharp.Logger.#ctor">
  5921. <summary>
  5922. Initializes a new instance of the <see cref="T:WebSocketSharp.Logger"/> class.
  5923. </summary>
  5924. <remarks>
  5925. This constructor initializes the current logging level with <see cref="F:WebSocketSharp.LogLevel.Error"/>.
  5926. </remarks>
  5927. </member>
  5928. <member name="M:WebSocketSharp.Logger.#ctor(WebSocketSharp.LogLevel)">
  5929. <summary>
  5930. Initializes a new instance of the <see cref="T:WebSocketSharp.Logger"/> class with
  5931. the specified logging <paramref name="level"/>.
  5932. </summary>
  5933. <param name="level">
  5934. One of the <see cref="T:WebSocketSharp.LogLevel"/> enum values.
  5935. </param>
  5936. </member>
  5937. <member name="M:WebSocketSharp.Logger.#ctor(WebSocketSharp.LogLevel,System.String,System.Action{WebSocketSharp.LogData,System.String})">
  5938. <summary>
  5939. Initializes a new instance of the <see cref="T:WebSocketSharp.Logger"/> class with
  5940. the specified logging <paramref name="level"/>, path to the log <paramref name="file"/>,
  5941. and <paramref name="output"/> action.
  5942. </summary>
  5943. <param name="level">
  5944. One of the <see cref="T:WebSocketSharp.LogLevel"/> enum values.
  5945. </param>
  5946. <param name="file">
  5947. A <see cref="T:System.String"/> that represents the path to the log file.
  5948. </param>
  5949. <param name="output">
  5950. An <c>Action&lt;LogData, string&gt;</c> delegate that references the method(s) used to
  5951. output a log. A <see cref="T:System.String"/> parameter passed to this delegate is
  5952. <paramref name="file"/>.
  5953. </param>
  5954. </member>
  5955. <member name="M:WebSocketSharp.Logger.Debug(System.String)">
  5956. <summary>
  5957. Outputs <paramref name="message"/> as a log with <see cref="F:WebSocketSharp.LogLevel.Debug"/>.
  5958. </summary>
  5959. <remarks>
  5960. If the current logging level is higher than <see cref="F:WebSocketSharp.LogLevel.Debug"/>,
  5961. this method doesn't output <paramref name="message"/> as a log.
  5962. </remarks>
  5963. <param name="message">
  5964. A <see cref="T:System.String"/> that represents the message to output as a log.
  5965. </param>
  5966. </member>
  5967. <member name="M:WebSocketSharp.Logger.Error(System.String)">
  5968. <summary>
  5969. Outputs <paramref name="message"/> as a log with <see cref="F:WebSocketSharp.LogLevel.Error"/>.
  5970. </summary>
  5971. <remarks>
  5972. If the current logging level is higher than <see cref="F:WebSocketSharp.LogLevel.Error"/>,
  5973. this method doesn't output <paramref name="message"/> as a log.
  5974. </remarks>
  5975. <param name="message">
  5976. A <see cref="T:System.String"/> that represents the message to output as a log.
  5977. </param>
  5978. </member>
  5979. <member name="M:WebSocketSharp.Logger.Fatal(System.String)">
  5980. <summary>
  5981. Outputs <paramref name="message"/> as a log with <see cref="F:WebSocketSharp.LogLevel.Fatal"/>.
  5982. </summary>
  5983. <param name="message">
  5984. A <see cref="T:System.String"/> that represents the message to output as a log.
  5985. </param>
  5986. </member>
  5987. <member name="M:WebSocketSharp.Logger.Info(System.String)">
  5988. <summary>
  5989. Outputs <paramref name="message"/> as a log with <see cref="F:WebSocketSharp.LogLevel.Info"/>.
  5990. </summary>
  5991. <remarks>
  5992. If the current logging level is higher than <see cref="F:WebSocketSharp.LogLevel.Info"/>,
  5993. this method doesn't output <paramref name="message"/> as a log.
  5994. </remarks>
  5995. <param name="message">
  5996. A <see cref="T:System.String"/> that represents the message to output as a log.
  5997. </param>
  5998. </member>
  5999. <member name="M:WebSocketSharp.Logger.Trace(System.String)">
  6000. <summary>
  6001. Outputs <paramref name="message"/> as a log with <see cref="F:WebSocketSharp.LogLevel.Trace"/>.
  6002. </summary>
  6003. <remarks>
  6004. If the current logging level is higher than <see cref="F:WebSocketSharp.LogLevel.Trace"/>,
  6005. this method doesn't output <paramref name="message"/> as a log.
  6006. </remarks>
  6007. <param name="message">
  6008. A <see cref="T:System.String"/> that represents the message to output as a log.
  6009. </param>
  6010. </member>
  6011. <member name="M:WebSocketSharp.Logger.Warn(System.String)">
  6012. <summary>
  6013. Outputs <paramref name="message"/> as a log with <see cref="F:WebSocketSharp.LogLevel.Warn"/>.
  6014. </summary>
  6015. <remarks>
  6016. If the current logging level is higher than <see cref="F:WebSocketSharp.LogLevel.Warn"/>,
  6017. this method doesn't output <paramref name="message"/> as a log.
  6018. </remarks>
  6019. <param name="message">
  6020. A <see cref="T:System.String"/> that represents the message to output as a log.
  6021. </param>
  6022. </member>
  6023. <member name="P:WebSocketSharp.Logger.File">
  6024. <summary>
  6025. Gets or sets the current path to the log file.
  6026. </summary>
  6027. <value>
  6028. A <see cref="T:System.String"/> that represents the current path to the log file if any.
  6029. </value>
  6030. </member>
  6031. <member name="P:WebSocketSharp.Logger.Level">
  6032. <summary>
  6033. Gets or sets the current logging level.
  6034. </summary>
  6035. <remarks>
  6036. A log with lower than the value of this property cannot be outputted.
  6037. </remarks>
  6038. <value>
  6039. One of the <see cref="T:WebSocketSharp.LogLevel"/> enum values, specifies the current logging level.
  6040. </value>
  6041. </member>
  6042. <member name="P:WebSocketSharp.Logger.Output">
  6043. <summary>
  6044. Gets or sets the current output action used to output a log.
  6045. </summary>
  6046. <value>
  6047. <para>
  6048. An <c>Action&lt;LogData, string&gt;</c> delegate that references the method(s) used to
  6049. output a log. A <see cref="T:System.String"/> parameter passed to this delegate is the value of
  6050. the <see cref="P:WebSocketSharp.Logger.File"/> property.
  6051. </para>
  6052. <para>
  6053. If the value to set is <see langword="null"/>, the current output action is changed to
  6054. the default output action.
  6055. </para>
  6056. </value>
  6057. </member>
  6058. <member name="T:WebSocketSharp.WebSocketState">
  6059. <summary>
  6060. Indicates the state of a WebSocket connection.
  6061. </summary>
  6062. <remarks>
  6063. The values of this enumeration are defined in
  6064. <see href="http://www.w3.org/TR/websockets/#dom-websocket-readystate">The WebSocket API</see>.
  6065. </remarks>
  6066. </member>
  6067. <member name="F:WebSocketSharp.WebSocketState.Connecting">
  6068. <summary>
  6069. Equivalent to numeric value 0. Indicates that the connection hasn't yet been established.
  6070. </summary>
  6071. </member>
  6072. <member name="F:WebSocketSharp.WebSocketState.Open">
  6073. <summary>
  6074. Equivalent to numeric value 1. Indicates that the connection has been established,
  6075. and the communication is possible.
  6076. </summary>
  6077. </member>
  6078. <member name="F:WebSocketSharp.WebSocketState.Closing">
  6079. <summary>
  6080. Equivalent to numeric value 2. Indicates that the connection is going through
  6081. the closing handshake, or the <c>WebSocket.Close</c> method has been invoked.
  6082. </summary>
  6083. </member>
  6084. <member name="F:WebSocketSharp.WebSocketState.Closed">
  6085. <summary>
  6086. Equivalent to numeric value 3. Indicates that the connection has been closed or
  6087. couldn't be established.
  6088. </summary>
  6089. </member>
  6090. <member name="T:WebSocketSharp.Server.IWebSocketSession">
  6091. <summary>
  6092. Exposes the properties used to access the information in a session in a WebSocket service.
  6093. </summary>
  6094. </member>
  6095. <member name="P:WebSocketSharp.Server.IWebSocketSession.Context">
  6096. <summary>
  6097. Gets the information in the connection request to the WebSocket service.
  6098. </summary>
  6099. <value>
  6100. A <see cref="T:WebSocketSharp.Net.WebSockets.WebSocketContext"/> that provides the access to the connection request.
  6101. </value>
  6102. </member>
  6103. <member name="P:WebSocketSharp.Server.IWebSocketSession.ID">
  6104. <summary>
  6105. Gets the unique ID of the session.
  6106. </summary>
  6107. <value>
  6108. A <see cref="T:System.String"/> that represents the unique ID of the session.
  6109. </value>
  6110. </member>
  6111. <member name="P:WebSocketSharp.Server.IWebSocketSession.Protocol">
  6112. <summary>
  6113. Gets the WebSocket subprotocol used in the session.
  6114. </summary>
  6115. <value>
  6116. A <see cref="T:System.String"/> that represents the subprotocol if any.
  6117. </value>
  6118. </member>
  6119. <member name="P:WebSocketSharp.Server.IWebSocketSession.StartTime">
  6120. <summary>
  6121. Gets the time that the session has started.
  6122. </summary>
  6123. <value>
  6124. A <see cref="T:System.DateTime"/> that represents the time that the session has started.
  6125. </value>
  6126. </member>
  6127. <member name="P:WebSocketSharp.Server.IWebSocketSession.State">
  6128. <summary>
  6129. Gets the state of the <see cref="T:WebSocketSharp.WebSocket"/> used in the session.
  6130. </summary>
  6131. <value>
  6132. One of the <see cref="T:WebSocketSharp.WebSocketState"/> enum values, indicates the state of
  6133. the <see cref="T:WebSocketSharp.WebSocket"/> used in the session.
  6134. </value>
  6135. </member>
  6136. <member name="T:WebSocketSharp.Server.WebSocketSessionManager">
  6137. <summary>
  6138. Manages the sessions in a Websocket service.
  6139. </summary>
  6140. </member>
  6141. <member name="M:WebSocketSharp.Server.WebSocketSessionManager.Broadcast(System.Byte[])">
  6142. <summary>
  6143. Sends binary <paramref name="data"/> to every client in the WebSocket service.
  6144. </summary>
  6145. <param name="data">
  6146. An array of <see cref="T:System.Byte"/> that represents the binary data to send.
  6147. </param>
  6148. </member>
  6149. <member name="M:WebSocketSharp.Server.WebSocketSessionManager.Broadcast(System.String)">
  6150. <summary>
  6151. Sends text <paramref name="data"/> to every client in the WebSocket service.
  6152. </summary>
  6153. <param name="data">
  6154. A <see cref="T:System.String"/> that represents the text data to send.
  6155. </param>
  6156. </member>
  6157. <member name="M:WebSocketSharp.Server.WebSocketSessionManager.BroadcastAsync(System.Byte[],System.Action)">
  6158. <summary>
  6159. Sends binary <paramref name="data"/> asynchronously to every client in
  6160. the WebSocket service.
  6161. </summary>
  6162. <remarks>
  6163. This method doesn't wait for the send to be complete.
  6164. </remarks>
  6165. <param name="data">
  6166. An array of <see cref="T:System.Byte"/> that represents the binary data to send.
  6167. </param>
  6168. <param name="completed">
  6169. An <see cref="T:System.Action"/> delegate that references the method(s) called when
  6170. the send is complete.
  6171. </param>
  6172. </member>
  6173. <member name="M:WebSocketSharp.Server.WebSocketSessionManager.BroadcastAsync(System.String,System.Action)">
  6174. <summary>
  6175. Sends text <paramref name="data"/> asynchronously to every client in
  6176. the WebSocket service.
  6177. </summary>
  6178. <remarks>
  6179. This method doesn't wait for the send to be complete.
  6180. </remarks>
  6181. <param name="data">
  6182. A <see cref="T:System.String"/> that represents the text data to send.
  6183. </param>
  6184. <param name="completed">
  6185. An <see cref="T:System.Action"/> delegate that references the method(s) called when
  6186. the send is complete.
  6187. </param>
  6188. </member>
  6189. <member name="M:WebSocketSharp.Server.WebSocketSessionManager.BroadcastAsync(System.IO.Stream,System.Int32,System.Action)">
  6190. <summary>
  6191. Sends binary data from the specified <see cref="T:System.IO.Stream"/> asynchronously to
  6192. every client in the WebSocket service.
  6193. </summary>
  6194. <remarks>
  6195. This method doesn't wait for the send to be complete.
  6196. </remarks>
  6197. <param name="stream">
  6198. A <see cref="T:System.IO.Stream"/> from which contains the binary data to send.
  6199. </param>
  6200. <param name="length">
  6201. An <see cref="T:System.Int32"/> that represents the number of bytes to send.
  6202. </param>
  6203. <param name="completed">
  6204. An <see cref="T:System.Action"/> delegate that references the method(s) called when
  6205. the send is complete.
  6206. </param>
  6207. </member>
  6208. <member name="M:WebSocketSharp.Server.WebSocketSessionManager.Broadping">
  6209. <summary>
  6210. Sends a Ping to every client in the WebSocket service.
  6211. </summary>
  6212. <returns>
  6213. A <c>Dictionary&lt;string, bool&gt;</c> that contains a collection of pairs of
  6214. a session ID and a value indicating whether the manager received a Pong from
  6215. each client in a time.
  6216. </returns>
  6217. </member>
  6218. <member name="M:WebSocketSharp.Server.WebSocketSessionManager.Broadping(System.String)">
  6219. <summary>
  6220. Sends a Ping with the specified <paramref name="message"/> to every client in
  6221. the WebSocket service.
  6222. </summary>
  6223. <returns>
  6224. A <c>Dictionary&lt;string, bool&gt;</c> that contains a collection of pairs of
  6225. a session ID and a value indicating whether the manager received a Pong from
  6226. each client in a time.
  6227. </returns>
  6228. <param name="message">
  6229. A <see cref="T:System.String"/> that represents the message to send.
  6230. </param>
  6231. </member>
  6232. <member name="M:WebSocketSharp.Server.WebSocketSessionManager.CloseSession(System.String)">
  6233. <summary>
  6234. Closes the session with the specified <paramref name="id"/>.
  6235. </summary>
  6236. <param name="id">
  6237. A <see cref="T:System.String"/> that represents the ID of the session to close.
  6238. </param>
  6239. </member>
  6240. <member name="M:WebSocketSharp.Server.WebSocketSessionManager.CloseSession(System.String,System.UInt16,System.String)">
  6241. <summary>
  6242. Closes the session with the specified <paramref name="id"/>, <paramref name="code"/>,
  6243. and <paramref name="reason"/>.
  6244. </summary>
  6245. <param name="id">
  6246. A <see cref="T:System.String"/> that represents the ID of the session to close.
  6247. </param>
  6248. <param name="code">
  6249. A <see cref="T:System.UInt16"/> that represents the status code indicating the reason for the close.
  6250. </param>
  6251. <param name="reason">
  6252. A <see cref="T:System.String"/> that represents the reason for the close.
  6253. </param>
  6254. </member>
  6255. <member name="M:WebSocketSharp.Server.WebSocketSessionManager.CloseSession(System.String,WebSocketSharp.CloseStatusCode,System.String)">
  6256. <summary>
  6257. Closes the session with the specified <paramref name="id"/>, <paramref name="code"/>,
  6258. and <paramref name="reason"/>.
  6259. </summary>
  6260. <param name="id">
  6261. A <see cref="T:System.String"/> that represents the ID of the session to close.
  6262. </param>
  6263. <param name="code">
  6264. One of the <see cref="T:WebSocketSharp.CloseStatusCode"/> enum values, represents the status code
  6265. indicating the reason for the close.
  6266. </param>
  6267. <param name="reason">
  6268. A <see cref="T:System.String"/> that represents the reason for the close.
  6269. </param>
  6270. </member>
  6271. <member name="M:WebSocketSharp.Server.WebSocketSessionManager.PingTo(System.String)">
  6272. <summary>
  6273. Sends a Ping to the client on the session with the specified <paramref name="id"/>.
  6274. </summary>
  6275. <returns>
  6276. <c>true</c> if the manager receives a Pong from the client in a time;
  6277. otherwise, <c>false</c>.
  6278. </returns>
  6279. <param name="id">
  6280. A <see cref="T:System.String"/> that represents the ID of the session to find.
  6281. </param>
  6282. </member>
  6283. <member name="M:WebSocketSharp.Server.WebSocketSessionManager.PingTo(System.String,System.String)">
  6284. <summary>
  6285. Sends a Ping with the specified <paramref name="message"/> to the client on
  6286. the session with the specified <paramref name="id"/>.
  6287. </summary>
  6288. <returns>
  6289. <c>true</c> if the manager receives a Pong from the client in a time;
  6290. otherwise, <c>false</c>.
  6291. </returns>
  6292. <param name="message">
  6293. A <see cref="T:System.String"/> that represents the message to send.
  6294. </param>
  6295. <param name="id">
  6296. A <see cref="T:System.String"/> that represents the ID of the session to find.
  6297. </param>
  6298. </member>
  6299. <member name="M:WebSocketSharp.Server.WebSocketSessionManager.SendTo(System.Byte[],System.String)">
  6300. <summary>
  6301. Sends binary <paramref name="data"/> to the client on the session with
  6302. the specified <paramref name="id"/>.
  6303. </summary>
  6304. <param name="data">
  6305. An array of <see cref="T:System.Byte"/> that represents the binary data to send.
  6306. </param>
  6307. <param name="id">
  6308. A <see cref="T:System.String"/> that represents the ID of the session to find.
  6309. </param>
  6310. </member>
  6311. <member name="M:WebSocketSharp.Server.WebSocketSessionManager.SendTo(System.String,System.String)">
  6312. <summary>
  6313. Sends text <paramref name="data"/> to the client on the session with
  6314. the specified <paramref name="id"/>.
  6315. </summary>
  6316. <param name="data">
  6317. A <see cref="T:System.String"/> that represents the text data to send.
  6318. </param>
  6319. <param name="id">
  6320. A <see cref="T:System.String"/> that represents the ID of the session to find.
  6321. </param>
  6322. </member>
  6323. <member name="M:WebSocketSharp.Server.WebSocketSessionManager.SendToAsync(System.Byte[],System.String,System.Action{System.Boolean})">
  6324. <summary>
  6325. Sends binary <paramref name="data"/> asynchronously to the client on
  6326. the session with the specified <paramref name="id"/>.
  6327. </summary>
  6328. <remarks>
  6329. This method doesn't wait for the send to be complete.
  6330. </remarks>
  6331. <param name="data">
  6332. An array of <see cref="T:System.Byte"/> that represents the binary data to send.
  6333. </param>
  6334. <param name="id">
  6335. A <see cref="T:System.String"/> that represents the ID of the session to find.
  6336. </param>
  6337. <param name="completed">
  6338. An <c>Action&lt;bool&gt;</c> delegate that references the method(s) called when
  6339. the send is complete. A <see cref="T:System.Boolean"/> passed to this delegate is <c>true</c>
  6340. if the send is complete successfully.
  6341. </param>
  6342. </member>
  6343. <member name="M:WebSocketSharp.Server.WebSocketSessionManager.SendToAsync(System.String,System.String,System.Action{System.Boolean})">
  6344. <summary>
  6345. Sends text <paramref name="data"/> asynchronously to the client on
  6346. the session with the specified <paramref name="id"/>.
  6347. </summary>
  6348. <remarks>
  6349. This method doesn't wait for the send to be complete.
  6350. </remarks>
  6351. <param name="data">
  6352. A <see cref="T:System.String"/> that represents the text data to send.
  6353. </param>
  6354. <param name="id">
  6355. A <see cref="T:System.String"/> that represents the ID of the session to find.
  6356. </param>
  6357. <param name="completed">
  6358. An <c>Action&lt;bool&gt;</c> delegate that references the method(s) called when
  6359. the send is complete. A <see cref="T:System.Boolean"/> passed to this delegate is <c>true</c>
  6360. if the send is complete successfully.
  6361. </param>
  6362. </member>
  6363. <member name="M:WebSocketSharp.Server.WebSocketSessionManager.SendToAsync(System.IO.Stream,System.Int32,System.String,System.Action{System.Boolean})">
  6364. <summary>
  6365. Sends binary data from the specified <see cref="T:System.IO.Stream"/> asynchronously to
  6366. the client on the session with the specified <paramref name="id"/>.
  6367. </summary>
  6368. <remarks>
  6369. This method doesn't wait for the send to be complete.
  6370. </remarks>
  6371. <param name="stream">
  6372. A <see cref="T:System.IO.Stream"/> from which contains the binary data to send.
  6373. </param>
  6374. <param name="length">
  6375. An <see cref="T:System.Int32"/> that represents the number of bytes to send.
  6376. </param>
  6377. <param name="id">
  6378. A <see cref="T:System.String"/> that represents the ID of the session to find.
  6379. </param>
  6380. <param name="completed">
  6381. An <c>Action&lt;bool&gt;</c> delegate that references the method(s) called when
  6382. the send is complete. A <see cref="T:System.Boolean"/> passed to this delegate is <c>true</c>
  6383. if the send is complete successfully.
  6384. </param>
  6385. </member>
  6386. <member name="M:WebSocketSharp.Server.WebSocketSessionManager.Sweep">
  6387. <summary>
  6388. Cleans up the inactive sessions in the WebSocket service.
  6389. </summary>
  6390. </member>
  6391. <member name="M:WebSocketSharp.Server.WebSocketSessionManager.TryGetSession(System.String,WebSocketSharp.Server.IWebSocketSession@)">
  6392. <summary>
  6393. Tries to get the session with the specified <paramref name="id"/>.
  6394. </summary>
  6395. <returns>
  6396. <c>true</c> if the session is successfully found; otherwise, <c>false</c>.
  6397. </returns>
  6398. <param name="id">
  6399. A <see cref="T:System.String"/> that represents the ID of the session to find.
  6400. </param>
  6401. <param name="session">
  6402. When this method returns, a <see cref="T:WebSocketSharp.Server.IWebSocketSession"/> instance that
  6403. provides the access to the information in the session, or <see langword="null"/>
  6404. if it's not found. This parameter is passed uninitialized.
  6405. </param>
  6406. </member>
  6407. <member name="P:WebSocketSharp.Server.WebSocketSessionManager.ActiveIDs">
  6408. <summary>
  6409. Gets the IDs for the active sessions in the Websocket service.
  6410. </summary>
  6411. <value>
  6412. An <c>IEnumerable&lt;string&gt;</c> instance that provides an enumerator which
  6413. supports the iteration over the collection of the IDs for the active sessions.
  6414. </value>
  6415. </member>
  6416. <member name="P:WebSocketSharp.Server.WebSocketSessionManager.Count">
  6417. <summary>
  6418. Gets the number of the sessions in the Websocket service.
  6419. </summary>
  6420. <value>
  6421. An <see cref="T:System.Int32"/> that represents the number of the sessions.
  6422. </value>
  6423. </member>
  6424. <member name="P:WebSocketSharp.Server.WebSocketSessionManager.IDs">
  6425. <summary>
  6426. Gets the IDs for the sessions in the Websocket service.
  6427. </summary>
  6428. <value>
  6429. An <c>IEnumerable&lt;string&gt;</c> instance that provides an enumerator which
  6430. supports the iteration over the collection of the IDs for the sessions.
  6431. </value>
  6432. </member>
  6433. <member name="P:WebSocketSharp.Server.WebSocketSessionManager.InactiveIDs">
  6434. <summary>
  6435. Gets the IDs for the inactive sessions in the Websocket service.
  6436. </summary>
  6437. <value>
  6438. An <c>IEnumerable&lt;string&gt;</c> instance that provides an enumerator which
  6439. supports the iteration over the collection of the IDs for the inactive sessions.
  6440. </value>
  6441. </member>
  6442. <member name="P:WebSocketSharp.Server.WebSocketSessionManager.Item(System.String)">
  6443. <summary>
  6444. Gets the session with the specified <paramref name="id"/>.
  6445. </summary>
  6446. <value>
  6447. A <see cref="T:WebSocketSharp.Server.IWebSocketSession"/> instance that provides the access to
  6448. the information in the session, or <see langword="null"/> if it's not found.
  6449. </value>
  6450. <param name="id">
  6451. A <see cref="T:System.String"/> that represents the ID of the session to find.
  6452. </param>
  6453. </member>
  6454. <member name="P:WebSocketSharp.Server.WebSocketSessionManager.KeepClean">
  6455. <summary>
  6456. Gets a value indicating whether the manager cleans up the inactive sessions in
  6457. the WebSocket service periodically.
  6458. </summary>
  6459. <value>
  6460. <c>true</c> if the manager cleans up the inactive sessions every 60 seconds;
  6461. otherwise, <c>false</c>.
  6462. </value>
  6463. </member>
  6464. <member name="P:WebSocketSharp.Server.WebSocketSessionManager.Sessions">
  6465. <summary>
  6466. Gets the sessions in the Websocket service.
  6467. </summary>
  6468. <value>
  6469. An <c>IEnumerable&lt;IWebSocketSession&gt;</c> instance that provides an enumerator
  6470. which supports the iteration over the collection of the sessions in the service.
  6471. </value>
  6472. </member>
  6473. <member name="P:WebSocketSharp.Server.WebSocketSessionManager.WaitTime">
  6474. <summary>
  6475. Gets the wait time for the response to the WebSocket Ping or Close.
  6476. </summary>
  6477. <value>
  6478. A <see cref="T:System.TimeSpan"/> that represents the wait time.
  6479. </value>
  6480. </member>
  6481. <member name="T:WebSocketSharp.Net.HttpBasicIdentity">
  6482. <summary>
  6483. Holds the user name and password from the HTTP Basic authentication credentials.
  6484. </summary>
  6485. </member>
  6486. <member name="P:WebSocketSharp.Net.HttpBasicIdentity.Password">
  6487. <summary>
  6488. Gets the password from the HTTP Basic authentication credentials.
  6489. </summary>
  6490. <value>
  6491. A <see cref="T:System.String"/> that represents the password.
  6492. </value>
  6493. </member>
  6494. <member name="T:WebSocketSharp.Net.HttpDigestIdentity">
  6495. <summary>
  6496. Holds the user name and other parameters from the HTTP Digest authentication credentials.
  6497. </summary>
  6498. </member>
  6499. <member name="P:WebSocketSharp.Net.HttpDigestIdentity.Algorithm">
  6500. <summary>
  6501. Gets the algorithm parameter from the HTTP Digest authentication credentials.
  6502. </summary>
  6503. <value>
  6504. A <see cref="T:System.String"/> that represents the algorithm parameter.
  6505. </value>
  6506. </member>
  6507. <member name="P:WebSocketSharp.Net.HttpDigestIdentity.Cnonce">
  6508. <summary>
  6509. Gets the cnonce parameter from the HTTP Digest authentication credentials.
  6510. </summary>
  6511. <value>
  6512. A <see cref="T:System.String"/> that represents the cnonce parameter.
  6513. </value>
  6514. </member>
  6515. <member name="P:WebSocketSharp.Net.HttpDigestIdentity.Nc">
  6516. <summary>
  6517. Gets the nc parameter from the HTTP Digest authentication credentials.
  6518. </summary>
  6519. <value>
  6520. A <see cref="T:System.String"/> that represents the nc parameter.
  6521. </value>
  6522. </member>
  6523. <member name="P:WebSocketSharp.Net.HttpDigestIdentity.Nonce">
  6524. <summary>
  6525. Gets the nonce parameter from the HTTP Digest authentication credentials.
  6526. </summary>
  6527. <value>
  6528. A <see cref="T:System.String"/> that represents the nonce parameter.
  6529. </value>
  6530. </member>
  6531. <member name="P:WebSocketSharp.Net.HttpDigestIdentity.Opaque">
  6532. <summary>
  6533. Gets the opaque parameter from the HTTP Digest authentication credentials.
  6534. </summary>
  6535. <value>
  6536. A <see cref="T:System.String"/> that represents the opaque parameter.
  6537. </value>
  6538. </member>
  6539. <member name="P:WebSocketSharp.Net.HttpDigestIdentity.Qop">
  6540. <summary>
  6541. Gets the qop parameter from the HTTP Digest authentication credentials.
  6542. </summary>
  6543. <value>
  6544. A <see cref="T:System.String"/> that represents the qop parameter.
  6545. </value>
  6546. </member>
  6547. <member name="P:WebSocketSharp.Net.HttpDigestIdentity.Realm">
  6548. <summary>
  6549. Gets the realm parameter from the HTTP Digest authentication credentials.
  6550. </summary>
  6551. <value>
  6552. A <see cref="T:System.String"/> that represents the realm parameter.
  6553. </value>
  6554. </member>
  6555. <member name="P:WebSocketSharp.Net.HttpDigestIdentity.Response">
  6556. <summary>
  6557. Gets the response parameter from the HTTP Digest authentication credentials.
  6558. </summary>
  6559. <value>
  6560. A <see cref="T:System.String"/> that represents the response parameter.
  6561. </value>
  6562. </member>
  6563. <member name="P:WebSocketSharp.Net.HttpDigestIdentity.Uri">
  6564. <summary>
  6565. Gets the uri parameter from the HTTP Digest authentication credentials.
  6566. </summary>
  6567. <value>
  6568. A <see cref="T:System.String"/> that represents the uri parameter.
  6569. </value>
  6570. </member>
  6571. <member name="T:WebSocketSharp.Net.NetworkCredential">
  6572. <summary>
  6573. Provides the credentials for the HTTP authentication (Basic/Digest).
  6574. </summary>
  6575. </member>
  6576. <member name="M:WebSocketSharp.Net.NetworkCredential.#ctor(System.String,System.String)">
  6577. <summary>
  6578. Initializes a new instance of the <see cref="T:WebSocketSharp.Net.NetworkCredential"/> class with
  6579. the specified user name and password.
  6580. </summary>
  6581. <param name="userName">
  6582. A <see cref="T:System.String"/> that represents the user name associated with the credentials.
  6583. </param>
  6584. <param name="password">
  6585. A <see cref="T:System.String"/> that represents the password for the user name associated with
  6586. the credentials.
  6587. </param>
  6588. <exception cref="T:System.ArgumentNullException">
  6589. <paramref name="userName"/> is <see langword="null"/>.
  6590. </exception>
  6591. <exception cref="T:System.ArgumentException">
  6592. <paramref name="userName"/> is empty.
  6593. </exception>
  6594. </member>
  6595. <member name="M:WebSocketSharp.Net.NetworkCredential.#ctor(System.String,System.String,System.String,System.String[])">
  6596. <summary>
  6597. Initializes a new instance of the <see cref="T:WebSocketSharp.Net.NetworkCredential"/> class with
  6598. the specified user name, password, domain, and roles.
  6599. </summary>
  6600. <param name="userName">
  6601. A <see cref="T:System.String"/> that represents the user name associated with the credentials.
  6602. </param>
  6603. <param name="password">
  6604. A <see cref="T:System.String"/> that represents the password for the user name associated with
  6605. the credentials.
  6606. </param>
  6607. <param name="domain">
  6608. A <see cref="T:System.String"/> that represents the name of the user domain associated with
  6609. the credentials.
  6610. </param>
  6611. <param name="roles">
  6612. An array of <see cref="T:System.String"/> that contains the role names to which
  6613. the user associated with the credentials belongs if any.
  6614. </param>
  6615. <exception cref="T:System.ArgumentNullException">
  6616. <paramref name="userName"/> is <see langword="null"/>.
  6617. </exception>
  6618. <exception cref="T:System.ArgumentException">
  6619. <paramref name="userName"/> is empty.
  6620. </exception>
  6621. </member>
  6622. <member name="P:WebSocketSharp.Net.NetworkCredential.Domain">
  6623. <summary>
  6624. Gets the name of the user domain associated with the credentials.
  6625. </summary>
  6626. <value>
  6627. A <see cref="T:System.String"/> that represents the name of the user domain associated with
  6628. the credentials.
  6629. </value>
  6630. </member>
  6631. <member name="P:WebSocketSharp.Net.NetworkCredential.Password">
  6632. <summary>
  6633. Gets the password for the user name associated with the credentials.
  6634. </summary>
  6635. <value>
  6636. A <see cref="T:System.String"/> that represents the password for the user name associated with
  6637. the credentials.
  6638. </value>
  6639. </member>
  6640. <member name="P:WebSocketSharp.Net.NetworkCredential.Roles">
  6641. <summary>
  6642. Gets the role names to which the user associated with the credentials belongs.
  6643. </summary>
  6644. <value>
  6645. An array of <see cref="T:System.String"/> that contains the role names to which
  6646. the user associated with the credentials belongs if any.
  6647. </value>
  6648. </member>
  6649. <member name="P:WebSocketSharp.Net.NetworkCredential.UserName">
  6650. <summary>
  6651. Gets the user name associated with the credentials.
  6652. </summary>
  6653. <value>
  6654. A <see cref="T:System.String"/> that represents the user name associated with the credentials.
  6655. </value>
  6656. </member>
  6657. <member name="T:WebSocketSharp.Server.WebSocketServiceManager">
  6658. <summary>
  6659. Manages the WebSocket services provided by the <see cref="T:WebSocketSharp.Server.HttpServer"/> or
  6660. <see cref="T:WebSocketSharp.Server.WebSocketServer"/>.
  6661. </summary>
  6662. </member>
  6663. <member name="M:WebSocketSharp.Server.WebSocketServiceManager.Broadcast(System.Byte[])">
  6664. <summary>
  6665. Sends binary <paramref name="data"/> to every client in the WebSocket services.
  6666. </summary>
  6667. <param name="data">
  6668. An array of <see cref="T:System.Byte"/> that represents the binary data to send.
  6669. </param>
  6670. </member>
  6671. <member name="M:WebSocketSharp.Server.WebSocketServiceManager.Broadcast(System.String)">
  6672. <summary>
  6673. Sends text <paramref name="data"/> to every client in the WebSocket services.
  6674. </summary>
  6675. <param name="data">
  6676. A <see cref="T:System.String"/> that represents the text data to send.
  6677. </param>
  6678. </member>
  6679. <member name="M:WebSocketSharp.Server.WebSocketServiceManager.BroadcastAsync(System.Byte[],System.Action)">
  6680. <summary>
  6681. Sends binary <paramref name="data"/> asynchronously to every client in
  6682. the WebSocket services.
  6683. </summary>
  6684. <remarks>
  6685. This method doesn't wait for the send to be complete.
  6686. </remarks>
  6687. <param name="data">
  6688. An array of <see cref="T:System.Byte"/> that represents the binary data to send.
  6689. </param>
  6690. <param name="completed">
  6691. An <see cref="T:System.Action"/> delegate that references the method(s) called when
  6692. the send is complete.
  6693. </param>
  6694. </member>
  6695. <member name="M:WebSocketSharp.Server.WebSocketServiceManager.BroadcastAsync(System.String,System.Action)">
  6696. <summary>
  6697. Sends text <paramref name="data"/> asynchronously to every client in
  6698. the WebSocket services.
  6699. </summary>
  6700. <remarks>
  6701. This method doesn't wait for the send to be complete.
  6702. </remarks>
  6703. <param name="data">
  6704. A <see cref="T:System.String"/> that represents the text data to send.
  6705. </param>
  6706. <param name="completed">
  6707. An <see cref="T:System.Action"/> delegate that references the method(s) called when
  6708. the send is complete.
  6709. </param>
  6710. </member>
  6711. <member name="M:WebSocketSharp.Server.WebSocketServiceManager.BroadcastAsync(System.IO.Stream,System.Int32,System.Action)">
  6712. <summary>
  6713. Sends binary data from the specified <see cref="T:System.IO.Stream"/> asynchronously to
  6714. every client in the WebSocket services.
  6715. </summary>
  6716. <remarks>
  6717. This method doesn't wait for the send to be complete.
  6718. </remarks>
  6719. <param name="stream">
  6720. A <see cref="T:System.IO.Stream"/> from which contains the binary data to send.
  6721. </param>
  6722. <param name="length">
  6723. An <see cref="T:System.Int32"/> that represents the number of bytes to send.
  6724. </param>
  6725. <param name="completed">
  6726. An <see cref="T:System.Action"/> delegate that references the method(s) called when
  6727. the send is complete.
  6728. </param>
  6729. </member>
  6730. <member name="M:WebSocketSharp.Server.WebSocketServiceManager.Broadping">
  6731. <summary>
  6732. Sends a Ping to every client in the WebSocket services.
  6733. </summary>
  6734. <returns>
  6735. A <c>Dictionary&lt;string, Dictionary&lt;string, bool&gt;&gt;</c> that contains
  6736. a collection of pairs of a service path and a collection of pairs of a session ID
  6737. and a value indicating whether the manager received a Pong from each client in a time,
  6738. or <see langword="null"/> if this method isn't available.
  6739. </returns>
  6740. </member>
  6741. <member name="M:WebSocketSharp.Server.WebSocketServiceManager.Broadping(System.String)">
  6742. <summary>
  6743. Sends a Ping with the specified <paramref name="message"/> to every client in
  6744. the WebSocket services.
  6745. </summary>
  6746. <returns>
  6747. A <c>Dictionary&lt;string, Dictionary&lt;string, bool&gt;&gt;</c> that contains
  6748. a collection of pairs of a service path and a collection of pairs of a session ID
  6749. and a value indicating whether the manager received a Pong from each client in a time,
  6750. or <see langword="null"/> if this method isn't available or <paramref name="message"/>
  6751. is invalid.
  6752. </returns>
  6753. <param name="message">
  6754. A <see cref="T:System.String"/> that represents the message to send.
  6755. </param>
  6756. </member>
  6757. <member name="M:WebSocketSharp.Server.WebSocketServiceManager.TryGetServiceHost(System.String,WebSocketSharp.Server.WebSocketServiceHost@)">
  6758. <summary>
  6759. Tries to get the WebSocket service host with the specified <paramref name="path"/>.
  6760. </summary>
  6761. <returns>
  6762. <c>true</c> if the service is successfully found; otherwise, <c>false</c>.
  6763. </returns>
  6764. <param name="path">
  6765. A <see cref="T:System.String"/> that represents the absolute path to the service to find.
  6766. </param>
  6767. <param name="host">
  6768. When this method returns, a <see cref="T:WebSocketSharp.Server.WebSocketServiceHost"/> instance that
  6769. provides the access to the information in the service, or <see langword="null"/>
  6770. if it's not found. This parameter is passed uninitialized.
  6771. </param>
  6772. </member>
  6773. <member name="P:WebSocketSharp.Server.WebSocketServiceManager.Count">
  6774. <summary>
  6775. Gets the number of the WebSocket services.
  6776. </summary>
  6777. <value>
  6778. An <see cref="T:System.Int32"/> that represents the number of the services.
  6779. </value>
  6780. </member>
  6781. <member name="P:WebSocketSharp.Server.WebSocketServiceManager.Hosts">
  6782. <summary>
  6783. Gets the host instances for the Websocket services.
  6784. </summary>
  6785. <value>
  6786. An <c>IEnumerable&lt;WebSocketServiceHost&gt;</c> instance that provides an enumerator
  6787. which supports the iteration over the collection of the host instances for the services.
  6788. </value>
  6789. </member>
  6790. <member name="P:WebSocketSharp.Server.WebSocketServiceManager.Item(System.String)">
  6791. <summary>
  6792. Gets the WebSocket service host with the specified <paramref name="path"/>.
  6793. </summary>
  6794. <value>
  6795. A <see cref="T:WebSocketSharp.Server.WebSocketServiceHost"/> instance that provides the access to
  6796. the information in the service, or <see langword="null"/> if it's not found.
  6797. </value>
  6798. <param name="path">
  6799. A <see cref="T:System.String"/> that represents the absolute path to the service to find.
  6800. </param>
  6801. </member>
  6802. <member name="P:WebSocketSharp.Server.WebSocketServiceManager.KeepClean">
  6803. <summary>
  6804. Gets a value indicating whether the manager cleans up the inactive sessions
  6805. in the WebSocket services periodically.
  6806. </summary>
  6807. <value>
  6808. <c>true</c> if the manager cleans up the inactive sessions every 60 seconds;
  6809. otherwise, <c>false</c>.
  6810. </value>
  6811. </member>
  6812. <member name="P:WebSocketSharp.Server.WebSocketServiceManager.Paths">
  6813. <summary>
  6814. Gets the paths for the WebSocket services.
  6815. </summary>
  6816. <value>
  6817. An <c>IEnumerable&lt;string&gt;</c> instance that provides an enumerator which supports
  6818. the iteration over the collection of the paths for the services.
  6819. </value>
  6820. </member>
  6821. <member name="P:WebSocketSharp.Server.WebSocketServiceManager.SessionCount">
  6822. <summary>
  6823. Gets the total number of the sessions in the WebSocket services.
  6824. </summary>
  6825. <value>
  6826. An <see cref="T:System.Int32"/> that represents the total number of the sessions in the services.
  6827. </value>
  6828. </member>
  6829. <member name="P:WebSocketSharp.Server.WebSocketServiceManager.WaitTime">
  6830. <summary>
  6831. Gets the wait time for the response to the WebSocket Ping or Close.
  6832. </summary>
  6833. <value>
  6834. A <see cref="T:System.TimeSpan"/> that represents the wait time.
  6835. </value>
  6836. </member>
  6837. <member name="F:WebSocketSharp.WebSocketFrame.EmptyPingBytes">
  6838. <summary>
  6839. Represents the ping frame without the payload data as an array of <see cref="T:System.Byte"/>.
  6840. </summary>
  6841. <remarks>
  6842. The value of this field is created from a non masked frame, so it can only be used to
  6843. send a ping from a server.
  6844. </remarks>
  6845. </member>
  6846. <member name="T:WebSocketSharp.Server.WebSocketBehavior">
  6847. <summary>
  6848. Exposes the methods and properties used to define the behavior of a WebSocket service
  6849. provided by the <see cref="T:WebSocketSharp.Server.WebSocketServer"/> or <see cref="T:WebSocketSharp.Server.HttpServer"/>.
  6850. </summary>
  6851. <remarks>
  6852. The WebSocketBehavior class is an abstract class.
  6853. </remarks>
  6854. </member>
  6855. <member name="M:WebSocketSharp.Server.WebSocketBehavior.#ctor">
  6856. <summary>
  6857. Initializes a new instance of the <see cref="T:WebSocketSharp.Server.WebSocketBehavior"/> class.
  6858. </summary>
  6859. </member>
  6860. <member name="M:WebSocketSharp.Server.WebSocketBehavior.Error(System.String,System.Exception)">
  6861. <summary>
  6862. Calls the <see cref="M:WebSocketSharp.Server.WebSocketBehavior.OnError(WebSocketSharp.ErrorEventArgs)"/> method with the specified <paramref name="message"/> and
  6863. <paramref name="exception"/>.
  6864. </summary>
  6865. <remarks>
  6866. This method doesn't call the <see cref="M:WebSocketSharp.Server.WebSocketBehavior.OnError(WebSocketSharp.ErrorEventArgs)"/> method if <paramref name="message"/> is
  6867. <see langword="null"/> or empty.
  6868. </remarks>
  6869. <param name="message">
  6870. A <see cref="T:System.String"/> that represents the error message.
  6871. </param>
  6872. <param name="exception">
  6873. An <see cref="T:System.Exception"/> instance that represents the cause of the error if any.
  6874. </param>
  6875. </member>
  6876. <member name="M:WebSocketSharp.Server.WebSocketBehavior.OnClose(WebSocketSharp.CloseEventArgs)">
  6877. <summary>
  6878. Called when the WebSocket connection used in a session has been closed.
  6879. </summary>
  6880. <param name="e">
  6881. A <see cref="T:WebSocketSharp.CloseEventArgs"/> that represents the event data passed to
  6882. a <see cref="E:WebSocketSharp.WebSocket.OnClose"/> event.
  6883. </param>
  6884. </member>
  6885. <member name="M:WebSocketSharp.Server.WebSocketBehavior.OnError(WebSocketSharp.ErrorEventArgs)">
  6886. <summary>
  6887. Called when the <see cref="T:WebSocketSharp.WebSocket"/> used in a session gets an error.
  6888. </summary>
  6889. <param name="e">
  6890. A <see cref="T:WebSocketSharp.ErrorEventArgs"/> that represents the event data passed to
  6891. a <see cref="E:WebSocketSharp.WebSocket.OnError"/> event.
  6892. </param>
  6893. </member>
  6894. <member name="M:WebSocketSharp.Server.WebSocketBehavior.OnMessage(WebSocketSharp.MessageEventArgs)">
  6895. <summary>
  6896. Called when the <see cref="T:WebSocketSharp.WebSocket"/> used in a session receives a message.
  6897. </summary>
  6898. <param name="e">
  6899. A <see cref="T:WebSocketSharp.MessageEventArgs"/> that represents the event data passed to
  6900. a <see cref="E:WebSocketSharp.WebSocket.OnMessage"/> event.
  6901. </param>
  6902. </member>
  6903. <member name="M:WebSocketSharp.Server.WebSocketBehavior.OnOpen">
  6904. <summary>
  6905. Called when the WebSocket connection used in a session has been established.
  6906. </summary>
  6907. </member>
  6908. <member name="M:WebSocketSharp.Server.WebSocketBehavior.Send(System.Byte[])">
  6909. <summary>
  6910. Sends binary <paramref name="data"/> to the client on a session.
  6911. </summary>
  6912. <remarks>
  6913. This method is available after the WebSocket connection has been established.
  6914. </remarks>
  6915. <param name="data">
  6916. An array of <see cref="T:System.Byte"/> that represents the binary data to send.
  6917. </param>
  6918. </member>
  6919. <member name="M:WebSocketSharp.Server.WebSocketBehavior.Send(System.IO.FileInfo)">
  6920. <summary>
  6921. Sends the specified <paramref name="file"/> as binary data to the client on a session.
  6922. </summary>
  6923. <remarks>
  6924. This method is available after the WebSocket connection has been established.
  6925. </remarks>
  6926. <param name="file">
  6927. A <see cref="T:System.IO.FileInfo"/> that represents the file to send.
  6928. </param>
  6929. </member>
  6930. <member name="M:WebSocketSharp.Server.WebSocketBehavior.Send(System.String)">
  6931. <summary>
  6932. Sends text <paramref name="data"/> to the client on a session.
  6933. </summary>
  6934. <remarks>
  6935. This method is available after the WebSocket connection has been established.
  6936. </remarks>
  6937. <param name="data">
  6938. A <see cref="T:System.String"/> that represents the text data to send.
  6939. </param>
  6940. </member>
  6941. <member name="M:WebSocketSharp.Server.WebSocketBehavior.SendAsync(System.Byte[],System.Action{System.Boolean})">
  6942. <summary>
  6943. Sends binary <paramref name="data"/> asynchronously to the client on a session.
  6944. </summary>
  6945. <remarks>
  6946. <para>
  6947. This method is available after the WebSocket connection has been established.
  6948. </para>
  6949. <para>
  6950. This method doesn't wait for the send to be complete.
  6951. </para>
  6952. </remarks>
  6953. <param name="data">
  6954. An array of <see cref="T:System.Byte"/> that represents the binary data to send.
  6955. </param>
  6956. <param name="completed">
  6957. An <c>Action&lt;bool&gt;</c> delegate that references the method(s) called when
  6958. the send is complete. A <see cref="T:System.Boolean"/> passed to this delegate is <c>true</c>
  6959. if the send is complete successfully.
  6960. </param>
  6961. </member>
  6962. <member name="M:WebSocketSharp.Server.WebSocketBehavior.SendAsync(System.IO.FileInfo,System.Action{System.Boolean})">
  6963. <summary>
  6964. Sends the specified <paramref name="file"/> as binary data asynchronously to
  6965. the client on a session.
  6966. </summary>
  6967. <remarks>
  6968. <para>
  6969. This method is available after the WebSocket connection has been established.
  6970. </para>
  6971. <para>
  6972. This method doesn't wait for the send to be complete.
  6973. </para>
  6974. </remarks>
  6975. <param name="file">
  6976. A <see cref="T:System.IO.FileInfo"/> that represents the file to send.
  6977. </param>
  6978. <param name="completed">
  6979. An <c>Action&lt;bool&gt;</c> delegate that references the method(s) called when
  6980. the send is complete. A <see cref="T:System.Boolean"/> passed to this delegate is <c>true</c>
  6981. if the send is complete successfully.
  6982. </param>
  6983. </member>
  6984. <member name="M:WebSocketSharp.Server.WebSocketBehavior.SendAsync(System.String,System.Action{System.Boolean})">
  6985. <summary>
  6986. Sends text <paramref name="data"/> asynchronously to the client on a session.
  6987. </summary>
  6988. <remarks>
  6989. <para>
  6990. This method is available after the WebSocket connection has been established.
  6991. </para>
  6992. <para>
  6993. This method doesn't wait for the send to be complete.
  6994. </para>
  6995. </remarks>
  6996. <param name="data">
  6997. A <see cref="T:System.String"/> that represents the text data to send.
  6998. </param>
  6999. <param name="completed">
  7000. An <c>Action&lt;bool&gt;</c> delegate that references the method(s) called when
  7001. the send is complete. A <see cref="T:System.Boolean"/> passed to this delegate is <c>true</c>
  7002. if the send is complete successfully.
  7003. </param>
  7004. </member>
  7005. <member name="M:WebSocketSharp.Server.WebSocketBehavior.SendAsync(System.IO.Stream,System.Int32,System.Action{System.Boolean})">
  7006. <summary>
  7007. Sends binary data from the specified <see cref="T:System.IO.Stream"/> asynchronously to
  7008. the client on a session.
  7009. </summary>
  7010. <remarks>
  7011. <para>
  7012. This method is available after the WebSocket connection has been established.
  7013. </para>
  7014. <para>
  7015. This method doesn't wait for the send to be complete.
  7016. </para>
  7017. </remarks>
  7018. <param name="stream">
  7019. A <see cref="T:System.IO.Stream"/> from which contains the binary data to send.
  7020. </param>
  7021. <param name="length">
  7022. An <see cref="T:System.Int32"/> that represents the number of bytes to send.
  7023. </param>
  7024. <param name="completed">
  7025. An <c>Action&lt;bool&gt;</c> delegate that references the method(s) called when
  7026. the send is complete. A <see cref="T:System.Boolean"/> passed to this delegate is <c>true</c>
  7027. if the send is complete successfully.
  7028. </param>
  7029. </member>
  7030. <member name="P:WebSocketSharp.Server.WebSocketBehavior.Log">
  7031. <summary>
  7032. Gets the logging functions.
  7033. </summary>
  7034. <value>
  7035. A <see cref="T:WebSocketSharp.Logger"/> that provides the logging functions,
  7036. or <see langword="null"/> if the WebSocket connection isn't established.
  7037. </value>
  7038. </member>
  7039. <member name="P:WebSocketSharp.Server.WebSocketBehavior.Sessions">
  7040. <summary>
  7041. Gets the access to the sessions in the WebSocket service.
  7042. </summary>
  7043. <value>
  7044. A <see cref="T:WebSocketSharp.Server.WebSocketSessionManager"/> that provides the access to the sessions,
  7045. or <see langword="null"/> if the WebSocket connection isn't established.
  7046. </value>
  7047. </member>
  7048. <member name="P:WebSocketSharp.Server.WebSocketBehavior.Context">
  7049. <summary>
  7050. Gets the information in a handshake request to the WebSocket service.
  7051. </summary>
  7052. <value>
  7053. A <see cref="T:WebSocketSharp.Net.WebSockets.WebSocketContext"/> instance that provides the access to the handshake request,
  7054. or <see langword="null"/> if the WebSocket connection isn't established.
  7055. </value>
  7056. </member>
  7057. <member name="P:WebSocketSharp.Server.WebSocketBehavior.CookiesValidator">
  7058. <summary>
  7059. Gets or sets the delegate called to validate the HTTP cookies included in
  7060. a handshake request to the WebSocket service.
  7061. </summary>
  7062. <remarks>
  7063. This delegate is called when the <see cref="T:WebSocketSharp.WebSocket"/> used in a session validates
  7064. the handshake request.
  7065. </remarks>
  7066. <value>
  7067. <para>
  7068. A <c>Func&lt;CookieCollection, CookieCollection, bool&gt;</c> delegate that references
  7069. the method(s) used to validate the cookies.
  7070. </para>
  7071. <para>
  7072. 1st <see cref="T:WebSocketSharp.Net.CookieCollection"/> parameter passed to this delegate contains
  7073. the cookies to validate if any.
  7074. </para>
  7075. <para>
  7076. 2nd <see cref="T:WebSocketSharp.Net.CookieCollection"/> parameter passed to this delegate receives
  7077. the cookies to send to the client.
  7078. </para>
  7079. <para>
  7080. This delegate should return <c>true</c> if the cookies are valid.
  7081. </para>
  7082. <para>
  7083. The default value is <see langword="null"/>, and it does nothing to validate.
  7084. </para>
  7085. </value>
  7086. </member>
  7087. <member name="P:WebSocketSharp.Server.WebSocketBehavior.EmitOnPing">
  7088. <summary>
  7089. Gets or sets a value indicating whether the <see cref="T:WebSocketSharp.WebSocket"/> used in a session emits
  7090. a <see cref="E:WebSocketSharp.WebSocket.OnMessage"/> event when receives a Ping.
  7091. </summary>
  7092. <value>
  7093. <c>true</c> if the <see cref="T:WebSocketSharp.WebSocket"/> emits a <see cref="E:WebSocketSharp.WebSocket.OnMessage"/> event
  7094. when receives a Ping; otherwise, <c>false</c>. The default value is <c>false</c>.
  7095. </value>
  7096. </member>
  7097. <member name="P:WebSocketSharp.Server.WebSocketBehavior.ID">
  7098. <summary>
  7099. Gets the unique ID of a session.
  7100. </summary>
  7101. <value>
  7102. A <see cref="T:System.String"/> that represents the unique ID of the session,
  7103. or <see langword="null"/> if the WebSocket connection isn't established.
  7104. </value>
  7105. </member>
  7106. <member name="P:WebSocketSharp.Server.WebSocketBehavior.IgnoreExtensions">
  7107. <summary>
  7108. Gets or sets a value indicating whether the WebSocket service ignores
  7109. the Sec-WebSocket-Extensions header included in a handshake request.
  7110. </summary>
  7111. <value>
  7112. <c>true</c> if the WebSocket service ignores the extensions requested from
  7113. a client; otherwise, <c>false</c>. The default value is <c>false</c>.
  7114. </value>
  7115. </member>
  7116. <member name="P:WebSocketSharp.Server.WebSocketBehavior.OriginValidator">
  7117. <summary>
  7118. Gets or sets the delegate called to validate the Origin header included in
  7119. a handshake request to the WebSocket service.
  7120. </summary>
  7121. <remarks>
  7122. This delegate is called when the <see cref="T:WebSocketSharp.WebSocket"/> used in a session validates
  7123. the handshake request.
  7124. </remarks>
  7125. <value>
  7126. <para>
  7127. A <c>Func&lt;string, bool&gt;</c> delegate that references the method(s) used to
  7128. validate the origin header.
  7129. </para>
  7130. <para>
  7131. <see cref="T:System.String"/> parameter passed to this delegate represents the value of
  7132. the origin header to validate if any.
  7133. </para>
  7134. <para>
  7135. This delegate should return <c>true</c> if the origin header is valid.
  7136. </para>
  7137. <para>
  7138. The default value is <see langword="null"/>, and it does nothing to validate.
  7139. </para>
  7140. </value>
  7141. </member>
  7142. <member name="P:WebSocketSharp.Server.WebSocketBehavior.Protocol">
  7143. <summary>
  7144. Gets or sets the WebSocket subprotocol used in the WebSocket service.
  7145. </summary>
  7146. <remarks>
  7147. Set operation of this property is available before the WebSocket connection has
  7148. been established.
  7149. </remarks>
  7150. <value>
  7151. <para>
  7152. A <see cref="T:System.String"/> that represents the subprotocol if any.
  7153. The default value is <see cref="F:System.String.Empty"/>.
  7154. </para>
  7155. <para>
  7156. The value to set must be a token defined in
  7157. <see href="http://tools.ietf.org/html/rfc2616#section-2.2">RFC 2616</see>.
  7158. </para>
  7159. </value>
  7160. </member>
  7161. <member name="P:WebSocketSharp.Server.WebSocketBehavior.StartTime">
  7162. <summary>
  7163. Gets the time that a session has started.
  7164. </summary>
  7165. <value>
  7166. A <see cref="T:System.DateTime"/> that represents the time that the session has started,
  7167. or <see cref="F:System.DateTime.MaxValue"/> if the WebSocket connection isn't established.
  7168. </value>
  7169. </member>
  7170. <member name="P:WebSocketSharp.Server.WebSocketBehavior.State">
  7171. <summary>
  7172. Gets the state of the <see cref="T:WebSocketSharp.WebSocket"/> used in a session.
  7173. </summary>
  7174. <value>
  7175. One of the <see cref="T:WebSocketSharp.WebSocketState"/> enum values, indicates the state of
  7176. the <see cref="T:WebSocketSharp.WebSocket"/>.
  7177. </value>
  7178. </member>
  7179. <member name="M:WebSocketSharp.Net.HttpListenerPrefix.#ctor(System.String)">
  7180. <summary>
  7181. Initializes a new instance of the <see cref="T:WebSocketSharp.Net.HttpListenerPrefix"/> class with
  7182. the specified <paramref name="uriPrefix"/>.
  7183. </summary>
  7184. <remarks>
  7185. This constructor must be called after calling the CheckPrefix method.
  7186. </remarks>
  7187. <param name="uriPrefix">
  7188. A <see cref="T:System.String"/> that represents the URI prefix.
  7189. </param>
  7190. </member>
  7191. <member name="M:WebSocketSharp.Net.HttpListenerPrefix.Equals(System.Object)">
  7192. <summary>
  7193. Determines whether this instance and the specified <see cref="T:System.Object"/> have the same value.
  7194. </summary>
  7195. <remarks>
  7196. This method will be required to detect duplicates in any collection.
  7197. </remarks>
  7198. <param name="obj">
  7199. An <see cref="T:System.Object"/> to compare to this instance.
  7200. </param>
  7201. <returns>
  7202. <c>true</c> if <paramref name="obj"/> is a <see cref="T:WebSocketSharp.Net.HttpListenerPrefix"/> and
  7203. its value is the same as this instance; otherwise, <c>false</c>.
  7204. </returns>
  7205. </member>
  7206. <member name="M:WebSocketSharp.Net.HttpListenerPrefix.GetHashCode">
  7207. <summary>
  7208. Gets the hash code for this instance.
  7209. </summary>
  7210. <remarks>
  7211. This method will be required to detect duplicates in any collection.
  7212. </remarks>
  7213. <returns>
  7214. An <see cref="T:System.Int32"/> that represents the hash code.
  7215. </returns>
  7216. </member>
  7217. <member name="T:WebSocketSharp.Net.ClientSslConfiguration">
  7218. <summary>
  7219. Stores the parameters used to configure a <see cref="T:System.Net.Security.SslStream"/> instance as a client.
  7220. </summary>
  7221. </member>
  7222. <member name="T:WebSocketSharp.Net.SslConfiguration">
  7223. <summary>
  7224. Stores the parameters used to configure a <see cref="T:System.Net.Security.SslStream"/> instance.
  7225. </summary>
  7226. <remarks>
  7227. The SslConfiguration class is an abstract class.
  7228. </remarks>
  7229. </member>
  7230. <member name="M:WebSocketSharp.Net.SslConfiguration.#ctor(System.Security.Authentication.SslProtocols,System.Boolean)">
  7231. <summary>
  7232. Initializes a new instance of the <see cref="T:WebSocketSharp.Net.SslConfiguration"/> class with
  7233. the specified <paramref name="enabledSslProtocols"/> and
  7234. <paramref name="checkCertificateRevocation"/>.
  7235. </summary>
  7236. <param name="enabledSslProtocols">
  7237. The <see cref="T:System.Security.Authentication.SslProtocols"/> enum value that represents the protocols used for
  7238. authentication.
  7239. </param>
  7240. <param name="checkCertificateRevocation">
  7241. <c>true</c> if the certificate revocation list is checked during authentication;
  7242. otherwise, <c>false</c>.
  7243. </param>
  7244. </member>
  7245. <member name="P:WebSocketSharp.Net.SslConfiguration.CertificateSelectionCallback">
  7246. <summary>
  7247. Gets or sets the callback used to select a certificate to supply to the remote party.
  7248. </summary>
  7249. <remarks>
  7250. If this callback returns <see langword="null"/>, no certificate will be supplied.
  7251. </remarks>
  7252. <value>
  7253. A <see cref="T:System.Net.Security.LocalCertificateSelectionCallback"/> delegate that references the method
  7254. used to select a certificate. The default value is a function that only returns
  7255. <see langword="null"/>.
  7256. </value>
  7257. </member>
  7258. <member name="P:WebSocketSharp.Net.SslConfiguration.CertificateValidationCallback">
  7259. <summary>
  7260. Gets or sets the callback used to validate the certificate supplied by the remote party.
  7261. </summary>
  7262. <remarks>
  7263. If this callback returns <c>true</c>, the certificate will be valid.
  7264. </remarks>
  7265. <value>
  7266. A <see cref="T:System.Net.Security.RemoteCertificateValidationCallback"/> delegate that references the method
  7267. used to validate the certificate. The default value is a function that only returns
  7268. <c>true</c>.
  7269. </value>
  7270. </member>
  7271. <member name="P:WebSocketSharp.Net.SslConfiguration.CheckCertificateRevocation">
  7272. <summary>
  7273. Gets or sets a value indicating whether the certificate revocation list is checked
  7274. during authentication.
  7275. </summary>
  7276. <value>
  7277. <c>true</c> if the certificate revocation list is checked; otherwise, <c>false</c>.
  7278. </value>
  7279. </member>
  7280. <member name="P:WebSocketSharp.Net.SslConfiguration.EnabledSslProtocols">
  7281. <summary>
  7282. Gets or sets the SSL protocols used for authentication.
  7283. </summary>
  7284. <value>
  7285. The <see cref="T:System.Security.Authentication.SslProtocols"/> enum value that represents the protocols used for
  7286. authentication.
  7287. </value>
  7288. </member>
  7289. <member name="M:WebSocketSharp.Net.ClientSslConfiguration.#ctor(System.String)">
  7290. <summary>
  7291. Initializes a new instance of the <see cref="T:WebSocketSharp.Net.ClientSslConfiguration"/> class with
  7292. the specified <paramref name="targetHost"/>.
  7293. </summary>
  7294. <param name="targetHost">
  7295. A <see cref="T:System.String"/> that represents the name of the server that shares
  7296. a secure connection.
  7297. </param>
  7298. </member>
  7299. <member name="M:WebSocketSharp.Net.ClientSslConfiguration.#ctor(System.String,System.Security.Cryptography.X509Certificates.X509CertificateCollection,System.Security.Authentication.SslProtocols,System.Boolean)">
  7300. <summary>
  7301. Initializes a new instance of the <see cref="T:WebSocketSharp.Net.ClientSslConfiguration"/> class with
  7302. the specified <paramref name="targetHost"/>, <paramref name="clientCertificates"/>,
  7303. <paramref name="enabledSslProtocols"/>, and <paramref name="checkCertificateRevocation"/>.
  7304. </summary>
  7305. <param name="targetHost">
  7306. A <see cref="T:System.String"/> that represents the name of the server that shares
  7307. a secure connection.
  7308. </param>
  7309. <param name="clientCertificates">
  7310. A <see cref="T:System.Security.Cryptography.X509Certificates.X509CertificateCollection"/> that contains client certificates.
  7311. </param>
  7312. <param name="enabledSslProtocols">
  7313. The <see cref="T:System.Security.Authentication.SslProtocols"/> enum value that represents the protocols used for
  7314. authentication.
  7315. </param>
  7316. <param name="checkCertificateRevocation">
  7317. <c>true</c> if the certificate revocation list is checked during authentication;
  7318. otherwise, <c>false</c>.
  7319. </param>
  7320. </member>
  7321. <member name="P:WebSocketSharp.Net.ClientSslConfiguration.ClientCertificates">
  7322. <summary>
  7323. Gets or sets the collection that contains client certificates.
  7324. </summary>
  7325. <value>
  7326. A <see cref="T:System.Security.Cryptography.X509Certificates.X509CertificateCollection"/> that contains client certificates.
  7327. </value>
  7328. </member>
  7329. <member name="P:WebSocketSharp.Net.ClientSslConfiguration.ClientCertificateSelectionCallback">
  7330. <summary>
  7331. Gets or sets the callback used to select a client certificate to supply to the server.
  7332. </summary>
  7333. <remarks>
  7334. If this callback returns <see langword="null"/>, no client certificate will be supplied.
  7335. </remarks>
  7336. <value>
  7337. A <see cref="T:System.Net.Security.LocalCertificateSelectionCallback"/> delegate that references the method
  7338. used to select the client certificate. The default value is a function that only returns
  7339. <see langword="null"/>.
  7340. </value>
  7341. </member>
  7342. <member name="P:WebSocketSharp.Net.ClientSslConfiguration.ServerCertificateValidationCallback">
  7343. <summary>
  7344. Gets or sets the callback used to validate the certificate supplied by the server.
  7345. </summary>
  7346. <remarks>
  7347. If this callback returns <c>true</c>, the server certificate will be valid.
  7348. </remarks>
  7349. <value>
  7350. A <see cref="T:System.Net.Security.RemoteCertificateValidationCallback"/> delegate that references the method
  7351. used to validate the server certificate. The default value is a function that only returns
  7352. <c>true</c>.
  7353. </value>
  7354. </member>
  7355. <member name="P:WebSocketSharp.Net.ClientSslConfiguration.TargetHost">
  7356. <summary>
  7357. Gets or sets the name of the server that shares a secure connection.
  7358. </summary>
  7359. <value>
  7360. A <see cref="T:System.String"/> that represents the name of the server that shares
  7361. a secure connection.
  7362. </value>
  7363. </member>
  7364. <member name="T:WebSocketSharp.Net.ServerSslConfiguration">
  7365. <summary>
  7366. Stores the parameters used to configure a <see cref="T:System.Net.Security.SslStream"/> instance as a server.
  7367. </summary>
  7368. </member>
  7369. <member name="M:WebSocketSharp.Net.ServerSslConfiguration.#ctor(System.Security.Cryptography.X509Certificates.X509Certificate2)">
  7370. <summary>
  7371. Initializes a new instance of the <see cref="T:WebSocketSharp.Net.ServerSslConfiguration"/> class with
  7372. the specified <paramref name="serverCertificate"/>.
  7373. </summary>
  7374. <param name="serverCertificate">
  7375. A <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2"/> that represents the certificate used to authenticate
  7376. the server.
  7377. </param>
  7378. </member>
  7379. <member name="M:WebSocketSharp.Net.ServerSslConfiguration.#ctor(System.Security.Cryptography.X509Certificates.X509Certificate2,System.Boolean,System.Security.Authentication.SslProtocols,System.Boolean)">
  7380. <summary>
  7381. Initializes a new instance of the <see cref="T:WebSocketSharp.Net.ServerSslConfiguration"/> class with
  7382. the specified <paramref name="serverCertificate"/>,
  7383. <paramref name="clientCertificateRequired"/>, <paramref name="enabledSslProtocols"/>,
  7384. and <paramref name="checkCertificateRevocation"/>.
  7385. </summary>
  7386. <param name="serverCertificate">
  7387. A <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2"/> that represents the certificate used to authenticate
  7388. the server.
  7389. </param>
  7390. <param name="clientCertificateRequired">
  7391. <c>true</c> if the client must supply a certificate for authentication;
  7392. otherwise, <c>false</c>.
  7393. </param>
  7394. <param name="enabledSslProtocols">
  7395. The <see cref="T:System.Security.Authentication.SslProtocols"/> enum value that represents the protocols used for
  7396. authentication.
  7397. </param>
  7398. <param name="checkCertificateRevocation">
  7399. <c>true</c> if the certificate revocation list is checked during authentication;
  7400. otherwise, <c>false</c>.
  7401. </param>
  7402. </member>
  7403. <member name="P:WebSocketSharp.Net.ServerSslConfiguration.ClientCertificateRequired">
  7404. <summary>
  7405. Gets or sets a value indicating whether the client must supply a certificate for
  7406. authentication.
  7407. </summary>
  7408. <value>
  7409. <c>true</c> if the client must supply a certificate; otherwise, <c>false</c>.
  7410. </value>
  7411. </member>
  7412. <member name="P:WebSocketSharp.Net.ServerSslConfiguration.ClientCertificateValidationCallback">
  7413. <summary>
  7414. Gets or sets the callback used to validate the certificate supplied by the client.
  7415. </summary>
  7416. <remarks>
  7417. If this callback returns <c>true</c>, the client certificate will be valid.
  7418. </remarks>
  7419. <value>
  7420. A <see cref="T:System.Net.Security.RemoteCertificateValidationCallback"/> delegate that references the method
  7421. used to validate the client certificate. The default value is a function that only returns
  7422. <c>true</c>.
  7423. </value>
  7424. </member>
  7425. <member name="P:WebSocketSharp.Net.ServerSslConfiguration.ServerCertificate">
  7426. <summary>
  7427. Gets or sets the certificate used to authenticate the server for secure connection.
  7428. </summary>
  7429. <value>
  7430. A <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2"/> that represents the certificate used to authenticate
  7431. the server.
  7432. </value>
  7433. </member>
  7434. <member name="T:WebSocketSharp.Net.HttpRequestHeader">
  7435. <summary>
  7436. Contains the HTTP headers that may be specified in a client request.
  7437. </summary>
  7438. <remarks>
  7439. The HttpRequestHeader enumeration contains the HTTP request headers defined in
  7440. <see href="http://tools.ietf.org/html/rfc2616#section-14">RFC 2616</see> for the HTTP/1.1 and
  7441. <see href="http://tools.ietf.org/html/rfc6455#section-11.3">RFC 6455</see> for the WebSocket.
  7442. </remarks>
  7443. </member>
  7444. <member name="F:WebSocketSharp.Net.HttpRequestHeader.CacheControl">
  7445. <summary>
  7446. Indicates the Cache-Control header.
  7447. </summary>
  7448. </member>
  7449. <member name="F:WebSocketSharp.Net.HttpRequestHeader.Connection">
  7450. <summary>
  7451. Indicates the Connection header.
  7452. </summary>
  7453. </member>
  7454. <member name="F:WebSocketSharp.Net.HttpRequestHeader.Date">
  7455. <summary>
  7456. Indicates the Date header.
  7457. </summary>
  7458. </member>
  7459. <member name="F:WebSocketSharp.Net.HttpRequestHeader.KeepAlive">
  7460. <summary>
  7461. Indicates the Keep-Alive header.
  7462. </summary>
  7463. </member>
  7464. <member name="F:WebSocketSharp.Net.HttpRequestHeader.Pragma">
  7465. <summary>
  7466. Indicates the Pragma header.
  7467. </summary>
  7468. </member>
  7469. <member name="F:WebSocketSharp.Net.HttpRequestHeader.Trailer">
  7470. <summary>
  7471. Indicates the Trailer header.
  7472. </summary>
  7473. </member>
  7474. <member name="F:WebSocketSharp.Net.HttpRequestHeader.TransferEncoding">
  7475. <summary>
  7476. Indicates the Transfer-Encoding header.
  7477. </summary>
  7478. </member>
  7479. <member name="F:WebSocketSharp.Net.HttpRequestHeader.Upgrade">
  7480. <summary>
  7481. Indicates the Upgrade header.
  7482. </summary>
  7483. </member>
  7484. <member name="F:WebSocketSharp.Net.HttpRequestHeader.Via">
  7485. <summary>
  7486. Indicates the Via header.
  7487. </summary>
  7488. </member>
  7489. <member name="F:WebSocketSharp.Net.HttpRequestHeader.Warning">
  7490. <summary>
  7491. Indicates the Warning header.
  7492. </summary>
  7493. </member>
  7494. <member name="F:WebSocketSharp.Net.HttpRequestHeader.Allow">
  7495. <summary>
  7496. Indicates the Allow header.
  7497. </summary>
  7498. </member>
  7499. <member name="F:WebSocketSharp.Net.HttpRequestHeader.ContentLength">
  7500. <summary>
  7501. Indicates the Content-Length header.
  7502. </summary>
  7503. </member>
  7504. <member name="F:WebSocketSharp.Net.HttpRequestHeader.ContentType">
  7505. <summary>
  7506. Indicates the Content-Type header.
  7507. </summary>
  7508. </member>
  7509. <member name="F:WebSocketSharp.Net.HttpRequestHeader.ContentEncoding">
  7510. <summary>
  7511. Indicates the Content-Encoding header.
  7512. </summary>
  7513. </member>
  7514. <member name="F:WebSocketSharp.Net.HttpRequestHeader.ContentLanguage">
  7515. <summary>
  7516. Indicates the Content-Language header.
  7517. </summary>
  7518. </member>
  7519. <member name="F:WebSocketSharp.Net.HttpRequestHeader.ContentLocation">
  7520. <summary>
  7521. Indicates the Content-Location header.
  7522. </summary>
  7523. </member>
  7524. <member name="F:WebSocketSharp.Net.HttpRequestHeader.ContentMd5">
  7525. <summary>
  7526. Indicates the Content-MD5 header.
  7527. </summary>
  7528. </member>
  7529. <member name="F:WebSocketSharp.Net.HttpRequestHeader.ContentRange">
  7530. <summary>
  7531. Indicates the Content-Range header.
  7532. </summary>
  7533. </member>
  7534. <member name="F:WebSocketSharp.Net.HttpRequestHeader.Expires">
  7535. <summary>
  7536. Indicates the Expires header.
  7537. </summary>
  7538. </member>
  7539. <member name="F:WebSocketSharp.Net.HttpRequestHeader.LastModified">
  7540. <summary>
  7541. Indicates the Last-Modified header.
  7542. </summary>
  7543. </member>
  7544. <member name="F:WebSocketSharp.Net.HttpRequestHeader.Accept">
  7545. <summary>
  7546. Indicates the Accept header.
  7547. </summary>
  7548. </member>
  7549. <member name="F:WebSocketSharp.Net.HttpRequestHeader.AcceptCharset">
  7550. <summary>
  7551. Indicates the Accept-Charset header.
  7552. </summary>
  7553. </member>
  7554. <member name="F:WebSocketSharp.Net.HttpRequestHeader.AcceptEncoding">
  7555. <summary>
  7556. Indicates the Accept-Encoding header.
  7557. </summary>
  7558. </member>
  7559. <member name="F:WebSocketSharp.Net.HttpRequestHeader.AcceptLanguage">
  7560. <summary>
  7561. Indicates the Accept-Language header.
  7562. </summary>
  7563. </member>
  7564. <member name="F:WebSocketSharp.Net.HttpRequestHeader.Authorization">
  7565. <summary>
  7566. Indicates the Authorization header.
  7567. </summary>
  7568. </member>
  7569. <member name="F:WebSocketSharp.Net.HttpRequestHeader.Cookie">
  7570. <summary>
  7571. Indicates the Cookie header.
  7572. </summary>
  7573. </member>
  7574. <member name="F:WebSocketSharp.Net.HttpRequestHeader.Expect">
  7575. <summary>
  7576. Indicates the Expect header.
  7577. </summary>
  7578. </member>
  7579. <member name="F:WebSocketSharp.Net.HttpRequestHeader.From">
  7580. <summary>
  7581. Indicates the From header.
  7582. </summary>
  7583. </member>
  7584. <member name="F:WebSocketSharp.Net.HttpRequestHeader.Host">
  7585. <summary>
  7586. Indicates the Host header.
  7587. </summary>
  7588. </member>
  7589. <member name="F:WebSocketSharp.Net.HttpRequestHeader.IfMatch">
  7590. <summary>
  7591. Indicates the If-Match header.
  7592. </summary>
  7593. </member>
  7594. <member name="F:WebSocketSharp.Net.HttpRequestHeader.IfModifiedSince">
  7595. <summary>
  7596. Indicates the If-Modified-Since header.
  7597. </summary>
  7598. </member>
  7599. <member name="F:WebSocketSharp.Net.HttpRequestHeader.IfNoneMatch">
  7600. <summary>
  7601. Indicates the If-None-Match header.
  7602. </summary>
  7603. </member>
  7604. <member name="F:WebSocketSharp.Net.HttpRequestHeader.IfRange">
  7605. <summary>
  7606. Indicates the If-Range header.
  7607. </summary>
  7608. </member>
  7609. <member name="F:WebSocketSharp.Net.HttpRequestHeader.IfUnmodifiedSince">
  7610. <summary>
  7611. Indicates the If-Unmodified-Since header.
  7612. </summary>
  7613. </member>
  7614. <member name="F:WebSocketSharp.Net.HttpRequestHeader.MaxForwards">
  7615. <summary>
  7616. Indicates the Max-Forwards header.
  7617. </summary>
  7618. </member>
  7619. <member name="F:WebSocketSharp.Net.HttpRequestHeader.ProxyAuthorization">
  7620. <summary>
  7621. Indicates the Proxy-Authorization header.
  7622. </summary>
  7623. </member>
  7624. <member name="F:WebSocketSharp.Net.HttpRequestHeader.Referer">
  7625. <summary>
  7626. Indicates the Referer header.
  7627. </summary>
  7628. </member>
  7629. <member name="F:WebSocketSharp.Net.HttpRequestHeader.Range">
  7630. <summary>
  7631. Indicates the Range header.
  7632. </summary>
  7633. </member>
  7634. <member name="F:WebSocketSharp.Net.HttpRequestHeader.Te">
  7635. <summary>
  7636. Indicates the TE header.
  7637. </summary>
  7638. </member>
  7639. <member name="F:WebSocketSharp.Net.HttpRequestHeader.Translate">
  7640. <summary>
  7641. Indicates the Translate header.
  7642. </summary>
  7643. </member>
  7644. <member name="F:WebSocketSharp.Net.HttpRequestHeader.UserAgent">
  7645. <summary>
  7646. Indicates the User-Agent header.
  7647. </summary>
  7648. </member>
  7649. <member name="F:WebSocketSharp.Net.HttpRequestHeader.SecWebSocketKey">
  7650. <summary>
  7651. Indicates the Sec-WebSocket-Key header.
  7652. </summary>
  7653. </member>
  7654. <member name="F:WebSocketSharp.Net.HttpRequestHeader.SecWebSocketExtensions">
  7655. <summary>
  7656. Indicates the Sec-WebSocket-Extensions header.
  7657. </summary>
  7658. </member>
  7659. <member name="F:WebSocketSharp.Net.HttpRequestHeader.SecWebSocketProtocol">
  7660. <summary>
  7661. Indicates the Sec-WebSocket-Protocol header.
  7662. </summary>
  7663. </member>
  7664. <member name="F:WebSocketSharp.Net.HttpRequestHeader.SecWebSocketVersion">
  7665. <summary>
  7666. Indicates the Sec-WebSocket-Version header.
  7667. </summary>
  7668. </member>
  7669. <member name="T:WebSocketSharp.Net.HttpResponseHeader">
  7670. <summary>
  7671. Contains the HTTP headers that can be specified in a server response.
  7672. </summary>
  7673. <remarks>
  7674. The HttpResponseHeader enumeration contains the HTTP response headers defined in
  7675. <see href="http://tools.ietf.org/html/rfc2616#section-14">RFC 2616</see> for the HTTP/1.1 and
  7676. <see href="http://tools.ietf.org/html/rfc6455#section-11.3">RFC 6455</see> for the WebSocket.
  7677. </remarks>
  7678. </member>
  7679. <member name="F:WebSocketSharp.Net.HttpResponseHeader.CacheControl">
  7680. <summary>
  7681. Indicates the Cache-Control header.
  7682. </summary>
  7683. </member>
  7684. <member name="F:WebSocketSharp.Net.HttpResponseHeader.Connection">
  7685. <summary>
  7686. Indicates the Connection header.
  7687. </summary>
  7688. </member>
  7689. <member name="F:WebSocketSharp.Net.HttpResponseHeader.Date">
  7690. <summary>
  7691. Indicates the Date header.
  7692. </summary>
  7693. </member>
  7694. <member name="F:WebSocketSharp.Net.HttpResponseHeader.KeepAlive">
  7695. <summary>
  7696. Indicates the Keep-Alive header.
  7697. </summary>
  7698. </member>
  7699. <member name="F:WebSocketSharp.Net.HttpResponseHeader.Pragma">
  7700. <summary>
  7701. Indicates the Pragma header.
  7702. </summary>
  7703. </member>
  7704. <member name="F:WebSocketSharp.Net.HttpResponseHeader.Trailer">
  7705. <summary>
  7706. Indicates the Trailer header.
  7707. </summary>
  7708. </member>
  7709. <member name="F:WebSocketSharp.Net.HttpResponseHeader.TransferEncoding">
  7710. <summary>
  7711. Indicates the Transfer-Encoding header.
  7712. </summary>
  7713. </member>
  7714. <member name="F:WebSocketSharp.Net.HttpResponseHeader.Upgrade">
  7715. <summary>
  7716. Indicates the Upgrade header.
  7717. </summary>
  7718. </member>
  7719. <member name="F:WebSocketSharp.Net.HttpResponseHeader.Via">
  7720. <summary>
  7721. Indicates the Via header.
  7722. </summary>
  7723. </member>
  7724. <member name="F:WebSocketSharp.Net.HttpResponseHeader.Warning">
  7725. <summary>
  7726. Indicates the Warning header.
  7727. </summary>
  7728. </member>
  7729. <member name="F:WebSocketSharp.Net.HttpResponseHeader.Allow">
  7730. <summary>
  7731. Indicates the Allow header.
  7732. </summary>
  7733. </member>
  7734. <member name="F:WebSocketSharp.Net.HttpResponseHeader.ContentLength">
  7735. <summary>
  7736. Indicates the Content-Length header.
  7737. </summary>
  7738. </member>
  7739. <member name="F:WebSocketSharp.Net.HttpResponseHeader.ContentType">
  7740. <summary>
  7741. Indicates the Content-Type header.
  7742. </summary>
  7743. </member>
  7744. <member name="F:WebSocketSharp.Net.HttpResponseHeader.ContentEncoding">
  7745. <summary>
  7746. Indicates the Content-Encoding header.
  7747. </summary>
  7748. </member>
  7749. <member name="F:WebSocketSharp.Net.HttpResponseHeader.ContentLanguage">
  7750. <summary>
  7751. Indicates the Content-Language header.
  7752. </summary>
  7753. </member>
  7754. <member name="F:WebSocketSharp.Net.HttpResponseHeader.ContentLocation">
  7755. <summary>
  7756. Indicates the Content-Location header.
  7757. </summary>
  7758. </member>
  7759. <member name="F:WebSocketSharp.Net.HttpResponseHeader.ContentMd5">
  7760. <summary>
  7761. Indicates the Content-MD5 header.
  7762. </summary>
  7763. </member>
  7764. <member name="F:WebSocketSharp.Net.HttpResponseHeader.ContentRange">
  7765. <summary>
  7766. Indicates the Content-Range header.
  7767. </summary>
  7768. </member>
  7769. <member name="F:WebSocketSharp.Net.HttpResponseHeader.Expires">
  7770. <summary>
  7771. Indicates the Expires header.
  7772. </summary>
  7773. </member>
  7774. <member name="F:WebSocketSharp.Net.HttpResponseHeader.LastModified">
  7775. <summary>
  7776. Indicates the Last-Modified header.
  7777. </summary>
  7778. </member>
  7779. <member name="F:WebSocketSharp.Net.HttpResponseHeader.AcceptRanges">
  7780. <summary>
  7781. Indicates the Accept-Ranges header.
  7782. </summary>
  7783. </member>
  7784. <member name="F:WebSocketSharp.Net.HttpResponseHeader.Age">
  7785. <summary>
  7786. Indicates the Age header.
  7787. </summary>
  7788. </member>
  7789. <member name="F:WebSocketSharp.Net.HttpResponseHeader.ETag">
  7790. <summary>
  7791. Indicates the ETag header.
  7792. </summary>
  7793. </member>
  7794. <member name="F:WebSocketSharp.Net.HttpResponseHeader.Location">
  7795. <summary>
  7796. Indicates the Location header.
  7797. </summary>
  7798. </member>
  7799. <member name="F:WebSocketSharp.Net.HttpResponseHeader.ProxyAuthenticate">
  7800. <summary>
  7801. Indicates the Proxy-Authenticate header.
  7802. </summary>
  7803. </member>
  7804. <member name="F:WebSocketSharp.Net.HttpResponseHeader.RetryAfter">
  7805. <summary>
  7806. Indicates the Retry-After header.
  7807. </summary>
  7808. </member>
  7809. <member name="F:WebSocketSharp.Net.HttpResponseHeader.Server">
  7810. <summary>
  7811. Indicates the Server header.
  7812. </summary>
  7813. </member>
  7814. <member name="F:WebSocketSharp.Net.HttpResponseHeader.SetCookie">
  7815. <summary>
  7816. Indicates the Set-Cookie header.
  7817. </summary>
  7818. </member>
  7819. <member name="F:WebSocketSharp.Net.HttpResponseHeader.Vary">
  7820. <summary>
  7821. Indicates the Vary header.
  7822. </summary>
  7823. </member>
  7824. <member name="F:WebSocketSharp.Net.HttpResponseHeader.WwwAuthenticate">
  7825. <summary>
  7826. Indicates the WWW-Authenticate header.
  7827. </summary>
  7828. </member>
  7829. <member name="F:WebSocketSharp.Net.HttpResponseHeader.SecWebSocketExtensions">
  7830. <summary>
  7831. Indicates the Sec-WebSocket-Extensions header.
  7832. </summary>
  7833. </member>
  7834. <member name="F:WebSocketSharp.Net.HttpResponseHeader.SecWebSocketAccept">
  7835. <summary>
  7836. Indicates the Sec-WebSocket-Accept header.
  7837. </summary>
  7838. </member>
  7839. <member name="F:WebSocketSharp.Net.HttpResponseHeader.SecWebSocketProtocol">
  7840. <summary>
  7841. Indicates the Sec-WebSocket-Protocol header.
  7842. </summary>
  7843. </member>
  7844. <member name="F:WebSocketSharp.Net.HttpResponseHeader.SecWebSocketVersion">
  7845. <summary>
  7846. Indicates the Sec-WebSocket-Version header.
  7847. </summary>
  7848. </member>
  7849. </members>
  7850. </doc>