12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850 |
- <?xml version="1.0"?>
- <doc>
- <assembly>
- <name>websocket-sharp</name>
- </assembly>
- <members>
- <member name="T:WebSocketSharp.Ext">
- <summary>
- Provides a set of static methods for websocket-sharp.
- </summary>
- </member>
- <member name="M:WebSocketSharp.Ext.EqualsWith(System.Int32,System.Char,System.Action{System.Int32})">
- <summary>
- Determines whether the specified <see cref="T:System.Int32"/> equals the specified <see cref="T:System.Char"/>,
- and invokes the specified <c>Action<int></c> delegate at the same time.
- </summary>
- <returns>
- <c>true</c> if <paramref name="value"/> equals <paramref name="c"/>;
- otherwise, <c>false</c>.
- </returns>
- <param name="value">
- An <see cref="T:System.Int32"/> to compare.
- </param>
- <param name="c">
- A <see cref="T:System.Char"/> to compare.
- </param>
- <param name="action">
- An <c>Action<int></c> delegate that references the method(s) called
- at the same time as comparing. An <see cref="T:System.Int32"/> parameter to pass to
- the method(s) is <paramref name="value"/>.
- </param>
- </member>
- <member name="M:WebSocketSharp.Ext.GetAbsolutePath(System.Uri)">
- <summary>
- Gets the absolute path from the specified <see cref="T:System.Uri"/>.
- </summary>
- <returns>
- A <see cref="T:System.String"/> that represents the absolute path if it's successfully found;
- otherwise, <see langword="null"/>.
- </returns>
- <param name="uri">
- A <see cref="T:System.Uri"/> that represents the URI to get the absolute path from.
- </param>
- </member>
- <member name="M:WebSocketSharp.Ext.GetName(System.String,System.Char)">
- <summary>
- Gets the name from the specified <see cref="T:System.String"/> that contains a pair of name and
- value separated by a separator character.
- </summary>
- <returns>
- A <see cref="T:System.String"/> that represents the name if any; otherwise, <c>null</c>.
- </returns>
- <param name="nameAndValue">
- A <see cref="T:System.String"/> that contains a pair of name and value separated by
- a separator character.
- </param>
- <param name="separator">
- A <see cref="T:System.Char"/> that represents the separator character.
- </param>
- </member>
- <member name="M:WebSocketSharp.Ext.GetValue(System.String,System.Char)">
- <summary>
- Gets the value from the specified <see cref="T:System.String"/> that contains a pair of name and
- value separated by a separator character.
- </summary>
- <returns>
- A <see cref="T:System.String"/> that represents the value if any; otherwise, <c>null</c>.
- </returns>
- <param name="nameAndValue">
- A <see cref="T:System.String"/> that contains a pair of name and value separated by
- a separator character.
- </param>
- <param name="separator">
- A <see cref="T:System.Char"/> that represents the separator character.
- </param>
- </member>
- <member name="M:WebSocketSharp.Ext.TryCreateWebSocketUri(System.String,System.Uri@,System.String@)">
- <summary>
- Tries to create a <see cref="T:System.Uri"/> for WebSocket with
- the specified <paramref name="uriString"/>.
- </summary>
- <returns>
- <c>true</c> if a <see cref="T:System.Uri"/> is successfully created; otherwise, <c>false</c>.
- </returns>
- <param name="uriString">
- A <see cref="T:System.String"/> that represents a WebSocket URL to try.
- </param>
- <param name="result">
- When this method returns, a <see cref="T:System.Uri"/> that represents a WebSocket URL,
- or <see langword="null"/> if <paramref name="uriString"/> is invalid.
- </param>
- <param name="message">
- When this method returns, a <see cref="T:System.String"/> that represents an error message,
- or <see cref="F:System.String.Empty"/> if <paramref name="uriString"/> is valid.
- </param>
- </member>
- <member name="M:WebSocketSharp.Ext.Contains(System.String,System.Char[])">
- <summary>
- Determines whether the specified <see cref="T:System.String"/> contains any of characters in
- the specified array of <see cref="T:System.Char"/>.
- </summary>
- <returns>
- <c>true</c> if <paramref name="value"/> contains any of <paramref name="chars"/>;
- otherwise, <c>false</c>.
- </returns>
- <param name="value">
- A <see cref="T:System.String"/> to test.
- </param>
- <param name="chars">
- An array of <see cref="T:System.Char"/> that contains characters to find.
- </param>
- </member>
- <member name="M:WebSocketSharp.Ext.Contains(System.Collections.Specialized.NameValueCollection,System.String)">
- <summary>
- Determines whether the specified <see cref="T:System.Collections.Specialized.NameValueCollection"/> contains
- the entry with the specified <paramref name="name"/>.
- </summary>
- <returns>
- <c>true</c> if <paramref name="collection"/> contains the entry with
- <paramref name="name"/>; otherwise, <c>false</c>.
- </returns>
- <param name="collection">
- A <see cref="T:System.Collections.Specialized.NameValueCollection"/> to test.
- </param>
- <param name="name">
- A <see cref="T:System.String"/> that represents the key of the entry to find.
- </param>
- </member>
- <member name="M:WebSocketSharp.Ext.Contains(System.Collections.Specialized.NameValueCollection,System.String,System.String)">
- <summary>
- Determines whether the specified <see cref="T:System.Collections.Specialized.NameValueCollection"/> contains the entry with
- the specified both <paramref name="name"/> and <paramref name="value"/>.
- </summary>
- <returns>
- <c>true</c> if <paramref name="collection"/> contains the entry with both
- <paramref name="name"/> and <paramref name="value"/>; otherwise, <c>false</c>.
- </returns>
- <param name="collection">
- A <see cref="T:System.Collections.Specialized.NameValueCollection"/> to test.
- </param>
- <param name="name">
- A <see cref="T:System.String"/> that represents the key of the entry to find.
- </param>
- <param name="value">
- A <see cref="T:System.String"/> that represents the value of the entry to find.
- </param>
- </member>
- <member name="M:WebSocketSharp.Ext.Emit(System.EventHandler,System.Object,System.EventArgs)">
- <summary>
- Emits the specified <see cref="T:System.EventHandler"/> delegate if it isn't <see langword="null"/>.
- </summary>
- <param name="eventHandler">
- A <see cref="T:System.EventHandler"/> to emit.
- </param>
- <param name="sender">
- An <see cref="T:System.Object"/> from which emits this <paramref name="eventHandler"/>.
- </param>
- <param name="e">
- A <see cref="T:System.EventArgs"/> that contains no event data.
- </param>
- </member>
- <member name="M:WebSocketSharp.Ext.Emit``1(System.EventHandler{``0},System.Object,``0)">
- <summary>
- Emits the specified <c>EventHandler<TEventArgs></c> delegate if it isn't
- <see langword="null"/>.
- </summary>
- <param name="eventHandler">
- An <c>EventHandler<TEventArgs></c> to emit.
- </param>
- <param name="sender">
- An <see cref="T:System.Object"/> from which emits this <paramref name="eventHandler"/>.
- </param>
- <param name="e">
- A <c>TEventArgs</c> that represents the event data.
- </param>
- <typeparam name="TEventArgs">
- The type of the event data generated by the event.
- </typeparam>
- </member>
- <member name="M:WebSocketSharp.Ext.GetCookies(System.Collections.Specialized.NameValueCollection,System.Boolean)">
- <summary>
- Gets the collection of the HTTP cookies from the specified HTTP <paramref name="headers"/>.
- </summary>
- <returns>
- A <see cref="T:WebSocketSharp.Net.CookieCollection"/> that receives a collection of the HTTP cookies.
- </returns>
- <param name="headers">
- A <see cref="T:System.Collections.Specialized.NameValueCollection"/> that contains a collection of the HTTP headers.
- </param>
- <param name="response">
- <c>true</c> if <paramref name="headers"/> is a collection of the response headers;
- otherwise, <c>false</c>.
- </param>
- </member>
- <member name="M:WebSocketSharp.Ext.GetDescription(WebSocketSharp.Net.HttpStatusCode)">
- <summary>
- Gets the description of the specified HTTP status <paramref name="code"/>.
- </summary>
- <returns>
- A <see cref="T:System.String"/> that represents the description of the HTTP status code.
- </returns>
- <param name="code">
- One of <see cref="T:WebSocketSharp.Net.HttpStatusCode"/> enum values, indicates the HTTP status code.
- </param>
- </member>
- <member name="M:WebSocketSharp.Ext.GetStatusDescription(System.Int32)">
- <summary>
- Gets the description of the specified HTTP status <paramref name="code"/>.
- </summary>
- <returns>
- A <see cref="T:System.String"/> that represents the description of the HTTP status code.
- </returns>
- <param name="code">
- An <see cref="T:System.Int32"/> that represents the HTTP status code.
- </param>
- </member>
- <member name="M:WebSocketSharp.Ext.IsCloseStatusCode(System.UInt16)">
- <summary>
- Determines whether the specified <see cref="T:System.UInt16"/> is in the allowable range of
- the WebSocket close status code.
- </summary>
- <remarks>
- Not allowable ranges are the following:
- <list type="bullet">
- <item>
- <term>
- Numbers in the range 0-999 are not used.
- </term>
- </item>
- <item>
- <term>
- Numbers greater than 4999 are out of the reserved close status code ranges.
- </term>
- </item>
- </list>
- </remarks>
- <returns>
- <c>true</c> if <paramref name="value"/> is in the allowable range of the WebSocket
- close status code; otherwise, <c>false</c>.
- </returns>
- <param name="value">
- A <see cref="T:System.UInt16"/> to test.
- </param>
- </member>
- <member name="M:WebSocketSharp.Ext.IsEnclosedIn(System.String,System.Char)">
- <summary>
- Determines whether the specified <see cref="T:System.String"/> is enclosed in the specified
- <see cref="T:System.Char"/>.
- </summary>
- <returns>
- <c>true</c> if <paramref name="value"/> is enclosed in <paramref name="c"/>;
- otherwise, <c>false</c>.
- </returns>
- <param name="value">
- A <see cref="T:System.String"/> to test.
- </param>
- <param name="c">
- A <see cref="T:System.Char"/> that represents the character to find.
- </param>
- </member>
- <member name="M:WebSocketSharp.Ext.IsHostOrder(WebSocketSharp.ByteOrder)">
- <summary>
- Determines whether the specified <see cref="T:WebSocketSharp.ByteOrder"/> is host (this computer
- architecture) byte order.
- </summary>
- <returns>
- <c>true</c> if <paramref name="order"/> is host byte order; otherwise, <c>false</c>.
- </returns>
- <param name="order">
- One of the <see cref="T:WebSocketSharp.ByteOrder"/> enum values, to test.
- </param>
- </member>
- <member name="M:WebSocketSharp.Ext.IsLocal(System.Net.IPAddress)">
- <summary>
- Determines whether the specified <see cref="T:System.Net.IPAddress"/> represents
- a local IP address.
- </summary>
- <remarks>
- This local means NOT REMOTE for the current host.
- </remarks>
- <returns>
- <c>true</c> if <paramref name="address"/> represents a local IP address;
- otherwise, <c>false</c>.
- </returns>
- <param name="address">
- A <see cref="T:System.Net.IPAddress"/> to test.
- </param>
- </member>
- <member name="M:WebSocketSharp.Ext.IsNullOrEmpty(System.String)">
- <summary>
- Determines whether the specified <see cref="T:System.String"/> is <see langword="null"/> or empty.
- </summary>
- <returns>
- <c>true</c> if <paramref name="value"/> is <see langword="null"/> or empty;
- otherwise, <c>false</c>.
- </returns>
- <param name="value">
- A <see cref="T:System.String"/> to test.
- </param>
- </member>
- <member name="M:WebSocketSharp.Ext.IsPredefinedScheme(System.String)">
- <summary>
- Determines whether the specified <see cref="T:System.String"/> is a predefined scheme.
- </summary>
- <returns>
- <c>true</c> if <paramref name="value"/> is a predefined scheme; otherwise, <c>false</c>.
- </returns>
- <param name="value">
- A <see cref="T:System.String"/> to test.
- </param>
- </member>
- <member name="M:WebSocketSharp.Ext.IsUpgradeTo(WebSocketSharp.Net.HttpListenerRequest,System.String)">
- <summary>
- Determines whether the specified <see cref="T:WebSocketSharp.Net.HttpListenerRequest"/> is
- an HTTP Upgrade request to switch to the specified <paramref name="protocol"/>.
- </summary>
- <returns>
- <c>true</c> if <paramref name="request"/> is an HTTP Upgrade request to switch to
- <paramref name="protocol"/>; otherwise, <c>false</c>.
- </returns>
- <param name="request">
- A <see cref="T:WebSocketSharp.Net.HttpListenerRequest"/> that represents the HTTP request.
- </param>
- <param name="protocol">
- A <see cref="T:System.String"/> that represents the protocol name.
- </param>
- <exception cref="T:System.ArgumentNullException">
- <para>
- <paramref name="request"/> is <see langword="null"/>.
- </para>
- <para>
- -or-
- </para>
- <para>
- <paramref name="protocol"/> is <see langword="null"/>.
- </para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="protocol"/> is empty.
- </exception>
- </member>
- <member name="M:WebSocketSharp.Ext.MaybeUri(System.String)">
- <summary>
- Determines whether the specified <see cref="T:System.String"/> is a URI string.
- </summary>
- <returns>
- <c>true</c> if <paramref name="value"/> may be a URI string; otherwise, <c>false</c>.
- </returns>
- <param name="value">
- A <see cref="T:System.String"/> to test.
- </param>
- </member>
- <member name="M:WebSocketSharp.Ext.SubArray``1(``0[],System.Int32,System.Int32)">
- <summary>
- Retrieves a sub-array from the specified <paramref name="array"/>. A sub-array starts at
- the specified element position in <paramref name="array"/>.
- </summary>
- <returns>
- An array of T that receives a sub-array, or an empty array of T if any problems with
- the parameters.
- </returns>
- <param name="array">
- An array of T from which to retrieve a sub-array.
- </param>
- <param name="startIndex">
- An <see cref="T:System.Int32"/> that represents the zero-based starting position of
- a sub-array in <paramref name="array"/>.
- </param>
- <param name="length">
- An <see cref="T:System.Int32"/> that represents the number of elements to retrieve.
- </param>
- <typeparam name="T">
- The type of elements in <paramref name="array"/>.
- </typeparam>
- </member>
- <member name="M:WebSocketSharp.Ext.SubArray``1(``0[],System.Int64,System.Int64)">
- <summary>
- Retrieves a sub-array from the specified <paramref name="array"/>. A sub-array starts at
- the specified element position in <paramref name="array"/>.
- </summary>
- <returns>
- An array of T that receives a sub-array, or an empty array of T if any problems with
- the parameters.
- </returns>
- <param name="array">
- An array of T from which to retrieve a sub-array.
- </param>
- <param name="startIndex">
- A <see cref="T:System.Int64"/> that represents the zero-based starting position of
- a sub-array in <paramref name="array"/>.
- </param>
- <param name="length">
- A <see cref="T:System.Int64"/> that represents the number of elements to retrieve.
- </param>
- <typeparam name="T">
- The type of elements in <paramref name="array"/>.
- </typeparam>
- </member>
- <member name="M:WebSocketSharp.Ext.Times(System.Int32,System.Action)">
- <summary>
- Executes the specified <see cref="T:System.Action"/> delegate <paramref name="n"/> times.
- </summary>
- <param name="n">
- An <see cref="T:System.Int32"/> is the number of times to execute.
- </param>
- <param name="action">
- An <see cref="T:System.Action"/> delegate that references the method(s) to execute.
- </param>
- </member>
- <member name="M:WebSocketSharp.Ext.Times(System.Int64,System.Action)">
- <summary>
- Executes the specified <see cref="T:System.Action"/> delegate <paramref name="n"/> times.
- </summary>
- <param name="n">
- A <see cref="T:System.Int64"/> is the number of times to execute.
- </param>
- <param name="action">
- An <see cref="T:System.Action"/> delegate that references the method(s) to execute.
- </param>
- </member>
- <member name="M:WebSocketSharp.Ext.Times(System.UInt32,System.Action)">
- <summary>
- Executes the specified <see cref="T:System.Action"/> delegate <paramref name="n"/> times.
- </summary>
- <param name="n">
- A <see cref="T:System.UInt32"/> is the number of times to execute.
- </param>
- <param name="action">
- An <see cref="T:System.Action"/> delegate that references the method(s) to execute.
- </param>
- </member>
- <member name="M:WebSocketSharp.Ext.Times(System.UInt64,System.Action)">
- <summary>
- Executes the specified <see cref="T:System.Action"/> delegate <paramref name="n"/> times.
- </summary>
- <param name="n">
- A <see cref="T:System.UInt64"/> is the number of times to execute.
- </param>
- <param name="action">
- An <see cref="T:System.Action"/> delegate that references the method(s) to execute.
- </param>
- </member>
- <member name="M:WebSocketSharp.Ext.Times(System.Int32,System.Action{System.Int32})">
- <summary>
- Executes the specified <c>Action<int></c> delegate <paramref name="n"/> times.
- </summary>
- <param name="n">
- An <see cref="T:System.Int32"/> is the number of times to execute.
- </param>
- <param name="action">
- An <c>Action<int></c> delegate that references the method(s) to execute.
- An <see cref="T:System.Int32"/> parameter to pass to the method(s) is the zero-based count of
- iteration.
- </param>
- </member>
- <member name="M:WebSocketSharp.Ext.Times(System.Int64,System.Action{System.Int64})">
- <summary>
- Executes the specified <c>Action<long></c> delegate <paramref name="n"/> times.
- </summary>
- <param name="n">
- A <see cref="T:System.Int64"/> is the number of times to execute.
- </param>
- <param name="action">
- An <c>Action<long></c> delegate that references the method(s) to execute.
- A <see cref="T:System.Int64"/> parameter to pass to the method(s) is the zero-based count of
- iteration.
- </param>
- </member>
- <member name="M:WebSocketSharp.Ext.Times(System.UInt32,System.Action{System.UInt32})">
- <summary>
- Executes the specified <c>Action<uint></c> delegate <paramref name="n"/> times.
- </summary>
- <param name="n">
- A <see cref="T:System.UInt32"/> is the number of times to execute.
- </param>
- <param name="action">
- An <c>Action<uint></c> delegate that references the method(s) to execute.
- A <see cref="T:System.UInt32"/> parameter to pass to the method(s) is the zero-based count of
- iteration.
- </param>
- </member>
- <member name="M:WebSocketSharp.Ext.Times(System.UInt64,System.Action{System.UInt64})">
- <summary>
- Executes the specified <c>Action<ulong></c> delegate <paramref name="n"/> times.
- </summary>
- <param name="n">
- A <see cref="T:System.UInt64"/> is the number of times to execute.
- </param>
- <param name="action">
- An <c>Action<ulong></c> delegate that references the method(s) to execute.
- A <see cref="T:System.UInt64"/> parameter to pass to this method(s) is the zero-based count of
- iteration.
- </param>
- </member>
- <member name="M:WebSocketSharp.Ext.To``1(System.Byte[],WebSocketSharp.ByteOrder)">
- <summary>
- Converts the specified array of <see cref="T:System.Byte"/> to the specified type data.
- </summary>
- <returns>
- A T converted from <paramref name="source"/>, or a default value of
- T if <paramref name="source"/> is an empty array of <see cref="T:System.Byte"/> or
- if the type of T isn't <see cref="T:System.Boolean"/>, <see cref="T:System.Char"/>, <see cref="T:System.Double"/>,
- <see cref="T:System.Single"/>, <see cref="T:System.Int32"/>, <see cref="T:System.Int64"/>, <see cref="T:System.Int16"/>,
- <see cref="T:System.UInt32"/>, <see cref="T:System.UInt64"/>, or <see cref="T:System.UInt16"/>.
- </returns>
- <param name="source">
- An array of <see cref="T:System.Byte"/> to convert.
- </param>
- <param name="sourceOrder">
- One of the <see cref="T:WebSocketSharp.ByteOrder"/> enum values, specifies the byte order of
- <paramref name="source"/>.
- </param>
- <typeparam name="T">
- The type of the return. The T must be a value type.
- </typeparam>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="source"/> is <see langword="null"/>.
- </exception>
- </member>
- <member name="M:WebSocketSharp.Ext.ToByteArray``1(``0,WebSocketSharp.ByteOrder)">
- <summary>
- Converts the specified <paramref name="value"/> to an array of <see cref="T:System.Byte"/>.
- </summary>
- <returns>
- An array of <see cref="T:System.Byte"/> converted from <paramref name="value"/>.
- </returns>
- <param name="value">
- A T to convert.
- </param>
- <param name="order">
- One of the <see cref="T:WebSocketSharp.ByteOrder"/> enum values, specifies the byte order of the return.
- </param>
- <typeparam name="T">
- The type of <paramref name="value"/>. The T must be a value type.
- </typeparam>
- </member>
- <member name="M:WebSocketSharp.Ext.ToHostOrder(System.Byte[],WebSocketSharp.ByteOrder)">
- <summary>
- Converts the order of the specified array of <see cref="T:System.Byte"/> to the host byte order.
- </summary>
- <returns>
- An array of <see cref="T:System.Byte"/> converted from <paramref name="source"/>.
- </returns>
- <param name="source">
- An array of <see cref="T:System.Byte"/> to convert.
- </param>
- <param name="sourceOrder">
- One of the <see cref="T:WebSocketSharp.ByteOrder"/> enum values, specifies the byte order of
- <paramref name="source"/>.
- </param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="source"/> is <see langword="null"/>.
- </exception>
- </member>
- <member name="M:WebSocketSharp.Ext.ToString``1(``0[],System.String)">
- <summary>
- Converts the specified <paramref name="array"/> to a <see cref="T:System.String"/> that
- concatenates the each element of <paramref name="array"/> across the specified
- <paramref name="separator"/>.
- </summary>
- <returns>
- A <see cref="T:System.String"/> converted from <paramref name="array"/>,
- or <see cref="F:System.String.Empty"/> if <paramref name="array"/> is empty.
- </returns>
- <param name="array">
- An array of T to convert.
- </param>
- <param name="separator">
- A <see cref="T:System.String"/> that represents the separator string.
- </param>
- <typeparam name="T">
- The type of elements in <paramref name="array"/>.
- </typeparam>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="array"/> is <see langword="null"/>.
- </exception>
- </member>
- <member name="M:WebSocketSharp.Ext.ToUri(System.String)">
- <summary>
- Converts the specified <see cref="T:System.String"/> to a <see cref="T:System.Uri"/>.
- </summary>
- <returns>
- A <see cref="T:System.Uri"/> converted from <paramref name="uriString"/>,
- or <see langword="null"/> if <paramref name="uriString"/> isn't successfully converted.
- </returns>
- <param name="uriString">
- A <see cref="T:System.String"/> to convert.
- </param>
- </member>
- <member name="M:WebSocketSharp.Ext.UrlDecode(System.String)">
- <summary>
- URL-decodes the specified <see cref="T:System.String"/>.
- </summary>
- <returns>
- A <see cref="T:System.String"/> that receives the decoded string,
- or the <paramref name="value"/> if it's <see langword="null"/> or empty.
- </returns>
- <param name="value">
- A <see cref="T:System.String"/> to decode.
- </param>
- </member>
- <member name="M:WebSocketSharp.Ext.UrlEncode(System.String)">
- <summary>
- URL-encodes the specified <see cref="T:System.String"/>.
- </summary>
- <returns>
- A <see cref="T:System.String"/> that receives the encoded string,
- or <paramref name="value"/> if it's <see langword="null"/> or empty.
- </returns>
- <param name="value">
- A <see cref="T:System.String"/> to encode.
- </param>
- </member>
- <member name="M:WebSocketSharp.Ext.WriteContent(WebSocketSharp.Net.HttpListenerResponse,System.Byte[])">
- <summary>
- Writes and sends the specified <paramref name="content"/> data with the specified
- <see cref="T:WebSocketSharp.Net.HttpListenerResponse"/>.
- </summary>
- <param name="response">
- A <see cref="T:WebSocketSharp.Net.HttpListenerResponse"/> that represents the HTTP response used to
- send the content data.
- </param>
- <param name="content">
- An array of <see cref="T:System.Byte"/> that represents the content data to send.
- </param>
- <exception cref="T:System.ArgumentNullException">
- <para>
- <paramref name="response"/> is <see langword="null"/>.
- </para>
- <para>
- -or-
- </para>
- <para>
- <paramref name="content"/> is <see langword="null"/>.
- </para>
- </exception>
- </member>
- <member name="T:WebSocketSharp.MessageEventArgs">
- <summary>
- Represents the event data for the <see cref="E:WebSocketSharp.WebSocket.OnMessage"/> event.
- </summary>
- <remarks>
- <para>
- A <see cref="E:WebSocketSharp.WebSocket.OnMessage"/> event occurs when the <see cref="T:WebSocketSharp.WebSocket"/> receives
- a text or binary message, or a ping if the <see cref="P:WebSocketSharp.WebSocket.EmitOnPing"/> property is
- set to <c>true</c>.
- </para>
- <para>
- If you would like to get the message data, you should access the <see cref="P:WebSocketSharp.MessageEventArgs.Data"/> or
- <see cref="P:WebSocketSharp.MessageEventArgs.RawData"/> property.
- </para>
- </remarks>
- </member>
- <member name="P:WebSocketSharp.MessageEventArgs.Data">
- <summary>
- Gets the message data as a <see cref="T:System.String"/>.
- </summary>
- <value>
- A <see cref="T:System.String"/> that represents the message data,
- or <see langword="null"/> if the message data cannot be decoded to a string.
- </value>
- </member>
- <member name="P:WebSocketSharp.MessageEventArgs.IsBinary">
- <summary>
- Gets a value indicating whether the message type is binary.
- </summary>
- <value>
- <c>true</c> if the message type is binary; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:WebSocketSharp.MessageEventArgs.IsPing">
- <summary>
- Gets a value indicating whether the message type is ping.
- </summary>
- <value>
- <c>true</c> if the message type is ping; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:WebSocketSharp.MessageEventArgs.IsText">
- <summary>
- Gets a value indicating whether the message type is text.
- </summary>
- <value>
- <c>true</c> if the message type is text; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:WebSocketSharp.MessageEventArgs.RawData">
- <summary>
- Gets the message data as an array of <see cref="T:System.Byte"/>.
- </summary>
- <value>
- An array of <see cref="T:System.Byte"/> that represents the message data.
- </value>
- </member>
- <member name="P:WebSocketSharp.MessageEventArgs.Type">
- <summary>
- Gets the message type.
- </summary>
- <value>
- <see cref="F:WebSocketSharp.Opcode.Text"/>, <see cref="F:WebSocketSharp.Opcode.Binary"/>, or <see cref="F:WebSocketSharp.Opcode.Ping"/>.
- </value>
- </member>
- <member name="T:WebSocketSharp.CloseEventArgs">
- <summary>
- Represents the event data for the <see cref="E:WebSocketSharp.WebSocket.OnClose"/> event.
- </summary>
- <remarks>
- <para>
- A <see cref="E:WebSocketSharp.WebSocket.OnClose"/> event occurs when the WebSocket connection
- has been closed.
- </para>
- <para>
- If you would like to get the reason for the close, you should access
- the <see cref="P:WebSocketSharp.CloseEventArgs.Code"/> or <see cref="P:WebSocketSharp.CloseEventArgs.Reason"/> property.
- </para>
- </remarks>
- </member>
- <member name="P:WebSocketSharp.CloseEventArgs.Code">
- <summary>
- Gets the status code for the close.
- </summary>
- <value>
- A <see cref="T:System.UInt16"/> that represents the status code for the close if any.
- </value>
- </member>
- <member name="P:WebSocketSharp.CloseEventArgs.Reason">
- <summary>
- Gets the reason for the close.
- </summary>
- <value>
- A <see cref="T:System.String"/> that represents the reason for the close if any.
- </value>
- </member>
- <member name="P:WebSocketSharp.CloseEventArgs.WasClean">
- <summary>
- Gets a value indicating whether the connection has been closed cleanly.
- </summary>
- <value>
- <c>true</c> if the connection has been closed cleanly; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="T:WebSocketSharp.ByteOrder">
- <summary>
- Specifies the byte order.
- </summary>
- </member>
- <member name="F:WebSocketSharp.ByteOrder.Little">
- <summary>
- Specifies Little-endian.
- </summary>
- </member>
- <member name="F:WebSocketSharp.ByteOrder.Big">
- <summary>
- Specifies Big-endian.
- </summary>
- </member>
- <member name="T:WebSocketSharp.ErrorEventArgs">
- <summary>
- Represents the event data for the <see cref="E:WebSocketSharp.WebSocket.OnError"/> event.
- </summary>
- <remarks>
- <para>
- A <see cref="E:WebSocketSharp.WebSocket.OnError"/> event occurs when the <see cref="T:WebSocketSharp.WebSocket"/> gets
- an error.
- </para>
- <para>
- If you would like to get the error message, you should access
- the <see cref="P:WebSocketSharp.ErrorEventArgs.Message"/> property.
- </para>
- <para>
- And if the error is due to an exception, you can get the exception by accessing
- the <see cref="P:WebSocketSharp.ErrorEventArgs.Exception"/> property.
- </para>
- </remarks>
- </member>
- <member name="P:WebSocketSharp.ErrorEventArgs.Exception">
- <summary>
- Gets the exception that caused the error.
- </summary>
- <value>
- An <see cref="T:System.Exception"/> instance that represents the cause of the error,
- or <see langword="null"/> if the error isn't due to an exception.
- </value>
- </member>
- <member name="P:WebSocketSharp.ErrorEventArgs.Message">
- <summary>
- Gets the error message.
- </summary>
- <value>
- A <see cref="T:System.String"/> that represents the error message.
- </value>
- </member>
- <member name="T:WebSocketSharp.WebSocket">
- <summary>
- Implements the WebSocket interface.
- </summary>
- <remarks>
- The WebSocket class provides a set of methods and properties for two-way communication using
- the WebSocket protocol (<see href="http://tools.ietf.org/html/rfc6455">RFC 6455</see>).
- </remarks>
- </member>
- <member name="F:WebSocketSharp.WebSocket.EmptyBytes">
- <summary>
- Represents the empty array of <see cref="T:System.Byte"/> used internally.
- </summary>
- </member>
- <member name="F:WebSocketSharp.WebSocket.FragmentLength">
- <summary>
- Represents the length used to determine whether the data should be fragmented in sending.
- </summary>
- <remarks>
- <para>
- The data will be fragmented if that length is greater than the value of this field.
- </para>
- <para>
- If you would like to change the value, you must set it to a value between <c>125</c> and
- <c>Int32.MaxValue - 14</c> inclusive.
- </para>
- </remarks>
- </member>
- <member name="F:WebSocketSharp.WebSocket.RandomNumber">
- <summary>
- Represents the random number generator used internally.
- </summary>
- </member>
- <member name="M:WebSocketSharp.WebSocket.#ctor(System.String,System.String[])">
- <summary>
- Initializes a new instance of the <see cref="T:WebSocketSharp.WebSocket"/> class with
- the specified WebSocket URL and subprotocols.
- </summary>
- <param name="url">
- A <see cref="T:System.String"/> that represents the WebSocket URL to connect.
- </param>
- <param name="protocols">
- An array of <see cref="T:System.String"/> that contains the WebSocket subprotocols if any.
- Each value of <paramref name="protocols"/> must be a token defined in
- <see href="http://tools.ietf.org/html/rfc2616#section-2.2">RFC 2616</see>.
- </param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="url"/> is <see langword="null"/>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>
- <paramref name="url"/> is invalid.
- </para>
- <para>
- -or-
- </para>
- <para>
- <paramref name="protocols"/> is invalid.
- </para>
- </exception>
- </member>
- <member name="M:WebSocketSharp.WebSocket.Accept">
- <summary>
- Accepts the WebSocket handshake request.
- </summary>
- <remarks>
- This method isn't available in a client.
- </remarks>
- </member>
- <member name="M:WebSocketSharp.WebSocket.AcceptAsync">
- <summary>
- Accepts the WebSocket handshake request asynchronously.
- </summary>
- <remarks>
- <para>
- This method doesn't wait for the accept to be complete.
- </para>
- <para>
- This method isn't available in a client.
- </para>
- </remarks>
- </member>
- <member name="M:WebSocketSharp.WebSocket.Close">
- <summary>
- Closes the WebSocket connection, and releases all associated resources.
- </summary>
- </member>
- <member name="M:WebSocketSharp.WebSocket.Close(System.UInt16)">
- <summary>
- Closes the WebSocket connection with the specified <see cref="T:System.UInt16"/>,
- and releases all associated resources.
- </summary>
- <remarks>
- This method emits a <see cref="E:WebSocketSharp.WebSocket.OnError"/> event if <paramref name="code"/> isn't in
- the allowable range of the close status code.
- </remarks>
- <param name="code">
- A <see cref="T:System.UInt16"/> that represents the status code indicating the reason for the close.
- </param>
- </member>
- <member name="M:WebSocketSharp.WebSocket.Close(WebSocketSharp.CloseStatusCode)">
- <summary>
- Closes the WebSocket connection with the specified <see cref="T:WebSocketSharp.CloseStatusCode"/>,
- and releases all associated resources.
- </summary>
- <param name="code">
- One of the <see cref="T:WebSocketSharp.CloseStatusCode"/> enum values, represents the status code indicating
- the reason for the close.
- </param>
- </member>
- <member name="M:WebSocketSharp.WebSocket.Close(System.UInt16,System.String)">
- <summary>
- Closes the WebSocket connection with the specified <see cref="T:System.UInt16"/> and
- <see cref="T:System.String"/>, and releases all associated resources.
- </summary>
- <remarks>
- This method emits a <see cref="E:WebSocketSharp.WebSocket.OnError"/> event if <paramref name="code"/> isn't in
- the allowable range of the close status code or the size of <paramref name="reason"/> is
- greater than 123 bytes.
- </remarks>
- <param name="code">
- A <see cref="T:System.UInt16"/> that represents the status code indicating the reason for the close.
- </param>
- <param name="reason">
- A <see cref="T:System.String"/> that represents the reason for the close.
- </param>
- </member>
- <member name="M:WebSocketSharp.WebSocket.Close(WebSocketSharp.CloseStatusCode,System.String)">
- <summary>
- Closes the WebSocket connection with the specified <see cref="T:WebSocketSharp.CloseStatusCode"/> and
- <see cref="T:System.String"/>, and releases all associated resources.
- </summary>
- <remarks>
- This method emits a <see cref="E:WebSocketSharp.WebSocket.OnError"/> event if the size of <paramref name="reason"/> is
- greater than 123 bytes.
- </remarks>
- <param name="code">
- One of the <see cref="T:WebSocketSharp.CloseStatusCode"/> enum values, represents the status code indicating
- the reason for the close.
- </param>
- <param name="reason">
- A <see cref="T:System.String"/> that represents the reason for the close.
- </param>
- </member>
- <member name="M:WebSocketSharp.WebSocket.CloseAsync">
- <summary>
- Closes the WebSocket connection asynchronously, and releases all associated resources.
- </summary>
- <remarks>
- This method doesn't wait for the close to be complete.
- </remarks>
- </member>
- <member name="M:WebSocketSharp.WebSocket.CloseAsync(System.UInt16)">
- <summary>
- Closes the WebSocket connection asynchronously with the specified <see cref="T:System.UInt16"/>,
- and releases all associated resources.
- </summary>
- <remarks>
- <para>
- This method doesn't wait for the close to be complete.
- </para>
- <para>
- This method emits a <see cref="E:WebSocketSharp.WebSocket.OnError"/> event if <paramref name="code"/> isn't in
- the allowable range of the close status code.
- </para>
- </remarks>
- <param name="code">
- A <see cref="T:System.UInt16"/> that represents the status code indicating the reason for the close.
- </param>
- </member>
- <member name="M:WebSocketSharp.WebSocket.CloseAsync(WebSocketSharp.CloseStatusCode)">
- <summary>
- Closes the WebSocket connection asynchronously with the specified
- <see cref="T:WebSocketSharp.CloseStatusCode"/>, and releases all associated resources.
- </summary>
- <remarks>
- This method doesn't wait for the close to be complete.
- </remarks>
- <param name="code">
- One of the <see cref="T:WebSocketSharp.CloseStatusCode"/> enum values, represents the status code indicating
- the reason for the close.
- </param>
- </member>
- <member name="M:WebSocketSharp.WebSocket.CloseAsync(System.UInt16,System.String)">
- <summary>
- Closes the WebSocket connection asynchronously with the specified <see cref="T:System.UInt16"/> and
- <see cref="T:System.String"/>, and releases all associated resources.
- </summary>
- <remarks>
- <para>
- This method doesn't wait for the close to be complete.
- </para>
- <para>
- This method emits a <see cref="E:WebSocketSharp.WebSocket.OnError"/> event if <paramref name="code"/> isn't in
- the allowable range of the close status code or the size of <paramref name="reason"/> is
- greater than 123 bytes.
- </para>
- </remarks>
- <param name="code">
- A <see cref="T:System.UInt16"/> that represents the status code indicating the reason for the close.
- </param>
- <param name="reason">
- A <see cref="T:System.String"/> that represents the reason for the close.
- </param>
- </member>
- <member name="M:WebSocketSharp.WebSocket.CloseAsync(WebSocketSharp.CloseStatusCode,System.String)">
- <summary>
- Closes the WebSocket connection asynchronously with the specified
- <see cref="T:WebSocketSharp.CloseStatusCode"/> and <see cref="T:System.String"/>, and releases
- all associated resources.
- </summary>
- <remarks>
- <para>
- This method doesn't wait for the close to be complete.
- </para>
- <para>
- This method emits a <see cref="E:WebSocketSharp.WebSocket.OnError"/> event if the size of
- <paramref name="reason"/> is greater than 123 bytes.
- </para>
- </remarks>
- <param name="code">
- One of the <see cref="T:WebSocketSharp.CloseStatusCode"/> enum values, represents the status code indicating
- the reason for the close.
- </param>
- <param name="reason">
- A <see cref="T:System.String"/> that represents the reason for the close.
- </param>
- </member>
- <member name="M:WebSocketSharp.WebSocket.Connect">
- <summary>
- Establishes a WebSocket connection.
- </summary>
- <remarks>
- This method isn't available in a server.
- </remarks>
- </member>
- <member name="M:WebSocketSharp.WebSocket.ConnectAsync">
- <summary>
- Establishes a WebSocket connection asynchronously.
- </summary>
- <remarks>
- <para>
- This method doesn't wait for the connect to be complete.
- </para>
- <para>
- This method isn't available in a server.
- </para>
- </remarks>
- </member>
- <member name="M:WebSocketSharp.WebSocket.Ping">
- <summary>
- Sends a ping using the WebSocket connection.
- </summary>
- <returns>
- <c>true</c> if the <see cref="T:WebSocketSharp.WebSocket"/> receives a pong to this ping in a time;
- otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:WebSocketSharp.WebSocket.Ping(System.String)">
- <summary>
- Sends a ping with the specified <paramref name="message"/> using the WebSocket connection.
- </summary>
- <returns>
- <c>true</c> if the <see cref="T:WebSocketSharp.WebSocket"/> receives a pong to this ping in a time;
- otherwise, <c>false</c>.
- </returns>
- <param name="message">
- A <see cref="T:System.String"/> that represents the message to send.
- </param>
- </member>
- <member name="M:WebSocketSharp.WebSocket.Send(System.Byte[])">
- <summary>
- Sends binary <paramref name="data"/> using the WebSocket connection.
- </summary>
- <param name="data">
- An array of <see cref="T:System.Byte"/> that represents the binary data to send.
- </param>
- </member>
- <member name="M:WebSocketSharp.WebSocket.Send(System.IO.FileInfo)">
- <summary>
- Sends the specified <paramref name="file"/> as binary data using the WebSocket connection.
- </summary>
- <param name="file">
- A <see cref="T:System.IO.FileInfo"/> that represents the file to send.
- </param>
- </member>
- <member name="M:WebSocketSharp.WebSocket.Send(System.String)">
- <summary>
- Sends text <paramref name="data"/> using the WebSocket connection.
- </summary>
- <param name="data">
- A <see cref="T:System.String"/> that represents the text data to send.
- </param>
- </member>
- <member name="M:WebSocketSharp.WebSocket.SendAsync(System.Byte[],System.Action{System.Boolean})">
- <summary>
- Sends binary <paramref name="data"/> asynchronously using the WebSocket connection.
- </summary>
- <remarks>
- This method doesn't wait for the send to be complete.
- </remarks>
- <param name="data">
- An array of <see cref="T:System.Byte"/> that represents the binary data to send.
- </param>
- <param name="completed">
- An <c>Action<bool></c> delegate that references the method(s) called when
- the send is complete. A <see cref="T:System.Boolean"/> passed to this delegate is <c>true</c>
- if the send is complete successfully.
- </param>
- </member>
- <member name="M:WebSocketSharp.WebSocket.SendAsync(System.IO.FileInfo,System.Action{System.Boolean})">
- <summary>
- Sends the specified <paramref name="file"/> as binary data asynchronously using
- the WebSocket connection.
- </summary>
- <remarks>
- This method doesn't wait for the send to be complete.
- </remarks>
- <param name="file">
- A <see cref="T:System.IO.FileInfo"/> that represents the file to send.
- </param>
- <param name="completed">
- An <c>Action<bool></c> delegate that references the method(s) called when
- the send is complete. A <see cref="T:System.Boolean"/> passed to this delegate is <c>true</c>
- if the send is complete successfully.
- </param>
- </member>
- <member name="M:WebSocketSharp.WebSocket.SendAsync(System.String,System.Action{System.Boolean})">
- <summary>
- Sends text <paramref name="data"/> asynchronously using the WebSocket connection.
- </summary>
- <remarks>
- This method doesn't wait for the send to be complete.
- </remarks>
- <param name="data">
- A <see cref="T:System.String"/> that represents the text data to send.
- </param>
- <param name="completed">
- An <c>Action<bool></c> delegate that references the method(s) called when
- the send is complete. A <see cref="T:System.Boolean"/> passed to this delegate is <c>true</c>
- if the send is complete successfully.
- </param>
- </member>
- <member name="M:WebSocketSharp.WebSocket.SendAsync(System.IO.Stream,System.Int32,System.Action{System.Boolean})">
- <summary>
- Sends binary data from the specified <see cref="T:System.IO.Stream"/> asynchronously using
- the WebSocket connection.
- </summary>
- <remarks>
- This method doesn't wait for the send to be complete.
- </remarks>
- <param name="stream">
- A <see cref="T:System.IO.Stream"/> from which contains the binary data to send.
- </param>
- <param name="length">
- An <see cref="T:System.Int32"/> that represents the number of bytes to send.
- </param>
- <param name="completed">
- An <c>Action<bool></c> delegate that references the method(s) called when
- the send is complete. A <see cref="T:System.Boolean"/> passed to this delegate is <c>true</c>
- if the send is complete successfully.
- </param>
- </member>
- <member name="M:WebSocketSharp.WebSocket.SetCookie(WebSocketSharp.Net.Cookie)">
- <summary>
- Sets an HTTP <paramref name="cookie"/> to send with
- the WebSocket handshake request to the server.
- </summary>
- <param name="cookie">
- A <see cref="T:WebSocketSharp.Net.Cookie"/> that represents the cookie to send.
- </param>
- </member>
- <member name="M:WebSocketSharp.WebSocket.SetCredentials(System.String,System.String,System.Boolean)">
- <summary>
- Sets a pair of <paramref name="username"/> and <paramref name="password"/> for
- the HTTP authentication (Basic/Digest).
- </summary>
- <param name="username">
- A <see cref="T:System.String"/> that represents the user name used to authenticate.
- </param>
- <param name="password">
- A <see cref="T:System.String"/> that represents the password for <paramref name="username"/>
- used to authenticate.
- </param>
- <param name="preAuth">
- <c>true</c> if the <see cref="T:WebSocketSharp.WebSocket"/> sends the Basic authentication credentials with
- the first handshake request to the server; otherwise, <c>false</c>.
- </param>
- </member>
- <member name="M:WebSocketSharp.WebSocket.SetProxy(System.String,System.String,System.String)">
- <summary>
- Sets an HTTP proxy server URL to connect through, and if necessary,
- a pair of <paramref name="username"/> and <paramref name="password"/> for
- the proxy server authentication (Basic/Digest).
- </summary>
- <param name="url">
- A <see cref="T:System.String"/> that represents the proxy server URL to connect through.
- </param>
- <param name="username">
- A <see cref="T:System.String"/> that represents the user name used to authenticate.
- </param>
- <param name="password">
- A <see cref="T:System.String"/> that represents the password for <paramref name="username"/>
- used to authenticate.
- </param>
- </member>
- <member name="M:WebSocketSharp.WebSocket.System#IDisposable#Dispose">
- <summary>
- Closes the WebSocket connection, and releases all associated resources.
- </summary>
- <remarks>
- This method closes the connection with <see cref="F:WebSocketSharp.CloseStatusCode.Away"/>.
- </remarks>
- </member>
- <member name="P:WebSocketSharp.WebSocket.Compression">
- <summary>
- Gets or sets the compression method used to compress a message on the WebSocket connection.
- </summary>
- <value>
- One of the <see cref="T:WebSocketSharp.CompressionMethod"/> enum values, specifies the compression method
- used to compress a message. The default value is <see cref="F:WebSocketSharp.CompressionMethod.None"/>.
- </value>
- </member>
- <member name="P:WebSocketSharp.WebSocket.Cookies">
- <summary>
- Gets the HTTP cookies included in the WebSocket handshake request and response.
- </summary>
- <value>
- An <see cref="T:System.Collections.Generic.IEnumerable{WebSocketSharp.Net.Cookie}"/>
- instance that provides an enumerator which supports the iteration over the collection of
- the cookies.
- </value>
- </member>
- <member name="P:WebSocketSharp.WebSocket.Credentials">
- <summary>
- Gets the credentials for the HTTP authentication (Basic/Digest).
- </summary>
- <value>
- A <see cref="T:WebSocketSharp.Net.NetworkCredential"/> that represents the credentials for
- the authentication. The default value is <see langword="null"/>.
- </value>
- </member>
- <member name="P:WebSocketSharp.WebSocket.EmitOnPing">
- <summary>
- Gets or sets a value indicating whether the <see cref="T:WebSocketSharp.WebSocket"/> emits
- a <see cref="E:WebSocketSharp.WebSocket.OnMessage"/> event when receives a ping.
- </summary>
- <value>
- <c>true</c> if the <see cref="T:WebSocketSharp.WebSocket"/> emits a <see cref="E:WebSocketSharp.WebSocket.OnMessage"/> event
- when receives a ping; otherwise, <c>false</c>. The default value is <c>false</c>.
- </value>
- </member>
- <member name="P:WebSocketSharp.WebSocket.EnableRedirection">
- <summary>
- Gets or sets a value indicating whether the <see cref="T:WebSocketSharp.WebSocket"/> redirects
- the handshake request to the new URL located in the handshake response.
- </summary>
- <value>
- <c>true</c> if the <see cref="T:WebSocketSharp.WebSocket"/> redirects the handshake request to
- the new URL; otherwise, <c>false</c>. The default value is <c>false</c>.
- </value>
- </member>
- <member name="P:WebSocketSharp.WebSocket.Extensions">
- <summary>
- Gets the WebSocket extensions selected by the server.
- </summary>
- <value>
- A <see cref="T:System.String"/> that represents the extensions if any.
- The default value is <see cref="F:System.String.Empty"/>.
- </value>
- </member>
- <member name="P:WebSocketSharp.WebSocket.IsAlive">
- <summary>
- Gets a value indicating whether the WebSocket connection is alive.
- </summary>
- <value>
- <c>true</c> if the connection is alive; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:WebSocketSharp.WebSocket.IsSecure">
- <summary>
- Gets a value indicating whether the WebSocket connection is secure.
- </summary>
- <value>
- <c>true</c> if the connection is secure; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:WebSocketSharp.WebSocket.Log">
- <summary>
- Gets the logging functions.
- </summary>
- <remarks>
- The default logging level is <see cref="F:WebSocketSharp.LogLevel.Error"/>. If you would like to change it,
- you should set this <c>Log.Level</c> property to any of the <see cref="T:WebSocketSharp.LogLevel"/> enum
- values.
- </remarks>
- <value>
- A <see cref="T:WebSocketSharp.Logger"/> that provides the logging functions.
- </value>
- </member>
- <member name="P:WebSocketSharp.WebSocket.Origin">
- <summary>
- Gets or sets the value of the HTTP Origin header to send with
- the WebSocket handshake request to the server.
- </summary>
- <remarks>
- The <see cref="T:WebSocketSharp.WebSocket"/> sends the Origin header if this property has any.
- </remarks>
- <value>
- <para>
- A <see cref="T:System.String"/> that represents the value of
- the <see href="http://tools.ietf.org/html/rfc6454#section-7">Origin</see> header to send.
- The default value is <see langword="null"/>.
- </para>
- <para>
- The Origin header has the following syntax:
- <c><scheme>://<host>[:<port>]</c>
- </para>
- </value>
- </member>
- <member name="P:WebSocketSharp.WebSocket.Protocol">
- <summary>
- Gets the WebSocket subprotocol selected by the server.
- </summary>
- <value>
- A <see cref="T:System.String"/> that represents the subprotocol if any.
- The default value is <see cref="F:System.String.Empty"/>.
- </value>
- </member>
- <member name="P:WebSocketSharp.WebSocket.ReadyState">
- <summary>
- Gets the state of the WebSocket connection.
- </summary>
- <value>
- One of the <see cref="T:WebSocketSharp.WebSocketState"/> enum values, indicates the state of the connection.
- The default value is <see cref="F:WebSocketSharp.WebSocketState.Connecting"/>.
- </value>
- </member>
- <member name="P:WebSocketSharp.WebSocket.SslConfiguration">
- <summary>
- Gets or sets the SSL configuration used to authenticate the server and
- optionally the client for secure connection.
- </summary>
- <value>
- A <see cref="T:WebSocketSharp.Net.ClientSslConfiguration"/> that represents the configuration used
- to authenticate the server and optionally the client for secure connection,
- or <see langword="null"/> if the <see cref="T:WebSocketSharp.WebSocket"/> is used in a server.
- </value>
- </member>
- <member name="P:WebSocketSharp.WebSocket.Url">
- <summary>
- Gets the WebSocket URL used to connect, or accepted.
- </summary>
- <value>
- A <see cref="T:System.Uri"/> that represents the URL used to connect, or accepted.
- </value>
- </member>
- <member name="P:WebSocketSharp.WebSocket.WaitTime">
- <summary>
- Gets or sets the wait time for the response to the Ping or Close.
- </summary>
- <value>
- A <see cref="T:System.TimeSpan"/> that represents the wait time. The default value is the same as
- 5 seconds, or 1 second if the <see cref="T:WebSocketSharp.WebSocket"/> is used in a server.
- </value>
- </member>
- <member name="E:WebSocketSharp.WebSocket.OnClose">
- <summary>
- Occurs when the WebSocket connection has been closed.
- </summary>
- </member>
- <member name="E:WebSocketSharp.WebSocket.OnError">
- <summary>
- Occurs when the <see cref="T:WebSocketSharp.WebSocket"/> gets an error.
- </summary>
- </member>
- <member name="E:WebSocketSharp.WebSocket.OnMessage">
- <summary>
- Occurs when the <see cref="T:WebSocketSharp.WebSocket"/> receives a message.
- </summary>
- </member>
- <member name="E:WebSocketSharp.WebSocket.OnOpen">
- <summary>
- Occurs when the WebSocket connection has been established.
- </summary>
- </member>
- <member name="T:WebSocketSharp.Server.WebSocketServer">
- <summary>
- Provides a WebSocket protocol server.
- </summary>
- <remarks>
- The WebSocketServer class can provide multiple WebSocket services.
- </remarks>
- </member>
- <member name="M:WebSocketSharp.Server.WebSocketServer.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:WebSocketSharp.Server.WebSocketServer"/> class.
- </summary>
- <remarks>
- An instance initialized by this constructor listens for the incoming connection requests on
- port 80.
- </remarks>
- </member>
- <member name="M:WebSocketSharp.Server.WebSocketServer.#ctor(System.Int32)">
- <summary>
- Initializes a new instance of the <see cref="T:WebSocketSharp.Server.WebSocketServer"/> class with
- the specified <paramref name="port"/>.
- </summary>
- <remarks>
- <para>
- An instance initialized by this constructor listens for the incoming connection requests
- on <paramref name="port"/>.
- </para>
- <para>
- If <paramref name="port"/> is 443, that instance provides a secure connection.
- </para>
- </remarks>
- <param name="port">
- An <see cref="T:System.Int32"/> that represents the port number on which to listen.
- </param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> isn't between 1 and 65535 inclusive.
- </exception>
- </member>
- <member name="M:WebSocketSharp.Server.WebSocketServer.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:WebSocketSharp.Server.WebSocketServer"/> class with
- the specified WebSocket URL.
- </summary>
- <remarks>
- <para>
- An instance initialized by this constructor listens for the incoming connection requests
- on the host name and port in <paramref name="url"/>.
- </para>
- <para>
- If <paramref name="url"/> doesn't include a port, either port 80 or 443 is used on
- which to listen. It's determined by the scheme (ws or wss) in <paramref name="url"/>.
- (Port 80 if the scheme is ws.)
- </para>
- </remarks>
- <param name="url">
- A <see cref="T:System.String"/> that represents the WebSocket URL of the server.
- </param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="url"/> is <see langword="null"/>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>
- <paramref name="url"/> is empty.
- </para>
- <para>
- -or-
- </para>
- <para>
- <paramref name="url"/> is invalid.
- </para>
- </exception>
- </member>
- <member name="M:WebSocketSharp.Server.WebSocketServer.#ctor(System.Int32,System.Boolean)">
- <summary>
- Initializes a new instance of the <see cref="T:WebSocketSharp.Server.WebSocketServer"/> class with
- the specified <paramref name="port"/> and <paramref name="secure"/>.
- </summary>
- <remarks>
- An instance initialized by this constructor listens for the incoming connection requests on
- <paramref name="port"/>.
- </remarks>
- <param name="port">
- An <see cref="T:System.Int32"/> that represents the port number on which to listen.
- </param>
- <param name="secure">
- A <see cref="T:System.Boolean"/> that indicates providing a secure connection or not.
- (<c>true</c> indicates providing a secure connection.)
- </param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> isn't between 1 and 65535 inclusive.
- </exception>
- </member>
- <member name="M:WebSocketSharp.Server.WebSocketServer.#ctor(System.Net.IPAddress,System.Int32)">
- <summary>
- Initializes a new instance of the <see cref="T:WebSocketSharp.Server.WebSocketServer"/> class with
- the specified <paramref name="address"/> and <paramref name="port"/>.
- </summary>
- <remarks>
- <para>
- An instance initialized by this constructor listens for the incoming connection requests
- on <paramref name="address"/> and <paramref name="port"/>.
- </para>
- <para>
- If <paramref name="port"/> is 443, that instance provides a secure connection.
- </para>
- </remarks>
- <param name="address">
- A <see cref="T:System.Net.IPAddress"/> that represents the local IP address of the server.
- </param>
- <param name="port">
- An <see cref="T:System.Int32"/> that represents the port number on which to listen.
- </param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="address"/> is <see langword="null"/>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="address"/> isn't a local IP address.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> isn't between 1 and 65535 inclusive.
- </exception>
- </member>
- <member name="M:WebSocketSharp.Server.WebSocketServer.#ctor(System.Net.IPAddress,System.Int32,System.Boolean)">
- <summary>
- Initializes a new instance of the <see cref="T:WebSocketSharp.Server.WebSocketServer"/> class with
- the specified <paramref name="address"/>, <paramref name="port"/>,
- and <paramref name="secure"/>.
- </summary>
- <remarks>
- An instance initialized by this constructor listens for the incoming connection requests on
- <paramref name="address"/> and <paramref name="port"/>.
- </remarks>
- <param name="address">
- A <see cref="T:System.Net.IPAddress"/> that represents the local IP address of the server.
- </param>
- <param name="port">
- An <see cref="T:System.Int32"/> that represents the port number on which to listen.
- </param>
- <param name="secure">
- A <see cref="T:System.Boolean"/> that indicates providing a secure connection or not.
- (<c>true</c> indicates providing a secure connection.)
- </param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="address"/> is <see langword="null"/>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="address"/> isn't a local IP address.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> isn't between 1 and 65535 inclusive.
- </exception>
- </member>
- <member name="M:WebSocketSharp.Server.WebSocketServer.AddWebSocketService``1(System.String,System.Func{``0})">
- <summary>
- Adds a WebSocket service with the specified behavior, <paramref name="path"/>,
- and <paramref name="initializer"/>.
- </summary>
- <remarks>
- <para>
- This method converts <paramref name="path"/> to URL-decoded string,
- and removes <c>'/'</c> from tail end of <paramref name="path"/>.
- </para>
- <para>
- <paramref name="initializer"/> returns an initialized specified typed
- <see cref="T:WebSocketSharp.Server.WebSocketBehavior"/> instance.
- </para>
- </remarks>
- <param name="path">
- A <see cref="T:System.String"/> that represents the absolute path to the service to add.
- </param>
- <param name="initializer">
- A <c>Func<T></c> delegate that references the method used to initialize
- a new specified typed <see cref="T:WebSocketSharp.Server.WebSocketBehavior"/> instance (a new
- <see cref="T:WebSocketSharp.Server.IWebSocketSession"/> instance).
- </param>
- <typeparam name="TBehavior">
- The type of the behavior of the service to add. The TBehavior must inherit
- the <see cref="T:WebSocketSharp.Server.WebSocketBehavior"/> class.
- </typeparam>
- </member>
- <member name="M:WebSocketSharp.Server.WebSocketServer.AddWebSocketService``1(System.String)">
- <summary>
- Adds a WebSocket service with the specified behavior and <paramref name="path"/>.
- </summary>
- <remarks>
- This method converts <paramref name="path"/> to URL-decoded string,
- and removes <c>'/'</c> from tail end of <paramref name="path"/>.
- </remarks>
- <param name="path">
- A <see cref="T:System.String"/> that represents the absolute path to the service to add.
- </param>
- <typeparam name="TBehaviorWithNew">
- The type of the behavior of the service to add. The TBehaviorWithNew must inherit
- the <see cref="T:WebSocketSharp.Server.WebSocketBehavior"/> class, and must have a public parameterless
- constructor.
- </typeparam>
- </member>
- <member name="M:WebSocketSharp.Server.WebSocketServer.RemoveWebSocketService(System.String)">
- <summary>
- Removes the WebSocket service with the specified <paramref name="path"/>.
- </summary>
- <remarks>
- This method converts <paramref name="path"/> to URL-decoded string,
- and removes <c>'/'</c> from tail end of <paramref name="path"/>.
- </remarks>
- <returns>
- <c>true</c> if the service is successfully found and removed; otherwise, <c>false</c>.
- </returns>
- <param name="path">
- A <see cref="T:System.String"/> that represents the absolute path to the service to find.
- </param>
- </member>
- <member name="M:WebSocketSharp.Server.WebSocketServer.Start">
- <summary>
- Starts receiving the WebSocket connection requests.
- </summary>
- </member>
- <member name="M:WebSocketSharp.Server.WebSocketServer.Stop">
- <summary>
- Stops receiving the WebSocket connection requests.
- </summary>
- </member>
- <member name="M:WebSocketSharp.Server.WebSocketServer.Stop(System.UInt16,System.String)">
- <summary>
- Stops receiving the WebSocket connection requests with
- the specified <see cref="T:System.UInt16"/> and <see cref="T:System.String"/>.
- </summary>
- <param name="code">
- A <see cref="T:System.UInt16"/> that represents the status code indicating the reason for the stop.
- </param>
- <param name="reason">
- A <see cref="T:System.String"/> that represents the reason for the stop.
- </param>
- </member>
- <member name="M:WebSocketSharp.Server.WebSocketServer.Stop(WebSocketSharp.CloseStatusCode,System.String)">
- <summary>
- Stops receiving the WebSocket connection requests with
- the specified <see cref="T:WebSocketSharp.CloseStatusCode"/> and <see cref="T:System.String"/>.
- </summary>
- <param name="code">
- One of the <see cref="T:WebSocketSharp.CloseStatusCode"/> enum values, represents the status code indicating
- the reason for the stop.
- </param>
- <param name="reason">
- A <see cref="T:System.String"/> that represents the reason for the stop.
- </param>
- </member>
- <member name="P:WebSocketSharp.Server.WebSocketServer.Address">
- <summary>
- Gets the local IP address of the server.
- </summary>
- <value>
- A <see cref="T:System.Net.IPAddress"/> that represents the local IP address of the server.
- </value>
- </member>
- <member name="P:WebSocketSharp.Server.WebSocketServer.AuthenticationSchemes">
- <summary>
- Gets or sets the scheme used to authenticate the clients.
- </summary>
- <value>
- One of the <see cref="T:WebSocketSharp.Net.AuthenticationSchemes"/> enum values,
- indicates the scheme used to authenticate the clients. The default value is
- <see cref="F:WebSocketSharp.Net.AuthenticationSchemes.Anonymous"/>.
- </value>
- </member>
- <member name="P:WebSocketSharp.Server.WebSocketServer.IsListening">
- <summary>
- Gets a value indicating whether the server has started.
- </summary>
- <value>
- <c>true</c> if the server has started; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:WebSocketSharp.Server.WebSocketServer.IsSecure">
- <summary>
- Gets a value indicating whether the server provides a secure connection.
- </summary>
- <value>
- <c>true</c> if the server provides a secure connection; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:WebSocketSharp.Server.WebSocketServer.KeepClean">
- <summary>
- Gets or sets a value indicating whether the server cleans up
- the inactive sessions periodically.
- </summary>
- <value>
- <c>true</c> if the server cleans up the inactive sessions every 60 seconds;
- otherwise, <c>false</c>. The default value is <c>true</c>.
- </value>
- </member>
- <member name="P:WebSocketSharp.Server.WebSocketServer.Log">
- <summary>
- Gets the logging functions.
- </summary>
- <remarks>
- The default logging level is <see cref="F:WebSocketSharp.LogLevel.Error"/>. If you would like to change it,
- you should set the <c>Log.Level</c> property to any of the <see cref="T:WebSocketSharp.LogLevel"/> enum
- values.
- </remarks>
- <value>
- A <see cref="T:WebSocketSharp.Logger"/> that provides the logging functions.
- </value>
- </member>
- <member name="P:WebSocketSharp.Server.WebSocketServer.Port">
- <summary>
- Gets the port on which to listen for incoming connection requests.
- </summary>
- <value>
- An <see cref="T:System.Int32"/> that represents the port number on which to listen.
- </value>
- </member>
- <member name="P:WebSocketSharp.Server.WebSocketServer.Realm">
- <summary>
- Gets or sets the name of the realm associated with the server.
- </summary>
- <remarks>
- If this property is <see langword="null"/> or empty, <c>"SECRET AREA"</c> will be used as
- the name of the realm.
- </remarks>
- <value>
- A <see cref="T:System.String"/> that represents the name of the realm. The default value is
- <see langword="null"/>.
- </value>
- </member>
- <member name="P:WebSocketSharp.Server.WebSocketServer.ReuseAddress">
- <summary>
- Gets or sets a value indicating whether the server is allowed to be bound to
- an address that is already in use.
- </summary>
- <remarks>
- If you would like to resolve to wait for socket in <c>TIME_WAIT</c> state,
- you should set this property to <c>true</c>.
- </remarks>
- <value>
- <c>true</c> if the server is allowed to be bound to an address that is already in use;
- otherwise, <c>false</c>. The default value is <c>false</c>.
- </value>
- </member>
- <member name="P:WebSocketSharp.Server.WebSocketServer.SslConfiguration">
- <summary>
- Gets or sets the SSL configuration used to authenticate the server and
- optionally the client for secure connection.
- </summary>
- <value>
- A <see cref="T:WebSocketSharp.Net.ServerSslConfiguration"/> that represents the configuration used to
- authenticate the server and optionally the client for secure connection.
- </value>
- </member>
- <member name="P:WebSocketSharp.Server.WebSocketServer.UserCredentialsFinder">
- <summary>
- Gets or sets the delegate called to find the credentials for an identity used to
- authenticate a client.
- </summary>
- <value>
- A <c>Func<<see cref="T:System.Security.Principal.IIdentity"/>, <see cref="T:WebSocketSharp.Net.NetworkCredential"/>></c> delegate
- that references the method(s) used to find the credentials. The default value is
- <see langword="null"/>.
- </value>
- </member>
- <member name="P:WebSocketSharp.Server.WebSocketServer.WaitTime">
- <summary>
- Gets or sets the wait time for the response to the WebSocket Ping or Close.
- </summary>
- <value>
- A <see cref="T:System.TimeSpan"/> that represents the wait time. The default value is
- the same as 1 second.
- </value>
- </member>
- <member name="P:WebSocketSharp.Server.WebSocketServer.WebSocketServices">
- <summary>
- Gets the access to the WebSocket services provided by the server.
- </summary>
- <value>
- A <see cref="T:WebSocketSharp.Server.WebSocketServiceManager"/> that manages the WebSocket services.
- </value>
- </member>
- <member name="T:WebSocketSharp.Net.AuthenticationSchemes">
- <summary>
- Specifies the scheme for authentication.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.AuthenticationSchemes.None">
- <summary>
- No authentication is allowed.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.AuthenticationSchemes.Digest">
- <summary>
- Specifies digest authentication.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.AuthenticationSchemes.Basic">
- <summary>
- Specifies basic authentication.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.AuthenticationSchemes.Anonymous">
- <summary>
- Specifies anonymous authentication.
- </summary>
- </member>
- <member name="T:WebSocketSharp.Net.Cookie">
- <summary>
- Provides a set of methods and properties used to manage an HTTP Cookie.
- </summary>
- <remarks>
- <para>
- The Cookie class supports the following cookie formats:
- <see href="http://web.archive.org/web/20020803110822/http://wp.netscape.com/newsref/std/cookie_spec.html">Netscape specification</see>,
- <see href="http://www.ietf.org/rfc/rfc2109.txt">RFC 2109</see>, and
- <see href="http://www.ietf.org/rfc/rfc2965.txt">RFC 2965</see>
- </para>
- <para>
- The Cookie class cannot be inherited.
- </para>
- </remarks>
- </member>
- <member name="M:WebSocketSharp.Net.Cookie.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:WebSocketSharp.Net.Cookie"/> class.
- </summary>
- </member>
- <member name="M:WebSocketSharp.Net.Cookie.#ctor(System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:WebSocketSharp.Net.Cookie"/> class with the specified
- <paramref name="name"/> and <paramref name="value"/>.
- </summary>
- <param name="name">
- A <see cref="T:System.String"/> that represents the Name of the cookie.
- </param>
- <param name="value">
- A <see cref="T:System.String"/> that represents the Value of the cookie.
- </param>
- <exception cref="T:WebSocketSharp.Net.CookieException">
- <para>
- <paramref name="name"/> is <see langword="null"/> or empty.
- </para>
- <para>
- - or -
- </para>
- <para>
- <paramref name="name"/> contains an invalid character.
- </para>
- <para>
- - or -
- </para>
- <para>
- <paramref name="value"/> is <see langword="null"/>.
- </para>
- <para>
- - or -
- </para>
- <para>
- <paramref name="value"/> contains a string not enclosed in double quotes
- that contains an invalid character.
- </para>
- </exception>
- </member>
- <member name="M:WebSocketSharp.Net.Cookie.#ctor(System.String,System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:WebSocketSharp.Net.Cookie"/> class with the specified
- <paramref name="name"/>, <paramref name="value"/>, and <paramref name="path"/>.
- </summary>
- <param name="name">
- A <see cref="T:System.String"/> that represents the Name of the cookie.
- </param>
- <param name="value">
- A <see cref="T:System.String"/> that represents the Value of the cookie.
- </param>
- <param name="path">
- A <see cref="T:System.String"/> that represents the value of the Path attribute of the cookie.
- </param>
- <exception cref="T:WebSocketSharp.Net.CookieException">
- <para>
- <paramref name="name"/> is <see langword="null"/> or empty.
- </para>
- <para>
- - or -
- </para>
- <para>
- <paramref name="name"/> contains an invalid character.
- </para>
- <para>
- - or -
- </para>
- <para>
- <paramref name="value"/> is <see langword="null"/>.
- </para>
- <para>
- - or -
- </para>
- <para>
- <paramref name="value"/> contains a string not enclosed in double quotes
- that contains an invalid character.
- </para>
- </exception>
- </member>
- <member name="M:WebSocketSharp.Net.Cookie.#ctor(System.String,System.String,System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:WebSocketSharp.Net.Cookie"/> class with the specified
- <paramref name="name"/>, <paramref name="value"/>, <paramref name="path"/>, and
- <paramref name="domain"/>.
- </summary>
- <param name="name">
- A <see cref="T:System.String"/> that represents the Name of the cookie.
- </param>
- <param name="value">
- A <see cref="T:System.String"/> that represents the Value of the cookie.
- </param>
- <param name="path">
- A <see cref="T:System.String"/> that represents the value of the Path attribute of the cookie.
- </param>
- <param name="domain">
- A <see cref="T:System.String"/> that represents the value of the Domain attribute of the cookie.
- </param>
- <exception cref="T:WebSocketSharp.Net.CookieException">
- <para>
- <paramref name="name"/> is <see langword="null"/> or empty.
- </para>
- <para>
- - or -
- </para>
- <para>
- <paramref name="name"/> contains an invalid character.
- </para>
- <para>
- - or -
- </para>
- <para>
- <paramref name="value"/> is <see langword="null"/>.
- </para>
- <para>
- - or -
- </para>
- <para>
- <paramref name="value"/> contains a string not enclosed in double quotes
- that contains an invalid character.
- </para>
- </exception>
- </member>
- <member name="M:WebSocketSharp.Net.Cookie.Equals(System.Object)">
- <summary>
- Determines whether the specified <see cref="T:System.Object"/> is equal to the current
- <see cref="T:WebSocketSharp.Net.Cookie"/>.
- </summary>
- <param name="comparand">
- An <see cref="T:System.Object"/> to compare with the current <see cref="T:WebSocketSharp.Net.Cookie"/>.
- </param>
- <returns>
- <c>true</c> if <paramref name="comparand"/> is equal to the current <see cref="T:WebSocketSharp.Net.Cookie"/>;
- otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:WebSocketSharp.Net.Cookie.GetHashCode">
- <summary>
- Serves as a hash function for a <see cref="T:WebSocketSharp.Net.Cookie"/> object.
- </summary>
- <returns>
- An <see cref="T:System.Int32"/> that represents the hash code for the current <see cref="T:WebSocketSharp.Net.Cookie"/>.
- </returns>
- </member>
- <member name="M:WebSocketSharp.Net.Cookie.ToString">
- <summary>
- Returns a <see cref="T:System.String"/> that represents the current <see cref="T:WebSocketSharp.Net.Cookie"/>.
- </summary>
- <remarks>
- This method returns a <see cref="T:System.String"/> to use to send an HTTP Cookie to
- an origin server.
- </remarks>
- <returns>
- A <see cref="T:System.String"/> that represents the current <see cref="T:WebSocketSharp.Net.Cookie"/>.
- </returns>
- </member>
- <member name="P:WebSocketSharp.Net.Cookie.Comment">
- <summary>
- Gets or sets the value of the Comment attribute of the cookie.
- </summary>
- <value>
- A <see cref="T:System.String"/> that represents the comment to document intended use of the cookie.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.Cookie.CommentUri">
- <summary>
- Gets or sets the value of the CommentURL attribute of the cookie.
- </summary>
- <value>
- A <see cref="T:System.Uri"/> that represents the URI that provides the comment to document intended
- use of the cookie.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.Cookie.Discard">
- <summary>
- Gets or sets a value indicating whether the client discards the cookie unconditionally
- when the client terminates.
- </summary>
- <value>
- <c>true</c> if the client discards the cookie unconditionally when the client terminates;
- otherwise, <c>false</c>. The default value is <c>false</c>.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.Cookie.Domain">
- <summary>
- Gets or sets the value of the Domain attribute of the cookie.
- </summary>
- <value>
- A <see cref="T:System.String"/> that represents the URI for which the cookie is valid.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.Cookie.Expired">
- <summary>
- Gets or sets a value indicating whether the cookie has expired.
- </summary>
- <value>
- <c>true</c> if the cookie has expired; otherwise, <c>false</c>.
- The default value is <c>false</c>.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.Cookie.Expires">
- <summary>
- Gets or sets the value of the Expires attribute of the cookie.
- </summary>
- <value>
- A <see cref="T:System.DateTime"/> that represents the date and time at which the cookie expires.
- The default value is <see cref="F:System.DateTime.MinValue"/>.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.Cookie.HttpOnly">
- <summary>
- Gets or sets a value indicating whether non-HTTP APIs can access the cookie.
- </summary>
- <value>
- <c>true</c> if non-HTTP APIs cannot access the cookie; otherwise, <c>false</c>.
- The default value is <c>false</c>.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.Cookie.Name">
- <summary>
- Gets or sets the Name of the cookie.
- </summary>
- <value>
- A <see cref="T:System.String"/> that represents the Name of the cookie.
- </value>
- <exception cref="T:WebSocketSharp.Net.CookieException">
- <para>
- The value specified for a set operation is <see langword="null"/> or empty.
- </para>
- <para>
- - or -
- </para>
- <para>
- The value specified for a set operation contains an invalid character.
- </para>
- </exception>
- </member>
- <member name="P:WebSocketSharp.Net.Cookie.Path">
- <summary>
- Gets or sets the value of the Path attribute of the cookie.
- </summary>
- <value>
- A <see cref="T:System.String"/> that represents the subset of URI on the origin server
- to which the cookie applies.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.Cookie.Port">
- <summary>
- Gets or sets the value of the Port attribute of the cookie.
- </summary>
- <value>
- A <see cref="T:System.String"/> that represents the list of TCP ports to which the cookie applies.
- </value>
- <exception cref="T:WebSocketSharp.Net.CookieException">
- The value specified for a set operation isn't enclosed in double quotes or
- couldn't be parsed.
- </exception>
- </member>
- <member name="P:WebSocketSharp.Net.Cookie.Secure">
- <summary>
- Gets or sets a value indicating whether the security level of the cookie is secure.
- </summary>
- <remarks>
- When this property is <c>true</c>, the cookie may be included in the HTTP request
- only if the request is transmitted over the HTTPS.
- </remarks>
- <value>
- <c>true</c> if the security level of the cookie is secure; otherwise, <c>false</c>.
- The default value is <c>false</c>.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.Cookie.TimeStamp">
- <summary>
- Gets the time when the cookie was issued.
- </summary>
- <value>
- A <see cref="T:System.DateTime"/> that represents the time when the cookie was issued.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.Cookie.Value">
- <summary>
- Gets or sets the Value of the cookie.
- </summary>
- <value>
- A <see cref="T:System.String"/> that represents the Value of the cookie.
- </value>
- <exception cref="T:WebSocketSharp.Net.CookieException">
- <para>
- The value specified for a set operation is <see langword="null"/>.
- </para>
- <para>
- - or -
- </para>
- <para>
- The value specified for a set operation contains a string not enclosed in double quotes
- that contains an invalid character.
- </para>
- </exception>
- </member>
- <member name="P:WebSocketSharp.Net.Cookie.Version">
- <summary>
- Gets or sets the value of the Version attribute of the cookie.
- </summary>
- <value>
- An <see cref="T:System.Int32"/> that represents the version of the HTTP state management
- to which the cookie conforms.
- </value>
- <exception cref="T:System.ArgumentOutOfRangeException">
- The value specified for a set operation isn't 0 or 1.
- </exception>
- </member>
- <member name="T:WebSocketSharp.Net.CookieCollection">
- <summary>
- Provides a collection container for instances of the <see cref="T:WebSocketSharp.Net.Cookie"/> class.
- </summary>
- </member>
- <member name="M:WebSocketSharp.Net.CookieCollection.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:WebSocketSharp.Net.CookieCollection"/> class.
- </summary>
- </member>
- <member name="M:WebSocketSharp.Net.CookieCollection.Add(WebSocketSharp.Net.Cookie)">
- <summary>
- Adds the specified <paramref name="cookie"/> to the collection.
- </summary>
- <param name="cookie">
- A <see cref="T:WebSocketSharp.Net.Cookie"/> to add.
- </param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="cookie"/> is <see langword="null"/>.
- </exception>
- </member>
- <member name="M:WebSocketSharp.Net.CookieCollection.Add(WebSocketSharp.Net.CookieCollection)">
- <summary>
- Adds the specified <paramref name="cookies"/> to the collection.
- </summary>
- <param name="cookies">
- A <see cref="T:WebSocketSharp.Net.CookieCollection"/> that contains the cookies to add.
- </param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="cookies"/> is <see langword="null"/>.
- </exception>
- </member>
- <member name="M:WebSocketSharp.Net.CookieCollection.CopyTo(System.Array,System.Int32)">
- <summary>
- Copies the elements of the collection to the specified <see cref="T:System.Array"/>, starting at
- the specified <paramref name="index"/> in the <paramref name="array"/>.
- </summary>
- <param name="array">
- An <see cref="T:System.Array"/> that represents the destination of the elements copied from
- the collection.
- </param>
- <param name="index">
- An <see cref="T:System.Int32"/> that represents the zero-based index in <paramref name="array"/>
- at which copying begins.
- </param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="array"/> is <see langword="null"/>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is less than zero.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>
- <paramref name="array"/> is multidimensional.
- </para>
- <para>
- -or-
- </para>
- <para>
- The number of elements in the collection is greater than the available space from
- <paramref name="index"/> to the end of the destination <paramref name="array"/>.
- </para>
- </exception>
- <exception cref="T:System.InvalidCastException">
- The elements in the collection cannot be cast automatically to the type of the destination
- <paramref name="array"/>.
- </exception>
- </member>
- <member name="M:WebSocketSharp.Net.CookieCollection.CopyTo(WebSocketSharp.Net.Cookie[],System.Int32)">
- <summary>
- Copies the elements of the collection to the specified array of <see cref="T:WebSocketSharp.Net.Cookie"/>,
- starting at the specified <paramref name="index"/> in the <paramref name="array"/>.
- </summary>
- <param name="array">
- An array of <see cref="T:WebSocketSharp.Net.Cookie"/> that represents the destination of the elements
- copied from the collection.
- </param>
- <param name="index">
- An <see cref="T:System.Int32"/> that represents the zero-based index in <paramref name="array"/>
- at which copying begins.
- </param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="array"/> is <see langword="null"/>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is less than zero.
- </exception>
- <exception cref="T:System.ArgumentException">
- The number of elements in the collection is greater than the available space from
- <paramref name="index"/> to the end of the destination <paramref name="array"/>.
- </exception>
- </member>
- <member name="M:WebSocketSharp.Net.CookieCollection.GetEnumerator">
- <summary>
- Gets the enumerator used to iterate through the collection.
- </summary>
- <returns>
- An <see cref="T:System.Collections.IEnumerator"/> instance used to iterate through the collection.
- </returns>
- </member>
- <member name="P:WebSocketSharp.Net.CookieCollection.Count">
- <summary>
- Gets the number of cookies in the collection.
- </summary>
- <value>
- An <see cref="T:System.Int32"/> that represents the number of cookies in the collection.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.CookieCollection.IsReadOnly">
- <summary>
- Gets a value indicating whether the collection is read-only.
- </summary>
- <value>
- <c>true</c> if the collection is read-only; otherwise, <c>false</c>.
- The default value is <c>true</c>.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.CookieCollection.IsSynchronized">
- <summary>
- Gets a value indicating whether the access to the collection is thread safe.
- </summary>
- <value>
- <c>true</c> if the access to the collection is thread safe; otherwise, <c>false</c>.
- The default value is <c>false</c>.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.CookieCollection.Item(System.Int32)">
- <summary>
- Gets the <see cref="T:WebSocketSharp.Net.Cookie"/> at the specified <paramref name="index"/> from
- the collection.
- </summary>
- <value>
- A <see cref="T:WebSocketSharp.Net.Cookie"/> at the specified <paramref name="index"/> in the collection.
- </value>
- <param name="index">
- An <see cref="T:System.Int32"/> that represents the zero-based index of the <see cref="T:WebSocketSharp.Net.Cookie"/>
- to find.
- </param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of allowable range of indexes for the collection.
- </exception>
- </member>
- <member name="P:WebSocketSharp.Net.CookieCollection.Item(System.String)">
- <summary>
- Gets the <see cref="T:WebSocketSharp.Net.Cookie"/> with the specified <paramref name="name"/> from
- the collection.
- </summary>
- <value>
- A <see cref="T:WebSocketSharp.Net.Cookie"/> with the specified <paramref name="name"/> in the collection.
- </value>
- <param name="name">
- A <see cref="T:System.String"/> that represents the name of the <see cref="T:WebSocketSharp.Net.Cookie"/> to find.
- </param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="name"/> is <see langword="null"/>.
- </exception>
- </member>
- <member name="P:WebSocketSharp.Net.CookieCollection.SyncRoot">
- <summary>
- Gets an object used to synchronize access to the collection.
- </summary>
- <value>
- An <see cref="T:System.Object"/> used to synchronize access to the collection.
- </value>
- </member>
- <member name="T:WebSocketSharp.Net.CookieException">
- <summary>
- The exception that is thrown when a <see cref="T:WebSocketSharp.Net.Cookie"/> gets an error.
- </summary>
- </member>
- <member name="M:WebSocketSharp.Net.CookieException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Initializes a new instance of the <see cref="T:WebSocketSharp.Net.CookieException"/> class from
- the specified <see cref="T:System.Runtime.Serialization.SerializationInfo"/> and <see cref="T:System.Runtime.Serialization.StreamingContext"/>.
- </summary>
- <param name="serializationInfo">
- A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that contains the serialized object data.
- </param>
- <param name="streamingContext">
- A <see cref="T:System.Runtime.Serialization.StreamingContext"/> that specifies the source for the deserialization.
- </param>
- </member>
- <member name="M:WebSocketSharp.Net.CookieException.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:WebSocketSharp.Net.CookieException"/> class.
- </summary>
- </member>
- <member name="M:WebSocketSharp.Net.CookieException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Populates the specified <see cref="T:System.Runtime.Serialization.SerializationInfo"/> with the data needed to serialize
- the current <see cref="T:WebSocketSharp.Net.CookieException"/>.
- </summary>
- <param name="serializationInfo">
- A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data.
- </param>
- <param name="streamingContext">
- A <see cref="T:System.Runtime.Serialization.StreamingContext"/> that specifies the destination for the serialization.
- </param>
- </member>
- <member name="M:WebSocketSharp.Net.CookieException.System#Runtime#Serialization#ISerializable#GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Populates the specified <see cref="T:System.Runtime.Serialization.SerializationInfo"/> with the data needed to serialize
- the current <see cref="T:WebSocketSharp.Net.CookieException"/>.
- </summary>
- <param name="serializationInfo">
- A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data.
- </param>
- <param name="streamingContext">
- A <see cref="T:System.Runtime.Serialization.StreamingContext"/> that specifies the destination for the serialization.
- </param>
- </member>
- <member name="T:WebSocketSharp.Net.HttpListener">
- <summary>
- Provides a simple, programmatically controlled HTTP listener.
- </summary>
- </member>
- <member name="M:WebSocketSharp.Net.HttpListener.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:WebSocketSharp.Net.HttpListener"/> class.
- </summary>
- </member>
- <member name="M:WebSocketSharp.Net.HttpListener.Abort">
- <summary>
- Shuts down the listener immediately.
- </summary>
- </member>
- <member name="M:WebSocketSharp.Net.HttpListener.BeginGetContext(System.AsyncCallback,System.Object)">
- <summary>
- Begins getting an incoming request asynchronously.
- </summary>
- <remarks>
- This asynchronous operation must be completed by calling the <c>EndGetContext</c> method.
- Typically, the method is invoked by the <paramref name="callback"/> delegate.
- </remarks>
- <returns>
- An <see cref="T:System.IAsyncResult"/> that represents the status of the asynchronous operation.
- </returns>
- <param name="callback">
- An <see cref="T:System.AsyncCallback"/> delegate that references the method to invoke when
- the asynchronous operation completes.
- </param>
- <param name="state">
- An <see cref="T:System.Object"/> that represents a user defined object to pass to
- the <paramref name="callback"/> delegate.
- </param>
- <exception cref="T:System.InvalidOperationException">
- <para>
- This listener has no URI prefix on which listens.
- </para>
- <para>
- -or-
- </para>
- <para>
- This listener hasn't been started, or is currently stopped.
- </para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- This listener has been closed.
- </exception>
- </member>
- <member name="M:WebSocketSharp.Net.HttpListener.Close">
- <summary>
- Shuts down the listener.
- </summary>
- </member>
- <member name="M:WebSocketSharp.Net.HttpListener.EndGetContext(System.IAsyncResult)">
- <summary>
- Ends an asynchronous operation to get an incoming request.
- </summary>
- <remarks>
- This method completes an asynchronous operation started by calling
- the <c>BeginGetContext</c> method.
- </remarks>
- <returns>
- A <see cref="T:WebSocketSharp.Net.HttpListenerContext"/> that represents a request.
- </returns>
- <param name="asyncResult">
- An <see cref="T:System.IAsyncResult"/> obtained by calling the <c>BeginGetContext</c> method.
- </param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="asyncResult"/> is <see langword="null"/>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="asyncResult"/> wasn't obtained by calling the <c>BeginGetContext</c> method.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- This method was already called for the specified <paramref name="asyncResult"/>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- This listener has been closed.
- </exception>
- </member>
- <member name="M:WebSocketSharp.Net.HttpListener.GetContext">
- <summary>
- Gets an incoming request.
- </summary>
- <remarks>
- This method waits for an incoming request, and returns when a request is received.
- </remarks>
- <returns>
- A <see cref="T:WebSocketSharp.Net.HttpListenerContext"/> that represents a request.
- </returns>
- <exception cref="T:System.InvalidOperationException">
- <para>
- This listener has no URI prefix on which listens.
- </para>
- <para>
- -or-
- </para>
- <para>
- This listener hasn't been started, or is currently stopped.
- </para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- This listener has been closed.
- </exception>
- </member>
- <member name="M:WebSocketSharp.Net.HttpListener.Start">
- <summary>
- Starts receiving incoming requests.
- </summary>
- <exception cref="T:System.ObjectDisposedException">
- This listener has been closed.
- </exception>
- </member>
- <member name="M:WebSocketSharp.Net.HttpListener.Stop">
- <summary>
- Stops receiving incoming requests.
- </summary>
- <exception cref="T:System.ObjectDisposedException">
- This listener has been closed.
- </exception>
- </member>
- <member name="M:WebSocketSharp.Net.HttpListener.System#IDisposable#Dispose">
- <summary>
- Releases all resources used by the listener.
- </summary>
- </member>
- <member name="P:WebSocketSharp.Net.HttpListener.AuthenticationSchemes">
- <summary>
- Gets or sets the scheme used to authenticate the clients.
- </summary>
- <value>
- One of the <see cref="T:WebSocketSharp.Net.AuthenticationSchemes"/> enum values,
- represents the scheme used to authenticate the clients. The default value is
- <see cref="F:WebSocketSharp.Net.AuthenticationSchemes.Anonymous"/>.
- </value>
- <exception cref="T:System.ObjectDisposedException">
- This listener has been closed.
- </exception>
- </member>
- <member name="P:WebSocketSharp.Net.HttpListener.AuthenticationSchemeSelector">
- <summary>
- Gets or sets the delegate called to select the scheme used to authenticate the clients.
- </summary>
- <remarks>
- If you set this property, the listener uses the authentication scheme selected by
- the delegate for each request. Or if you don't set, the listener uses the value of
- the <see cref="P:WebSocketSharp.Net.HttpListener.AuthenticationSchemes"/> property as the authentication
- scheme for all requests.
- </remarks>
- <value>
- A <c>Func<<see cref="T:WebSocketSharp.Net.HttpListenerRequest"/>, <see cref="P:WebSocketSharp.Net.HttpListener.AuthenticationSchemes"/>></c>
- delegate that references the method used to select an authentication scheme. The default
- value is <see langword="null"/>.
- </value>
- <exception cref="T:System.ObjectDisposedException">
- This listener has been closed.
- </exception>
- </member>
- <member name="P:WebSocketSharp.Net.HttpListener.CertificateFolderPath">
- <summary>
- Gets or sets the path to the folder in which stores the certificate files used to
- authenticate the server on the secure connection.
- </summary>
- <remarks>
- <para>
- This property represents the path to the folder in which stores the certificate files
- associated with each port number of added URI prefixes. A set of the certificate files
- is a pair of the <c>'port number'.cer</c> (DER) and <c>'port number'.key</c>
- (DER, RSA Private Key).
- </para>
- <para>
- If this property is <see langword="null"/> or empty, the result of
- <c>System.Environment.GetFolderPath
- (<see cref="F:System.Environment.SpecialFolder.ApplicationData"/>)</c> is used as the default path.
- </para>
- </remarks>
- <value>
- A <see cref="T:System.String"/> that represents the path to the folder in which stores
- the certificate files. The default value is <see langword="null"/>.
- </value>
- <exception cref="T:System.ObjectDisposedException">
- This listener has been closed.
- </exception>
- </member>
- <member name="P:WebSocketSharp.Net.HttpListener.IgnoreWriteExceptions">
- <summary>
- Gets or sets a value indicating whether the listener returns exceptions that occur when
- sending the response to the client.
- </summary>
- <value>
- <c>true</c> if the listener shouldn't return those exceptions; otherwise, <c>false</c>.
- The default value is <c>false</c>.
- </value>
- <exception cref="T:System.ObjectDisposedException">
- This listener has been closed.
- </exception>
- </member>
- <member name="P:WebSocketSharp.Net.HttpListener.IsListening">
- <summary>
- Gets a value indicating whether the listener has been started.
- </summary>
- <value>
- <c>true</c> if the listener has been started; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.HttpListener.IsSupported">
- <summary>
- Gets a value indicating whether the listener can be used with the current operating system.
- </summary>
- <value>
- <c>true</c>.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.HttpListener.Log">
- <summary>
- Gets the logging functions.
- </summary>
- <remarks>
- The default logging level is <see cref="F:WebSocketSharp.LogLevel.Error"/>. If you would like to change it,
- you should set the <c>Log.Level</c> property to any of the <see cref="T:WebSocketSharp.LogLevel"/> enum
- values.
- </remarks>
- <value>
- A <see cref="T:WebSocketSharp.Logger"/> that provides the logging functions.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.HttpListener.Prefixes">
- <summary>
- Gets the URI prefixes handled by the listener.
- </summary>
- <value>
- A <see cref="T:WebSocketSharp.Net.HttpListenerPrefixCollection"/> that contains the URI prefixes.
- </value>
- <exception cref="T:System.ObjectDisposedException">
- This listener has been closed.
- </exception>
- </member>
- <member name="P:WebSocketSharp.Net.HttpListener.Realm">
- <summary>
- Gets or sets the name of the realm associated with the listener.
- </summary>
- <remarks>
- If this property is <see langword="null"/> or empty, <c>"SECRET AREA"</c> will be used as
- the name of the realm.
- </remarks>
- <value>
- A <see cref="T:System.String"/> that represents the name of the realm. The default value is
- <see langword="null"/>.
- </value>
- <exception cref="T:System.ObjectDisposedException">
- This listener has been closed.
- </exception>
- </member>
- <member name="P:WebSocketSharp.Net.HttpListener.SslConfiguration">
- <summary>
- Gets or sets the SSL configuration used to authenticate the server and
- optionally the client for secure connection.
- </summary>
- <value>
- A <see cref="T:WebSocketSharp.Net.ServerSslConfiguration"/> that represents the configuration used to
- authenticate the server and optionally the client for secure connection.
- </value>
- <exception cref="T:System.ObjectDisposedException">
- This listener has been closed.
- </exception>
- </member>
- <member name="P:WebSocketSharp.Net.HttpListener.UnsafeConnectionNtlmAuthentication">
- <summary>
- Gets or sets a value indicating whether, when NTLM authentication is used,
- the authentication information of first request is used to authenticate
- additional requests on the same connection.
- </summary>
- <remarks>
- This property isn't currently supported and always throws
- a <see cref="T:System.NotSupportedException"/>.
- </remarks>
- <value>
- <c>true</c> if the authentication information of first request is used;
- otherwise, <c>false</c>.
- </value>
- <exception cref="T:System.NotSupportedException">
- Any use of this property.
- </exception>
- </member>
- <member name="P:WebSocketSharp.Net.HttpListener.UserCredentialsFinder">
- <summary>
- Gets or sets the delegate called to find the credentials for an identity used to
- authenticate a client.
- </summary>
- <value>
- A <c>Func<<see cref="T:System.Security.Principal.IIdentity"/>, <see cref="T:WebSocketSharp.Net.NetworkCredential"/>></c> delegate
- that references the method used to find the credentials. The default value is
- <see langword="null"/>.
- </value>
- <exception cref="T:System.ObjectDisposedException">
- This listener has been closed.
- </exception>
- </member>
- <member name="T:WebSocketSharp.Net.HttpListenerContext">
- <summary>
- Provides the access to the HTTP request and response objects used by
- the <see cref="T:WebSocketSharp.Net.HttpListener"/>.
- </summary>
- <remarks>
- This class cannot be inherited.
- </remarks>
- </member>
- <member name="M:WebSocketSharp.Net.HttpListenerContext.AcceptWebSocket(System.String)">
- <summary>
- Accepts a WebSocket handshake request.
- </summary>
- <returns>
- A <see cref="T:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext"/> that represents
- the WebSocket handshake request.
- </returns>
- <param name="protocol">
- A <see cref="T:System.String"/> that represents the subprotocol supported on
- this WebSocket connection.
- </param>
- <exception cref="T:System.ArgumentException">
- <para>
- <paramref name="protocol"/> is empty.
- </para>
- <para>
- -or-
- </para>
- <para>
- <paramref name="protocol"/> contains an invalid character.
- </para>
- </exception>
- <exception cref="T:System.InvalidOperationException">
- This method has already been called.
- </exception>
- </member>
- <member name="P:WebSocketSharp.Net.HttpListenerContext.Request">
- <summary>
- Gets the HTTP request object that represents a client request.
- </summary>
- <value>
- A <see cref="T:WebSocketSharp.Net.HttpListenerRequest"/> that represents the client request.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.HttpListenerContext.Response">
- <summary>
- Gets the HTTP response object used to send a response to the client.
- </summary>
- <value>
- A <see cref="T:WebSocketSharp.Net.HttpListenerResponse"/> that represents a response to the client request.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.HttpListenerContext.User">
- <summary>
- Gets the client information (identity, authentication, and security roles).
- </summary>
- <value>
- A <see cref="T:System.Security.Principal.IPrincipal"/> instance that represents the client information.
- </value>
- </member>
- <member name="T:WebSocketSharp.Net.HttpListenerException">
- <summary>
- The exception that is thrown when a <see cref="T:WebSocketSharp.Net.HttpListener"/> gets an error
- processing an HTTP request.
- </summary>
- </member>
- <member name="M:WebSocketSharp.Net.HttpListenerException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Initializes a new instance of the <see cref="T:WebSocketSharp.Net.HttpListenerException"/> class from
- the specified <see cref="T:System.Runtime.Serialization.SerializationInfo"/> and <see cref="T:System.Runtime.Serialization.StreamingContext"/>.
- </summary>
- <param name="serializationInfo">
- A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that contains the serialized object data.
- </param>
- <param name="streamingContext">
- A <see cref="T:System.Runtime.Serialization.StreamingContext"/> that specifies the source for the deserialization.
- </param>
- </member>
- <member name="M:WebSocketSharp.Net.HttpListenerException.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:WebSocketSharp.Net.HttpListenerException"/> class.
- </summary>
- </member>
- <member name="M:WebSocketSharp.Net.HttpListenerException.#ctor(System.Int32)">
- <summary>
- Initializes a new instance of the <see cref="T:WebSocketSharp.Net.HttpListenerException"/> class
- with the specified <paramref name="errorCode"/>.
- </summary>
- <param name="errorCode">
- An <see cref="T:System.Int32"/> that identifies the error.
- </param>
- </member>
- <member name="M:WebSocketSharp.Net.HttpListenerException.#ctor(System.Int32,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:WebSocketSharp.Net.HttpListenerException"/> class
- with the specified <paramref name="errorCode"/> and <paramref name="message"/>.
- </summary>
- <param name="errorCode">
- An <see cref="T:System.Int32"/> that identifies the error.
- </param>
- <param name="message">
- A <see cref="T:System.String"/> that describes the error.
- </param>
- </member>
- <member name="P:WebSocketSharp.Net.HttpListenerException.ErrorCode">
- <summary>
- Gets the error code that identifies the error that occurred.
- </summary>
- <value>
- An <see cref="T:System.Int32"/> that identifies the error.
- </value>
- </member>
- <member name="T:WebSocketSharp.Net.HttpListenerPrefixCollection">
- <summary>
- Provides the collection used to store the URI prefixes for the <see cref="T:WebSocketSharp.Net.HttpListener"/>.
- </summary>
- <remarks>
- The <see cref="T:WebSocketSharp.Net.HttpListener"/> responds to the request which has a requested URI that
- the prefixes most closely match.
- </remarks>
- </member>
- <member name="M:WebSocketSharp.Net.HttpListenerPrefixCollection.Add(System.String)">
- <summary>
- Adds the specified <paramref name="uriPrefix"/> to the collection.
- </summary>
- <param name="uriPrefix">
- A <see cref="T:System.String"/> that represents the URI prefix to add. The prefix must be
- a well-formed URI prefix with http or https scheme, and must end with a <c>'/'</c>.
- </param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uriPrefix"/> is <see langword="null"/>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="uriPrefix"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:WebSocketSharp.Net.HttpListener"/> associated with this collection is closed.
- </exception>
- </member>
- <member name="M:WebSocketSharp.Net.HttpListenerPrefixCollection.Clear">
- <summary>
- Removes all URI prefixes from the collection.
- </summary>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:WebSocketSharp.Net.HttpListener"/> associated with this collection is closed.
- </exception>
- </member>
- <member name="M:WebSocketSharp.Net.HttpListenerPrefixCollection.Contains(System.String)">
- <summary>
- Returns a value indicating whether the collection contains the specified
- <paramref name="uriPrefix"/>.
- </summary>
- <returns>
- <c>true</c> if the collection contains <paramref name="uriPrefix"/>;
- otherwise, <c>false</c>.
- </returns>
- <param name="uriPrefix">
- A <see cref="T:System.String"/> that represents the URI prefix to test.
- </param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uriPrefix"/> is <see langword="null"/>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:WebSocketSharp.Net.HttpListener"/> associated with this collection is closed.
- </exception>
- </member>
- <member name="M:WebSocketSharp.Net.HttpListenerPrefixCollection.CopyTo(System.Array,System.Int32)">
- <summary>
- Copies the contents of the collection to the specified <see cref="T:System.Array"/>.
- </summary>
- <param name="array">
- An <see cref="T:System.Array"/> that receives the URI prefix strings in the collection.
- </param>
- <param name="offset">
- An <see cref="T:System.Int32"/> that represents the zero-based index in <paramref name="array"/>
- at which copying begins.
- </param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:WebSocketSharp.Net.HttpListener"/> associated with this collection is closed.
- </exception>
- </member>
- <member name="M:WebSocketSharp.Net.HttpListenerPrefixCollection.CopyTo(System.String[],System.Int32)">
- <summary>
- Copies the contents of the collection to the specified array of <see cref="T:System.String"/>.
- </summary>
- <param name="array">
- An array of <see cref="T:System.String"/> that receives the URI prefix strings in the collection.
- </param>
- <param name="offset">
- An <see cref="T:System.Int32"/> that represents the zero-based index in <paramref name="array"/>
- at which copying begins.
- </param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:WebSocketSharp.Net.HttpListener"/> associated with this collection is closed.
- </exception>
- </member>
- <member name="M:WebSocketSharp.Net.HttpListenerPrefixCollection.GetEnumerator">
- <summary>
- Gets the enumerator used to iterate through the <see cref="T:WebSocketSharp.Net.HttpListenerPrefixCollection"/>.
- </summary>
- <returns>
- An <see cref="T:System.Collections.Generic.IEnumerator{string}"/> instance used to iterate
- through the collection.
- </returns>
- </member>
- <member name="M:WebSocketSharp.Net.HttpListenerPrefixCollection.Remove(System.String)">
- <summary>
- Removes the specified <paramref name="uriPrefix"/> from the collection.
- </summary>
- <returns>
- <c>true</c> if <paramref name="uriPrefix"/> is successfully found and removed;
- otherwise, <c>false</c>.
- </returns>
- <param name="uriPrefix">
- A <see cref="T:System.String"/> that represents the URI prefix to remove.
- </param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uriPrefix"/> is <see langword="null"/>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:WebSocketSharp.Net.HttpListener"/> associated with this collection is closed.
- </exception>
- </member>
- <member name="M:WebSocketSharp.Net.HttpListenerPrefixCollection.System#Collections#IEnumerable#GetEnumerator">
- <summary>
- Gets the enumerator used to iterate through the <see cref="T:WebSocketSharp.Net.HttpListenerPrefixCollection"/>.
- </summary>
- <returns>
- An <see cref="T:System.Collections.IEnumerator"/> instance used to iterate through the collection.
- </returns>
- </member>
- <member name="P:WebSocketSharp.Net.HttpListenerPrefixCollection.Count">
- <summary>
- Gets the number of prefixes in the collection.
- </summary>
- <value>
- An <see cref="T:System.Int32"/> that represents the number of prefixes.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.HttpListenerPrefixCollection.IsReadOnly">
- <summary>
- Gets a value indicating whether the access to the collection is read-only.
- </summary>
- <value>
- Always returns <c>false</c>.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.HttpListenerPrefixCollection.IsSynchronized">
- <summary>
- Gets a value indicating whether the access to the collection is synchronized.
- </summary>
- <value>
- Always returns <c>false</c>.
- </value>
- </member>
- <member name="T:WebSocketSharp.Net.HttpListenerRequest">
- <summary>
- Provides the access to a request to the <see cref="T:WebSocketSharp.Net.HttpListener"/>.
- </summary>
- <remarks>
- The HttpListenerRequest class cannot be inherited.
- </remarks>
- </member>
- <member name="M:WebSocketSharp.Net.HttpListenerRequest.BeginGetClientCertificate(System.AsyncCallback,System.Object)">
- <summary>
- Begins getting the client's X.509 v.3 certificate asynchronously.
- </summary>
- <remarks>
- This asynchronous operation must be completed by calling
- the <see cref="M:WebSocketSharp.Net.HttpListenerRequest.EndGetClientCertificate(System.IAsyncResult)"/> method. Typically,
- that method is invoked by the <paramref name="requestCallback"/> delegate.
- </remarks>
- <returns>
- An <see cref="T:System.IAsyncResult"/> that contains the status of the asynchronous operation.
- </returns>
- <param name="requestCallback">
- An <see cref="T:System.AsyncCallback"/> delegate that references the method(s) called when
- the asynchronous operation completes.
- </param>
- <param name="state">
- An <see cref="T:System.Object"/> that contains a user defined object to pass to
- the <paramref name="requestCallback"/> delegate.
- </param>
- <exception cref="T:System.NotImplementedException">
- This method isn't implemented.
- </exception>
- </member>
- <member name="M:WebSocketSharp.Net.HttpListenerRequest.EndGetClientCertificate(System.IAsyncResult)">
- <summary>
- Ends an asynchronous operation to get the client's X.509 v.3 certificate.
- </summary>
- <remarks>
- This method completes an asynchronous operation started by calling
- the <see cref="M:WebSocketSharp.Net.HttpListenerRequest.BeginGetClientCertificate(System.AsyncCallback,System.Object)"/> method.
- </remarks>
- <returns>
- A <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2"/> that contains the client's X.509 v.3 certificate.
- </returns>
- <param name="asyncResult">
- An <see cref="T:System.IAsyncResult"/> obtained by calling
- the <see cref="M:WebSocketSharp.Net.HttpListenerRequest.BeginGetClientCertificate(System.AsyncCallback,System.Object)"/> method.
- </param>
- <exception cref="T:System.NotImplementedException">
- This method isn't implemented.
- </exception>
- </member>
- <member name="M:WebSocketSharp.Net.HttpListenerRequest.GetClientCertificate">
- <summary>
- Gets the client's X.509 v.3 certificate.
- </summary>
- <returns>
- A <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2"/> that contains the client's X.509 v.3 certificate.
- </returns>
- <exception cref="T:System.NotImplementedException">
- This method isn't implemented.
- </exception>
- </member>
- <member name="M:WebSocketSharp.Net.HttpListenerRequest.ToString">
- <summary>
- Returns a <see cref="T:System.String"/> that represents
- the current <see cref="T:WebSocketSharp.Net.HttpListenerRequest"/>.
- </summary>
- <returns>
- A <see cref="T:System.String"/> that represents the current <see cref="T:WebSocketSharp.Net.HttpListenerRequest"/>.
- </returns>
- </member>
- <member name="P:WebSocketSharp.Net.HttpListenerRequest.AcceptTypes">
- <summary>
- Gets the media types which are acceptable for the response.
- </summary>
- <value>
- An array of <see cref="T:System.String"/> that contains the media type names in
- the Accept request-header, or <see langword="null"/> if the request didn't include
- the Accept header.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.HttpListenerRequest.ClientCertificateError">
- <summary>
- Gets an error code that identifies a problem with the client's certificate.
- </summary>
- <value>
- Always returns <c>0</c>.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.HttpListenerRequest.ContentEncoding">
- <summary>
- Gets the encoding for the entity body data included in the request.
- </summary>
- <value>
- A <see cref="T:System.Text.Encoding"/> that represents the encoding for the entity body data,
- or <see cref="P:System.Text.Encoding.Default"/> if the request didn't include the information about
- the encoding.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.HttpListenerRequest.ContentLength64">
- <summary>
- Gets the number of bytes in the entity body data included in the request.
- </summary>
- <value>
- A <see cref="T:System.Int64"/> that represents the value of the Content-Length entity-header,
- or <c>-1</c> if the value isn't known.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.HttpListenerRequest.ContentType">
- <summary>
- Gets the media type of the entity body included in the request.
- </summary>
- <value>
- A <see cref="T:System.String"/> that represents the value of the Content-Type entity-header.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.HttpListenerRequest.Cookies">
- <summary>
- Gets the cookies included in the request.
- </summary>
- <value>
- A <see cref="T:WebSocketSharp.Net.CookieCollection"/> that contains the cookies included in the request.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.HttpListenerRequest.HasEntityBody">
- <summary>
- Gets a value indicating whether the request has the entity body.
- </summary>
- <value>
- <c>true</c> if the request has the entity body; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.HttpListenerRequest.Headers">
- <summary>
- Gets the HTTP headers used in the request.
- </summary>
- <value>
- A <see cref="T:System.Collections.Specialized.NameValueCollection"/> that contains the HTTP headers used in the request.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.HttpListenerRequest.HttpMethod">
- <summary>
- Gets the HTTP method used in the request.
- </summary>
- <value>
- A <see cref="T:System.String"/> that represents the HTTP method used in the request.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.HttpListenerRequest.InputStream">
- <summary>
- Gets a <see cref="T:System.IO.Stream"/> that contains the entity body data included in the request.
- </summary>
- <value>
- A <see cref="T:System.IO.Stream"/> that contains the entity body data included in the request.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.HttpListenerRequest.IsAuthenticated">
- <summary>
- Gets a value indicating whether the client that sent the request is authenticated.
- </summary>
- <value>
- <c>true</c> if the client is authenticated; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.HttpListenerRequest.IsLocal">
- <summary>
- Gets a value indicating whether the request is sent from the local computer.
- </summary>
- <value>
- <c>true</c> if the request is sent from the local computer; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.HttpListenerRequest.IsSecureConnection">
- <summary>
- Gets a value indicating whether the HTTP connection is secured using the SSL protocol.
- </summary>
- <value>
- <c>true</c> if the HTTP connection is secured; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.HttpListenerRequest.IsWebSocketRequest">
- <summary>
- Gets a value indicating whether the request is a WebSocket connection request.
- </summary>
- <value>
- <c>true</c> if the request is a WebSocket connection request; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.HttpListenerRequest.KeepAlive">
- <summary>
- Gets a value indicating whether the client requests a persistent connection.
- </summary>
- <value>
- <c>true</c> if the client requests a persistent connection; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.HttpListenerRequest.LocalEndPoint">
- <summary>
- Gets the server endpoint as an IP address and a port number.
- </summary>
- <value>
- A <see cref="T:System.Net.IPEndPoint"/> that represents the server endpoint.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.HttpListenerRequest.ProtocolVersion">
- <summary>
- Gets the HTTP version used in the request.
- </summary>
- <value>
- A <see cref="T:System.Version"/> that represents the HTTP version used in the request.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.HttpListenerRequest.QueryString">
- <summary>
- Gets the query string included in the request.
- </summary>
- <value>
- A <see cref="T:System.Collections.Specialized.NameValueCollection"/> that contains the query string parameters.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.HttpListenerRequest.RawUrl">
- <summary>
- Gets the raw URL (without the scheme, host, and port) requested by the client.
- </summary>
- <value>
- A <see cref="T:System.String"/> that represents the raw URL requested by the client.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.HttpListenerRequest.RemoteEndPoint">
- <summary>
- Gets the client endpoint as an IP address and a port number.
- </summary>
- <value>
- A <see cref="T:System.Net.IPEndPoint"/> that represents the client endpoint.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.HttpListenerRequest.RequestTraceIdentifier">
- <summary>
- Gets the request identifier of a incoming HTTP request.
- </summary>
- <value>
- A <see cref="T:System.Guid"/> that represents the identifier of a request.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.HttpListenerRequest.Url">
- <summary>
- Gets the URL requested by the client.
- </summary>
- <value>
- A <see cref="T:System.Uri"/> that represents the URL requested by the client.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.HttpListenerRequest.UrlReferrer">
- <summary>
- Gets the URL of the resource from which the requested URL was obtained.
- </summary>
- <value>
- A <see cref="T:System.Uri"/> that represents the value of the Referer request-header,
- or <see langword="null"/> if the request didn't include an Referer header.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.HttpListenerRequest.UserAgent">
- <summary>
- Gets the information about the user agent originating the request.
- </summary>
- <value>
- A <see cref="T:System.String"/> that represents the value of the User-Agent request-header.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.HttpListenerRequest.UserHostAddress">
- <summary>
- Gets the server endpoint as an IP address and a port number.
- </summary>
- <value>
- A <see cref="T:System.String"/> that represents the server endpoint.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.HttpListenerRequest.UserHostName">
- <summary>
- Gets the internet host name and port number (if present) specified by the client.
- </summary>
- <value>
- A <see cref="T:System.String"/> that represents the value of the Host request-header.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.HttpListenerRequest.UserLanguages">
- <summary>
- Gets the natural languages which are preferred for the response.
- </summary>
- <value>
- An array of <see cref="T:System.String"/> that contains the natural language names in
- the Accept-Language request-header, or <see langword="null"/> if the request
- didn't include an Accept-Language header.
- </value>
- </member>
- <member name="T:WebSocketSharp.Net.HttpListenerResponse">
- <summary>
- Provides the access to a response to a request received by the <see cref="T:WebSocketSharp.Net.HttpListener"/>.
- </summary>
- <remarks>
- The HttpListenerResponse class cannot be inherited.
- </remarks>
- </member>
- <member name="M:WebSocketSharp.Net.HttpListenerResponse.Abort">
- <summary>
- Closes the connection to the client without returning a response.
- </summary>
- </member>
- <member name="M:WebSocketSharp.Net.HttpListenerResponse.AddHeader(System.String,System.String)">
- <summary>
- Adds an HTTP header with the specified <paramref name="name"/> and
- <paramref name="value"/> to the headers for the response.
- </summary>
- <param name="name">
- A <see cref="T:System.String"/> that represents the name of the header to add.
- </param>
- <param name="value">
- A <see cref="T:System.String"/> that represents the value of the header to add.
- </param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="name"/> is <see langword="null"/> or empty.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>
- <paramref name="name"/> or <paramref name="value"/> contains invalid characters.
- </para>
- <para>
- -or-
- </para>
- <para>
- <paramref name="name"/> is a restricted header name.
- </para>
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- The length of <paramref name="value"/> is greater than 65,535 characters.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The header cannot be allowed to add to the current headers.
- </exception>
- </member>
- <member name="M:WebSocketSharp.Net.HttpListenerResponse.AppendCookie(WebSocketSharp.Net.Cookie)">
- <summary>
- Appends the specified <paramref name="cookie"/> to the cookies sent with the response.
- </summary>
- <param name="cookie">
- A <see cref="T:WebSocketSharp.Net.Cookie"/> to append.
- </param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="cookie"/> is <see langword="null"/>.
- </exception>
- </member>
- <member name="M:WebSocketSharp.Net.HttpListenerResponse.AppendHeader(System.String,System.String)">
- <summary>
- Appends a <paramref name="value"/> to the specified HTTP header sent with the response.
- </summary>
- <param name="name">
- A <see cref="T:System.String"/> that represents the name of the header to append
- <paramref name="value"/> to.
- </param>
- <param name="value">
- A <see cref="T:System.String"/> that represents the value to append to the header.
- </param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="name"/> is <see langword="null"/> or empty.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>
- <paramref name="name"/> or <paramref name="value"/> contains invalid characters.
- </para>
- <para>
- -or-
- </para>
- <para>
- <paramref name="name"/> is a restricted header name.
- </para>
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- The length of <paramref name="value"/> is greater than 65,535 characters.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The current headers cannot allow the header to append a value.
- </exception>
- </member>
- <member name="M:WebSocketSharp.Net.HttpListenerResponse.Close">
- <summary>
- Returns the response to the client and releases the resources used by
- this <see cref="T:WebSocketSharp.Net.HttpListenerResponse"/> instance.
- </summary>
- </member>
- <member name="M:WebSocketSharp.Net.HttpListenerResponse.Close(System.Byte[],System.Boolean)">
- <summary>
- Returns the response with the specified array of <see cref="T:System.Byte"/> to the client and
- releases the resources used by this <see cref="T:WebSocketSharp.Net.HttpListenerResponse"/> instance.
- </summary>
- <param name="responseEntity">
- An array of <see cref="T:System.Byte"/> that contains the response entity body data.
- </param>
- <param name="willBlock">
- <c>true</c> if this method blocks execution while flushing the stream to the client;
- otherwise, <c>false</c>.
- </param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="responseEntity"/> is <see langword="null"/>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- This object is closed.
- </exception>
- </member>
- <member name="M:WebSocketSharp.Net.HttpListenerResponse.CopyFrom(WebSocketSharp.Net.HttpListenerResponse)">
- <summary>
- Copies some properties from the specified <see cref="T:WebSocketSharp.Net.HttpListenerResponse"/> to
- this response.
- </summary>
- <param name="templateResponse">
- A <see cref="T:WebSocketSharp.Net.HttpListenerResponse"/> to copy.
- </param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="templateResponse"/> is <see langword="null"/>.
- </exception>
- </member>
- <member name="M:WebSocketSharp.Net.HttpListenerResponse.Redirect(System.String)">
- <summary>
- Configures the response to redirect the client's request to
- the specified <paramref name="url"/>.
- </summary>
- <remarks>
- This method sets the <see cref="P:WebSocketSharp.Net.HttpListenerResponse.RedirectLocation"/> property to
- <paramref name="url"/>, the <see cref="P:WebSocketSharp.Net.HttpListenerResponse.StatusCode"/> property to
- <c>302</c>, and the <see cref="P:WebSocketSharp.Net.HttpListenerResponse.StatusDescription"/> property to
- <c>"Found"</c>.
- </remarks>
- <param name="url">
- A <see cref="T:System.String"/> that represents the URL to redirect the client's request to.
- </param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="url"/> is <see langword="null"/>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="url"/> isn't an absolute URL.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The response has already been sent.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- This object is closed.
- </exception>
- </member>
- <member name="M:WebSocketSharp.Net.HttpListenerResponse.SetCookie(WebSocketSharp.Net.Cookie)">
- <summary>
- Adds or updates a <paramref name="cookie"/> in the cookies sent with the response.
- </summary>
- <param name="cookie">
- A <see cref="T:WebSocketSharp.Net.Cookie"/> to set.
- </param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="cookie"/> is <see langword="null"/>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="cookie"/> already exists in the cookies and couldn't be replaced.
- </exception>
- </member>
- <member name="M:WebSocketSharp.Net.HttpListenerResponse.System#IDisposable#Dispose">
- <summary>
- Releases all resources used by the <see cref="T:WebSocketSharp.Net.HttpListenerResponse"/>.
- </summary>
- </member>
- <member name="P:WebSocketSharp.Net.HttpListenerResponse.ContentEncoding">
- <summary>
- Gets or sets the encoding for the entity body data included in the response.
- </summary>
- <value>
- A <see cref="T:System.Text.Encoding"/> that represents the encoding for the entity body data,
- or <see langword="null"/> if no encoding is specified.
- </value>
- <exception cref="T:System.ObjectDisposedException">
- This object is closed.
- </exception>
- </member>
- <member name="P:WebSocketSharp.Net.HttpListenerResponse.ContentLength64">
- <summary>
- Gets or sets the number of bytes in the entity body data included in the response.
- </summary>
- <value>
- A <see cref="T:System.Int64"/> that represents the value of the Content-Length entity-header.
- </value>
- <exception cref="T:System.ArgumentOutOfRangeException">
- The value specified for a set operation is less than zero.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The response has already been sent.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- This object is closed.
- </exception>
- </member>
- <member name="P:WebSocketSharp.Net.HttpListenerResponse.ContentType">
- <summary>
- Gets or sets the media type of the entity body included in the response.
- </summary>
- <value>
- A <see cref="T:System.String"/> that represents the media type of the entity body,
- or <see langword="null"/> if no media type is specified. This value is
- used for the value of the Content-Type entity-header.
- </value>
- <exception cref="T:System.ArgumentException">
- The value specified for a set operation is empty.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- This object is closed.
- </exception>
- </member>
- <member name="P:WebSocketSharp.Net.HttpListenerResponse.Cookies">
- <summary>
- Gets or sets the cookies sent with the response.
- </summary>
- <value>
- A <see cref="T:WebSocketSharp.Net.CookieCollection"/> that contains the cookies sent with the response.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.HttpListenerResponse.Headers">
- <summary>
- Gets or sets the HTTP headers sent to the client.
- </summary>
- <value>
- A <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/> that contains the headers sent to the client.
- </value>
- <exception cref="T:System.InvalidOperationException">
- The value specified for a set operation isn't valid for a response.
- </exception>
- </member>
- <member name="P:WebSocketSharp.Net.HttpListenerResponse.KeepAlive">
- <summary>
- Gets or sets a value indicating whether the server requests a persistent connection.
- </summary>
- <value>
- <c>true</c> if the server requests a persistent connection; otherwise, <c>false</c>.
- The default value is <c>true</c>.
- </value>
- <exception cref="T:System.InvalidOperationException">
- The response has already been sent.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- This object is closed.
- </exception>
- </member>
- <member name="P:WebSocketSharp.Net.HttpListenerResponse.OutputStream">
- <summary>
- Gets a <see cref="T:System.IO.Stream"/> to use to write the entity body data.
- </summary>
- <value>
- A <see cref="T:System.IO.Stream"/> to use to write the entity body data.
- </value>
- <exception cref="T:System.ObjectDisposedException">
- This object is closed.
- </exception>
- </member>
- <member name="P:WebSocketSharp.Net.HttpListenerResponse.ProtocolVersion">
- <summary>
- Gets or sets the HTTP version used in the response.
- </summary>
- <value>
- A <see cref="T:System.Version"/> that represents the version used in the response.
- </value>
- <exception cref="T:System.ArgumentNullException">
- The value specified for a set operation is <see langword="null"/>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The value specified for a set operation doesn't have its <c>Major</c> property set to 1 or
- doesn't have its <c>Minor</c> property set to either 0 or 1.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The response has already been sent.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- This object is closed.
- </exception>
- </member>
- <member name="P:WebSocketSharp.Net.HttpListenerResponse.RedirectLocation">
- <summary>
- Gets or sets the URL to which the client is redirected to locate a requested resource.
- </summary>
- <value>
- A <see cref="T:System.String"/> that represents the value of the Location response-header,
- or <see langword="null"/> if no redirect location is specified.
- </value>
- <exception cref="T:System.ArgumentException">
- The value specified for a set operation isn't an absolute URL.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- This object is closed.
- </exception>
- </member>
- <member name="P:WebSocketSharp.Net.HttpListenerResponse.SendChunked">
- <summary>
- Gets or sets a value indicating whether the response uses the chunked transfer encoding.
- </summary>
- <value>
- <c>true</c> if the response uses the chunked transfer encoding;
- otherwise, <c>false</c>. The default value is <c>false</c>.
- </value>
- <exception cref="T:System.InvalidOperationException">
- The response has already been sent.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- This object is closed.
- </exception>
- </member>
- <member name="P:WebSocketSharp.Net.HttpListenerResponse.StatusCode">
- <summary>
- Gets or sets the HTTP status code returned to the client.
- </summary>
- <value>
- An <see cref="T:System.Int32"/> that represents the status code for the response to
- the request. The default value is same as <see cref="F:WebSocketSharp.Net.HttpStatusCode.OK"/>.
- </value>
- <exception cref="T:System.InvalidOperationException">
- The response has already been sent.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- This object is closed.
- </exception>
- <exception cref="T:System.Net.ProtocolViolationException">
- The value specified for a set operation is invalid. Valid values are
- between 100 and 999 inclusive.
- </exception>
- </member>
- <member name="P:WebSocketSharp.Net.HttpListenerResponse.StatusDescription">
- <summary>
- Gets or sets the description of the HTTP status code returned to the client.
- </summary>
- <value>
- A <see cref="T:System.String"/> that represents the description of the status code. The default
- value is the <see href="http://tools.ietf.org/html/rfc2616#section-10">RFC 2616</see>
- description for the <see cref="P:WebSocketSharp.Net.HttpListenerResponse.StatusCode"/> property value,
- or <see cref="F:System.String.Empty"/> if an RFC 2616 description doesn't exist.
- </value>
- <exception cref="T:System.ArgumentException">
- The value specified for a set operation contains invalid characters.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The response has already been sent.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- This object is closed.
- </exception>
- </member>
- <member name="M:WebSocketSharp.Net.HttpUtility.HtmlDecode(System.String)">
- <summary>
- Decodes an HTML-encoded <see cref="T:System.String"/> and returns the decoded <see cref="T:System.String"/>.
- </summary>
- <returns>
- A <see cref="T:System.String"/> that represents the decoded string.
- </returns>
- <param name="s">
- A <see cref="T:System.String"/> to decode.
- </param>
- </member>
- <member name="M:WebSocketSharp.Net.HttpUtility.HtmlDecode(System.String,System.IO.TextWriter)">
- <summary>
- Decodes an HTML-encoded <see cref="T:System.String"/> and sends the decoded <see cref="T:System.String"/>
- to the specified <see cref="T:System.IO.TextWriter"/>.
- </summary>
- <param name="s">
- A <see cref="T:System.String"/> to decode.
- </param>
- <param name="output">
- A <see cref="T:System.IO.TextWriter"/> that receives the decoded string.
- </param>
- </member>
- <member name="M:WebSocketSharp.Net.HttpUtility.HtmlEncode(System.String)">
- <summary>
- HTML-encodes a <see cref="T:System.String"/> and returns the encoded <see cref="T:System.String"/>.
- </summary>
- <returns>
- A <see cref="T:System.String"/> that represents the encoded string.
- </returns>
- <param name="s">
- A <see cref="T:System.String"/> to encode.
- </param>
- </member>
- <member name="M:WebSocketSharp.Net.HttpUtility.HtmlEncode(System.String,System.IO.TextWriter)">
- <summary>
- HTML-encodes a <see cref="T:System.String"/> and sends the encoded <see cref="T:System.String"/>
- to the specified <see cref="T:System.IO.TextWriter"/>.
- </summary>
- <param name="s">
- A <see cref="T:System.String"/> to encode.
- </param>
- <param name="output">
- A <see cref="T:System.IO.TextWriter"/> that receives the encoded string.
- </param>
- </member>
- <member name="T:WebSocketSharp.Net.WebHeaderCollection">
- <summary>
- Provides a collection of the HTTP headers associated with a request or response.
- </summary>
- </member>
- <member name="M:WebSocketSharp.Net.WebHeaderCollection.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Initializes a new instance of the <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/> class from
- the specified <see cref="T:System.Runtime.Serialization.SerializationInfo"/> and <see cref="T:System.Runtime.Serialization.StreamingContext"/>.
- </summary>
- <param name="serializationInfo">
- A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that contains the serialized object data.
- </param>
- <param name="streamingContext">
- A <see cref="T:System.Runtime.Serialization.StreamingContext"/> that specifies the source for the deserialization.
- </param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="serializationInfo"/> is <see langword="null"/>.
- </exception>
- <exception cref="T:System.ArgumentException">
- An element with the specified name isn't found in <paramref name="serializationInfo"/>.
- </exception>
- </member>
- <member name="M:WebSocketSharp.Net.WebHeaderCollection.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/> class.
- </summary>
- </member>
- <member name="M:WebSocketSharp.Net.WebHeaderCollection.AddWithoutValidate(System.String,System.String)">
- <summary>
- Adds a header to the collection without checking if the header is on
- the restricted header list.
- </summary>
- <param name="headerName">
- A <see cref="T:System.String"/> that represents the name of the header to add.
- </param>
- <param name="headerValue">
- A <see cref="T:System.String"/> that represents the value of the header to add.
- </param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="headerName"/> is <see langword="null"/> or empty.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="headerName"/> or <paramref name="headerValue"/> contains invalid characters.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- The length of <paramref name="headerValue"/> is greater than 65,535 characters.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The current <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/> instance doesn't allow
- the <paramref name="headerName"/>.
- </exception>
- </member>
- <member name="M:WebSocketSharp.Net.WebHeaderCollection.Add(System.String)">
- <summary>
- Adds the specified <paramref name="header"/> to the collection.
- </summary>
- <param name="header">
- A <see cref="T:System.String"/> that represents the header with the name and value separated by
- a colon (<c>':'</c>).
- </param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="header"/> is <see langword="null"/>, empty, or the name part of
- <paramref name="header"/> is empty.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>
- <paramref name="header"/> doesn't contain a colon.
- </para>
- <para>
- -or-
- </para>
- <para>
- <paramref name="header"/> is a restricted header.
- </para>
- <para>
- -or-
- </para>
- <para>
- The name or value part of <paramref name="header"/> contains invalid characters.
- </para>
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- The length of the value part of <paramref name="header"/> is greater than 65,535 characters.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The current <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/> instance doesn't allow
- the <paramref name="header"/>.
- </exception>
- </member>
- <member name="M:WebSocketSharp.Net.WebHeaderCollection.Add(WebSocketSharp.Net.HttpRequestHeader,System.String)">
- <summary>
- Adds the specified request <paramref name="header"/> with
- the specified <paramref name="value"/> to the collection.
- </summary>
- <param name="header">
- One of the <see cref="T:WebSocketSharp.Net.HttpRequestHeader"/> enum values, represents
- the request header to add.
- </param>
- <param name="value">
- A <see cref="T:System.String"/> that represents the value of the header to add.
- </param>
- <exception cref="T:System.ArgumentException">
- <para>
- <paramref name="header"/> is a restricted header.
- </para>
- <para>
- -or-
- </para>
- <para>
- <paramref name="value"/> contains invalid characters.
- </para>
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- The length of <paramref name="value"/> is greater than 65,535 characters.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The current <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/> instance doesn't allow
- the request <paramref name="header"/>.
- </exception>
- </member>
- <member name="M:WebSocketSharp.Net.WebHeaderCollection.Add(WebSocketSharp.Net.HttpResponseHeader,System.String)">
- <summary>
- Adds the specified response <paramref name="header"/> with
- the specified <paramref name="value"/> to the collection.
- </summary>
- <param name="header">
- One of the <see cref="T:WebSocketSharp.Net.HttpResponseHeader"/> enum values, represents
- the response header to add.
- </param>
- <param name="value">
- A <see cref="T:System.String"/> that represents the value of the header to add.
- </param>
- <exception cref="T:System.ArgumentException">
- <para>
- <paramref name="header"/> is a restricted header.
- </para>
- <para>
- -or-
- </para>
- <para>
- <paramref name="value"/> contains invalid characters.
- </para>
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- The length of <paramref name="value"/> is greater than 65,535 characters.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The current <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/> instance doesn't allow
- the response <paramref name="header"/>.
- </exception>
- </member>
- <member name="M:WebSocketSharp.Net.WebHeaderCollection.Add(System.String,System.String)">
- <summary>
- Adds a header with the specified <paramref name="name"/> and
- <paramref name="value"/> to the collection.
- </summary>
- <param name="name">
- A <see cref="T:System.String"/> that represents the name of the header to add.
- </param>
- <param name="value">
- A <see cref="T:System.String"/> that represents the value of the header to add.
- </param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="name"/> is <see langword="null"/> or empty.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>
- <paramref name="name"/> or <paramref name="value"/> contains invalid characters.
- </para>
- <para>
- -or-
- </para>
- <para>
- <paramref name="name"/> is a restricted header name.
- </para>
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- The length of <paramref name="value"/> is greater than 65,535 characters.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The current <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/> instance doesn't allow
- the header <paramref name="name"/>.
- </exception>
- </member>
- <member name="M:WebSocketSharp.Net.WebHeaderCollection.Clear">
- <summary>
- Removes all headers from the collection.
- </summary>
- </member>
- <member name="M:WebSocketSharp.Net.WebHeaderCollection.Get(System.Int32)">
- <summary>
- Get the value of the header at the specified <paramref name="index"/> in the collection.
- </summary>
- <returns>
- A <see cref="T:System.String"/> that receives the value of the header.
- </returns>
- <param name="index">
- An <see cref="T:System.Int32"/> that represents the zero-based index of the header to find.
- </param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of allowable range of indexes for the collection.
- </exception>
- </member>
- <member name="M:WebSocketSharp.Net.WebHeaderCollection.Get(System.String)">
- <summary>
- Get the value of the header with the specified <paramref name="name"/> in the collection.
- </summary>
- <returns>
- A <see cref="T:System.String"/> that receives the value of the header if found;
- otherwise, <see langword="null"/>.
- </returns>
- <param name="name">
- A <see cref="T:System.String"/> that represents the name of the header to find.
- </param>
- </member>
- <member name="M:WebSocketSharp.Net.WebHeaderCollection.GetEnumerator">
- <summary>
- Gets the enumerator used to iterate through the collection.
- </summary>
- <returns>
- An <see cref="T:System.Collections.IEnumerator"/> instance used to iterate through the collection.
- </returns>
- </member>
- <member name="M:WebSocketSharp.Net.WebHeaderCollection.GetKey(System.Int32)">
- <summary>
- Get the name of the header at the specified <paramref name="index"/> in the collection.
- </summary>
- <returns>
- A <see cref="T:System.String"/> that receives the header name.
- </returns>
- <param name="index">
- An <see cref="T:System.Int32"/> that represents the zero-based index of the header to find.
- </param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of allowable range of indexes for the collection.
- </exception>
- </member>
- <member name="M:WebSocketSharp.Net.WebHeaderCollection.GetValues(System.Int32)">
- <summary>
- Gets an array of header values stored in the specified <paramref name="index"/> position of
- the collection.
- </summary>
- <returns>
- An array of <see cref="T:System.String"/> that receives the header values if found;
- otherwise, <see langword="null"/>.
- </returns>
- <param name="index">
- An <see cref="T:System.Int32"/> that represents the zero-based index of the header to find.
- </param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of allowable range of indexes for the collection.
- </exception>
- </member>
- <member name="M:WebSocketSharp.Net.WebHeaderCollection.GetValues(System.String)">
- <summary>
- Gets an array of header values stored in the specified <paramref name="header"/>.
- </summary>
- <returns>
- An array of <see cref="T:System.String"/> that receives the header values if found;
- otherwise, <see langword="null"/>.
- </returns>
- <param name="header">
- A <see cref="T:System.String"/> that represents the name of the header to find.
- </param>
- </member>
- <member name="M:WebSocketSharp.Net.WebHeaderCollection.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Populates the specified <see cref="T:System.Runtime.Serialization.SerializationInfo"/> with the data needed to serialize
- the <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/>.
- </summary>
- <param name="serializationInfo">
- A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data.
- </param>
- <param name="streamingContext">
- A <see cref="T:System.Runtime.Serialization.StreamingContext"/> that specifies the destination for the serialization.
- </param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="serializationInfo"/> is <see langword="null"/>.
- </exception>
- </member>
- <member name="M:WebSocketSharp.Net.WebHeaderCollection.IsRestricted(System.String)">
- <summary>
- Determines whether the specified header can be set for the request.
- </summary>
- <returns>
- <c>true</c> if the header is restricted; otherwise, <c>false</c>.
- </returns>
- <param name="headerName">
- A <see cref="T:System.String"/> that represents the name of the header to test.
- </param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="headerName"/> is <see langword="null"/> or empty.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="headerName"/> contains invalid characters.
- </exception>
- </member>
- <member name="M:WebSocketSharp.Net.WebHeaderCollection.IsRestricted(System.String,System.Boolean)">
- <summary>
- Determines whether the specified header can be set for the request or the response.
- </summary>
- <returns>
- <c>true</c> if the header is restricted; otherwise, <c>false</c>.
- </returns>
- <param name="headerName">
- A <see cref="T:System.String"/> that represents the name of the header to test.
- </param>
- <param name="response">
- <c>true</c> if does the test for the response; for the request, <c>false</c>.
- </param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="headerName"/> is <see langword="null"/> or empty.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="headerName"/> contains invalid characters.
- </exception>
- </member>
- <member name="M:WebSocketSharp.Net.WebHeaderCollection.OnDeserialization(System.Object)">
- <summary>
- Implements the <see cref="T:System.Runtime.Serialization.ISerializable"/> interface and raises the deserialization event
- when the deserialization is complete.
- </summary>
- <param name="sender">
- An <see cref="T:System.Object"/> that represents the source of the deserialization event.
- </param>
- </member>
- <member name="M:WebSocketSharp.Net.WebHeaderCollection.Remove(WebSocketSharp.Net.HttpRequestHeader)">
- <summary>
- Removes the specified request <paramref name="header"/> from the collection.
- </summary>
- <param name="header">
- One of the <see cref="T:WebSocketSharp.Net.HttpRequestHeader"/> enum values, represents
- the request header to remove.
- </param>
- <exception cref="T:System.ArgumentException">
- <paramref name="header"/> is a restricted header.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The current <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/> instance doesn't allow
- the request <paramref name="header"/>.
- </exception>
- </member>
- <member name="M:WebSocketSharp.Net.WebHeaderCollection.Remove(WebSocketSharp.Net.HttpResponseHeader)">
- <summary>
- Removes the specified response <paramref name="header"/> from the collection.
- </summary>
- <param name="header">
- One of the <see cref="T:WebSocketSharp.Net.HttpResponseHeader"/> enum values, represents
- the response header to remove.
- </param>
- <exception cref="T:System.ArgumentException">
- <paramref name="header"/> is a restricted header.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The current <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/> instance doesn't allow
- the response <paramref name="header"/>.
- </exception>
- </member>
- <member name="M:WebSocketSharp.Net.WebHeaderCollection.Remove(System.String)">
- <summary>
- Removes the specified header from the collection.
- </summary>
- <param name="name">
- A <see cref="T:System.String"/> that represents the name of the header to remove.
- </param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="name"/> is <see langword="null"/> or empty.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>
- <paramref name="name"/> contains invalid characters.
- </para>
- <para>
- -or-
- </para>
- <para>
- <paramref name="name"/> is a restricted header name.
- </para>
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The current <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/> instance doesn't allow
- the header <paramref name="name"/>.
- </exception>
- </member>
- <member name="M:WebSocketSharp.Net.WebHeaderCollection.Set(WebSocketSharp.Net.HttpRequestHeader,System.String)">
- <summary>
- Sets the specified request <paramref name="header"/> to the specified value.
- </summary>
- <param name="header">
- One of the <see cref="T:WebSocketSharp.Net.HttpRequestHeader"/> enum values, represents
- the request header to set.
- </param>
- <param name="value">
- A <see cref="T:System.String"/> that represents the value of the request header to set.
- </param>
- <exception cref="T:System.ArgumentException">
- <para>
- <paramref name="header"/> is a restricted header.
- </para>
- <para>
- -or-
- </para>
- <para>
- <paramref name="value"/> contains invalid characters.
- </para>
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- The length of <paramref name="value"/> is greater than 65,535 characters.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The current <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/> instance doesn't allow
- the request <paramref name="header"/>.
- </exception>
- </member>
- <member name="M:WebSocketSharp.Net.WebHeaderCollection.Set(WebSocketSharp.Net.HttpResponseHeader,System.String)">
- <summary>
- Sets the specified response <paramref name="header"/> to the specified value.
- </summary>
- <param name="header">
- One of the <see cref="T:WebSocketSharp.Net.HttpResponseHeader"/> enum values, represents
- the response header to set.
- </param>
- <param name="value">
- A <see cref="T:System.String"/> that represents the value of the response header to set.
- </param>
- <exception cref="T:System.ArgumentException">
- <para>
- <paramref name="header"/> is a restricted header.
- </para>
- <para>
- -or-
- </para>
- <para>
- <paramref name="value"/> contains invalid characters.
- </para>
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- The length of <paramref name="value"/> is greater than 65,535 characters.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The current <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/> instance doesn't allow
- the response <paramref name="header"/>.
- </exception>
- </member>
- <member name="M:WebSocketSharp.Net.WebHeaderCollection.Set(System.String,System.String)">
- <summary>
- Sets the specified header to the specified value.
- </summary>
- <param name="name">
- A <see cref="T:System.String"/> that represents the name of the header to set.
- </param>
- <param name="value">
- A <see cref="T:System.String"/> that represents the value of the header to set.
- </param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="name"/> is <see langword="null"/> or empty.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>
- <paramref name="name"/> or <paramref name="value"/> contains invalid characters.
- </para>
- <para>
- -or-
- </para>
- <para>
- <paramref name="name"/> is a restricted header name.
- </para>
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- The length of <paramref name="value"/> is greater than 65,535 characters.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The current <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/> instance doesn't allow
- the header <paramref name="name"/>.
- </exception>
- </member>
- <member name="M:WebSocketSharp.Net.WebHeaderCollection.ToByteArray">
- <summary>
- Converts the current <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/> to an array of <see cref="T:System.Byte"/>.
- </summary>
- <returns>
- An array of <see cref="T:System.Byte"/> that receives the converted current
- <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/>.
- </returns>
- </member>
- <member name="M:WebSocketSharp.Net.WebHeaderCollection.ToString">
- <summary>
- Returns a <see cref="T:System.String"/> that represents the current
- <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/>.
- </summary>
- <returns>
- A <see cref="T:System.String"/> that represents the current <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/>.
- </returns>
- </member>
- <member name="M:WebSocketSharp.Net.WebHeaderCollection.System#Runtime#Serialization#ISerializable#GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Populates the specified <see cref="T:System.Runtime.Serialization.SerializationInfo"/> with the data needed to serialize
- the current <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/>.
- </summary>
- <param name="serializationInfo">
- A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data.
- </param>
- <param name="streamingContext">
- A <see cref="T:System.Runtime.Serialization.StreamingContext"/> that specifies the destination for the serialization.
- </param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="serializationInfo"/> is <see langword="null"/>.
- </exception>
- </member>
- <member name="P:WebSocketSharp.Net.WebHeaderCollection.AllKeys">
- <summary>
- Gets all header names in the collection.
- </summary>
- <value>
- An array of <see cref="T:System.String"/> that contains all header names in the collection.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.WebHeaderCollection.Count">
- <summary>
- Gets the number of headers in the collection.
- </summary>
- <value>
- An <see cref="T:System.Int32"/> that represents the number of headers in the collection.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.WebHeaderCollection.Item(WebSocketSharp.Net.HttpRequestHeader)">
- <summary>
- Gets or sets the specified request <paramref name="header"/> in the collection.
- </summary>
- <value>
- A <see cref="T:System.String"/> that represents the value of the request <paramref name="header"/>.
- </value>
- <param name="header">
- One of the <see cref="T:WebSocketSharp.Net.HttpRequestHeader"/> enum values, represents
- the request header to get or set.
- </param>
- <exception cref="T:System.ArgumentException">
- <para>
- <paramref name="header"/> is a restricted header.
- </para>
- <para>
- -or-
- </para>
- <para>
- <paramref name="value"/> contains invalid characters.
- </para>
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- The length of <paramref name="value"/> is greater than 65,535 characters.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The current <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/> instance doesn't allow
- the request <paramref name="header"/>.
- </exception>
- </member>
- <member name="P:WebSocketSharp.Net.WebHeaderCollection.Item(WebSocketSharp.Net.HttpResponseHeader)">
- <summary>
- Gets or sets the specified response <paramref name="header"/> in the collection.
- </summary>
- <value>
- A <see cref="T:System.String"/> that represents the value of the response <paramref name="header"/>.
- </value>
- <param name="header">
- One of the <see cref="T:WebSocketSharp.Net.HttpResponseHeader"/> enum values, represents
- the response header to get or set.
- </param>
- <exception cref="T:System.ArgumentException">
- <para>
- <paramref name="header"/> is a restricted header.
- </para>
- <para>
- -or-
- </para>
- <para>
- <paramref name="value"/> contains invalid characters.
- </para>
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- The length of <paramref name="value"/> is greater than 65,535 characters.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The current <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/> instance doesn't allow
- the response <paramref name="header"/>.
- </exception>
- </member>
- <member name="P:WebSocketSharp.Net.WebHeaderCollection.Keys">
- <summary>
- Gets a collection of header names in the collection.
- </summary>
- <value>
- A <see cref="T:System.Collections.Specialized.NameObjectCollectionBase.KeysCollection"/> that contains
- all header names in the collection.
- </value>
- </member>
- <member name="T:WebSocketSharp.Server.HttpServer">
- <summary>
- Provides a simple HTTP server that allows to accept the WebSocket connection requests.
- </summary>
- <remarks>
- The HttpServer class can provide multiple WebSocket services.
- </remarks>
- </member>
- <member name="M:WebSocketSharp.Server.HttpServer.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:WebSocketSharp.Server.HttpServer"/> class.
- </summary>
- <remarks>
- An instance initialized by this constructor listens for the incoming requests on port 80.
- </remarks>
- </member>
- <member name="M:WebSocketSharp.Server.HttpServer.#ctor(System.Int32)">
- <summary>
- Initializes a new instance of the <see cref="T:WebSocketSharp.Server.HttpServer"/> class with
- the specified <paramref name="port"/>.
- </summary>
- <remarks>
- <para>
- An instance initialized by this constructor listens for the incoming requests on
- <paramref name="port"/>.
- </para>
- <para>
- If <paramref name="port"/> is 443, that instance provides a secure connection.
- </para>
- </remarks>
- <param name="port">
- An <see cref="T:System.Int32"/> that represents the port number on which to listen.
- </param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> isn't between 1 and 65535 inclusive.
- </exception>
- </member>
- <member name="M:WebSocketSharp.Server.HttpServer.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:WebSocketSharp.Server.HttpServer"/> class with
- the specified HTTP URL.
- </summary>
- <remarks>
- <para>
- An instance initialized by this constructor listens for the incoming requests on
- the host name and port in <paramref name="url"/>.
- </para>
- <para>
- If <paramref name="url"/> doesn't include a port, either port 80 or 443 is used on
- which to listen. It's determined by the scheme (http or https) in <paramref name="url"/>.
- (Port 80 if the scheme is http.)
- </para>
- </remarks>
- <param name="url">
- A <see cref="T:System.String"/> that represents the HTTP URL of the server.
- </param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="url"/> is <see langword="null"/>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>
- <paramref name="url"/> is empty.
- </para>
- <para>
- -or-
- </para>
- <para>
- <paramref name="url"/> is invalid.
- </para>
- </exception>
- </member>
- <member name="M:WebSocketSharp.Server.HttpServer.#ctor(System.Int32,System.Boolean)">
- <summary>
- Initializes a new instance of the <see cref="T:WebSocketSharp.Server.HttpServer"/> class with
- the specified <paramref name="port"/> and <paramref name="secure"/>.
- </summary>
- <remarks>
- An instance initialized by this constructor listens for the incoming requests on
- <paramref name="port"/>.
- </remarks>
- <param name="port">
- An <see cref="T:System.Int32"/> that represents the port number on which to listen.
- </param>
- <param name="secure">
- A <see cref="T:System.Boolean"/> that indicates providing a secure connection or not.
- (<c>true</c> indicates providing a secure connection.)
- </param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> isn't between 1 and 65535 inclusive.
- </exception>
- </member>
- <member name="M:WebSocketSharp.Server.HttpServer.#ctor(System.Net.IPAddress,System.Int32)">
- <summary>
- Initializes a new instance of the <see cref="T:WebSocketSharp.Server.HttpServer"/> class with
- the specified <paramref name="address"/> and <paramref name="port"/>.
- </summary>
- <remarks>
- <para>
- An instance initialized by this constructor listens for the incoming requests on
- <paramref name="address"/> and <paramref name="port"/>.
- </para>
- <para>
- If <paramref name="port"/> is 443, that instance provides a secure connection.
- </para>
- </remarks>
- <param name="address">
- A <see cref="T:System.Net.IPAddress"/> that represents the local IP address of the server.
- </param>
- <param name="port">
- An <see cref="T:System.Int32"/> that represents the port number on which to listen.
- </param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="address"/> is <see langword="null"/>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="address"/> isn't a local IP address.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> isn't between 1 and 65535 inclusive.
- </exception>
- </member>
- <member name="M:WebSocketSharp.Server.HttpServer.#ctor(System.Net.IPAddress,System.Int32,System.Boolean)">
- <summary>
- Initializes a new instance of the <see cref="T:WebSocketSharp.Server.HttpServer"/> class with
- the specified <paramref name="address"/>, <paramref name="port"/>,
- and <paramref name="secure"/>.
- </summary>
- <remarks>
- An instance initialized by this constructor listens for the incoming requests on
- <paramref name="address"/> and <paramref name="port"/>.
- </remarks>
- <param name="address">
- A <see cref="T:System.Net.IPAddress"/> that represents the local IP address of the server.
- </param>
- <param name="port">
- An <see cref="T:System.Int32"/> that represents the port number on which to listen.
- </param>
- <param name="secure">
- A <see cref="T:System.Boolean"/> that indicates providing a secure connection or not.
- (<c>true</c> indicates providing a secure connection.)
- </param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="address"/> is <see langword="null"/>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="address"/> isn't a local IP address.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> isn't between 1 and 65535 inclusive.
- </exception>
- </member>
- <member name="M:WebSocketSharp.Server.HttpServer.AddWebSocketService``1(System.String,System.Func{``0})">
- <summary>
- Adds the WebSocket service with the specified behavior, <paramref name="path"/>,
- and <paramref name="initializer"/>.
- </summary>
- <remarks>
- <para>
- This method converts <paramref name="path"/> to URL-decoded string,
- and removes <c>'/'</c> from tail end of <paramref name="path"/>.
- </para>
- <para>
- <paramref name="initializer"/> returns an initialized specified typed
- <see cref="T:WebSocketSharp.Server.WebSocketBehavior"/> instance.
- </para>
- </remarks>
- <param name="path">
- A <see cref="T:System.String"/> that represents the absolute path to the service to add.
- </param>
- <param name="initializer">
- A <c>Func<T></c> delegate that references the method used to initialize
- a new specified typed <see cref="T:WebSocketSharp.Server.WebSocketBehavior"/> instance (a new
- <see cref="T:WebSocketSharp.Server.IWebSocketSession"/> instance).
- </param>
- <typeparam name="TBehavior">
- The type of the behavior of the service to add. The TBehavior must inherit
- the <see cref="T:WebSocketSharp.Server.WebSocketBehavior"/> class.
- </typeparam>
- </member>
- <member name="M:WebSocketSharp.Server.HttpServer.AddWebSocketService``1(System.String)">
- <summary>
- Adds a WebSocket service with the specified behavior and <paramref name="path"/>.
- </summary>
- <remarks>
- This method converts <paramref name="path"/> to URL-decoded string,
- and removes <c>'/'</c> from tail end of <paramref name="path"/>.
- </remarks>
- <param name="path">
- A <see cref="T:System.String"/> that represents the absolute path to the service to add.
- </param>
- <typeparam name="TBehaviorWithNew">
- The type of the behavior of the service to add. The TBehaviorWithNew must inherit
- the <see cref="T:WebSocketSharp.Server.WebSocketBehavior"/> class, and must have a public parameterless
- constructor.
- </typeparam>
- </member>
- <member name="M:WebSocketSharp.Server.HttpServer.GetFile(System.String)">
- <summary>
- Gets the contents of the file with the specified <paramref name="path"/>.
- </summary>
- <returns>
- An array of <see cref="T:System.Byte"/> that receives the contents of the file,
- or <see langword="null"/> if it doesn't exist.
- </returns>
- <param name="path">
- A <see cref="T:System.String"/> that represents the virtual path to the file to find.
- </param>
- </member>
- <member name="M:WebSocketSharp.Server.HttpServer.RemoveWebSocketService(System.String)">
- <summary>
- Removes the WebSocket service with the specified <paramref name="path"/>.
- </summary>
- <remarks>
- This method converts <paramref name="path"/> to URL-decoded string,
- and removes <c>'/'</c> from tail end of <paramref name="path"/>.
- </remarks>
- <returns>
- <c>true</c> if the service is successfully found and removed; otherwise, <c>false</c>.
- </returns>
- <param name="path">
- A <see cref="T:System.String"/> that represents the absolute path to the service to find.
- </param>
- </member>
- <member name="M:WebSocketSharp.Server.HttpServer.Start">
- <summary>
- Starts receiving the HTTP requests.
- </summary>
- </member>
- <member name="M:WebSocketSharp.Server.HttpServer.Stop">
- <summary>
- Stops receiving the HTTP requests.
- </summary>
- </member>
- <member name="M:WebSocketSharp.Server.HttpServer.Stop(System.UInt16,System.String)">
- <summary>
- Stops receiving the HTTP requests with the specified <see cref="T:System.UInt16"/> and
- <see cref="T:System.String"/> used to stop the WebSocket services.
- </summary>
- <param name="code">
- A <see cref="T:System.UInt16"/> that represents the status code indicating the reason for the stop.
- </param>
- <param name="reason">
- A <see cref="T:System.String"/> that represents the reason for the stop.
- </param>
- </member>
- <member name="M:WebSocketSharp.Server.HttpServer.Stop(WebSocketSharp.CloseStatusCode,System.String)">
- <summary>
- Stops receiving the HTTP requests with the specified <see cref="T:WebSocketSharp.CloseStatusCode"/> and
- <see cref="T:System.String"/> used to stop the WebSocket services.
- </summary>
- <param name="code">
- One of the <see cref="T:WebSocketSharp.CloseStatusCode"/> enum values, represents the status code indicating
- the reason for the stop.
- </param>
- <param name="reason">
- A <see cref="T:System.String"/> that represents the reason for the stop.
- </param>
- </member>
- <member name="P:WebSocketSharp.Server.HttpServer.Address">
- <summary>
- Gets the local IP address of the server.
- </summary>
- <value>
- A <see cref="T:System.Net.IPAddress"/> that represents the local IP address of the server.
- </value>
- </member>
- <member name="P:WebSocketSharp.Server.HttpServer.AuthenticationSchemes">
- <summary>
- Gets or sets the scheme used to authenticate the clients.
- </summary>
- <value>
- One of the <see cref="T:WebSocketSharp.Net.AuthenticationSchemes"/> enum values,
- indicates the scheme used to authenticate the clients. The default value is
- <see cref="F:WebSocketSharp.Net.AuthenticationSchemes.Anonymous"/>.
- </value>
- </member>
- <member name="P:WebSocketSharp.Server.HttpServer.IsListening">
- <summary>
- Gets a value indicating whether the server has started.
- </summary>
- <value>
- <c>true</c> if the server has started; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:WebSocketSharp.Server.HttpServer.IsSecure">
- <summary>
- Gets a value indicating whether the server provides a secure connection.
- </summary>
- <value>
- <c>true</c> if the server provides a secure connection; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:WebSocketSharp.Server.HttpServer.KeepClean">
- <summary>
- Gets or sets a value indicating whether the server cleans up
- the inactive sessions in the WebSocket services periodically.
- </summary>
- <value>
- <c>true</c> if the server cleans up the inactive sessions every 60 seconds;
- otherwise, <c>false</c>. The default value is <c>true</c>.
- </value>
- </member>
- <member name="P:WebSocketSharp.Server.HttpServer.Log">
- <summary>
- Gets the logging functions.
- </summary>
- <remarks>
- The default logging level is <see cref="F:WebSocketSharp.LogLevel.Error"/>. If you would like to change it,
- you should set the <c>Log.Level</c> property to any of the <see cref="T:WebSocketSharp.LogLevel"/> enum
- values.
- </remarks>
- <value>
- A <see cref="T:WebSocketSharp.Logger"/> that provides the logging functions.
- </value>
- </member>
- <member name="P:WebSocketSharp.Server.HttpServer.Port">
- <summary>
- Gets the port on which to listen for incoming requests.
- </summary>
- <value>
- An <see cref="T:System.Int32"/> that represents the port number on which to listen.
- </value>
- </member>
- <member name="P:WebSocketSharp.Server.HttpServer.Realm">
- <summary>
- Gets or sets the name of the realm associated with the server.
- </summary>
- <remarks>
- If this property is <see langword="null"/> or empty, <c>"SECRET AREA"</c> will be used as
- the name of the realm.
- </remarks>
- <value>
- A <see cref="T:System.String"/> that represents the name of the realm. The default value is
- <see langword="null"/>.
- </value>
- </member>
- <member name="P:WebSocketSharp.Server.HttpServer.ReuseAddress">
- <summary>
- Gets or sets a value indicating whether the server is allowed to be bound to
- an address that is already in use.
- </summary>
- <remarks>
- If you would like to resolve to wait for socket in <c>TIME_WAIT</c> state,
- you should set this property to <c>true</c>.
- </remarks>
- <value>
- <c>true</c> if the server is allowed to be bound to an address that is already in use;
- otherwise, <c>false</c>. The default value is <c>false</c>.
- </value>
- </member>
- <member name="P:WebSocketSharp.Server.HttpServer.RootPath">
- <summary>
- Gets or sets the document root path of the server.
- </summary>
- <value>
- A <see cref="T:System.String"/> that represents the document root path of the server.
- The default value is <c>"./Public"</c>.
- </value>
- </member>
- <member name="P:WebSocketSharp.Server.HttpServer.SslConfiguration">
- <summary>
- Gets or sets the SSL configuration used to authenticate the server and
- optionally the client for secure connection.
- </summary>
- <value>
- A <see cref="T:WebSocketSharp.Net.ServerSslConfiguration"/> that represents the configuration used to
- authenticate the server and optionally the client for secure connection.
- </value>
- </member>
- <member name="P:WebSocketSharp.Server.HttpServer.UserCredentialsFinder">
- <summary>
- Gets or sets the delegate called to find the credentials for an identity used to
- authenticate a client.
- </summary>
- <value>
- A <c>Func<<see cref="T:System.Security.Principal.IIdentity"/>, <see cref="T:WebSocketSharp.Net.NetworkCredential"/>></c> delegate
- that references the method(s) used to find the credentials. The default value is
- <see langword="null"/>.
- </value>
- </member>
- <member name="P:WebSocketSharp.Server.HttpServer.WaitTime">
- <summary>
- Gets or sets the wait time for the response to the WebSocket Ping or Close.
- </summary>
- <value>
- A <see cref="T:System.TimeSpan"/> that represents the wait time. The default value is
- the same as 1 second.
- </value>
- </member>
- <member name="P:WebSocketSharp.Server.HttpServer.WebSocketServices">
- <summary>
- Gets the access to the WebSocket services provided by the server.
- </summary>
- <value>
- A <see cref="T:WebSocketSharp.Server.WebSocketServiceManager"/> that manages the WebSocket services.
- </value>
- </member>
- <member name="E:WebSocketSharp.Server.HttpServer.OnConnect">
- <summary>
- Occurs when the server receives an HTTP CONNECT request.
- </summary>
- </member>
- <member name="E:WebSocketSharp.Server.HttpServer.OnDelete">
- <summary>
- Occurs when the server receives an HTTP DELETE request.
- </summary>
- </member>
- <member name="E:WebSocketSharp.Server.HttpServer.OnGet">
- <summary>
- Occurs when the server receives an HTTP GET request.
- </summary>
- </member>
- <member name="E:WebSocketSharp.Server.HttpServer.OnHead">
- <summary>
- Occurs when the server receives an HTTP HEAD request.
- </summary>
- </member>
- <member name="E:WebSocketSharp.Server.HttpServer.OnOptions">
- <summary>
- Occurs when the server receives an HTTP OPTIONS request.
- </summary>
- </member>
- <member name="E:WebSocketSharp.Server.HttpServer.OnPatch">
- <summary>
- Occurs when the server receives an HTTP PATCH request.
- </summary>
- </member>
- <member name="E:WebSocketSharp.Server.HttpServer.OnPost">
- <summary>
- Occurs when the server receives an HTTP POST request.
- </summary>
- </member>
- <member name="E:WebSocketSharp.Server.HttpServer.OnPut">
- <summary>
- Occurs when the server receives an HTTP PUT request.
- </summary>
- </member>
- <member name="E:WebSocketSharp.Server.HttpServer.OnTrace">
- <summary>
- Occurs when the server receives an HTTP TRACE request.
- </summary>
- </member>
- <member name="T:WebSocketSharp.Net.HttpVersion">
- <summary>
- Provides the HTTP version numbers.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpVersion.Version10">
- <summary>
- Provides a <see cref="T:System.Version"/> instance for the HTTP/1.0.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpVersion.Version11">
- <summary>
- Provides a <see cref="T:System.Version"/> instance for the HTTP/1.1.
- </summary>
- </member>
- <member name="M:WebSocketSharp.Net.HttpVersion.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:WebSocketSharp.Net.HttpVersion"/> class.
- </summary>
- </member>
- <member name="T:WebSocketSharp.Net.HttpStatusCode">
- <summary>
- Contains the values of the HTTP status codes.
- </summary>
- <remarks>
- The HttpStatusCode enumeration contains the values of the HTTP status codes defined in
- <see href="http://tools.ietf.org/html/rfc2616#section-10">RFC 2616</see> for the HTTP/1.1.
- </remarks>
- </member>
- <member name="F:WebSocketSharp.Net.HttpStatusCode.Continue">
- <summary>
- Equivalent to status code 100.
- Indicates that the client should continue with its request.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpStatusCode.SwitchingProtocols">
- <summary>
- Equivalent to status code 101.
- Indicates that the server is switching the HTTP version or protocol on the connection.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpStatusCode.OK">
- <summary>
- Equivalent to status code 200.
- Indicates that the client's request has succeeded.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpStatusCode.Created">
- <summary>
- Equivalent to status code 201.
- Indicates that the client's request has been fulfilled and resulted in a new resource being
- created.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpStatusCode.Accepted">
- <summary>
- Equivalent to status code 202.
- Indicates that the client's request has been accepted for processing, but the processing
- hasn't been completed.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpStatusCode.NonAuthoritativeInformation">
- <summary>
- Equivalent to status code 203.
- Indicates that the returned metainformation is from a local or a third-party copy instead of
- the origin server.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpStatusCode.NoContent">
- <summary>
- Equivalent to status code 204.
- Indicates that the server has fulfilled the client's request but doesn't need to return
- an entity-body.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpStatusCode.ResetContent">
- <summary>
- Equivalent to status code 205.
- Indicates that the server has fulfilled the client's request, and the user agent should
- reset the document view which caused the request to be sent.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpStatusCode.PartialContent">
- <summary>
- Equivalent to status code 206.
- Indicates that the server has fulfilled the partial GET request for the resource.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpStatusCode.MultipleChoices">
- <summary>
- <para>
- Equivalent to status code 300.
- Indicates that the requested resource corresponds to any of multiple representations.
- </para>
- <para>
- MultipleChoices is a synonym for Ambiguous.
- </para>
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpStatusCode.Ambiguous">
- <summary>
- <para>
- Equivalent to status code 300.
- Indicates that the requested resource corresponds to any of multiple representations.
- </para>
- <para>
- Ambiguous is a synonym for MultipleChoices.
- </para>
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpStatusCode.MovedPermanently">
- <summary>
- <para>
- Equivalent to status code 301.
- Indicates that the requested resource has been assigned a new permanent URI and
- any future references to this resource should use one of the returned URIs.
- </para>
- <para>
- MovedPermanently is a synonym for Moved.
- </para>
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpStatusCode.Moved">
- <summary>
- <para>
- Equivalent to status code 301.
- Indicates that the requested resource has been assigned a new permanent URI and
- any future references to this resource should use one of the returned URIs.
- </para>
- <para>
- Moved is a synonym for MovedPermanently.
- </para>
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpStatusCode.Found">
- <summary>
- <para>
- Equivalent to status code 302.
- Indicates that the requested resource is located temporarily under a different URI.
- </para>
- <para>
- Found is a synonym for Redirect.
- </para>
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpStatusCode.Redirect">
- <summary>
- <para>
- Equivalent to status code 302.
- Indicates that the requested resource is located temporarily under a different URI.
- </para>
- <para>
- Redirect is a synonym for Found.
- </para>
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpStatusCode.SeeOther">
- <summary>
- <para>
- Equivalent to status code 303.
- Indicates that the response to the request can be found under a different URI and
- should be retrieved using a GET method on that resource.
- </para>
- <para>
- SeeOther is a synonym for RedirectMethod.
- </para>
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpStatusCode.RedirectMethod">
- <summary>
- <para>
- Equivalent to status code 303.
- Indicates that the response to the request can be found under a different URI and
- should be retrieved using a GET method on that resource.
- </para>
- <para>
- RedirectMethod is a synonym for SeeOther.
- </para>
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpStatusCode.NotModified">
- <summary>
- Equivalent to status code 304.
- Indicates that the client has performed a conditional GET request and access is allowed,
- but the document hasn't been modified.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpStatusCode.UseProxy">
- <summary>
- Equivalent to status code 305.
- Indicates that the requested resource must be accessed through the proxy given by
- the Location field.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpStatusCode.Unused">
- <summary>
- Equivalent to status code 306.
- This status code was used in a previous version of the specification, is no longer used,
- and is reserved for future use.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpStatusCode.TemporaryRedirect">
- <summary>
- <para>
- Equivalent to status code 307.
- Indicates that the requested resource is located temporarily under a different URI.
- </para>
- <para>
- TemporaryRedirect is a synonym for RedirectKeepVerb.
- </para>
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpStatusCode.RedirectKeepVerb">
- <summary>
- <para>
- Equivalent to status code 307.
- Indicates that the requested resource is located temporarily under a different URI.
- </para>
- <para>
- RedirectKeepVerb is a synonym for TemporaryRedirect.
- </para>
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpStatusCode.BadRequest">
- <summary>
- Equivalent to status code 400.
- Indicates that the client's request couldn't be understood by the server due to
- malformed syntax.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpStatusCode.Unauthorized">
- <summary>
- Equivalent to status code 401.
- Indicates that the client's request requires user authentication.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpStatusCode.PaymentRequired">
- <summary>
- Equivalent to status code 402.
- This status code is reserved for future use.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpStatusCode.Forbidden">
- <summary>
- Equivalent to status code 403.
- Indicates that the server understood the client's request but is refusing to fulfill it.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpStatusCode.NotFound">
- <summary>
- Equivalent to status code 404.
- Indicates that the server hasn't found anything matching the request URI.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpStatusCode.MethodNotAllowed">
- <summary>
- Equivalent to status code 405.
- Indicates that the method specified in the request line isn't allowed for the resource
- identified by the request URI.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpStatusCode.NotAcceptable">
- <summary>
- Equivalent to status code 406.
- Indicates that the server doesn't have the appropriate resource to respond to the Accept
- headers in the client's request.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpStatusCode.ProxyAuthenticationRequired">
- <summary>
- Equivalent to status code 407.
- Indicates that the client must first authenticate itself with the proxy.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpStatusCode.RequestTimeout">
- <summary>
- Equivalent to status code 408.
- Indicates that the client didn't produce a request within the time that the server was
- prepared to wait.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpStatusCode.Conflict">
- <summary>
- Equivalent to status code 409.
- Indicates that the client's request couldn't be completed due to a conflict on the server.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpStatusCode.Gone">
- <summary>
- Equivalent to status code 410.
- Indicates that the requested resource is no longer available at the server and
- no forwarding address is known.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpStatusCode.LengthRequired">
- <summary>
- Equivalent to status code 411.
- Indicates that the server refuses to accept the client's request without a defined
- Content-Length.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpStatusCode.PreconditionFailed">
- <summary>
- Equivalent to status code 412.
- Indicates that the precondition given in one or more of the request headers evaluated to
- false when it was tested on the server.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpStatusCode.RequestEntityTooLarge">
- <summary>
- Equivalent to status code 413.
- Indicates that the entity of the client's request is larger than the server is willing or
- able to process.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpStatusCode.RequestUriTooLong">
- <summary>
- Equivalent to status code 414.
- Indicates that the request URI is longer than the server is willing to interpret.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpStatusCode.UnsupportedMediaType">
- <summary>
- Equivalent to status code 415.
- Indicates that the entity of the client's request is in a format not supported by
- the requested resource for the requested method.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpStatusCode.RequestedRangeNotSatisfiable">
- <summary>
- Equivalent to status code 416.
- Indicates that none of the range specifier values in a Range request header overlap
- the current extent of the selected resource.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpStatusCode.ExpectationFailed">
- <summary>
- Equivalent to status code 417.
- Indicates that the expectation given in an Expect request header couldn't be met by
- the server.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpStatusCode.InternalServerError">
- <summary>
- Equivalent to status code 500.
- Indicates that the server encountered an unexpected condition which prevented it from
- fulfilling the client's request.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpStatusCode.NotImplemented">
- <summary>
- Equivalent to status code 501.
- Indicates that the server doesn't support the functionality required to fulfill the client's
- request.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpStatusCode.BadGateway">
- <summary>
- Equivalent to status code 502.
- Indicates that a gateway or proxy server received an invalid response from the upstream
- server.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpStatusCode.ServiceUnavailable">
- <summary>
- Equivalent to status code 503.
- Indicates that the server is currently unable to handle the client's request due to
- a temporary overloading or maintenance of the server.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpStatusCode.GatewayTimeout">
- <summary>
- Equivalent to status code 504.
- Indicates that a gateway or proxy server didn't receive a timely response from the upstream
- server or some other auxiliary server.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpStatusCode.HttpVersionNotSupported">
- <summary>
- Equivalent to status code 505.
- Indicates that the server doesn't support the HTTP version used in the client's request.
- </summary>
- </member>
- <member name="T:WebSocketSharp.Server.WebSocketServiceHost">
- <summary>
- Exposes the methods and properties used to access the information in a WebSocket service
- provided by the <see cref="T:WebSocketSharp.Server.WebSocketServer"/> or <see cref="T:WebSocketSharp.Server.HttpServer"/>.
- </summary>
- <remarks>
- The WebSocketServiceHost class is an abstract class.
- </remarks>
- </member>
- <member name="M:WebSocketSharp.Server.WebSocketServiceHost.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:WebSocketSharp.Server.WebSocketServiceHost"/> class.
- </summary>
- </member>
- <member name="M:WebSocketSharp.Server.WebSocketServiceHost.CreateSession">
- <summary>
- Creates a new session in the WebSocket service.
- </summary>
- <returns>
- A <see cref="T:WebSocketSharp.Server.WebSocketBehavior"/> instance that represents a new session.
- </returns>
- </member>
- <member name="P:WebSocketSharp.Server.WebSocketServiceHost.KeepClean">
- <summary>
- Gets or sets a value indicating whether the WebSocket service cleans up
- the inactive sessions periodically.
- </summary>
- <value>
- <c>true</c> if the service cleans up the inactive sessions periodically;
- otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:WebSocketSharp.Server.WebSocketServiceHost.Path">
- <summary>
- Gets the path to the WebSocket service.
- </summary>
- <value>
- A <see cref="T:System.String"/> that represents the absolute path to the service.
- </value>
- </member>
- <member name="P:WebSocketSharp.Server.WebSocketServiceHost.Sessions">
- <summary>
- Gets the access to the sessions in the WebSocket service.
- </summary>
- <value>
- A <see cref="T:WebSocketSharp.Server.WebSocketSessionManager"/> that manages the sessions in the service.
- </value>
- </member>
- <member name="P:WebSocketSharp.Server.WebSocketServiceHost.Type">
- <summary>
- Gets the <see cref="T:System.Type"/> of the behavior of the WebSocket service.
- </summary>
- <value>
- A <see cref="T:System.Type"/> that represents the type of the behavior of the service.
- </value>
- </member>
- <member name="P:WebSocketSharp.Server.WebSocketServiceHost.WaitTime">
- <summary>
- Gets or sets the wait time for the response to the WebSocket Ping or Close.
- </summary>
- <value>
- A <see cref="T:System.TimeSpan"/> that represents the wait time. The default value is
- the same as 1 second.
- </value>
- </member>
- <member name="T:WebSocketSharp.CloseStatusCode">
- <summary>
- Indicates the status code for the WebSocket connection close.
- </summary>
- <remarks>
- <para>
- The values of this enumeration are defined in
- <see href="http://tools.ietf.org/html/rfc6455#section-7.4">Section 7.4</see> of RFC 6455.
- </para>
- <para>
- "Reserved value" must not be set as a status code in a connection close frame by
- an endpoint. It's designated for use in applications expecting a status code to
- indicate that the connection was closed due to the system grounds.
- </para>
- </remarks>
- </member>
- <member name="F:WebSocketSharp.CloseStatusCode.Normal">
- <summary>
- Equivalent to close status 1000. Indicates normal close.
- </summary>
- </member>
- <member name="F:WebSocketSharp.CloseStatusCode.Away">
- <summary>
- Equivalent to close status 1001. Indicates that an endpoint is going away.
- </summary>
- </member>
- <member name="F:WebSocketSharp.CloseStatusCode.ProtocolError">
- <summary>
- Equivalent to close status 1002. Indicates that an endpoint is terminating
- the connection due to a protocol error.
- </summary>
- </member>
- <member name="F:WebSocketSharp.CloseStatusCode.UnsupportedData">
- <summary>
- Equivalent to close status 1003. Indicates that an endpoint is terminating
- the connection because it has received a type of data that it cannot accept.
- </summary>
- </member>
- <member name="F:WebSocketSharp.CloseStatusCode.Undefined">
- <summary>
- Equivalent to close status 1004. Still undefined. A Reserved value.
- </summary>
- </member>
- <member name="F:WebSocketSharp.CloseStatusCode.NoStatus">
- <summary>
- Equivalent to close status 1005. Indicates that no status code was actually present.
- A Reserved value.
- </summary>
- </member>
- <member name="F:WebSocketSharp.CloseStatusCode.Abnormal">
- <summary>
- Equivalent to close status 1006. Indicates that the connection was closed abnormally.
- A Reserved value.
- </summary>
- </member>
- <member name="F:WebSocketSharp.CloseStatusCode.InvalidData">
- <summary>
- Equivalent to close status 1007. Indicates that an endpoint is terminating
- the connection because it has received a message that contains data that
- isn't consistent with the type of the message.
- </summary>
- </member>
- <member name="F:WebSocketSharp.CloseStatusCode.PolicyViolation">
- <summary>
- Equivalent to close status 1008. Indicates that an endpoint is terminating
- the connection because it has received a message that violates its policy.
- </summary>
- </member>
- <member name="F:WebSocketSharp.CloseStatusCode.TooBig">
- <summary>
- Equivalent to close status 1009. Indicates that an endpoint is terminating
- the connection because it has received a message that is too big to process.
- </summary>
- </member>
- <member name="F:WebSocketSharp.CloseStatusCode.MandatoryExtension">
- <summary>
- Equivalent to close status 1010. Indicates that a client is terminating
- the connection because it has expected the server to negotiate one or more extension,
- but the server didn't return them in the handshake response.
- </summary>
- </member>
- <member name="F:WebSocketSharp.CloseStatusCode.ServerError">
- <summary>
- Equivalent to close status 1011. Indicates that a server is terminating
- the connection because it has encountered an unexpected condition that
- prevented it from fulfilling the request.
- </summary>
- </member>
- <member name="F:WebSocketSharp.CloseStatusCode.TlsHandshakeFailure">
- <summary>
- Equivalent to close status 1015. Indicates that the connection was closed
- due to a failure to perform a TLS handshake. A Reserved value.
- </summary>
- </member>
- <member name="T:WebSocketSharp.Fin">
- <summary>
- Indicates whether a WebSocket frame is the final frame of a message.
- </summary>
- <remarks>
- The values of this enumeration are defined in
- <see href="http://tools.ietf.org/html/rfc6455#section-5.2">Section 5.2</see> of RFC 6455.
- </remarks>
- </member>
- <member name="F:WebSocketSharp.Fin.More">
- <summary>
- Equivalent to numeric value 0. Indicates more frames of a message follow.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Fin.Final">
- <summary>
- Equivalent to numeric value 1. Indicates the final frame of a message.
- </summary>
- </member>
- <member name="T:WebSocketSharp.Mask">
- <summary>
- Indicates whether the payload data of a WebSocket frame is masked.
- </summary>
- <remarks>
- The values of this enumeration are defined in
- <see href="http://tools.ietf.org/html/rfc6455#section-5.2">Section 5.2</see> of RFC 6455.
- </remarks>
- </member>
- <member name="F:WebSocketSharp.Mask.Off">
- <summary>
- Equivalent to numeric value 0. Indicates not masked.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Mask.On">
- <summary>
- Equivalent to numeric value 1. Indicates masked.
- </summary>
- </member>
- <member name="T:WebSocketSharp.Opcode">
- <summary>
- Indicates the WebSocket frame type.
- </summary>
- <remarks>
- The values of this enumeration are defined in
- <see href="http://tools.ietf.org/html/rfc6455#section-5.2">Section 5.2</see> of RFC 6455.
- </remarks>
- </member>
- <member name="F:WebSocketSharp.Opcode.Cont">
- <summary>
- Equivalent to numeric value 0. Indicates continuation frame.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Opcode.Text">
- <summary>
- Equivalent to numeric value 1. Indicates text frame.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Opcode.Binary">
- <summary>
- Equivalent to numeric value 2. Indicates binary frame.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Opcode.Close">
- <summary>
- Equivalent to numeric value 8. Indicates connection close frame.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Opcode.Ping">
- <summary>
- Equivalent to numeric value 9. Indicates ping frame.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Opcode.Pong">
- <summary>
- Equivalent to numeric value 10. Indicates pong frame.
- </summary>
- </member>
- <member name="F:WebSocketSharp.PayloadData.Empty">
- <summary>
- Represents the empty payload data.
- </summary>
- </member>
- <member name="F:WebSocketSharp.PayloadData.MaxLength">
- <summary>
- Represents the allowable max length.
- </summary>
- <remarks>
- <para>
- A <see cref="T:WebSocketSharp.WebSocketException"/> will occur if the payload data length is
- greater than the value of this field.
- </para>
- <para>
- If you would like to change the value, you must set it to a value between
- <c>WebSocket.FragmentLength</c> and <c>Int64.MaxValue</c> inclusive.
- </para>
- </remarks>
- </member>
- <member name="T:WebSocketSharp.Rsv">
- <summary>
- Indicates whether each RSV (RSV1, RSV2, and RSV3) of a WebSocket frame is non-zero.
- </summary>
- <remarks>
- The values of this enumeration are defined in
- <see href="http://tools.ietf.org/html/rfc6455#section-5.2">Section 5.2</see> of RFC 6455.
- </remarks>
- </member>
- <member name="F:WebSocketSharp.Rsv.Off">
- <summary>
- Equivalent to numeric value 0. Indicates zero.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Rsv.On">
- <summary>
- Equivalent to numeric value 1. Indicates non-zero.
- </summary>
- </member>
- <member name="T:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext">
- <summary>
- Provides the properties used to access the information in
- a WebSocket handshake request received by the <see cref="T:WebSocketSharp.Net.HttpListener"/>.
- </summary>
- </member>
- <member name="T:WebSocketSharp.Net.WebSockets.WebSocketContext">
- <summary>
- Exposes the properties used to access the information in a WebSocket handshake request.
- </summary>
- <remarks>
- This class is an abstract class.
- </remarks>
- </member>
- <member name="M:WebSocketSharp.Net.WebSockets.WebSocketContext.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:WebSocketSharp.Net.WebSockets.WebSocketContext"/> class.
- </summary>
- </member>
- <member name="P:WebSocketSharp.Net.WebSockets.WebSocketContext.CookieCollection">
- <summary>
- Gets the HTTP cookies included in the request.
- </summary>
- <value>
- A <see cref="T:WebSocketSharp.Net.CookieCollection"/> that contains the cookies.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.WebSockets.WebSocketContext.Headers">
- <summary>
- Gets the HTTP headers included in the request.
- </summary>
- <value>
- A <see cref="T:System.Collections.Specialized.NameValueCollection"/> that contains the headers.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.WebSockets.WebSocketContext.Host">
- <summary>
- Gets the value of the Host header included in the request.
- </summary>
- <value>
- A <see cref="T:System.String"/> that represents the value of the Host header.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.WebSockets.WebSocketContext.IsAuthenticated">
- <summary>
- Gets a value indicating whether the client is authenticated.
- </summary>
- <value>
- <c>true</c> if the client is authenticated; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.WebSockets.WebSocketContext.IsLocal">
- <summary>
- Gets a value indicating whether the client connected from the local computer.
- </summary>
- <value>
- <c>true</c> if the client connected from the local computer; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.WebSockets.WebSocketContext.IsSecureConnection">
- <summary>
- Gets a value indicating whether the WebSocket connection is secured.
- </summary>
- <value>
- <c>true</c> if the connection is secured; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.WebSockets.WebSocketContext.IsWebSocketRequest">
- <summary>
- Gets a value indicating whether the request is a WebSocket handshake request.
- </summary>
- <value>
- <c>true</c> if the request is a WebSocket handshake request; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.WebSockets.WebSocketContext.Origin">
- <summary>
- Gets the value of the Origin header included in the request.
- </summary>
- <value>
- A <see cref="T:System.String"/> that represents the value of the Origin header.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.WebSockets.WebSocketContext.QueryString">
- <summary>
- Gets the query string included in the request.
- </summary>
- <value>
- A <see cref="T:System.Collections.Specialized.NameValueCollection"/> that contains the query string parameters.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.WebSockets.WebSocketContext.RequestUri">
- <summary>
- Gets the URI requested by the client.
- </summary>
- <value>
- A <see cref="T:System.Uri"/> that represents the requested URI.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.WebSockets.WebSocketContext.SecWebSocketKey">
- <summary>
- Gets the value of the Sec-WebSocket-Key header included in the request.
- </summary>
- <remarks>
- This property provides a part of the information used by the server to prove that
- it received a valid WebSocket handshake request.
- </remarks>
- <value>
- A <see cref="T:System.String"/> that represents the value of the Sec-WebSocket-Key header.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.WebSockets.WebSocketContext.SecWebSocketProtocols">
- <summary>
- Gets the values of the Sec-WebSocket-Protocol header included in the request.
- </summary>
- <remarks>
- This property represents the subprotocols requested by the client.
- </remarks>
- <value>
- An <see cref="T:System.Collections.Generic.IEnumerable{string}"/> instance that provides
- an enumerator which supports the iteration over the values of the Sec-WebSocket-Protocol
- header.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.WebSockets.WebSocketContext.SecWebSocketVersion">
- <summary>
- Gets the value of the Sec-WebSocket-Version header included in the request.
- </summary>
- <remarks>
- This property represents the WebSocket protocol version.
- </remarks>
- <value>
- A <see cref="T:System.String"/> that represents the value of the Sec-WebSocket-Version header.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.WebSockets.WebSocketContext.ServerEndPoint">
- <summary>
- Gets the server endpoint as an IP address and a port number.
- </summary>
- <value>
- A <see cref="T:System.Net.IPEndPoint"/> that represents the server endpoint.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.WebSockets.WebSocketContext.User">
- <summary>
- Gets the client information (identity, authentication, and security roles).
- </summary>
- <value>
- A <see cref="T:System.Security.Principal.IPrincipal"/> instance that represents the client information.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.WebSockets.WebSocketContext.UserEndPoint">
- <summary>
- Gets the client endpoint as an IP address and a port number.
- </summary>
- <value>
- A <see cref="T:System.Net.IPEndPoint"/> that represents the client endpoint.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.WebSockets.WebSocketContext.WebSocket">
- <summary>
- Gets the <see cref="T:WebSocketSharp.WebSocket"/> instance used for
- two-way communication between client and server.
- </summary>
- <value>
- A <see cref="T:WebSocketSharp.WebSocket"/>.
- </value>
- </member>
- <member name="M:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext.ToString">
- <summary>
- Returns a <see cref="T:System.String"/> that represents
- the current <see cref="T:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext"/>.
- </summary>
- <returns>
- A <see cref="T:System.String"/> that represents
- the current <see cref="T:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext"/>.
- </returns>
- </member>
- <member name="P:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext.CookieCollection">
- <summary>
- Gets the HTTP cookies included in the request.
- </summary>
- <value>
- A <see cref="T:WebSocketSharp.Net.CookieCollection"/> that contains the cookies.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext.Headers">
- <summary>
- Gets the HTTP headers included in the request.
- </summary>
- <value>
- A <see cref="T:System.Collections.Specialized.NameValueCollection"/> that contains the headers.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext.Host">
- <summary>
- Gets the value of the Host header included in the request.
- </summary>
- <value>
- A <see cref="T:System.String"/> that represents the value of the Host header.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext.IsAuthenticated">
- <summary>
- Gets a value indicating whether the client is authenticated.
- </summary>
- <value>
- <c>true</c> if the client is authenticated; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext.IsLocal">
- <summary>
- Gets a value indicating whether the client connected from the local computer.
- </summary>
- <value>
- <c>true</c> if the client connected from the local computer; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext.IsSecureConnection">
- <summary>
- Gets a value indicating whether the WebSocket connection is secured.
- </summary>
- <value>
- <c>true</c> if the connection is secured; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext.IsWebSocketRequest">
- <summary>
- Gets a value indicating whether the request is a WebSocket handshake request.
- </summary>
- <value>
- <c>true</c> if the request is a WebSocket handshake request; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext.Origin">
- <summary>
- Gets the value of the Origin header included in the request.
- </summary>
- <value>
- A <see cref="T:System.String"/> that represents the value of the Origin header.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext.QueryString">
- <summary>
- Gets the query string included in the request.
- </summary>
- <value>
- A <see cref="T:System.Collections.Specialized.NameValueCollection"/> that contains the query string parameters.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext.RequestUri">
- <summary>
- Gets the URI requested by the client.
- </summary>
- <value>
- A <see cref="T:System.Uri"/> that represents the requested URI.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext.SecWebSocketKey">
- <summary>
- Gets the value of the Sec-WebSocket-Key header included in the request.
- </summary>
- <remarks>
- This property provides a part of the information used by the server to prove that
- it received a valid WebSocket handshake request.
- </remarks>
- <value>
- A <see cref="T:System.String"/> that represents the value of the Sec-WebSocket-Key header.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext.SecWebSocketProtocols">
- <summary>
- Gets the values of the Sec-WebSocket-Protocol header included in the request.
- </summary>
- <remarks>
- This property represents the subprotocols requested by the client.
- </remarks>
- <value>
- An <see cref="T:System.Collections.Generic.IEnumerable{string}"/> instance that provides
- an enumerator which supports the iteration over the values of the Sec-WebSocket-Protocol
- header.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext.SecWebSocketVersion">
- <summary>
- Gets the value of the Sec-WebSocket-Version header included in the request.
- </summary>
- <remarks>
- This property represents the WebSocket protocol version.
- </remarks>
- <value>
- A <see cref="T:System.String"/> that represents the value of the Sec-WebSocket-Version header.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext.ServerEndPoint">
- <summary>
- Gets the server endpoint as an IP address and a port number.
- </summary>
- <value>
- A <see cref="T:System.Net.IPEndPoint"/> that represents the server endpoint.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext.User">
- <summary>
- Gets the client information (identity, authentication, and security roles).
- </summary>
- <value>
- A <see cref="T:System.Security.Principal.IPrincipal"/> instance that represents the client information.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext.UserEndPoint">
- <summary>
- Gets the client endpoint as an IP address and a port number.
- </summary>
- <value>
- A <see cref="T:System.Net.IPEndPoint"/> that represents the client endpoint.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext.WebSocket">
- <summary>
- Gets the <see cref="T:WebSocketSharp.WebSocket"/> instance used for
- two-way communication between client and server.
- </summary>
- <value>
- A <see cref="T:WebSocketSharp.WebSocket"/>.
- </value>
- </member>
- <member name="T:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext">
- <summary>
- Provides the properties used to access the information in
- a WebSocket handshake request received by the <see cref="T:System.Net.Sockets.TcpListener"/>.
- </summary>
- </member>
- <member name="M:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext.ToString">
- <summary>
- Returns a <see cref="T:System.String"/> that represents
- the current <see cref="T:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext"/>.
- </summary>
- <returns>
- A <see cref="T:System.String"/> that represents
- the current <see cref="T:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext"/>.
- </returns>
- </member>
- <member name="P:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext.CookieCollection">
- <summary>
- Gets the HTTP cookies included in the request.
- </summary>
- <value>
- A <see cref="T:WebSocketSharp.Net.CookieCollection"/> that contains the cookies.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext.Headers">
- <summary>
- Gets the HTTP headers included in the request.
- </summary>
- <value>
- A <see cref="T:System.Collections.Specialized.NameValueCollection"/> that contains the headers.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext.Host">
- <summary>
- Gets the value of the Host header included in the request.
- </summary>
- <value>
- A <see cref="T:System.String"/> that represents the value of the Host header.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext.IsAuthenticated">
- <summary>
- Gets a value indicating whether the client is authenticated.
- </summary>
- <value>
- <c>true</c> if the client is authenticated; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext.IsLocal">
- <summary>
- Gets a value indicating whether the client connected from the local computer.
- </summary>
- <value>
- <c>true</c> if the client connected from the local computer; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext.IsSecureConnection">
- <summary>
- Gets a value indicating whether the WebSocket connection is secured.
- </summary>
- <value>
- <c>true</c> if the connection is secured; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext.IsWebSocketRequest">
- <summary>
- Gets a value indicating whether the request is a WebSocket handshake request.
- </summary>
- <value>
- <c>true</c> if the request is a WebSocket handshake request; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext.Origin">
- <summary>
- Gets the value of the Origin header included in the request.
- </summary>
- <value>
- A <see cref="T:System.String"/> that represents the value of the Origin header.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext.QueryString">
- <summary>
- Gets the query string included in the request.
- </summary>
- <value>
- A <see cref="T:System.Collections.Specialized.NameValueCollection"/> that contains the query string parameters.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext.RequestUri">
- <summary>
- Gets the URI requested by the client.
- </summary>
- <value>
- A <see cref="T:System.Uri"/> that represents the requested URI.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext.SecWebSocketKey">
- <summary>
- Gets the value of the Sec-WebSocket-Key header included in the request.
- </summary>
- <remarks>
- This property provides a part of the information used by the server to prove that
- it received a valid WebSocket handshake request.
- </remarks>
- <value>
- A <see cref="T:System.String"/> that represents the value of the Sec-WebSocket-Key header.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext.SecWebSocketProtocols">
- <summary>
- Gets the values of the Sec-WebSocket-Protocol header included in the request.
- </summary>
- <remarks>
- This property represents the subprotocols requested by the client.
- </remarks>
- <value>
- An <see cref="T:System.Collections.Generic.IEnumerable{string}"/> instance that provides
- an enumerator which supports the iteration over the values of the Sec-WebSocket-Protocol
- header.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext.SecWebSocketVersion">
- <summary>
- Gets the value of the Sec-WebSocket-Version header included in the request.
- </summary>
- <remarks>
- This property represents the WebSocket protocol version.
- </remarks>
- <value>
- A <see cref="T:System.String"/> that represents the value of the Sec-WebSocket-Version header.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext.ServerEndPoint">
- <summary>
- Gets the server endpoint as an IP address and a port number.
- </summary>
- <value>
- A <see cref="T:System.Net.IPEndPoint"/> that represents the server endpoint.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext.User">
- <summary>
- Gets the client information (identity, authentication, and security roles).
- </summary>
- <value>
- A <see cref="T:System.Security.Principal.IPrincipal"/> instance that represents the client information.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext.UserEndPoint">
- <summary>
- Gets the client endpoint as an IP address and a port number.
- </summary>
- <value>
- A <see cref="T:System.Net.IPEndPoint"/> that represents the client endpoint.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext.WebSocket">
- <summary>
- Gets the <see cref="T:WebSocketSharp.WebSocket"/> instance used for
- two-way communication between client and server.
- </summary>
- <value>
- A <see cref="T:WebSocketSharp.WebSocket"/>.
- </value>
- </member>
- <member name="T:WebSocketSharp.Server.HttpRequestEventArgs">
- <summary>
- Represents the event data for the HTTP request event that the <see cref="T:WebSocketSharp.Server.HttpServer"/> emits.
- </summary>
- <remarks>
- <para>
- An HTTP request event occurs when the <see cref="T:WebSocketSharp.Server.HttpServer"/> receives an HTTP request.
- </para>
- <para>
- If you would like to get the request data sent from a client,
- you should access the <see cref="P:WebSocketSharp.Server.HttpRequestEventArgs.Request"/> property.
- </para>
- <para>
- And if you would like to get the response data used to return a response,
- you should access the <see cref="P:WebSocketSharp.Server.HttpRequestEventArgs.Response"/> property.
- </para>
- </remarks>
- </member>
- <member name="P:WebSocketSharp.Server.HttpRequestEventArgs.Request">
- <summary>
- Gets the HTTP request data sent from a client.
- </summary>
- <value>
- A <see cref="T:WebSocketSharp.Net.HttpListenerRequest"/> that represents the request data.
- </value>
- </member>
- <member name="P:WebSocketSharp.Server.HttpRequestEventArgs.Response">
- <summary>
- Gets the HTTP response data used to return a response to the client.
- </summary>
- <value>
- A <see cref="T:WebSocketSharp.Net.HttpListenerResponse"/> that represents the response data.
- </value>
- </member>
- <member name="T:WebSocketSharp.CompressionMethod">
- <summary>
- Specifies the compression method used to compress a message on the WebSocket connection.
- </summary>
- <remarks>
- The compression methods are defined in
- <see href="http://tools.ietf.org/html/draft-ietf-hybi-permessage-compression-19">
- Compression Extensions for WebSocket</see>.
- </remarks>
- </member>
- <member name="F:WebSocketSharp.CompressionMethod.None">
- <summary>
- Specifies non compression.
- </summary>
- </member>
- <member name="F:WebSocketSharp.CompressionMethod.Deflate">
- <summary>
- Specifies DEFLATE.
- </summary>
- </member>
- <member name="T:WebSocketSharp.WebSocketException">
- <summary>
- The exception that is thrown when a <see cref="T:WebSocketSharp.WebSocket"/> gets a fatal error.
- </summary>
- </member>
- <member name="P:WebSocketSharp.WebSocketException.Code">
- <summary>
- Gets the status code indicating the cause of the exception.
- </summary>
- <value>
- One of the <see cref="T:WebSocketSharp.CloseStatusCode"/> enum values, represents the status code
- indicating the cause of the exception.
- </value>
- </member>
- <member name="T:WebSocketSharp.LogData">
- <summary>
- Represents a log data used by the <see cref="T:WebSocketSharp.Logger"/> class.
- </summary>
- </member>
- <member name="M:WebSocketSharp.LogData.ToString">
- <summary>
- Returns a <see cref="T:System.String"/> that represents the current <see cref="T:WebSocketSharp.LogData"/>.
- </summary>
- <returns>
- A <see cref="T:System.String"/> that represents the current <see cref="T:WebSocketSharp.LogData"/>.
- </returns>
- </member>
- <member name="P:WebSocketSharp.LogData.Caller">
- <summary>
- Gets the information of the logging method caller.
- </summary>
- <value>
- A <see cref="T:System.Diagnostics.StackFrame"/> that provides the information of the logging method caller.
- </value>
- </member>
- <member name="P:WebSocketSharp.LogData.Date">
- <summary>
- Gets the date and time when the log data was created.
- </summary>
- <value>
- A <see cref="T:System.DateTime"/> that represents the date and time when the log data was created.
- </value>
- </member>
- <member name="P:WebSocketSharp.LogData.Level">
- <summary>
- Gets the logging level of the log data.
- </summary>
- <value>
- One of the <see cref="T:WebSocketSharp.LogLevel"/> enum values, indicates the logging level of the log data.
- </value>
- </member>
- <member name="P:WebSocketSharp.LogData.Message">
- <summary>
- Gets the message of the log data.
- </summary>
- <value>
- A <see cref="T:System.String"/> that represents the message of the log data.
- </value>
- </member>
- <member name="T:WebSocketSharp.LogLevel">
- <summary>
- Specifies the logging level.
- </summary>
- </member>
- <member name="F:WebSocketSharp.LogLevel.Trace">
- <summary>
- Specifies the bottom logging level.
- </summary>
- </member>
- <member name="F:WebSocketSharp.LogLevel.Debug">
- <summary>
- Specifies the 2nd logging level from the bottom.
- </summary>
- </member>
- <member name="F:WebSocketSharp.LogLevel.Info">
- <summary>
- Specifies the 3rd logging level from the bottom.
- </summary>
- </member>
- <member name="F:WebSocketSharp.LogLevel.Warn">
- <summary>
- Specifies the 3rd logging level from the top.
- </summary>
- </member>
- <member name="F:WebSocketSharp.LogLevel.Error">
- <summary>
- Specifies the 2nd logging level from the top.
- </summary>
- </member>
- <member name="F:WebSocketSharp.LogLevel.Fatal">
- <summary>
- Specifies the top logging level.
- </summary>
- </member>
- <member name="T:WebSocketSharp.Logger">
- <summary>
- Provides a set of methods and properties for logging.
- </summary>
- <remarks>
- <para>
- If you output a log with lower than the value of the <see cref="P:WebSocketSharp.Logger.Level"/> property,
- it cannot be outputted.
- </para>
- <para>
- The default output action writes a log to the standard output stream and the log file
- if the <see cref="P:WebSocketSharp.Logger.File"/> property has a valid path to it.
- </para>
- <para>
- If you would like to use the custom output action, you should set
- the <see cref="P:WebSocketSharp.Logger.Output"/> property to any <c>Action<LogData, string></c>
- delegate.
- </para>
- </remarks>
- </member>
- <member name="M:WebSocketSharp.Logger.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:WebSocketSharp.Logger"/> class.
- </summary>
- <remarks>
- This constructor initializes the current logging level with <see cref="F:WebSocketSharp.LogLevel.Error"/>.
- </remarks>
- </member>
- <member name="M:WebSocketSharp.Logger.#ctor(WebSocketSharp.LogLevel)">
- <summary>
- Initializes a new instance of the <see cref="T:WebSocketSharp.Logger"/> class with
- the specified logging <paramref name="level"/>.
- </summary>
- <param name="level">
- One of the <see cref="T:WebSocketSharp.LogLevel"/> enum values.
- </param>
- </member>
- <member name="M:WebSocketSharp.Logger.#ctor(WebSocketSharp.LogLevel,System.String,System.Action{WebSocketSharp.LogData,System.String})">
- <summary>
- Initializes a new instance of the <see cref="T:WebSocketSharp.Logger"/> class with
- the specified logging <paramref name="level"/>, path to the log <paramref name="file"/>,
- and <paramref name="output"/> action.
- </summary>
- <param name="level">
- One of the <see cref="T:WebSocketSharp.LogLevel"/> enum values.
- </param>
- <param name="file">
- A <see cref="T:System.String"/> that represents the path to the log file.
- </param>
- <param name="output">
- An <c>Action<LogData, string></c> delegate that references the method(s) used to
- output a log. A <see cref="T:System.String"/> parameter passed to this delegate is
- <paramref name="file"/>.
- </param>
- </member>
- <member name="M:WebSocketSharp.Logger.Debug(System.String)">
- <summary>
- Outputs <paramref name="message"/> as a log with <see cref="F:WebSocketSharp.LogLevel.Debug"/>.
- </summary>
- <remarks>
- If the current logging level is higher than <see cref="F:WebSocketSharp.LogLevel.Debug"/>,
- this method doesn't output <paramref name="message"/> as a log.
- </remarks>
- <param name="message">
- A <see cref="T:System.String"/> that represents the message to output as a log.
- </param>
- </member>
- <member name="M:WebSocketSharp.Logger.Error(System.String)">
- <summary>
- Outputs <paramref name="message"/> as a log with <see cref="F:WebSocketSharp.LogLevel.Error"/>.
- </summary>
- <remarks>
- If the current logging level is higher than <see cref="F:WebSocketSharp.LogLevel.Error"/>,
- this method doesn't output <paramref name="message"/> as a log.
- </remarks>
- <param name="message">
- A <see cref="T:System.String"/> that represents the message to output as a log.
- </param>
- </member>
- <member name="M:WebSocketSharp.Logger.Fatal(System.String)">
- <summary>
- Outputs <paramref name="message"/> as a log with <see cref="F:WebSocketSharp.LogLevel.Fatal"/>.
- </summary>
- <param name="message">
- A <see cref="T:System.String"/> that represents the message to output as a log.
- </param>
- </member>
- <member name="M:WebSocketSharp.Logger.Info(System.String)">
- <summary>
- Outputs <paramref name="message"/> as a log with <see cref="F:WebSocketSharp.LogLevel.Info"/>.
- </summary>
- <remarks>
- If the current logging level is higher than <see cref="F:WebSocketSharp.LogLevel.Info"/>,
- this method doesn't output <paramref name="message"/> as a log.
- </remarks>
- <param name="message">
- A <see cref="T:System.String"/> that represents the message to output as a log.
- </param>
- </member>
- <member name="M:WebSocketSharp.Logger.Trace(System.String)">
- <summary>
- Outputs <paramref name="message"/> as a log with <see cref="F:WebSocketSharp.LogLevel.Trace"/>.
- </summary>
- <remarks>
- If the current logging level is higher than <see cref="F:WebSocketSharp.LogLevel.Trace"/>,
- this method doesn't output <paramref name="message"/> as a log.
- </remarks>
- <param name="message">
- A <see cref="T:System.String"/> that represents the message to output as a log.
- </param>
- </member>
- <member name="M:WebSocketSharp.Logger.Warn(System.String)">
- <summary>
- Outputs <paramref name="message"/> as a log with <see cref="F:WebSocketSharp.LogLevel.Warn"/>.
- </summary>
- <remarks>
- If the current logging level is higher than <see cref="F:WebSocketSharp.LogLevel.Warn"/>,
- this method doesn't output <paramref name="message"/> as a log.
- </remarks>
- <param name="message">
- A <see cref="T:System.String"/> that represents the message to output as a log.
- </param>
- </member>
- <member name="P:WebSocketSharp.Logger.File">
- <summary>
- Gets or sets the current path to the log file.
- </summary>
- <value>
- A <see cref="T:System.String"/> that represents the current path to the log file if any.
- </value>
- </member>
- <member name="P:WebSocketSharp.Logger.Level">
- <summary>
- Gets or sets the current logging level.
- </summary>
- <remarks>
- A log with lower than the value of this property cannot be outputted.
- </remarks>
- <value>
- One of the <see cref="T:WebSocketSharp.LogLevel"/> enum values, specifies the current logging level.
- </value>
- </member>
- <member name="P:WebSocketSharp.Logger.Output">
- <summary>
- Gets or sets the current output action used to output a log.
- </summary>
- <value>
- <para>
- An <c>Action<LogData, string></c> delegate that references the method(s) used to
- output a log. A <see cref="T:System.String"/> parameter passed to this delegate is the value of
- the <see cref="P:WebSocketSharp.Logger.File"/> property.
- </para>
- <para>
- If the value to set is <see langword="null"/>, the current output action is changed to
- the default output action.
- </para>
- </value>
- </member>
- <member name="T:WebSocketSharp.WebSocketState">
- <summary>
- Indicates the state of a WebSocket connection.
- </summary>
- <remarks>
- The values of this enumeration are defined in
- <see href="http://www.w3.org/TR/websockets/#dom-websocket-readystate">The WebSocket API</see>.
- </remarks>
- </member>
- <member name="F:WebSocketSharp.WebSocketState.Connecting">
- <summary>
- Equivalent to numeric value 0. Indicates that the connection hasn't yet been established.
- </summary>
- </member>
- <member name="F:WebSocketSharp.WebSocketState.Open">
- <summary>
- Equivalent to numeric value 1. Indicates that the connection has been established,
- and the communication is possible.
- </summary>
- </member>
- <member name="F:WebSocketSharp.WebSocketState.Closing">
- <summary>
- Equivalent to numeric value 2. Indicates that the connection is going through
- the closing handshake, or the <c>WebSocket.Close</c> method has been invoked.
- </summary>
- </member>
- <member name="F:WebSocketSharp.WebSocketState.Closed">
- <summary>
- Equivalent to numeric value 3. Indicates that the connection has been closed or
- couldn't be established.
- </summary>
- </member>
- <member name="T:WebSocketSharp.Server.IWebSocketSession">
- <summary>
- Exposes the properties used to access the information in a session in a WebSocket service.
- </summary>
- </member>
- <member name="P:WebSocketSharp.Server.IWebSocketSession.Context">
- <summary>
- Gets the information in the connection request to the WebSocket service.
- </summary>
- <value>
- A <see cref="T:WebSocketSharp.Net.WebSockets.WebSocketContext"/> that provides the access to the connection request.
- </value>
- </member>
- <member name="P:WebSocketSharp.Server.IWebSocketSession.ID">
- <summary>
- Gets the unique ID of the session.
- </summary>
- <value>
- A <see cref="T:System.String"/> that represents the unique ID of the session.
- </value>
- </member>
- <member name="P:WebSocketSharp.Server.IWebSocketSession.Protocol">
- <summary>
- Gets the WebSocket subprotocol used in the session.
- </summary>
- <value>
- A <see cref="T:System.String"/> that represents the subprotocol if any.
- </value>
- </member>
- <member name="P:WebSocketSharp.Server.IWebSocketSession.StartTime">
- <summary>
- Gets the time that the session has started.
- </summary>
- <value>
- A <see cref="T:System.DateTime"/> that represents the time that the session has started.
- </value>
- </member>
- <member name="P:WebSocketSharp.Server.IWebSocketSession.State">
- <summary>
- Gets the state of the <see cref="T:WebSocketSharp.WebSocket"/> used in the session.
- </summary>
- <value>
- One of the <see cref="T:WebSocketSharp.WebSocketState"/> enum values, indicates the state of
- the <see cref="T:WebSocketSharp.WebSocket"/> used in the session.
- </value>
- </member>
- <member name="T:WebSocketSharp.Server.WebSocketSessionManager">
- <summary>
- Manages the sessions in a Websocket service.
- </summary>
- </member>
- <member name="M:WebSocketSharp.Server.WebSocketSessionManager.Broadcast(System.Byte[])">
- <summary>
- Sends binary <paramref name="data"/> to every client in the WebSocket service.
- </summary>
- <param name="data">
- An array of <see cref="T:System.Byte"/> that represents the binary data to send.
- </param>
- </member>
- <member name="M:WebSocketSharp.Server.WebSocketSessionManager.Broadcast(System.String)">
- <summary>
- Sends text <paramref name="data"/> to every client in the WebSocket service.
- </summary>
- <param name="data">
- A <see cref="T:System.String"/> that represents the text data to send.
- </param>
- </member>
- <member name="M:WebSocketSharp.Server.WebSocketSessionManager.BroadcastAsync(System.Byte[],System.Action)">
- <summary>
- Sends binary <paramref name="data"/> asynchronously to every client in
- the WebSocket service.
- </summary>
- <remarks>
- This method doesn't wait for the send to be complete.
- </remarks>
- <param name="data">
- An array of <see cref="T:System.Byte"/> that represents the binary data to send.
- </param>
- <param name="completed">
- An <see cref="T:System.Action"/> delegate that references the method(s) called when
- the send is complete.
- </param>
- </member>
- <member name="M:WebSocketSharp.Server.WebSocketSessionManager.BroadcastAsync(System.String,System.Action)">
- <summary>
- Sends text <paramref name="data"/> asynchronously to every client in
- the WebSocket service.
- </summary>
- <remarks>
- This method doesn't wait for the send to be complete.
- </remarks>
- <param name="data">
- A <see cref="T:System.String"/> that represents the text data to send.
- </param>
- <param name="completed">
- An <see cref="T:System.Action"/> delegate that references the method(s) called when
- the send is complete.
- </param>
- </member>
- <member name="M:WebSocketSharp.Server.WebSocketSessionManager.BroadcastAsync(System.IO.Stream,System.Int32,System.Action)">
- <summary>
- Sends binary data from the specified <see cref="T:System.IO.Stream"/> asynchronously to
- every client in the WebSocket service.
- </summary>
- <remarks>
- This method doesn't wait for the send to be complete.
- </remarks>
- <param name="stream">
- A <see cref="T:System.IO.Stream"/> from which contains the binary data to send.
- </param>
- <param name="length">
- An <see cref="T:System.Int32"/> that represents the number of bytes to send.
- </param>
- <param name="completed">
- An <see cref="T:System.Action"/> delegate that references the method(s) called when
- the send is complete.
- </param>
- </member>
- <member name="M:WebSocketSharp.Server.WebSocketSessionManager.Broadping">
- <summary>
- Sends a Ping to every client in the WebSocket service.
- </summary>
- <returns>
- A <c>Dictionary<string, bool></c> that contains a collection of pairs of
- a session ID and a value indicating whether the manager received a Pong from
- each client in a time.
- </returns>
- </member>
- <member name="M:WebSocketSharp.Server.WebSocketSessionManager.Broadping(System.String)">
- <summary>
- Sends a Ping with the specified <paramref name="message"/> to every client in
- the WebSocket service.
- </summary>
- <returns>
- A <c>Dictionary<string, bool></c> that contains a collection of pairs of
- a session ID and a value indicating whether the manager received a Pong from
- each client in a time.
- </returns>
- <param name="message">
- A <see cref="T:System.String"/> that represents the message to send.
- </param>
- </member>
- <member name="M:WebSocketSharp.Server.WebSocketSessionManager.CloseSession(System.String)">
- <summary>
- Closes the session with the specified <paramref name="id"/>.
- </summary>
- <param name="id">
- A <see cref="T:System.String"/> that represents the ID of the session to close.
- </param>
- </member>
- <member name="M:WebSocketSharp.Server.WebSocketSessionManager.CloseSession(System.String,System.UInt16,System.String)">
- <summary>
- Closes the session with the specified <paramref name="id"/>, <paramref name="code"/>,
- and <paramref name="reason"/>.
- </summary>
- <param name="id">
- A <see cref="T:System.String"/> that represents the ID of the session to close.
- </param>
- <param name="code">
- A <see cref="T:System.UInt16"/> that represents the status code indicating the reason for the close.
- </param>
- <param name="reason">
- A <see cref="T:System.String"/> that represents the reason for the close.
- </param>
- </member>
- <member name="M:WebSocketSharp.Server.WebSocketSessionManager.CloseSession(System.String,WebSocketSharp.CloseStatusCode,System.String)">
- <summary>
- Closes the session with the specified <paramref name="id"/>, <paramref name="code"/>,
- and <paramref name="reason"/>.
- </summary>
- <param name="id">
- A <see cref="T:System.String"/> that represents the ID of the session to close.
- </param>
- <param name="code">
- One of the <see cref="T:WebSocketSharp.CloseStatusCode"/> enum values, represents the status code
- indicating the reason for the close.
- </param>
- <param name="reason">
- A <see cref="T:System.String"/> that represents the reason for the close.
- </param>
- </member>
- <member name="M:WebSocketSharp.Server.WebSocketSessionManager.PingTo(System.String)">
- <summary>
- Sends a Ping to the client on the session with the specified <paramref name="id"/>.
- </summary>
- <returns>
- <c>true</c> if the manager receives a Pong from the client in a time;
- otherwise, <c>false</c>.
- </returns>
- <param name="id">
- A <see cref="T:System.String"/> that represents the ID of the session to find.
- </param>
- </member>
- <member name="M:WebSocketSharp.Server.WebSocketSessionManager.PingTo(System.String,System.String)">
- <summary>
- Sends a Ping with the specified <paramref name="message"/> to the client on
- the session with the specified <paramref name="id"/>.
- </summary>
- <returns>
- <c>true</c> if the manager receives a Pong from the client in a time;
- otherwise, <c>false</c>.
- </returns>
- <param name="message">
- A <see cref="T:System.String"/> that represents the message to send.
- </param>
- <param name="id">
- A <see cref="T:System.String"/> that represents the ID of the session to find.
- </param>
- </member>
- <member name="M:WebSocketSharp.Server.WebSocketSessionManager.SendTo(System.Byte[],System.String)">
- <summary>
- Sends binary <paramref name="data"/> to the client on the session with
- the specified <paramref name="id"/>.
- </summary>
- <param name="data">
- An array of <see cref="T:System.Byte"/> that represents the binary data to send.
- </param>
- <param name="id">
- A <see cref="T:System.String"/> that represents the ID of the session to find.
- </param>
- </member>
- <member name="M:WebSocketSharp.Server.WebSocketSessionManager.SendTo(System.String,System.String)">
- <summary>
- Sends text <paramref name="data"/> to the client on the session with
- the specified <paramref name="id"/>.
- </summary>
- <param name="data">
- A <see cref="T:System.String"/> that represents the text data to send.
- </param>
- <param name="id">
- A <see cref="T:System.String"/> that represents the ID of the session to find.
- </param>
- </member>
- <member name="M:WebSocketSharp.Server.WebSocketSessionManager.SendToAsync(System.Byte[],System.String,System.Action{System.Boolean})">
- <summary>
- Sends binary <paramref name="data"/> asynchronously to the client on
- the session with the specified <paramref name="id"/>.
- </summary>
- <remarks>
- This method doesn't wait for the send to be complete.
- </remarks>
- <param name="data">
- An array of <see cref="T:System.Byte"/> that represents the binary data to send.
- </param>
- <param name="id">
- A <see cref="T:System.String"/> that represents the ID of the session to find.
- </param>
- <param name="completed">
- An <c>Action<bool></c> delegate that references the method(s) called when
- the send is complete. A <see cref="T:System.Boolean"/> passed to this delegate is <c>true</c>
- if the send is complete successfully.
- </param>
- </member>
- <member name="M:WebSocketSharp.Server.WebSocketSessionManager.SendToAsync(System.String,System.String,System.Action{System.Boolean})">
- <summary>
- Sends text <paramref name="data"/> asynchronously to the client on
- the session with the specified <paramref name="id"/>.
- </summary>
- <remarks>
- This method doesn't wait for the send to be complete.
- </remarks>
- <param name="data">
- A <see cref="T:System.String"/> that represents the text data to send.
- </param>
- <param name="id">
- A <see cref="T:System.String"/> that represents the ID of the session to find.
- </param>
- <param name="completed">
- An <c>Action<bool></c> delegate that references the method(s) called when
- the send is complete. A <see cref="T:System.Boolean"/> passed to this delegate is <c>true</c>
- if the send is complete successfully.
- </param>
- </member>
- <member name="M:WebSocketSharp.Server.WebSocketSessionManager.SendToAsync(System.IO.Stream,System.Int32,System.String,System.Action{System.Boolean})">
- <summary>
- Sends binary data from the specified <see cref="T:System.IO.Stream"/> asynchronously to
- the client on the session with the specified <paramref name="id"/>.
- </summary>
- <remarks>
- This method doesn't wait for the send to be complete.
- </remarks>
- <param name="stream">
- A <see cref="T:System.IO.Stream"/> from which contains the binary data to send.
- </param>
- <param name="length">
- An <see cref="T:System.Int32"/> that represents the number of bytes to send.
- </param>
- <param name="id">
- A <see cref="T:System.String"/> that represents the ID of the session to find.
- </param>
- <param name="completed">
- An <c>Action<bool></c> delegate that references the method(s) called when
- the send is complete. A <see cref="T:System.Boolean"/> passed to this delegate is <c>true</c>
- if the send is complete successfully.
- </param>
- </member>
- <member name="M:WebSocketSharp.Server.WebSocketSessionManager.Sweep">
- <summary>
- Cleans up the inactive sessions in the WebSocket service.
- </summary>
- </member>
- <member name="M:WebSocketSharp.Server.WebSocketSessionManager.TryGetSession(System.String,WebSocketSharp.Server.IWebSocketSession@)">
- <summary>
- Tries to get the session with the specified <paramref name="id"/>.
- </summary>
- <returns>
- <c>true</c> if the session is successfully found; otherwise, <c>false</c>.
- </returns>
- <param name="id">
- A <see cref="T:System.String"/> that represents the ID of the session to find.
- </param>
- <param name="session">
- When this method returns, a <see cref="T:WebSocketSharp.Server.IWebSocketSession"/> instance that
- provides the access to the information in the session, or <see langword="null"/>
- if it's not found. This parameter is passed uninitialized.
- </param>
- </member>
- <member name="P:WebSocketSharp.Server.WebSocketSessionManager.ActiveIDs">
- <summary>
- Gets the IDs for the active sessions in the Websocket service.
- </summary>
- <value>
- An <c>IEnumerable<string></c> instance that provides an enumerator which
- supports the iteration over the collection of the IDs for the active sessions.
- </value>
- </member>
- <member name="P:WebSocketSharp.Server.WebSocketSessionManager.Count">
- <summary>
- Gets the number of the sessions in the Websocket service.
- </summary>
- <value>
- An <see cref="T:System.Int32"/> that represents the number of the sessions.
- </value>
- </member>
- <member name="P:WebSocketSharp.Server.WebSocketSessionManager.IDs">
- <summary>
- Gets the IDs for the sessions in the Websocket service.
- </summary>
- <value>
- An <c>IEnumerable<string></c> instance that provides an enumerator which
- supports the iteration over the collection of the IDs for the sessions.
- </value>
- </member>
- <member name="P:WebSocketSharp.Server.WebSocketSessionManager.InactiveIDs">
- <summary>
- Gets the IDs for the inactive sessions in the Websocket service.
- </summary>
- <value>
- An <c>IEnumerable<string></c> instance that provides an enumerator which
- supports the iteration over the collection of the IDs for the inactive sessions.
- </value>
- </member>
- <member name="P:WebSocketSharp.Server.WebSocketSessionManager.Item(System.String)">
- <summary>
- Gets the session with the specified <paramref name="id"/>.
- </summary>
- <value>
- A <see cref="T:WebSocketSharp.Server.IWebSocketSession"/> instance that provides the access to
- the information in the session, or <see langword="null"/> if it's not found.
- </value>
- <param name="id">
- A <see cref="T:System.String"/> that represents the ID of the session to find.
- </param>
- </member>
- <member name="P:WebSocketSharp.Server.WebSocketSessionManager.KeepClean">
- <summary>
- Gets a value indicating whether the manager cleans up the inactive sessions in
- the WebSocket service periodically.
- </summary>
- <value>
- <c>true</c> if the manager cleans up the inactive sessions every 60 seconds;
- otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:WebSocketSharp.Server.WebSocketSessionManager.Sessions">
- <summary>
- Gets the sessions in the Websocket service.
- </summary>
- <value>
- An <c>IEnumerable<IWebSocketSession></c> instance that provides an enumerator
- which supports the iteration over the collection of the sessions in the service.
- </value>
- </member>
- <member name="P:WebSocketSharp.Server.WebSocketSessionManager.WaitTime">
- <summary>
- Gets the wait time for the response to the WebSocket Ping or Close.
- </summary>
- <value>
- A <see cref="T:System.TimeSpan"/> that represents the wait time.
- </value>
- </member>
- <member name="T:WebSocketSharp.Net.HttpBasicIdentity">
- <summary>
- Holds the user name and password from the HTTP Basic authentication credentials.
- </summary>
- </member>
- <member name="P:WebSocketSharp.Net.HttpBasicIdentity.Password">
- <summary>
- Gets the password from the HTTP Basic authentication credentials.
- </summary>
- <value>
- A <see cref="T:System.String"/> that represents the password.
- </value>
- </member>
- <member name="T:WebSocketSharp.Net.HttpDigestIdentity">
- <summary>
- Holds the user name and other parameters from the HTTP Digest authentication credentials.
- </summary>
- </member>
- <member name="P:WebSocketSharp.Net.HttpDigestIdentity.Algorithm">
- <summary>
- Gets the algorithm parameter from the HTTP Digest authentication credentials.
- </summary>
- <value>
- A <see cref="T:System.String"/> that represents the algorithm parameter.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.HttpDigestIdentity.Cnonce">
- <summary>
- Gets the cnonce parameter from the HTTP Digest authentication credentials.
- </summary>
- <value>
- A <see cref="T:System.String"/> that represents the cnonce parameter.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.HttpDigestIdentity.Nc">
- <summary>
- Gets the nc parameter from the HTTP Digest authentication credentials.
- </summary>
- <value>
- A <see cref="T:System.String"/> that represents the nc parameter.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.HttpDigestIdentity.Nonce">
- <summary>
- Gets the nonce parameter from the HTTP Digest authentication credentials.
- </summary>
- <value>
- A <see cref="T:System.String"/> that represents the nonce parameter.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.HttpDigestIdentity.Opaque">
- <summary>
- Gets the opaque parameter from the HTTP Digest authentication credentials.
- </summary>
- <value>
- A <see cref="T:System.String"/> that represents the opaque parameter.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.HttpDigestIdentity.Qop">
- <summary>
- Gets the qop parameter from the HTTP Digest authentication credentials.
- </summary>
- <value>
- A <see cref="T:System.String"/> that represents the qop parameter.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.HttpDigestIdentity.Realm">
- <summary>
- Gets the realm parameter from the HTTP Digest authentication credentials.
- </summary>
- <value>
- A <see cref="T:System.String"/> that represents the realm parameter.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.HttpDigestIdentity.Response">
- <summary>
- Gets the response parameter from the HTTP Digest authentication credentials.
- </summary>
- <value>
- A <see cref="T:System.String"/> that represents the response parameter.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.HttpDigestIdentity.Uri">
- <summary>
- Gets the uri parameter from the HTTP Digest authentication credentials.
- </summary>
- <value>
- A <see cref="T:System.String"/> that represents the uri parameter.
- </value>
- </member>
- <member name="T:WebSocketSharp.Net.NetworkCredential">
- <summary>
- Provides the credentials for the HTTP authentication (Basic/Digest).
- </summary>
- </member>
- <member name="M:WebSocketSharp.Net.NetworkCredential.#ctor(System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:WebSocketSharp.Net.NetworkCredential"/> class with
- the specified user name and password.
- </summary>
- <param name="userName">
- A <see cref="T:System.String"/> that represents the user name associated with the credentials.
- </param>
- <param name="password">
- A <see cref="T:System.String"/> that represents the password for the user name associated with
- the credentials.
- </param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="userName"/> is <see langword="null"/>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="userName"/> is empty.
- </exception>
- </member>
- <member name="M:WebSocketSharp.Net.NetworkCredential.#ctor(System.String,System.String,System.String,System.String[])">
- <summary>
- Initializes a new instance of the <see cref="T:WebSocketSharp.Net.NetworkCredential"/> class with
- the specified user name, password, domain, and roles.
- </summary>
- <param name="userName">
- A <see cref="T:System.String"/> that represents the user name associated with the credentials.
- </param>
- <param name="password">
- A <see cref="T:System.String"/> that represents the password for the user name associated with
- the credentials.
- </param>
- <param name="domain">
- A <see cref="T:System.String"/> that represents the name of the user domain associated with
- the credentials.
- </param>
- <param name="roles">
- An array of <see cref="T:System.String"/> that contains the role names to which
- the user associated with the credentials belongs if any.
- </param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="userName"/> is <see langword="null"/>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="userName"/> is empty.
- </exception>
- </member>
- <member name="P:WebSocketSharp.Net.NetworkCredential.Domain">
- <summary>
- Gets the name of the user domain associated with the credentials.
- </summary>
- <value>
- A <see cref="T:System.String"/> that represents the name of the user domain associated with
- the credentials.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.NetworkCredential.Password">
- <summary>
- Gets the password for the user name associated with the credentials.
- </summary>
- <value>
- A <see cref="T:System.String"/> that represents the password for the user name associated with
- the credentials.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.NetworkCredential.Roles">
- <summary>
- Gets the role names to which the user associated with the credentials belongs.
- </summary>
- <value>
- An array of <see cref="T:System.String"/> that contains the role names to which
- the user associated with the credentials belongs if any.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.NetworkCredential.UserName">
- <summary>
- Gets the user name associated with the credentials.
- </summary>
- <value>
- A <see cref="T:System.String"/> that represents the user name associated with the credentials.
- </value>
- </member>
- <member name="T:WebSocketSharp.Server.WebSocketServiceManager">
- <summary>
- Manages the WebSocket services provided by the <see cref="T:WebSocketSharp.Server.HttpServer"/> or
- <see cref="T:WebSocketSharp.Server.WebSocketServer"/>.
- </summary>
- </member>
- <member name="M:WebSocketSharp.Server.WebSocketServiceManager.Broadcast(System.Byte[])">
- <summary>
- Sends binary <paramref name="data"/> to every client in the WebSocket services.
- </summary>
- <param name="data">
- An array of <see cref="T:System.Byte"/> that represents the binary data to send.
- </param>
- </member>
- <member name="M:WebSocketSharp.Server.WebSocketServiceManager.Broadcast(System.String)">
- <summary>
- Sends text <paramref name="data"/> to every client in the WebSocket services.
- </summary>
- <param name="data">
- A <see cref="T:System.String"/> that represents the text data to send.
- </param>
- </member>
- <member name="M:WebSocketSharp.Server.WebSocketServiceManager.BroadcastAsync(System.Byte[],System.Action)">
- <summary>
- Sends binary <paramref name="data"/> asynchronously to every client in
- the WebSocket services.
- </summary>
- <remarks>
- This method doesn't wait for the send to be complete.
- </remarks>
- <param name="data">
- An array of <see cref="T:System.Byte"/> that represents the binary data to send.
- </param>
- <param name="completed">
- An <see cref="T:System.Action"/> delegate that references the method(s) called when
- the send is complete.
- </param>
- </member>
- <member name="M:WebSocketSharp.Server.WebSocketServiceManager.BroadcastAsync(System.String,System.Action)">
- <summary>
- Sends text <paramref name="data"/> asynchronously to every client in
- the WebSocket services.
- </summary>
- <remarks>
- This method doesn't wait for the send to be complete.
- </remarks>
- <param name="data">
- A <see cref="T:System.String"/> that represents the text data to send.
- </param>
- <param name="completed">
- An <see cref="T:System.Action"/> delegate that references the method(s) called when
- the send is complete.
- </param>
- </member>
- <member name="M:WebSocketSharp.Server.WebSocketServiceManager.BroadcastAsync(System.IO.Stream,System.Int32,System.Action)">
- <summary>
- Sends binary data from the specified <see cref="T:System.IO.Stream"/> asynchronously to
- every client in the WebSocket services.
- </summary>
- <remarks>
- This method doesn't wait for the send to be complete.
- </remarks>
- <param name="stream">
- A <see cref="T:System.IO.Stream"/> from which contains the binary data to send.
- </param>
- <param name="length">
- An <see cref="T:System.Int32"/> that represents the number of bytes to send.
- </param>
- <param name="completed">
- An <see cref="T:System.Action"/> delegate that references the method(s) called when
- the send is complete.
- </param>
- </member>
- <member name="M:WebSocketSharp.Server.WebSocketServiceManager.Broadping">
- <summary>
- Sends a Ping to every client in the WebSocket services.
- </summary>
- <returns>
- A <c>Dictionary<string, Dictionary<string, bool>></c> that contains
- a collection of pairs of a service path and a collection of pairs of a session ID
- and a value indicating whether the manager received a Pong from each client in a time,
- or <see langword="null"/> if this method isn't available.
- </returns>
- </member>
- <member name="M:WebSocketSharp.Server.WebSocketServiceManager.Broadping(System.String)">
- <summary>
- Sends a Ping with the specified <paramref name="message"/> to every client in
- the WebSocket services.
- </summary>
- <returns>
- A <c>Dictionary<string, Dictionary<string, bool>></c> that contains
- a collection of pairs of a service path and a collection of pairs of a session ID
- and a value indicating whether the manager received a Pong from each client in a time,
- or <see langword="null"/> if this method isn't available or <paramref name="message"/>
- is invalid.
- </returns>
- <param name="message">
- A <see cref="T:System.String"/> that represents the message to send.
- </param>
- </member>
- <member name="M:WebSocketSharp.Server.WebSocketServiceManager.TryGetServiceHost(System.String,WebSocketSharp.Server.WebSocketServiceHost@)">
- <summary>
- Tries to get the WebSocket service host with the specified <paramref name="path"/>.
- </summary>
- <returns>
- <c>true</c> if the service is successfully found; otherwise, <c>false</c>.
- </returns>
- <param name="path">
- A <see cref="T:System.String"/> that represents the absolute path to the service to find.
- </param>
- <param name="host">
- When this method returns, a <see cref="T:WebSocketSharp.Server.WebSocketServiceHost"/> instance that
- provides the access to the information in the service, or <see langword="null"/>
- if it's not found. This parameter is passed uninitialized.
- </param>
- </member>
- <member name="P:WebSocketSharp.Server.WebSocketServiceManager.Count">
- <summary>
- Gets the number of the WebSocket services.
- </summary>
- <value>
- An <see cref="T:System.Int32"/> that represents the number of the services.
- </value>
- </member>
- <member name="P:WebSocketSharp.Server.WebSocketServiceManager.Hosts">
- <summary>
- Gets the host instances for the Websocket services.
- </summary>
- <value>
- An <c>IEnumerable<WebSocketServiceHost></c> instance that provides an enumerator
- which supports the iteration over the collection of the host instances for the services.
- </value>
- </member>
- <member name="P:WebSocketSharp.Server.WebSocketServiceManager.Item(System.String)">
- <summary>
- Gets the WebSocket service host with the specified <paramref name="path"/>.
- </summary>
- <value>
- A <see cref="T:WebSocketSharp.Server.WebSocketServiceHost"/> instance that provides the access to
- the information in the service, or <see langword="null"/> if it's not found.
- </value>
- <param name="path">
- A <see cref="T:System.String"/> that represents the absolute path to the service to find.
- </param>
- </member>
- <member name="P:WebSocketSharp.Server.WebSocketServiceManager.KeepClean">
- <summary>
- Gets a value indicating whether the manager cleans up the inactive sessions
- in the WebSocket services periodically.
- </summary>
- <value>
- <c>true</c> if the manager cleans up the inactive sessions every 60 seconds;
- otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:WebSocketSharp.Server.WebSocketServiceManager.Paths">
- <summary>
- Gets the paths for the WebSocket services.
- </summary>
- <value>
- An <c>IEnumerable<string></c> instance that provides an enumerator which supports
- the iteration over the collection of the paths for the services.
- </value>
- </member>
- <member name="P:WebSocketSharp.Server.WebSocketServiceManager.SessionCount">
- <summary>
- Gets the total number of the sessions in the WebSocket services.
- </summary>
- <value>
- An <see cref="T:System.Int32"/> that represents the total number of the sessions in the services.
- </value>
- </member>
- <member name="P:WebSocketSharp.Server.WebSocketServiceManager.WaitTime">
- <summary>
- Gets the wait time for the response to the WebSocket Ping or Close.
- </summary>
- <value>
- A <see cref="T:System.TimeSpan"/> that represents the wait time.
- </value>
- </member>
- <member name="F:WebSocketSharp.WebSocketFrame.EmptyPingBytes">
- <summary>
- Represents the ping frame without the payload data as an array of <see cref="T:System.Byte"/>.
- </summary>
- <remarks>
- The value of this field is created from a non masked frame, so it can only be used to
- send a ping from a server.
- </remarks>
- </member>
- <member name="T:WebSocketSharp.Server.WebSocketBehavior">
- <summary>
- Exposes the methods and properties used to define the behavior of a WebSocket service
- provided by the <see cref="T:WebSocketSharp.Server.WebSocketServer"/> or <see cref="T:WebSocketSharp.Server.HttpServer"/>.
- </summary>
- <remarks>
- The WebSocketBehavior class is an abstract class.
- </remarks>
- </member>
- <member name="M:WebSocketSharp.Server.WebSocketBehavior.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:WebSocketSharp.Server.WebSocketBehavior"/> class.
- </summary>
- </member>
- <member name="M:WebSocketSharp.Server.WebSocketBehavior.Error(System.String,System.Exception)">
- <summary>
- Calls the <see cref="M:WebSocketSharp.Server.WebSocketBehavior.OnError(WebSocketSharp.ErrorEventArgs)"/> method with the specified <paramref name="message"/> and
- <paramref name="exception"/>.
- </summary>
- <remarks>
- This method doesn't call the <see cref="M:WebSocketSharp.Server.WebSocketBehavior.OnError(WebSocketSharp.ErrorEventArgs)"/> method if <paramref name="message"/> is
- <see langword="null"/> or empty.
- </remarks>
- <param name="message">
- A <see cref="T:System.String"/> that represents the error message.
- </param>
- <param name="exception">
- An <see cref="T:System.Exception"/> instance that represents the cause of the error if any.
- </param>
- </member>
- <member name="M:WebSocketSharp.Server.WebSocketBehavior.OnClose(WebSocketSharp.CloseEventArgs)">
- <summary>
- Called when the WebSocket connection used in a session has been closed.
- </summary>
- <param name="e">
- A <see cref="T:WebSocketSharp.CloseEventArgs"/> that represents the event data passed to
- a <see cref="E:WebSocketSharp.WebSocket.OnClose"/> event.
- </param>
- </member>
- <member name="M:WebSocketSharp.Server.WebSocketBehavior.OnError(WebSocketSharp.ErrorEventArgs)">
- <summary>
- Called when the <see cref="T:WebSocketSharp.WebSocket"/> used in a session gets an error.
- </summary>
- <param name="e">
- A <see cref="T:WebSocketSharp.ErrorEventArgs"/> that represents the event data passed to
- a <see cref="E:WebSocketSharp.WebSocket.OnError"/> event.
- </param>
- </member>
- <member name="M:WebSocketSharp.Server.WebSocketBehavior.OnMessage(WebSocketSharp.MessageEventArgs)">
- <summary>
- Called when the <see cref="T:WebSocketSharp.WebSocket"/> used in a session receives a message.
- </summary>
- <param name="e">
- A <see cref="T:WebSocketSharp.MessageEventArgs"/> that represents the event data passed to
- a <see cref="E:WebSocketSharp.WebSocket.OnMessage"/> event.
- </param>
- </member>
- <member name="M:WebSocketSharp.Server.WebSocketBehavior.OnOpen">
- <summary>
- Called when the WebSocket connection used in a session has been established.
- </summary>
- </member>
- <member name="M:WebSocketSharp.Server.WebSocketBehavior.Send(System.Byte[])">
- <summary>
- Sends binary <paramref name="data"/> to the client on a session.
- </summary>
- <remarks>
- This method is available after the WebSocket connection has been established.
- </remarks>
- <param name="data">
- An array of <see cref="T:System.Byte"/> that represents the binary data to send.
- </param>
- </member>
- <member name="M:WebSocketSharp.Server.WebSocketBehavior.Send(System.IO.FileInfo)">
- <summary>
- Sends the specified <paramref name="file"/> as binary data to the client on a session.
- </summary>
- <remarks>
- This method is available after the WebSocket connection has been established.
- </remarks>
- <param name="file">
- A <see cref="T:System.IO.FileInfo"/> that represents the file to send.
- </param>
- </member>
- <member name="M:WebSocketSharp.Server.WebSocketBehavior.Send(System.String)">
- <summary>
- Sends text <paramref name="data"/> to the client on a session.
- </summary>
- <remarks>
- This method is available after the WebSocket connection has been established.
- </remarks>
- <param name="data">
- A <see cref="T:System.String"/> that represents the text data to send.
- </param>
- </member>
- <member name="M:WebSocketSharp.Server.WebSocketBehavior.SendAsync(System.Byte[],System.Action{System.Boolean})">
- <summary>
- Sends binary <paramref name="data"/> asynchronously to the client on a session.
- </summary>
- <remarks>
- <para>
- This method is available after the WebSocket connection has been established.
- </para>
- <para>
- This method doesn't wait for the send to be complete.
- </para>
- </remarks>
- <param name="data">
- An array of <see cref="T:System.Byte"/> that represents the binary data to send.
- </param>
- <param name="completed">
- An <c>Action<bool></c> delegate that references the method(s) called when
- the send is complete. A <see cref="T:System.Boolean"/> passed to this delegate is <c>true</c>
- if the send is complete successfully.
- </param>
- </member>
- <member name="M:WebSocketSharp.Server.WebSocketBehavior.SendAsync(System.IO.FileInfo,System.Action{System.Boolean})">
- <summary>
- Sends the specified <paramref name="file"/> as binary data asynchronously to
- the client on a session.
- </summary>
- <remarks>
- <para>
- This method is available after the WebSocket connection has been established.
- </para>
- <para>
- This method doesn't wait for the send to be complete.
- </para>
- </remarks>
- <param name="file">
- A <see cref="T:System.IO.FileInfo"/> that represents the file to send.
- </param>
- <param name="completed">
- An <c>Action<bool></c> delegate that references the method(s) called when
- the send is complete. A <see cref="T:System.Boolean"/> passed to this delegate is <c>true</c>
- if the send is complete successfully.
- </param>
- </member>
- <member name="M:WebSocketSharp.Server.WebSocketBehavior.SendAsync(System.String,System.Action{System.Boolean})">
- <summary>
- Sends text <paramref name="data"/> asynchronously to the client on a session.
- </summary>
- <remarks>
- <para>
- This method is available after the WebSocket connection has been established.
- </para>
- <para>
- This method doesn't wait for the send to be complete.
- </para>
- </remarks>
- <param name="data">
- A <see cref="T:System.String"/> that represents the text data to send.
- </param>
- <param name="completed">
- An <c>Action<bool></c> delegate that references the method(s) called when
- the send is complete. A <see cref="T:System.Boolean"/> passed to this delegate is <c>true</c>
- if the send is complete successfully.
- </param>
- </member>
- <member name="M:WebSocketSharp.Server.WebSocketBehavior.SendAsync(System.IO.Stream,System.Int32,System.Action{System.Boolean})">
- <summary>
- Sends binary data from the specified <see cref="T:System.IO.Stream"/> asynchronously to
- the client on a session.
- </summary>
- <remarks>
- <para>
- This method is available after the WebSocket connection has been established.
- </para>
- <para>
- This method doesn't wait for the send to be complete.
- </para>
- </remarks>
- <param name="stream">
- A <see cref="T:System.IO.Stream"/> from which contains the binary data to send.
- </param>
- <param name="length">
- An <see cref="T:System.Int32"/> that represents the number of bytes to send.
- </param>
- <param name="completed">
- An <c>Action<bool></c> delegate that references the method(s) called when
- the send is complete. A <see cref="T:System.Boolean"/> passed to this delegate is <c>true</c>
- if the send is complete successfully.
- </param>
- </member>
- <member name="P:WebSocketSharp.Server.WebSocketBehavior.Log">
- <summary>
- Gets the logging functions.
- </summary>
- <value>
- A <see cref="T:WebSocketSharp.Logger"/> that provides the logging functions,
- or <see langword="null"/> if the WebSocket connection isn't established.
- </value>
- </member>
- <member name="P:WebSocketSharp.Server.WebSocketBehavior.Sessions">
- <summary>
- Gets the access to the sessions in the WebSocket service.
- </summary>
- <value>
- A <see cref="T:WebSocketSharp.Server.WebSocketSessionManager"/> that provides the access to the sessions,
- or <see langword="null"/> if the WebSocket connection isn't established.
- </value>
- </member>
- <member name="P:WebSocketSharp.Server.WebSocketBehavior.Context">
- <summary>
- Gets the information in a handshake request to the WebSocket service.
- </summary>
- <value>
- A <see cref="T:WebSocketSharp.Net.WebSockets.WebSocketContext"/> instance that provides the access to the handshake request,
- or <see langword="null"/> if the WebSocket connection isn't established.
- </value>
- </member>
- <member name="P:WebSocketSharp.Server.WebSocketBehavior.CookiesValidator">
- <summary>
- Gets or sets the delegate called to validate the HTTP cookies included in
- a handshake request to the WebSocket service.
- </summary>
- <remarks>
- This delegate is called when the <see cref="T:WebSocketSharp.WebSocket"/> used in a session validates
- the handshake request.
- </remarks>
- <value>
- <para>
- A <c>Func<CookieCollection, CookieCollection, bool></c> delegate that references
- the method(s) used to validate the cookies.
- </para>
- <para>
- 1st <see cref="T:WebSocketSharp.Net.CookieCollection"/> parameter passed to this delegate contains
- the cookies to validate if any.
- </para>
- <para>
- 2nd <see cref="T:WebSocketSharp.Net.CookieCollection"/> parameter passed to this delegate receives
- the cookies to send to the client.
- </para>
- <para>
- This delegate should return <c>true</c> if the cookies are valid.
- </para>
- <para>
- The default value is <see langword="null"/>, and it does nothing to validate.
- </para>
- </value>
- </member>
- <member name="P:WebSocketSharp.Server.WebSocketBehavior.EmitOnPing">
- <summary>
- Gets or sets a value indicating whether the <see cref="T:WebSocketSharp.WebSocket"/> used in a session emits
- a <see cref="E:WebSocketSharp.WebSocket.OnMessage"/> event when receives a Ping.
- </summary>
- <value>
- <c>true</c> if the <see cref="T:WebSocketSharp.WebSocket"/> emits a <see cref="E:WebSocketSharp.WebSocket.OnMessage"/> event
- when receives a Ping; otherwise, <c>false</c>. The default value is <c>false</c>.
- </value>
- </member>
- <member name="P:WebSocketSharp.Server.WebSocketBehavior.ID">
- <summary>
- Gets the unique ID of a session.
- </summary>
- <value>
- A <see cref="T:System.String"/> that represents the unique ID of the session,
- or <see langword="null"/> if the WebSocket connection isn't established.
- </value>
- </member>
- <member name="P:WebSocketSharp.Server.WebSocketBehavior.IgnoreExtensions">
- <summary>
- Gets or sets a value indicating whether the WebSocket service ignores
- the Sec-WebSocket-Extensions header included in a handshake request.
- </summary>
- <value>
- <c>true</c> if the WebSocket service ignores the extensions requested from
- a client; otherwise, <c>false</c>. The default value is <c>false</c>.
- </value>
- </member>
- <member name="P:WebSocketSharp.Server.WebSocketBehavior.OriginValidator">
- <summary>
- Gets or sets the delegate called to validate the Origin header included in
- a handshake request to the WebSocket service.
- </summary>
- <remarks>
- This delegate is called when the <see cref="T:WebSocketSharp.WebSocket"/> used in a session validates
- the handshake request.
- </remarks>
- <value>
- <para>
- A <c>Func<string, bool></c> delegate that references the method(s) used to
- validate the origin header.
- </para>
- <para>
- <see cref="T:System.String"/> parameter passed to this delegate represents the value of
- the origin header to validate if any.
- </para>
- <para>
- This delegate should return <c>true</c> if the origin header is valid.
- </para>
- <para>
- The default value is <see langword="null"/>, and it does nothing to validate.
- </para>
- </value>
- </member>
- <member name="P:WebSocketSharp.Server.WebSocketBehavior.Protocol">
- <summary>
- Gets or sets the WebSocket subprotocol used in the WebSocket service.
- </summary>
- <remarks>
- Set operation of this property is available before the WebSocket connection has
- been established.
- </remarks>
- <value>
- <para>
- A <see cref="T:System.String"/> that represents the subprotocol if any.
- The default value is <see cref="F:System.String.Empty"/>.
- </para>
- <para>
- The value to set must be a token defined in
- <see href="http://tools.ietf.org/html/rfc2616#section-2.2">RFC 2616</see>.
- </para>
- </value>
- </member>
- <member name="P:WebSocketSharp.Server.WebSocketBehavior.StartTime">
- <summary>
- Gets the time that a session has started.
- </summary>
- <value>
- A <see cref="T:System.DateTime"/> that represents the time that the session has started,
- or <see cref="F:System.DateTime.MaxValue"/> if the WebSocket connection isn't established.
- </value>
- </member>
- <member name="P:WebSocketSharp.Server.WebSocketBehavior.State">
- <summary>
- Gets the state of the <see cref="T:WebSocketSharp.WebSocket"/> used in a session.
- </summary>
- <value>
- One of the <see cref="T:WebSocketSharp.WebSocketState"/> enum values, indicates the state of
- the <see cref="T:WebSocketSharp.WebSocket"/>.
- </value>
- </member>
- <member name="M:WebSocketSharp.Net.HttpListenerPrefix.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:WebSocketSharp.Net.HttpListenerPrefix"/> class with
- the specified <paramref name="uriPrefix"/>.
- </summary>
- <remarks>
- This constructor must be called after calling the CheckPrefix method.
- </remarks>
- <param name="uriPrefix">
- A <see cref="T:System.String"/> that represents the URI prefix.
- </param>
- </member>
- <member name="M:WebSocketSharp.Net.HttpListenerPrefix.Equals(System.Object)">
- <summary>
- Determines whether this instance and the specified <see cref="T:System.Object"/> have the same value.
- </summary>
- <remarks>
- This method will be required to detect duplicates in any collection.
- </remarks>
- <param name="obj">
- An <see cref="T:System.Object"/> to compare to this instance.
- </param>
- <returns>
- <c>true</c> if <paramref name="obj"/> is a <see cref="T:WebSocketSharp.Net.HttpListenerPrefix"/> and
- its value is the same as this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:WebSocketSharp.Net.HttpListenerPrefix.GetHashCode">
- <summary>
- Gets the hash code for this instance.
- </summary>
- <remarks>
- This method will be required to detect duplicates in any collection.
- </remarks>
- <returns>
- An <see cref="T:System.Int32"/> that represents the hash code.
- </returns>
- </member>
- <member name="T:WebSocketSharp.Net.ClientSslConfiguration">
- <summary>
- Stores the parameters used to configure a <see cref="T:System.Net.Security.SslStream"/> instance as a client.
- </summary>
- </member>
- <member name="T:WebSocketSharp.Net.SslConfiguration">
- <summary>
- Stores the parameters used to configure a <see cref="T:System.Net.Security.SslStream"/> instance.
- </summary>
- <remarks>
- The SslConfiguration class is an abstract class.
- </remarks>
- </member>
- <member name="M:WebSocketSharp.Net.SslConfiguration.#ctor(System.Security.Authentication.SslProtocols,System.Boolean)">
- <summary>
- Initializes a new instance of the <see cref="T:WebSocketSharp.Net.SslConfiguration"/> class with
- the specified <paramref name="enabledSslProtocols"/> and
- <paramref name="checkCertificateRevocation"/>.
- </summary>
- <param name="enabledSslProtocols">
- The <see cref="T:System.Security.Authentication.SslProtocols"/> enum value that represents the protocols used for
- authentication.
- </param>
- <param name="checkCertificateRevocation">
- <c>true</c> if the certificate revocation list is checked during authentication;
- otherwise, <c>false</c>.
- </param>
- </member>
- <member name="P:WebSocketSharp.Net.SslConfiguration.CertificateSelectionCallback">
- <summary>
- Gets or sets the callback used to select a certificate to supply to the remote party.
- </summary>
- <remarks>
- If this callback returns <see langword="null"/>, no certificate will be supplied.
- </remarks>
- <value>
- A <see cref="T:System.Net.Security.LocalCertificateSelectionCallback"/> delegate that references the method
- used to select a certificate. The default value is a function that only returns
- <see langword="null"/>.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.SslConfiguration.CertificateValidationCallback">
- <summary>
- Gets or sets the callback used to validate the certificate supplied by the remote party.
- </summary>
- <remarks>
- If this callback returns <c>true</c>, the certificate will be valid.
- </remarks>
- <value>
- A <see cref="T:System.Net.Security.RemoteCertificateValidationCallback"/> delegate that references the method
- used to validate the certificate. The default value is a function that only returns
- <c>true</c>.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.SslConfiguration.CheckCertificateRevocation">
- <summary>
- Gets or sets a value indicating whether the certificate revocation list is checked
- during authentication.
- </summary>
- <value>
- <c>true</c> if the certificate revocation list is checked; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.SslConfiguration.EnabledSslProtocols">
- <summary>
- Gets or sets the SSL protocols used for authentication.
- </summary>
- <value>
- The <see cref="T:System.Security.Authentication.SslProtocols"/> enum value that represents the protocols used for
- authentication.
- </value>
- </member>
- <member name="M:WebSocketSharp.Net.ClientSslConfiguration.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:WebSocketSharp.Net.ClientSslConfiguration"/> class with
- the specified <paramref name="targetHost"/>.
- </summary>
- <param name="targetHost">
- A <see cref="T:System.String"/> that represents the name of the server that shares
- a secure connection.
- </param>
- </member>
- <member name="M:WebSocketSharp.Net.ClientSslConfiguration.#ctor(System.String,System.Security.Cryptography.X509Certificates.X509CertificateCollection,System.Security.Authentication.SslProtocols,System.Boolean)">
- <summary>
- Initializes a new instance of the <see cref="T:WebSocketSharp.Net.ClientSslConfiguration"/> class with
- the specified <paramref name="targetHost"/>, <paramref name="clientCertificates"/>,
- <paramref name="enabledSslProtocols"/>, and <paramref name="checkCertificateRevocation"/>.
- </summary>
- <param name="targetHost">
- A <see cref="T:System.String"/> that represents the name of the server that shares
- a secure connection.
- </param>
- <param name="clientCertificates">
- A <see cref="T:System.Security.Cryptography.X509Certificates.X509CertificateCollection"/> that contains client certificates.
- </param>
- <param name="enabledSslProtocols">
- The <see cref="T:System.Security.Authentication.SslProtocols"/> enum value that represents the protocols used for
- authentication.
- </param>
- <param name="checkCertificateRevocation">
- <c>true</c> if the certificate revocation list is checked during authentication;
- otherwise, <c>false</c>.
- </param>
- </member>
- <member name="P:WebSocketSharp.Net.ClientSslConfiguration.ClientCertificates">
- <summary>
- Gets or sets the collection that contains client certificates.
- </summary>
- <value>
- A <see cref="T:System.Security.Cryptography.X509Certificates.X509CertificateCollection"/> that contains client certificates.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.ClientSslConfiguration.ClientCertificateSelectionCallback">
- <summary>
- Gets or sets the callback used to select a client certificate to supply to the server.
- </summary>
- <remarks>
- If this callback returns <see langword="null"/>, no client certificate will be supplied.
- </remarks>
- <value>
- A <see cref="T:System.Net.Security.LocalCertificateSelectionCallback"/> delegate that references the method
- used to select the client certificate. The default value is a function that only returns
- <see langword="null"/>.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.ClientSslConfiguration.ServerCertificateValidationCallback">
- <summary>
- Gets or sets the callback used to validate the certificate supplied by the server.
- </summary>
- <remarks>
- If this callback returns <c>true</c>, the server certificate will be valid.
- </remarks>
- <value>
- A <see cref="T:System.Net.Security.RemoteCertificateValidationCallback"/> delegate that references the method
- used to validate the server certificate. The default value is a function that only returns
- <c>true</c>.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.ClientSslConfiguration.TargetHost">
- <summary>
- Gets or sets the name of the server that shares a secure connection.
- </summary>
- <value>
- A <see cref="T:System.String"/> that represents the name of the server that shares
- a secure connection.
- </value>
- </member>
- <member name="T:WebSocketSharp.Net.ServerSslConfiguration">
- <summary>
- Stores the parameters used to configure a <see cref="T:System.Net.Security.SslStream"/> instance as a server.
- </summary>
- </member>
- <member name="M:WebSocketSharp.Net.ServerSslConfiguration.#ctor(System.Security.Cryptography.X509Certificates.X509Certificate2)">
- <summary>
- Initializes a new instance of the <see cref="T:WebSocketSharp.Net.ServerSslConfiguration"/> class with
- the specified <paramref name="serverCertificate"/>.
- </summary>
- <param name="serverCertificate">
- A <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2"/> that represents the certificate used to authenticate
- the server.
- </param>
- </member>
- <member name="M:WebSocketSharp.Net.ServerSslConfiguration.#ctor(System.Security.Cryptography.X509Certificates.X509Certificate2,System.Boolean,System.Security.Authentication.SslProtocols,System.Boolean)">
- <summary>
- Initializes a new instance of the <see cref="T:WebSocketSharp.Net.ServerSslConfiguration"/> class with
- the specified <paramref name="serverCertificate"/>,
- <paramref name="clientCertificateRequired"/>, <paramref name="enabledSslProtocols"/>,
- and <paramref name="checkCertificateRevocation"/>.
- </summary>
- <param name="serverCertificate">
- A <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2"/> that represents the certificate used to authenticate
- the server.
- </param>
- <param name="clientCertificateRequired">
- <c>true</c> if the client must supply a certificate for authentication;
- otherwise, <c>false</c>.
- </param>
- <param name="enabledSslProtocols">
- The <see cref="T:System.Security.Authentication.SslProtocols"/> enum value that represents the protocols used for
- authentication.
- </param>
- <param name="checkCertificateRevocation">
- <c>true</c> if the certificate revocation list is checked during authentication;
- otherwise, <c>false</c>.
- </param>
- </member>
- <member name="P:WebSocketSharp.Net.ServerSslConfiguration.ClientCertificateRequired">
- <summary>
- Gets or sets a value indicating whether the client must supply a certificate for
- authentication.
- </summary>
- <value>
- <c>true</c> if the client must supply a certificate; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.ServerSslConfiguration.ClientCertificateValidationCallback">
- <summary>
- Gets or sets the callback used to validate the certificate supplied by the client.
- </summary>
- <remarks>
- If this callback returns <c>true</c>, the client certificate will be valid.
- </remarks>
- <value>
- A <see cref="T:System.Net.Security.RemoteCertificateValidationCallback"/> delegate that references the method
- used to validate the client certificate. The default value is a function that only returns
- <c>true</c>.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.ServerSslConfiguration.ServerCertificate">
- <summary>
- Gets or sets the certificate used to authenticate the server for secure connection.
- </summary>
- <value>
- A <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2"/> that represents the certificate used to authenticate
- the server.
- </value>
- </member>
- <member name="T:WebSocketSharp.Net.HttpRequestHeader">
- <summary>
- Contains the HTTP headers that may be specified in a client request.
- </summary>
- <remarks>
- The HttpRequestHeader enumeration contains the HTTP request headers defined in
- <see href="http://tools.ietf.org/html/rfc2616#section-14">RFC 2616</see> for the HTTP/1.1 and
- <see href="http://tools.ietf.org/html/rfc6455#section-11.3">RFC 6455</see> for the WebSocket.
- </remarks>
- </member>
- <member name="F:WebSocketSharp.Net.HttpRequestHeader.CacheControl">
- <summary>
- Indicates the Cache-Control header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpRequestHeader.Connection">
- <summary>
- Indicates the Connection header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpRequestHeader.Date">
- <summary>
- Indicates the Date header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpRequestHeader.KeepAlive">
- <summary>
- Indicates the Keep-Alive header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpRequestHeader.Pragma">
- <summary>
- Indicates the Pragma header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpRequestHeader.Trailer">
- <summary>
- Indicates the Trailer header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpRequestHeader.TransferEncoding">
- <summary>
- Indicates the Transfer-Encoding header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpRequestHeader.Upgrade">
- <summary>
- Indicates the Upgrade header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpRequestHeader.Via">
- <summary>
- Indicates the Via header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpRequestHeader.Warning">
- <summary>
- Indicates the Warning header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpRequestHeader.Allow">
- <summary>
- Indicates the Allow header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpRequestHeader.ContentLength">
- <summary>
- Indicates the Content-Length header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpRequestHeader.ContentType">
- <summary>
- Indicates the Content-Type header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpRequestHeader.ContentEncoding">
- <summary>
- Indicates the Content-Encoding header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpRequestHeader.ContentLanguage">
- <summary>
- Indicates the Content-Language header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpRequestHeader.ContentLocation">
- <summary>
- Indicates the Content-Location header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpRequestHeader.ContentMd5">
- <summary>
- Indicates the Content-MD5 header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpRequestHeader.ContentRange">
- <summary>
- Indicates the Content-Range header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpRequestHeader.Expires">
- <summary>
- Indicates the Expires header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpRequestHeader.LastModified">
- <summary>
- Indicates the Last-Modified header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpRequestHeader.Accept">
- <summary>
- Indicates the Accept header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpRequestHeader.AcceptCharset">
- <summary>
- Indicates the Accept-Charset header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpRequestHeader.AcceptEncoding">
- <summary>
- Indicates the Accept-Encoding header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpRequestHeader.AcceptLanguage">
- <summary>
- Indicates the Accept-Language header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpRequestHeader.Authorization">
- <summary>
- Indicates the Authorization header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpRequestHeader.Cookie">
- <summary>
- Indicates the Cookie header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpRequestHeader.Expect">
- <summary>
- Indicates the Expect header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpRequestHeader.From">
- <summary>
- Indicates the From header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpRequestHeader.Host">
- <summary>
- Indicates the Host header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpRequestHeader.IfMatch">
- <summary>
- Indicates the If-Match header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpRequestHeader.IfModifiedSince">
- <summary>
- Indicates the If-Modified-Since header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpRequestHeader.IfNoneMatch">
- <summary>
- Indicates the If-None-Match header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpRequestHeader.IfRange">
- <summary>
- Indicates the If-Range header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpRequestHeader.IfUnmodifiedSince">
- <summary>
- Indicates the If-Unmodified-Since header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpRequestHeader.MaxForwards">
- <summary>
- Indicates the Max-Forwards header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpRequestHeader.ProxyAuthorization">
- <summary>
- Indicates the Proxy-Authorization header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpRequestHeader.Referer">
- <summary>
- Indicates the Referer header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpRequestHeader.Range">
- <summary>
- Indicates the Range header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpRequestHeader.Te">
- <summary>
- Indicates the TE header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpRequestHeader.Translate">
- <summary>
- Indicates the Translate header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpRequestHeader.UserAgent">
- <summary>
- Indicates the User-Agent header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpRequestHeader.SecWebSocketKey">
- <summary>
- Indicates the Sec-WebSocket-Key header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpRequestHeader.SecWebSocketExtensions">
- <summary>
- Indicates the Sec-WebSocket-Extensions header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpRequestHeader.SecWebSocketProtocol">
- <summary>
- Indicates the Sec-WebSocket-Protocol header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpRequestHeader.SecWebSocketVersion">
- <summary>
- Indicates the Sec-WebSocket-Version header.
- </summary>
- </member>
- <member name="T:WebSocketSharp.Net.HttpResponseHeader">
- <summary>
- Contains the HTTP headers that can be specified in a server response.
- </summary>
- <remarks>
- The HttpResponseHeader enumeration contains the HTTP response headers defined in
- <see href="http://tools.ietf.org/html/rfc2616#section-14">RFC 2616</see> for the HTTP/1.1 and
- <see href="http://tools.ietf.org/html/rfc6455#section-11.3">RFC 6455</see> for the WebSocket.
- </remarks>
- </member>
- <member name="F:WebSocketSharp.Net.HttpResponseHeader.CacheControl">
- <summary>
- Indicates the Cache-Control header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpResponseHeader.Connection">
- <summary>
- Indicates the Connection header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpResponseHeader.Date">
- <summary>
- Indicates the Date header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpResponseHeader.KeepAlive">
- <summary>
- Indicates the Keep-Alive header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpResponseHeader.Pragma">
- <summary>
- Indicates the Pragma header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpResponseHeader.Trailer">
- <summary>
- Indicates the Trailer header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpResponseHeader.TransferEncoding">
- <summary>
- Indicates the Transfer-Encoding header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpResponseHeader.Upgrade">
- <summary>
- Indicates the Upgrade header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpResponseHeader.Via">
- <summary>
- Indicates the Via header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpResponseHeader.Warning">
- <summary>
- Indicates the Warning header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpResponseHeader.Allow">
- <summary>
- Indicates the Allow header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpResponseHeader.ContentLength">
- <summary>
- Indicates the Content-Length header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpResponseHeader.ContentType">
- <summary>
- Indicates the Content-Type header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpResponseHeader.ContentEncoding">
- <summary>
- Indicates the Content-Encoding header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpResponseHeader.ContentLanguage">
- <summary>
- Indicates the Content-Language header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpResponseHeader.ContentLocation">
- <summary>
- Indicates the Content-Location header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpResponseHeader.ContentMd5">
- <summary>
- Indicates the Content-MD5 header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpResponseHeader.ContentRange">
- <summary>
- Indicates the Content-Range header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpResponseHeader.Expires">
- <summary>
- Indicates the Expires header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpResponseHeader.LastModified">
- <summary>
- Indicates the Last-Modified header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpResponseHeader.AcceptRanges">
- <summary>
- Indicates the Accept-Ranges header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpResponseHeader.Age">
- <summary>
- Indicates the Age header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpResponseHeader.ETag">
- <summary>
- Indicates the ETag header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpResponseHeader.Location">
- <summary>
- Indicates the Location header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpResponseHeader.ProxyAuthenticate">
- <summary>
- Indicates the Proxy-Authenticate header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpResponseHeader.RetryAfter">
- <summary>
- Indicates the Retry-After header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpResponseHeader.Server">
- <summary>
- Indicates the Server header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpResponseHeader.SetCookie">
- <summary>
- Indicates the Set-Cookie header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpResponseHeader.Vary">
- <summary>
- Indicates the Vary header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpResponseHeader.WwwAuthenticate">
- <summary>
- Indicates the WWW-Authenticate header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpResponseHeader.SecWebSocketExtensions">
- <summary>
- Indicates the Sec-WebSocket-Extensions header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpResponseHeader.SecWebSocketAccept">
- <summary>
- Indicates the Sec-WebSocket-Accept header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpResponseHeader.SecWebSocketProtocol">
- <summary>
- Indicates the Sec-WebSocket-Protocol header.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.HttpResponseHeader.SecWebSocketVersion">
- <summary>
- Indicates the Sec-WebSocket-Version header.
- </summary>
- </member>
- </members>
- </doc>
|