123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029130301303113032130331303413035130361303713038130391304013041130421304313044130451304613047130481304913050130511305213053130541305513056130571305813059130601306113062130631306413065130661306713068130691307013071130721307313074130751307613077130781307913080130811308213083130841308513086130871308813089130901309113092130931309413095130961309713098130991310013101131021310313104131051310613107131081310913110131111311213113131141311513116131171311813119131201312113122131231312413125131261312713128131291313013131131321313313134131351313613137131381313913140131411314213143131441314513146131471314813149131501315113152131531315413155131561315713158131591316013161131621316313164131651316613167131681316913170131711317213173131741317513176131771317813179131801318113182131831318413185131861318713188131891319013191131921319313194131951319613197131981319913200132011320213203132041320513206132071320813209132101321113212132131321413215132161321713218132191322013221132221322313224132251322613227132281322913230132311323213233132341323513236132371323813239132401324113242132431324413245132461324713248132491325013251132521325313254132551325613257132581325913260132611326213263132641326513266132671326813269132701327113272132731327413275132761327713278132791328013281132821328313284132851328613287132881328913290132911329213293132941329513296132971329813299133001330113302133031330413305133061330713308133091331013311133121331313314133151331613317133181331913320133211332213323133241332513326133271332813329133301333113332133331333413335133361333713338133391334013341133421334313344133451334613347133481334913350133511335213353133541335513356133571335813359133601336113362133631336413365133661336713368133691337013371133721337313374133751337613377133781337913380133811338213383133841338513386133871338813389133901339113392133931339413395133961339713398133991340013401134021340313404134051340613407134081340913410134111341213413134141341513416134171341813419134201342113422134231342413425134261342713428134291343013431134321343313434134351343613437134381343913440134411344213443134441344513446134471344813449134501345113452134531345413455134561345713458134591346013461134621346313464134651346613467134681346913470134711347213473134741347513476134771347813479134801348113482134831348413485134861348713488134891349013491134921349313494134951349613497134981349913500135011350213503135041350513506135071350813509135101351113512135131351413515135161351713518135191352013521135221352313524135251352613527135281352913530135311353213533135341353513536135371353813539135401354113542135431354413545135461354713548135491355013551135521355313554135551355613557135581355913560135611356213563135641356513566135671356813569135701357113572135731357413575135761357713578135791358013581135821358313584135851358613587135881358913590135911359213593135941359513596135971359813599136001360113602136031360413605136061360713608136091361013611136121361313614136151361613617136181361913620136211362213623136241362513626136271362813629136301363113632136331363413635136361363713638136391364013641136421364313644136451364613647136481364913650136511365213653136541365513656136571365813659136601366113662136631366413665136661366713668136691367013671136721367313674136751367613677136781367913680136811368213683136841368513686136871368813689136901369113692136931369413695136961369713698136991370013701137021370313704137051370613707137081370913710137111371213713137141371513716137171371813719137201372113722137231372413725137261372713728137291373013731137321373313734137351373613737137381373913740137411374213743137441374513746137471374813749137501375113752137531375413755137561375713758137591376013761137621376313764137651376613767137681376913770137711377213773137741377513776137771377813779137801378113782137831378413785137861378713788137891379013791137921379313794137951379613797137981379913800138011380213803138041380513806138071380813809138101381113812138131381413815138161381713818138191382013821138221382313824138251382613827138281382913830138311383213833138341383513836138371383813839138401384113842138431384413845138461384713848138491385013851138521385313854138551385613857138581385913860138611386213863138641386513866138671386813869138701387113872138731387413875138761387713878138791388013881138821388313884138851388613887138881388913890138911389213893138941389513896138971389813899139001390113902139031390413905139061390713908139091391013911139121391313914139151391613917139181391913920139211392213923139241392513926139271392813929139301393113932139331393413935139361393713938139391394013941139421394313944139451394613947139481394913950139511395213953139541395513956139571395813959139601396113962139631396413965139661396713968139691397013971139721397313974139751397613977139781397913980139811398213983139841398513986139871398813989139901399113992139931399413995139961399713998139991400014001140021400314004140051400614007140081400914010140111401214013140141401514016140171401814019140201402114022140231402414025140261402714028140291403014031140321403314034140351403614037140381403914040140411404214043140441404514046140471404814049140501405114052140531405414055140561405714058140591406014061140621406314064140651406614067140681406914070140711407214073140741407514076140771407814079140801408114082140831408414085140861408714088140891409014091140921409314094140951409614097140981409914100141011410214103141041410514106141071410814109141101411114112141131411414115141161411714118141191412014121141221412314124141251412614127141281412914130141311413214133141341413514136141371413814139141401414114142141431414414145141461414714148141491415014151141521415314154141551415614157141581415914160141611416214163141641416514166141671416814169141701417114172141731417414175141761417714178141791418014181141821418314184141851418614187141881418914190141911419214193141941419514196141971419814199142001420114202142031420414205142061420714208142091421014211142121421314214142151421614217142181421914220142211422214223142241422514226142271422814229142301423114232142331423414235142361423714238142391424014241142421424314244142451424614247142481424914250142511425214253142541425514256142571425814259142601426114262142631426414265142661426714268142691427014271142721427314274142751427614277142781427914280142811428214283142841428514286142871428814289142901429114292142931429414295142961429714298142991430014301143021430314304143051430614307143081430914310143111431214313143141431514316143171431814319143201432114322143231432414325143261432714328143291433014331143321433314334143351433614337143381433914340143411434214343143441434514346143471434814349143501435114352143531435414355143561435714358143591436014361143621436314364143651436614367143681436914370143711437214373143741437514376143771437814379143801438114382143831438414385143861438714388143891439014391143921439314394143951439614397143981439914400144011440214403144041440514406144071440814409144101441114412144131441414415144161441714418144191442014421144221442314424144251442614427144281442914430144311443214433144341443514436144371443814439144401444114442144431444414445144461444714448144491445014451144521445314454144551445614457144581445914460144611446214463144641446514466144671446814469144701447114472144731447414475144761447714478144791448014481144821448314484144851448614487144881448914490144911449214493144941449514496144971449814499145001450114502145031450414505145061450714508145091451014511145121451314514145151451614517145181451914520145211452214523145241452514526145271452814529145301453114532145331453414535145361453714538145391454014541145421454314544145451454614547145481454914550145511455214553145541455514556145571455814559145601456114562145631456414565145661456714568145691457014571145721457314574145751457614577145781457914580145811458214583145841458514586145871458814589145901459114592145931459414595145961459714598145991460014601146021460314604146051460614607146081460914610146111461214613146141461514616146171461814619146201462114622146231462414625146261462714628146291463014631146321463314634146351463614637146381463914640146411464214643146441464514646146471464814649146501465114652146531465414655146561465714658146591466014661146621466314664146651466614667146681466914670146711467214673146741467514676146771467814679146801468114682146831468414685146861468714688146891469014691146921469314694146951469614697146981469914700147011470214703147041470514706147071470814709147101471114712147131471414715147161471714718147191472014721147221472314724147251472614727147281472914730147311473214733147341473514736147371473814739147401474114742147431474414745147461474714748147491475014751147521475314754147551475614757147581475914760147611476214763147641476514766147671476814769147701477114772147731477414775147761477714778147791478014781147821478314784147851478614787147881478914790147911479214793147941479514796147971479814799148001480114802148031480414805148061480714808148091481014811148121481314814148151481614817148181481914820148211482214823148241482514826148271482814829148301483114832148331483414835148361483714838148391484014841148421484314844148451484614847148481484914850148511485214853148541485514856148571485814859148601486114862148631486414865148661486714868148691487014871148721487314874148751487614877148781487914880148811488214883148841488514886148871488814889148901489114892148931489414895148961489714898148991490014901149021490314904149051490614907149081490914910149111491214913149141491514916149171491814919149201492114922149231492414925149261492714928149291493014931149321493314934149351493614937149381493914940149411494214943149441494514946149471494814949149501495114952149531495414955149561495714958149591496014961149621496314964149651496614967149681496914970149711497214973149741497514976149771497814979149801498114982149831498414985149861498714988149891499014991149921499314994149951499614997149981499915000150011500215003150041500515006150071500815009150101501115012150131501415015150161501715018150191502015021150221502315024150251502615027150281502915030150311503215033150341503515036150371503815039150401504115042150431504415045150461504715048150491505015051150521505315054150551505615057150581505915060150611506215063150641506515066150671506815069150701507115072150731507415075150761507715078150791508015081150821508315084150851508615087150881508915090150911509215093150941509515096150971509815099151001510115102151031510415105151061510715108151091511015111151121511315114151151511615117151181511915120151211512215123151241512515126151271512815129151301513115132151331513415135151361513715138151391514015141151421514315144151451514615147151481514915150151511515215153151541515515156151571515815159151601516115162151631516415165151661516715168151691517015171151721517315174151751517615177151781517915180151811518215183151841518515186151871518815189151901519115192151931519415195151961519715198151991520015201152021520315204152051520615207152081520915210152111521215213152141521515216152171521815219152201522115222152231522415225152261522715228152291523015231152321523315234152351523615237152381523915240152411524215243152441524515246152471524815249152501525115252152531525415255152561525715258152591526015261152621526315264152651526615267152681526915270152711527215273152741527515276152771527815279152801528115282152831528415285152861528715288152891529015291152921529315294152951529615297152981529915300153011530215303153041530515306153071530815309153101531115312153131531415315153161531715318153191532015321153221532315324153251532615327153281532915330153311533215333153341533515336153371533815339153401534115342153431534415345153461534715348153491535015351153521535315354153551535615357153581535915360153611536215363153641536515366153671536815369153701537115372153731537415375153761537715378153791538015381153821538315384153851538615387153881538915390153911539215393153941539515396153971539815399154001540115402154031540415405154061540715408154091541015411154121541315414154151541615417154181541915420154211542215423154241542515426154271542815429154301543115432154331543415435154361543715438154391544015441154421544315444154451544615447154481544915450154511545215453154541545515456154571545815459154601546115462154631546415465154661546715468154691547015471154721547315474154751547615477154781547915480154811548215483154841548515486154871548815489154901549115492154931549415495154961549715498154991550015501155021550315504155051550615507155081550915510155111551215513155141551515516155171551815519155201552115522155231552415525155261552715528155291553015531155321553315534155351553615537155381553915540155411554215543155441554515546155471554815549155501555115552155531555415555155561555715558155591556015561155621556315564155651556615567155681556915570155711557215573155741557515576155771557815579155801558115582155831558415585155861558715588155891559015591155921559315594155951559615597155981559915600156011560215603156041560515606156071560815609156101561115612156131561415615156161561715618156191562015621156221562315624156251562615627156281562915630156311563215633156341563515636156371563815639156401564115642156431564415645156461564715648156491565015651156521565315654156551565615657156581565915660156611566215663156641566515666156671566815669156701567115672156731567415675156761567715678156791568015681156821568315684156851568615687156881568915690156911569215693156941569515696156971569815699157001570115702157031570415705157061570715708157091571015711157121571315714157151571615717157181571915720157211572215723157241572515726157271572815729157301573115732157331573415735157361573715738157391574015741157421574315744157451574615747157481574915750157511575215753157541575515756157571575815759157601576115762157631576415765157661576715768157691577015771157721577315774157751577615777157781577915780157811578215783157841578515786157871578815789157901579115792157931579415795157961579715798157991580015801158021580315804158051580615807158081580915810158111581215813158141581515816158171581815819158201582115822158231582415825158261582715828158291583015831158321583315834158351583615837158381583915840158411584215843158441584515846158471584815849158501585115852158531585415855158561585715858158591586015861158621586315864158651586615867158681586915870158711587215873158741587515876158771587815879158801588115882158831588415885158861588715888158891589015891158921589315894158951589615897158981589915900159011590215903159041590515906159071590815909159101591115912159131591415915159161591715918159191592015921159221592315924159251592615927159281592915930159311593215933159341593515936159371593815939159401594115942159431594415945159461594715948159491595015951159521595315954159551595615957159581595915960159611596215963159641596515966159671596815969159701597115972159731597415975159761597715978159791598015981159821598315984159851598615987159881598915990159911599215993159941599515996159971599815999160001600116002160031600416005160061600716008160091601016011160121601316014160151601616017160181601916020160211602216023160241602516026160271602816029160301603116032160331603416035160361603716038160391604016041160421604316044160451604616047160481604916050160511605216053160541605516056160571605816059160601606116062160631606416065160661606716068160691607016071160721607316074160751607616077160781607916080160811608216083160841608516086160871608816089160901609116092160931609416095160961609716098160991610016101161021610316104161051610616107161081610916110161111611216113161141611516116161171611816119161201612116122161231612416125161261612716128161291613016131161321613316134161351613616137161381613916140161411614216143161441614516146161471614816149161501615116152161531615416155161561615716158161591616016161161621616316164161651616616167161681616916170161711617216173161741617516176161771617816179161801618116182161831618416185161861618716188161891619016191161921619316194161951619616197161981619916200162011620216203162041620516206162071620816209162101621116212162131621416215162161621716218162191622016221162221622316224162251622616227162281622916230162311623216233162341623516236162371623816239162401624116242162431624416245162461624716248162491625016251162521625316254162551625616257162581625916260162611626216263162641626516266162671626816269162701627116272162731627416275162761627716278162791628016281162821628316284162851628616287162881628916290162911629216293162941629516296162971629816299163001630116302163031630416305163061630716308163091631016311163121631316314163151631616317163181631916320163211632216323163241632516326163271632816329163301633116332163331633416335163361633716338163391634016341163421634316344163451634616347163481634916350163511635216353163541635516356163571635816359163601636116362163631636416365163661636716368163691637016371163721637316374163751637616377163781637916380163811638216383163841638516386163871638816389163901639116392163931639416395163961639716398163991640016401164021640316404164051640616407164081640916410164111641216413164141641516416164171641816419164201642116422164231642416425164261642716428164291643016431164321643316434164351643616437164381643916440164411644216443164441644516446164471644816449164501645116452164531645416455164561645716458164591646016461164621646316464164651646616467164681646916470164711647216473164741647516476164771647816479164801648116482164831648416485164861648716488164891649016491164921649316494164951649616497164981649916500165011650216503165041650516506165071650816509165101651116512165131651416515165161651716518165191652016521165221652316524165251652616527165281652916530165311653216533165341653516536165371653816539165401654116542165431654416545165461654716548165491655016551165521655316554165551655616557165581655916560165611656216563165641656516566165671656816569165701657116572165731657416575165761657716578165791658016581165821658316584165851658616587165881658916590165911659216593165941659516596165971659816599166001660116602166031660416605166061660716608166091661016611166121661316614166151661616617166181661916620166211662216623166241662516626166271662816629166301663116632166331663416635166361663716638166391664016641166421664316644166451664616647166481664916650166511665216653166541665516656166571665816659166601666116662166631666416665166661666716668166691667016671166721667316674166751667616677166781667916680166811668216683166841668516686166871668816689166901669116692166931669416695166961669716698166991670016701167021670316704167051670616707167081670916710167111671216713167141671516716167171671816719167201672116722167231672416725167261672716728167291673016731167321673316734167351673616737167381673916740167411674216743167441674516746167471674816749167501675116752167531675416755167561675716758167591676016761167621676316764167651676616767167681676916770167711677216773167741677516776167771677816779167801678116782167831678416785167861678716788167891679016791167921679316794167951679616797167981679916800168011680216803168041680516806168071680816809168101681116812168131681416815168161681716818168191682016821168221682316824168251682616827168281682916830168311683216833168341683516836168371683816839168401684116842168431684416845168461684716848168491685016851168521685316854168551685616857168581685916860168611686216863168641686516866168671686816869168701687116872168731687416875168761687716878168791688016881168821688316884168851688616887168881688916890168911689216893168941689516896168971689816899169001690116902169031690416905169061690716908169091691016911169121691316914169151691616917169181691916920169211692216923169241692516926169271692816929169301693116932169331693416935169361693716938169391694016941169421694316944169451694616947169481694916950169511695216953169541695516956169571695816959169601696116962169631696416965169661696716968169691697016971169721697316974169751697616977169781697916980169811698216983169841698516986169871698816989169901699116992169931699416995169961699716998169991700017001170021700317004170051700617007170081700917010170111701217013170141701517016170171701817019170201702117022170231702417025170261702717028170291703017031170321703317034170351703617037170381703917040170411704217043170441704517046170471704817049170501705117052170531705417055170561705717058170591706017061170621706317064170651706617067170681706917070170711707217073170741707517076170771707817079170801708117082170831708417085170861708717088170891709017091170921709317094170951709617097170981709917100171011710217103171041710517106171071710817109171101711117112171131711417115171161711717118171191712017121171221712317124171251712617127171281712917130171311713217133171341713517136171371713817139171401714117142171431714417145171461714717148171491715017151171521715317154171551715617157171581715917160171611716217163171641716517166171671716817169171701717117172171731717417175171761717717178171791718017181171821718317184171851718617187171881718917190171911719217193171941719517196171971719817199172001720117202172031720417205172061720717208172091721017211172121721317214172151721617217172181721917220172211722217223172241722517226172271722817229172301723117232172331723417235172361723717238172391724017241172421724317244172451724617247172481724917250172511725217253172541725517256172571725817259172601726117262172631726417265172661726717268172691727017271172721727317274172751727617277172781727917280172811728217283172841728517286172871728817289172901729117292172931729417295172961729717298172991730017301173021730317304173051730617307173081730917310173111731217313173141731517316173171731817319173201732117322173231732417325173261732717328173291733017331173321733317334173351733617337173381733917340173411734217343173441734517346173471734817349173501735117352173531735417355173561735717358173591736017361173621736317364173651736617367173681736917370173711737217373173741737517376173771737817379173801738117382173831738417385173861738717388173891739017391173921739317394173951739617397173981739917400174011740217403174041740517406174071740817409174101741117412174131741417415174161741717418174191742017421174221742317424174251742617427174281742917430174311743217433174341743517436174371743817439174401744117442174431744417445174461744717448174491745017451174521745317454174551745617457174581745917460174611746217463174641746517466174671746817469174701747117472174731747417475174761747717478174791748017481174821748317484174851748617487174881748917490174911749217493174941749517496174971749817499175001750117502175031750417505175061750717508175091751017511175121751317514175151751617517175181751917520175211752217523175241752517526175271752817529175301753117532175331753417535175361753717538175391754017541175421754317544175451754617547175481754917550175511755217553175541755517556175571755817559175601756117562175631756417565175661756717568175691757017571175721757317574175751757617577175781757917580175811758217583175841758517586175871758817589175901759117592175931759417595175961759717598175991760017601176021760317604176051760617607176081760917610176111761217613176141761517616176171761817619176201762117622176231762417625176261762717628176291763017631176321763317634176351763617637176381763917640176411764217643176441764517646176471764817649176501765117652176531765417655176561765717658176591766017661176621766317664176651766617667176681766917670176711767217673176741767517676176771767817679176801768117682176831768417685176861768717688176891769017691176921769317694176951769617697176981769917700177011770217703177041770517706177071770817709177101771117712177131771417715177161771717718177191772017721177221772317724177251772617727177281772917730177311773217733177341773517736177371773817739177401774117742177431774417745177461774717748177491775017751177521775317754177551775617757177581775917760177611776217763177641776517766177671776817769177701777117772177731777417775177761777717778177791778017781177821778317784177851778617787177881778917790177911779217793177941779517796177971779817799178001780117802178031780417805178061780717808178091781017811178121781317814178151781617817178181781917820178211782217823178241782517826178271782817829178301783117832178331783417835178361783717838178391784017841178421784317844178451784617847178481784917850178511785217853178541785517856178571785817859178601786117862178631786417865178661786717868178691787017871178721787317874178751787617877178781787917880178811788217883178841788517886178871788817889178901789117892178931789417895178961789717898178991790017901179021790317904179051790617907179081790917910179111791217913179141791517916179171791817919179201792117922179231792417925179261792717928179291793017931179321793317934179351793617937179381793917940179411794217943179441794517946179471794817949179501795117952179531795417955179561795717958179591796017961179621796317964179651796617967179681796917970179711797217973179741797517976179771797817979179801798117982179831798417985179861798717988179891799017991179921799317994179951799617997179981799918000180011800218003180041800518006180071800818009180101801118012180131801418015180161801718018180191802018021180221802318024180251802618027180281802918030180311803218033180341803518036180371803818039180401804118042180431804418045180461804718048180491805018051180521805318054180551805618057180581805918060180611806218063180641806518066180671806818069180701807118072180731807418075180761807718078180791808018081180821808318084180851808618087180881808918090180911809218093180941809518096180971809818099181001810118102181031810418105181061810718108181091811018111181121811318114181151811618117181181811918120181211812218123181241812518126181271812818129181301813118132181331813418135181361813718138181391814018141181421814318144181451814618147181481814918150181511815218153181541815518156181571815818159181601816118162181631816418165181661816718168181691817018171181721817318174181751817618177181781817918180181811818218183181841818518186181871818818189181901819118192181931819418195181961819718198181991820018201182021820318204182051820618207182081820918210182111821218213182141821518216182171821818219182201822118222182231822418225182261822718228182291823018231182321823318234182351823618237182381823918240182411824218243182441824518246182471824818249182501825118252182531825418255182561825718258182591826018261182621826318264182651826618267182681826918270182711827218273182741827518276182771827818279182801828118282182831828418285182861828718288182891829018291182921829318294182951829618297182981829918300183011830218303183041830518306183071830818309183101831118312183131831418315183161831718318183191832018321183221832318324183251832618327183281832918330183311833218333183341833518336183371833818339183401834118342183431834418345183461834718348183491835018351183521835318354183551835618357183581835918360183611836218363183641836518366183671836818369183701837118372183731837418375183761837718378183791838018381183821838318384183851838618387183881838918390183911839218393183941839518396183971839818399184001840118402184031840418405184061840718408184091841018411184121841318414184151841618417184181841918420184211842218423184241842518426184271842818429184301843118432184331843418435184361843718438184391844018441184421844318444184451844618447184481844918450184511845218453184541845518456184571845818459184601846118462184631846418465184661846718468184691847018471184721847318474184751847618477184781847918480184811848218483184841848518486184871848818489184901849118492184931849418495184961849718498184991850018501185021850318504185051850618507185081850918510185111851218513185141851518516185171851818519185201852118522185231852418525185261852718528185291853018531185321853318534185351853618537185381853918540185411854218543185441854518546185471854818549185501855118552185531855418555185561855718558185591856018561185621856318564185651856618567185681856918570185711857218573185741857518576185771857818579185801858118582185831858418585185861858718588185891859018591185921859318594185951859618597185981859918600186011860218603186041860518606186071860818609186101861118612186131861418615186161861718618186191862018621186221862318624186251862618627186281862918630186311863218633186341863518636186371863818639186401864118642186431864418645186461864718648186491865018651186521865318654186551865618657186581865918660186611866218663186641866518666186671866818669186701867118672186731867418675186761867718678186791868018681186821868318684186851868618687186881868918690186911869218693186941869518696186971869818699187001870118702187031870418705187061870718708187091871018711187121871318714187151871618717187181871918720187211872218723187241872518726187271872818729187301873118732187331873418735187361873718738187391874018741187421874318744187451874618747187481874918750187511875218753187541875518756187571875818759187601876118762187631876418765187661876718768187691877018771187721877318774187751877618777187781877918780187811878218783187841878518786187871878818789187901879118792187931879418795187961879718798187991880018801188021880318804188051880618807188081880918810188111881218813188141881518816188171881818819188201882118822188231882418825188261882718828188291883018831188321883318834188351883618837188381883918840188411884218843188441884518846188471884818849188501885118852188531885418855188561885718858188591886018861188621886318864188651886618867188681886918870188711887218873188741887518876188771887818879188801888118882188831888418885188861888718888188891889018891188921889318894188951889618897188981889918900189011890218903189041890518906189071890818909189101891118912189131891418915189161891718918189191892018921189221892318924189251892618927189281892918930189311893218933189341893518936189371893818939189401894118942189431894418945189461894718948189491895018951189521895318954189551895618957189581895918960189611896218963189641896518966189671896818969189701897118972189731897418975189761897718978189791898018981189821898318984189851898618987189881898918990189911899218993189941899518996189971899818999190001900119002190031900419005190061900719008190091901019011190121901319014190151901619017190181901919020190211902219023190241902519026190271902819029190301903119032190331903419035190361903719038190391904019041190421904319044190451904619047190481904919050190511905219053190541905519056190571905819059190601906119062190631906419065190661906719068190691907019071190721907319074190751907619077190781907919080190811908219083190841908519086190871908819089190901909119092190931909419095190961909719098190991910019101191021910319104191051910619107191081910919110191111911219113191141911519116191171911819119191201912119122191231912419125191261912719128191291913019131191321913319134191351913619137191381913919140191411914219143191441914519146191471914819149191501915119152191531915419155191561915719158191591916019161191621916319164191651916619167191681916919170191711917219173191741917519176191771917819179191801918119182191831918419185191861918719188191891919019191191921919319194191951919619197191981919919200192011920219203192041920519206192071920819209192101921119212192131921419215192161921719218192191922019221192221922319224192251922619227192281922919230192311923219233192341923519236192371923819239192401924119242192431924419245192461924719248192491925019251192521925319254192551925619257192581925919260192611926219263192641926519266192671926819269192701927119272192731927419275192761927719278192791928019281192821928319284192851928619287192881928919290192911929219293192941929519296192971929819299193001930119302193031930419305193061930719308193091931019311193121931319314193151931619317193181931919320193211932219323193241932519326193271932819329193301933119332193331933419335193361933719338193391934019341193421934319344193451934619347193481934919350193511935219353193541935519356193571935819359193601936119362193631936419365193661936719368193691937019371193721937319374193751937619377193781937919380193811938219383193841938519386193871938819389193901939119392193931939419395193961939719398193991940019401194021940319404194051940619407194081940919410194111941219413194141941519416194171941819419194201942119422194231942419425194261942719428194291943019431194321943319434194351943619437194381943919440194411944219443194441944519446194471944819449194501945119452194531945419455194561945719458194591946019461194621946319464194651946619467194681946919470194711947219473194741947519476194771947819479194801948119482194831948419485194861948719488194891949019491194921949319494194951949619497194981949919500195011950219503195041950519506195071950819509195101951119512195131951419515195161951719518195191952019521195221952319524195251952619527195281952919530195311953219533195341953519536195371953819539195401954119542195431954419545195461954719548195491955019551195521955319554195551955619557195581955919560195611956219563195641956519566195671956819569195701957119572195731957419575195761957719578195791958019581195821958319584195851958619587195881958919590195911959219593195941959519596195971959819599196001960119602196031960419605196061960719608196091961019611196121961319614196151961619617196181961919620196211962219623196241962519626196271962819629196301963119632196331963419635196361963719638196391964019641196421964319644196451964619647196481964919650196511965219653196541965519656196571965819659196601966119662196631966419665196661966719668196691967019671196721967319674196751967619677196781967919680196811968219683196841968519686196871968819689196901969119692196931969419695196961969719698196991970019701197021970319704197051970619707197081970919710 |
- <?xml version="1.0"?>
- <doc>
- <assembly>
- <name>SmartFox2X</name>
- </assembly>
- <members>
- <member name="T:Sfs2X.SmartFox">
- <summary>
- SmartFox is the main class of the SmartFoxServer 2X API.
- </summary>
- <remarks>
- This class is responsible for connecting the client to a SmartFoxServer instance and for dispatching all asynchronous events. Developers always interact with SmartFoxServer through this class.
- <para/>
- <b>NOTE</b>: in the provided examples, <c>sfs</c> always indicates a SmartFox instance.
- <para/>
- Author: The gotoAndPlay() Team<br/>
- http://www.smartfoxserver.com
- </remarks>
- </member>
- <member name="P:Sfs2X.SmartFox.SocketClient">
- <exclude />
- </member>
- <member name="P:Sfs2X.SmartFox.Log">
- <exclude />
- </member>
- <member name="M:Sfs2X.SmartFox.#ctor">
- <summary>
- Creates a new SmartFox instance.
- </summary>
-
- <example>
- The following example instantiates the <b>SmartFox</b> class without enabling the debug messages:
- <code>
- SmartFox sfs = new SmartFox();
- </code>
- </example>
- </member>
- <member name="M:Sfs2X.SmartFox.#ctor(System.Boolean)">
- <summary>
- Creates a new SmartFox instance.
- </summary>
-
- <param name="debug">If <c>true</c>, the SmartFoxServer API debug messages are logged.</param>
-
- <example>
- The following example instantiates the <b>SmartFox</b> class enabling the debug messages:
- <code>
- SmartFox sfs = new SmartFox(true);
- </code>
- </example>
- </member>
- <member name="M:Sfs2X.SmartFox.#ctor(Sfs2X.Util.UseWebSocket)">
- <summary>
- Creates a new SmartFox instance enabling websocket communication instead of the default socket communication.
- </summary>
-
- <remarks>
- <b>IMPORTANT</b>: this constructor should be used in Unity only and when building for the web only (Unity WEBGL).
- In fact it is preferable to use the default socket communication, as websocket connection doesn't support BlueBox and HRC systems, the protocol is not binary and not compressed.<br/>
- This constructor is not available in .Net and Windows Universal DLLs (websocket communication not supported, because redundant).
- <para/>
- Starting from API v1.7.3, websocket communication uses the default SFS2X binary protocol (see <c>UseWebSocket</c> class). Legacy text protocol is still available for backward compatibility with SmartFoxserver 2X versions prior to 2.13.
- </remarks>
-
- <param name="useWebSocket">If set to <c>UseWebSocket.WS_BIN</c>, non-secure websocket communication (WS) is used; if set to <c>UseWebSocket.WSS_BIN</c>, secure websocket communication (WSS) is used.</param>
-
- <example>
- The following example instantiates the <b>SmartFox</b> class enabling websocket communication:
- <code>
- SmartFox sfs = new SmartFox(UseWebSocket.WS_BIN);
- </code>
- </example>
- </member>
- <member name="M:Sfs2X.SmartFox.#ctor(Sfs2X.Util.UseWebSocket,System.Boolean)">
- <summary>
- Creates a new SmartFox instance enabling websocket communication instead of the default socket communication.
- </summary>
-
- <remarks>
- <b>IMPORTANT</b>: this constructor should be used in Unity only and when building for the web only (Unity WEBGL).
- In fact it is preferable to use the default socket communication, as websocket connection doesn't support BlueBox and HRC systems, the protocol is not binary and not compressed.<br/>
- This constructor is not available in .Net and Windows Universal DLLs (websocket communication not supported, because redundant).
- <para/>
- Starting from API v1.7.3, websocket communication uses the default SFS2X binary protocol (see <c>UseWebSocket</c> class). Legacy text protocol is still available for backward compatibility with SmartFoxserver 2X versions prior to 2.13.
- </remarks>
-
- <param name="useWebSocket">If set to <c>UseWebSocket.WS_BIN</c>, non-secure websocket communication (WS) is used; if set to <c>UseWebSocket.WSS_BIN</c>, secure websocket communication (WSS) is used.</param>
- <param name="debug">If <c>true</c>, the SmartFoxServer API debug messages are logged.</param>
-
- <example>
- The following example instantiates the <b>SmartFox</b> class enabling secure websocket communication and debug messages:
- <code>
- SmartFox sfs = new SmartFox(UseWebSocket.WSS_BIN, true);
- </code>
- </example>
- </member>
- <member name="M:Sfs2X.SmartFox.SetClientDetails(System.String,System.String)">
- <summary>
- Allows to set custom client details used to gather statistics about the client platform in the SFS2X Analytics Module.
- </summary>
-
- <remarks>
- This method must be called before the connection is started. <br/>
- The length of the two strings combined must be < 512 characters.
- <para/>
- By default the generic "Unity" and "Windows Universal" labels (depending on the used DLL) are set as platform, without specifying the version.
- </remarks>
-
- <param name="platformId">The id of the runtime platform: for example "Unity WebPlayer" or "iOS".</param>
- <param name="version">An optional version of the runtime platform: for example "2.0.0".</param>
-
- </member>
- <member name="M:Sfs2X.SmartFox.EnableLagMonitor(System.Boolean,System.Int32,System.Int32)">
- <summary>
- Enables the automatic realtime monitoring of the lag between the client and the server (round robin).
- </summary>
-
- <remarks>
- When turned on, the <see cref="F:Sfs2X.Core.SFSEvent.PING_PONG"/> event type is dispatched continuously, providing the average of the last ten measured lag values.
- The lag monitoring can be enabled after the login has been performed successfully only and it is automatically halted when the user logs out of a Zone or gets disconnected.
- </remarks>
-
- <param name='enabled'>The lag monitoring status: <c>true</c> to start the monitoring, <c>false</c> to stop it.</param>
- <param name='interval'>(default: 4) An optional amount of seconds to wait between each query (recommended 3-4s).</param>
- <param name='queueSize'>(default: 10) The amount of values stored temporarily and used to calculate the average lag.</param>
-
- <seealso cref="F:Sfs2X.Core.SFSEvent.PING_PONG"/>
- </member>
- <member name="M:Sfs2X.SmartFox.EnableLagMonitor(System.Boolean)">
- <summary>
- See <see cref="M:Sfs2X.SmartFox.EnableLagMonitor(System.Boolean,System.Int32,System.Int32)"/>.
- </summary>
- </member>
- <member name="M:Sfs2X.SmartFox.EnableLagMonitor(System.Boolean,System.Int32)">
- <summary>
- See <see cref="M:Sfs2X.SmartFox.EnableLagMonitor(System.Boolean,System.Int32,System.Int32)"/>.
- </summary>
- </member>
- <member name="P:Sfs2X.SmartFox.IsConnecting">
- <exclude/>
- </member>
- <member name="M:Sfs2X.SmartFox.GetSocketEngine">
- <exclude/>
- </member>
- <member name="P:Sfs2X.SmartFox.LagMonitor">
- <exclude/>
- </member>
- <member name="P:Sfs2X.SmartFox.IsConnected">
- <summary>
- Indicates whether the client is connected to the server or not.
- </summary>
-
- <example>
- The following example checks the connection status:
- <code>
- Console.WriteLine("Am I connected? " + sfs.IsConnected); // .Net / Unity
- System.Diagnostics.Debug.WriteLine("Am I connected? " + sfs.IsConnected); // Windows Universal
- </code>
- </example>
- </member>
- <member name="P:Sfs2X.SmartFox.Version">
- <summary>
- Returns the current version of the SmartFoxServer 2X C# API.
- </summary>
- </member>
- <member name="P:Sfs2X.SmartFox.HttpUploadURI">
- <summary>
- Returns the HTTP URI that can be used to upload files to SmartFoxServer 2X, using regular HTTP POST.
- </summary>
-
- <remarks>
- For more details on how to use this functionality, see the <see href="http://docs2x.smartfoxserver.com/AdvancedTopics/file-uploads">Upload File</see> tutorial.
- <para/>
- <b>NOTE</b>: this property returns <c>null</c> if no API configuration has been set or the current user is not already logged in the server.
- </remarks>
- </member>
- <member name="P:Sfs2X.SmartFox.Config">
- <summary>
- Returns the client configuration details.
- </summary>
-
- <seealso cref="M:Sfs2X.SmartFox.LoadConfig(System.String,System.Boolean)"/>
- </member>
- <member name="P:Sfs2X.SmartFox.UseBlueBox">
- <summary>
- Indicates whether the client should attempt a tunnelled http connection through the BlueBox in case a socket connection can't be established.
- </summary>
-
- <remarks>
- This property must be set <b>before</b> the <see cref="M:Sfs2X.SmartFox.Connect(System.String,System.Int32)"/> method is called.<br/>
- Also, after a connection is established, this property does not return the current connection mode (socket or http); for this purpose use the <see cref="P:Sfs2X.SmartFox.ConnectionMode"/> property.<br/>
- BlueBox connection is not available if websocket connection is used.
- </remarks>
-
- <seealso cref="P:Sfs2X.SmartFox.ConnectionMode"/>
- <seealso cref="M:Sfs2X.SmartFox.LoadConfig(System.String,System.Boolean)"/>
- </member>
- <member name="P:Sfs2X.SmartFox.ConnectionMode">
- <summary>
- Returns the current connection mode after a connection has been successfully established.
- </summary>
-
- <remarks>
- Possible values are:
- <ul>
- <li><b>HTTP</b>: a tunnelled http connection (through the BlueBox) was established between the client and the server</li>
- <li><b>Socket</b>: a regular socket connection was established between the client and the server</li>
- <li><b>WebSocket</b>: a websocket connection was established between the client and the server (not available in Windows / Windows Phone)</li>
- <li><b>WebSocketSecure</b>: a secure websocket connection was established between the client and the server (not available in Windows / Windows Phone)</li>
- </ul>
- </remarks>
-
- <example>
- The following example shows the current connection mode:
- <code>
- Console.WriteLine("Connection mode: " + sfs.ConnectionMode); // .Net / Unity
- System.Diagnostics.Debug.WriteLine("Connection mode: " + sfs.ConnectionMode); // native windows / windows phone
- </code>
- </example>
- </member>
- <member name="P:Sfs2X.SmartFox.CompressionThreshold">
- <summary>
- Returns the current compression threshold.
- </summary>
-
- <remarks>
- This value represents the maximum message size (in bytes) before the protocol compression is activated and it is determined by the server configuration.<br/>
- Compression threshold doesn't apply if websocket connection is used.
- </remarks>
- </member>
- <member name="P:Sfs2X.SmartFox.MaxMessageSize">
- <summary>
- Returns the maximum size of messages allowed by the server.
- </summary>
-
- <remarks>
- Any request exceeding this size will not be sent. The value is determined by the server-side configuration.
- </remarks>
- </member>
- <member name="M:Sfs2X.SmartFox.GetRoomById(System.Int32)">
- <summary>
- Retrieves a Room object from its id.
- </summary>
-
- <remarks>
- The same object is returned by the <b>IRoomManager.getRoomById()</b> method, accessible through the <see cref="P:Sfs2X.SmartFox.RoomManager"/> getter;
- this was replicated on the <em>SmartFox</em> class for handy access due to its usually frequent usage.
- </remarks>
-
- <param name="id">The id of the Room.</param>
-
- <returns>An object representing the requested Room; <c>null</c> if no <see cref="T:Sfs2X.Entities.Room"/> object with the passed id exists in the Rooms list.</returns>
-
- <example>
- The following example retrieves a <see cref="T:Sfs2X.Entities.Room"/> object and writes its name:
- <code>
- int roomId = 3;
- Room room = sfs.GetRoomById(roomId);
- Console.WriteLine("The name of Room " + roomId + " is " + room.Name); // .Net / Unity
- System.Diagnostics.Debug.WriteLine("The name of Room " + roomId + " is " + room.Name); // Windows Universal
- </code>
- </example>
-
- <seealso cref="M:Sfs2X.SmartFox.GetRoomByName(System.String)"/>
- <seealso cref="P:Sfs2X.SmartFox.RoomList"/>
- <seealso cref="T:Sfs2X.Entities.Managers.SFSRoomManager"/>
- </member>
- <member name="M:Sfs2X.SmartFox.GetRoomByName(System.String)">
- <summary>
- Retrieves a Room object from its name.
- </summary>
-
- <remarks>
- The same object is returned by the <b>IRoomManager.getRoomById()</b> method, accessible through the <see cref="P:Sfs2X.SmartFox.RoomManager"/> getter;
- this was replicated on the <em>SmartFox</em> class for handy access due to its usually frequent usage.
- </remarks>
-
- <param name="name">The name of the Room.</param>
-
- <returns>An object representing the requested Room; <c>null</c> if no <see cref="T:Sfs2X.Entities.Room"/> object with the passed name exists in the Rooms list.</returns>
-
- <example>
- The following example retrieves a <see cref="T:Sfs2X.Entities.Room"/> object and writes its id:
- <code>
- string roomName = "The Lobby";
- Room room = sfs.GetRoomByName(roomName);
- Console.WriteLine("The id of Room '" + roomName + "' is " + room.Id); // .Net / Unity
- System.Diagnostics.Debug.WriteLine("The id of Room '" + roomName + "' is " + room.Id); // Windows Universal
- </code>
- </example>
-
- <seealso cref="T:Sfs2X.Entities.Managers.SFSRoomManager"/>
- <seealso cref="P:Sfs2X.SmartFox.RoomList"/>
- <seealso cref="T:Sfs2X.Entities.SFSRoom"/>
- </member>
- <member name="M:Sfs2X.SmartFox.GetRoomListFromGroup(System.String)">
- <summary>
- Retrieves the list of Rooms which are part of the specified Room Group.
- </summary>
-
- <remarks>
- The same list is returned by the <b>IRoomManager.getRoomById()</b> method, accessible through the <see cref="P:Sfs2X.SmartFox.RoomManager"/> getter;
- this was replicated on the <em>SmartFox</em> class for handy access due to its usually frequent usage.
- </remarks>
-
- <param name="groupId">The name of the Group.</param>
-
- <returns>The list of <see cref="T:Sfs2X.Entities.Room"/> objects belonging to the passed Group.</returns>
-
- <seealso cref="T:Sfs2X.Entities.Managers.SFSRoomManager"/>
- <seealso cref="T:Sfs2X.Entities.Room"/>
- </member>
- <member name="M:Sfs2X.SmartFox.KillConnection">
- <summary>
- Simulates an abrupt disconnection from the server.
- </summary>
-
- <remarks>
- This method should be used for testing and simulations only, otherwise use the <see cref="M:Sfs2X.SmartFox.Disconnect"/> method.<br/>
- This method is not supported in case of websocket connection.
- </remarks>
-
- <seealso cref="M:Sfs2X.SmartFox.Disconnect"/>
- </member>
- <member name="M:Sfs2X.SmartFox.Connect(System.String,System.Int32)">
- <summary>
- Establishes a connection between the client and a SmartFoxServer 2X instance.
- </summary>
-
- <remarks>
- If no argument is passed, the client will use the settings loaded via <see cref="M:Sfs2X.SmartFox.LoadConfig(System.String,System.Boolean)"/> method.
- <para/>
- The client usually connects to a SmartFoxServer instance through a socket connection. In case a socket connection can't be established,
- and the <b>UseBlueBox</b> property is set to <c>true</c>, a tunnelled http connection through the BlueBox module is attempted as a fail-safe system.
- When a successful connection is established, the <b>ConnectionMode</b> property can be used to check the current connection mode.
- <para/>
- Tunnelled http connection is not available in case of websocket connection.
- <para/>
- When using a websocket connection to an IPv6 address, always wrap the <i>host</i> value in square brackets.
- </remarks>
-
- <param name="host">The address of the server to connect to.</param>
- <param name="port">The TCP port to connect to.</param>
-
- <exception cref="T:System.ArgumentException">If an invalid host/address or port is passed, and it can't be found in the loaded settings.</exception>
-
- <example>
- The following example connects to a local SmartFoxServer 2X instance:
- <code>
- void SomeMethod() {
- SmartFox sfs = new SmartFox();
-
- sfs.AddEventListener(SFSEvent.CONNECTION, OnConnection);
- sfs.Connect("127.0.0.1", 9933);
- }
-
- void OnConnection(BaseEvent evt) {
- if ((bool)evt.Params["success"])
- {
- Console.WriteLine("Connection was established"); // .Net / Unity
- System.Diagnostics.Debug.WriteLine("Connection was established"); // Windows Universal
- }
- else
- {
- Console.WriteLine("Connection failed"); // .Net / Unity
- System.Diagnostics.Debug.WriteLine("Connection failed"); // Windows Universal
- }
- }
- </code>
- </example>
-
- <seealso cref="M:Sfs2X.SmartFox.LoadConfig(System.String,System.Boolean)"/>
- <seealso cref="P:Sfs2X.SmartFox.UseBlueBox"/>
- <seealso cref="P:Sfs2X.SmartFox.ConnectionMode"/>
- <seealso cref="M:Sfs2X.SmartFox.Disconnect"/>
- <seealso cref="F:Sfs2X.Core.SFSEvent.CONNECTION"/>
- </member>
- <member name="M:Sfs2X.SmartFox.Connect">
- <summary>
- See <see cref="M:Sfs2X.SmartFox.Connect(System.String,System.Int32)"/>.
- </summary>
- </member>
- <member name="M:Sfs2X.SmartFox.Connect(System.String)">
- <summary>
- See <see cref="M:Sfs2X.SmartFox.Connect(System.String,System.Int32)"/>.
- </summary>
- </member>
- <member name="M:Sfs2X.SmartFox.Connect(Sfs2X.Util.ConfigData)">
- <summary>
- Establishes a connection between the client and a SmartFoxServer 2X instance using a configuration object.
- </summary>
-
- <remarks>
- The client usually connects to a SmartFoxServer instance through a socket connection. In case a socket connection can't be established,
- and the <b>UseBlueBox</b> property is set to <c>true</c>, a tunnelled http connection through the BlueBox module is attempted as a fail-safe system.
- When a successful connection is established, the <b>ConnectionMode</b> property can be used to check the current connection mode.
- <para/>
- Tunnelled http connection is not available in case of websocket connection.
- </remarks>
-
- <param name="cfg">The client configuration object.</param>
-
- <exception cref="T:System.ArgumentException">If an invalid host/address or port is passed, and it can't be found in the loaded settings.</exception>
-
- <example>
- The following example connects to a local SmartFoxServer 2X instance:
- <code>
- ConfigData cfg = new ConfigData();
- cfg.Host = "127.0.0.1";
- cfg.Port = 9933;
- cfg.Zone = "BasicExamples";
-
- sfs.Connect(cfg);
- </code>
- </example>
-
- <seealso cref="T:Sfs2X.Util.ConfigData"/>
- <seealso cref="P:Sfs2X.SmartFox.UseBlueBox"/>
- <seealso cref="P:Sfs2X.SmartFox.ConnectionMode"/>
- <seealso cref="M:Sfs2X.SmartFox.Disconnect"/>
- <seealso cref="F:Sfs2X.Core.SFSEvent.CONNECTION"/>
- </member>
- <member name="M:Sfs2X.SmartFox.Disconnect">
- <summary>
- Closes the connection between the client and the SmartFoxServer 2X instance.
- </summary>
- <seealso cref="M:Sfs2X.SmartFox.Connect"/>
- <seealso cref="F:Sfs2X.Core.SFSEvent.CONNECTION_LOST"/>
- </member>
- <member name="P:Sfs2X.SmartFox.Debug">
- <summary>
- Indicates whether the client-server messages debug is enabled or not.
- </summary>
-
- <remarks>
- If set to <c>true</c>, detailed debugging informations for all the incoming and outgoing messages are provided.<br/>
- Debugging can be enabled when instantiating the <em>SmartFox</em> class too.
- </remarks>
- </member>
- <member name="P:Sfs2X.SmartFox.CurrentIp">
- <summary>
- Returns the IP address or domain name of the SmartFoxServer 2X instance to which the client is connected.
- </summary>
-
- <seealso cref="M:Sfs2X.SmartFox.Connect(System.String,System.Int32)"/>
- <seealso cref="M:Sfs2X.SmartFox.LoadConfig(System.String,System.Boolean)"/>
- </member>
- <member name="P:Sfs2X.SmartFox.CurrentPort">
- <summary>
- Returns the TCP port of the SmartFoxServer 2X instance to which the client is connected.
- </summary>
-
- <seealso cref="M:Sfs2X.SmartFox.Connect(System.String,System.Int32)"/>
- <seealso cref="M:Sfs2X.SmartFox.LoadConfig(System.String,System.Boolean)"/>
- </member>
- <member name="P:Sfs2X.SmartFox.CurrentZone">
- <summary>
- Returns the Zone currently in use, if the user is already logged in.
- </summary>
-
- <seealso cref="M:Sfs2X.SmartFox.LoadConfig(System.String,System.Boolean)"/>
- <seealso cref="T:Sfs2X.Requests.LoginRequest"/>
- </member>
- <member name="P:Sfs2X.SmartFox.MySelf">
- <summary>
- Returns the <em>User</em> object representing the client when connected to a SmartFoxServer 2X instance.
- </summary>
-
- <remarks>
- This object is generated upon successful login only, so it is <c>null</c> if login was not performed yet.
- <para/>
- <b>NOTE</b>: setting this property manually can disrupt the API functioning.
- </remarks>
-
- <seealso cref="P:Sfs2X.Entities.User.IsItMe"/>
- <seealso cref="T:Sfs2X.Requests.LoginRequest"/>
- </member>
- <member name="P:Sfs2X.SmartFox.Logger">
- <summary>
- Returns a reference to the internal <em>Logger</em> instance used by SmartFoxServer 2X.
- </summary>
- </member>
- <member name="P:Sfs2X.SmartFox.LastJoinedRoom">
- <summary>
- Returns the object representing the last Room joined by the client, if any.
- </summary>
-
- <remarks>
- This property is <c>null</c> if no Room was joined.
- <para/>
- <b>NOTE</b>: setting this property manually can disrupt the API functioning.
- Use the <see cref="T:Sfs2X.Requests.JoinRoomRequest"/> request to join a new Room instead.
- </remarks>
-
- <seealso cref="T:Sfs2X.Requests.JoinRoomRequest"/>
- <seealso cref="P:Sfs2X.SmartFox.JoinedRooms"/>
- </member>
- <member name="P:Sfs2X.SmartFox.JoinedRooms">
- <summary>
- Returns a list of Room objects representing the Rooms currently joined by the client.
- </summary>
-
- <remarks>
- The same list is returned by the <b>IRoomManager.getRoomById()</b> method, accessible through the <see cref="P:Sfs2X.SmartFox.RoomManager"/> getter;
- this was replicated on the <em>SmartFox</em> class for handy access due to its usually frequent usage.
- </remarks>
-
- <seealso cref="T:Sfs2X.Requests.JoinRoomRequest"/>
- <seealso cref="P:Sfs2X.SmartFox.LastJoinedRoom"/>
- <seealso cref="P:Sfs2X.SmartFox.RoomManager"/>
- <seealso cref="T:Sfs2X.Entities.Room"/>
- </member>
- <member name="P:Sfs2X.SmartFox.RoomList">
- <summary>
- Returns a list of Room objects representing the Rooms currently "watched" by the client.
- </summary>
-
- <remarks>
- The list contains all the Rooms that are currently joined and all the Rooms belonging to the Room Groups that have been subscribed.<br/>
- At login time, the client automatically subscribes all the Room Groups specified in the Zone's <b>Default Room Groups</b> setting.
- <para/>
- The same list is returned by the <b>IRoomManager.getRoomById()</b> method, accessible through the <see cref="P:Sfs2X.SmartFox.RoomManager"/> getter;
- this was replicated on the <em>SmartFox</em> class for handy access due to its usually frequent usage.
- </remarks>
-
- <seealso cref="P:Sfs2X.SmartFox.RoomManager"/>
- <seealso cref="T:Sfs2X.Requests.JoinRoomRequest"/>
- <seealso cref="T:Sfs2X.Requests.SubscribeRoomGroupRequest"/>
- <seealso cref="T:Sfs2X.Requests.UnsubscribeRoomGroupRequest"/>
- </member>
- <member name="P:Sfs2X.SmartFox.RoomManager">
- <summary>
- Returns a reference to the Room Manager.
- </summary>
-
- <remarks>
- This manager is used internally by the SmartFoxServer 2X API; the reference returned by this property
- gives access to the Rooms list and Groups, allowing interaction with <see cref="T:Sfs2X.Entities.Room"/> objects.
- </remarks>
-
- <seealso cref="T:Sfs2X.Entities.Managers.IRoomManager"/>
- </member>
- <member name="P:Sfs2X.SmartFox.UserManager">
- <summary>
- Returns a reference to the User Manager.
- </summary>
-
- <remarks>
- This manager is used internally by the SmartFoxServer 2X API; the reference returned by this property
- gives access to the users list, allowing interaction with <see cref="T:Sfs2X.Entities.User"/> objects.
- </remarks>
-
- <seealso cref="T:Sfs2X.Entities.Managers.IUserManager"/>
- </member>
- <member name="P:Sfs2X.SmartFox.BuddyManager">
- <summary>
- Returns a reference to the Buddy Manager.
- </summary>
-
- <remarks>
- This manager is used internally by the SmartFoxServer 2X API; the reference returned by this property
- gives access to the buddies list, allowing interaction with <see cref="T:Sfs2X.Entities.Buddy"/> and <see cref="T:Sfs2X.Entities.Variables.BuddyVariable"/> objects and access to user properties in the <b>Buddy List</b> system.
- </remarks>
-
- <seealso cref="T:Sfs2X.Entities.Managers.IBuddyManager"/>
- </member>
- <member name="P:Sfs2X.SmartFox.UdpAvailable">
- <summary>
- Indicates whether the UPD protocol is available or not in the current runtime.
- </summary>
-
- <remarks>
- UPD protocol is always available and this property always returns <c>true</c>, unless websocket connection is used.
- <para/>
- Using the UDP protocol in an application requires that a handshake is performed between the client and the server.
- By default this is NOT done by the SmartFoxServer 2X API, to avoid allocating resources that might never be used.<br/>
- In order to activate the UDP support, the initUDP() method must be invoked explicitly.
- </remarks>
-
- <seealso cref="M:Sfs2X.SmartFox.InitUDP(System.String,System.Int32)"/>
- </member>
- <member name="P:Sfs2X.SmartFox.UdpInited">
- <summary>
- Indicates whether the UDP handshake has been performed successfully or not.
- </summary>
-
- <seealso cref="M:Sfs2X.SmartFox.InitUDP(System.String,System.Int32)"/>
- </member>
- <member name="M:Sfs2X.SmartFox.InitUDP(System.String,System.Int32)">
- <summary>
- Initializes the UDP protocol by performing an handshake with the server.
- </summary>
-
- <remarks>
- This method needs to be called only once. It can be executed at any moment provided that a connection to the server has already been established.<br/>
- After a successful initialization, UDP requests can be sent to the server-side Extension at any moment.
- <para/>
- If <em>udpHost</em> or <em>udpPort</em> arguments are not passed, the client will use the settings loaded via <see cref="M:Sfs2X.SmartFox.LoadConfig(System.String,System.Boolean)"/> method.
- <para/>
- UDP protocol is not available in case of websocket connection.
- <para/>
- <b>MTU note</b>
- <para/>
- The <em>Maximum Transmission Unit</em> (MTU), represents the largest amount of bytes that can be sent at once before packet fragmentation occurs.
- Since the UDP protocol uses a "nothing-or-all" approach to the transmission, it is important to keep in mind that, on average, a message size of 1100-1200 bytes is probably the maximum you can reach.
- If you exceed the MTU size the data will be "lost in hyperspace" (the Internet).
- <para/>
- Another interesting matter is that there's no fixed size for the MTU, each operating system uses a slighlty different size.
- Because of this we suggest a conservative data size of 1000-1200 bytes per packet to avoid packet loss.
- <para/>
- The SFS2X protocol compression allows to send 2-3KBytes of uncompressed data which usually is squeezed down to a size of ~1000 bytes.
- If you have larger data to send we suggest to organize it in smaller chunks so that they don't exceed the suggested MTU size.
- <para/>
- More details about the MTU can be found here: <see href="http://en.wikipedia.org/wiki/Maximum_transmission_unit"/>.
- </remarks>
-
- <param name="udpHost">The IP address of the server to connect to.</param>
- <param name="udpPort">he UDP port to connect to.</param>
-
- <example>
- The following example initializes the UDP communication, sends a request to an Extension and handles the related events:
- <code>
- void SomeMethod() {
- sfs.AddEventListener(SFSEvent.UPD_INIT, OnUDPInit);
- sfs.InitUDP();
- }
-
- void OnUDPInit(BaseEvent evt) {
- if ((bool)evt.Params["success"]) {
- // Execute an extension call via UDP
- sfs.Send( new ExtensionRequest("udpTest", new SFSObject(), null, true) ):
- } else {
- Console.WriteLine("UDP init failed!"); // .Net / Unity
- System.Diagnostics.Debug.WriteLine("UDP init failed!"); // Windows Universal
- }
- }
- </code>
- </example>
-
- <seealso cref="P:Sfs2X.SmartFox.UdpAvailable"/>
- <seealso cref="F:Sfs2X.Core.SFSEvent.UDP_INIT"/>
- <seealso cref="M:Sfs2X.SmartFox.LoadConfig(System.String,System.Boolean)"/>
- </member>
- <member name="M:Sfs2X.SmartFox.InitUDP">
- <summary>
- See <see cref="M:Sfs2X.SmartFox.InitUDP(System.String,System.Int32)"/>.
- </summary>
- </member>
- <member name="M:Sfs2X.SmartFox.InitUDP(System.String)">
- <summary>
- See <see cref="M:Sfs2X.SmartFox.InitUDP(System.String,System.Int32)"/>.
- </summary>
- </member>
- <member name="M:Sfs2X.SmartFox.InitCrypto">
- <summary>
- Initializes the connection cryptography to protect all client-server communications with standard TLS protocol.
- </summary>
-
- <remarks>
- This method must be called right after a successful connection, before the login is performed.<br/>
- Once the encryption initialization process is successfully completed, all of the server's data will be encrypted using standard AES 128-bit algorithm, with a secure key served over HTTPS.
- <para/>
- <b>IMPORTANT UNITY REMARKS</b>
- <para/>
- In Unity this method must be executed as a coroutine, hence using MonoBehaviour.StartCoroutine method.
- For this reason, in case the Unity project is built for Windows Store (SDK 8.1, Phone 8.1, Universal 8.1), a conditional statement is required as in the example below.
- <para/>
- This method is not available when building for WebGL: use WSS connection instead.
- <para/>
- When building for the Web Player, do not use Security.PrefetchSocketPolicy in your code. In fact this method accepts an IP address only, while you should connect to the domain name instead, since the SSL certificate is (typically) bound to that.
- Let the Web Player auto-fetch the cross-domain policy from the default TCP port 843. In order to do this, add a listener for such port in the SFS2X AdminTool's Server Configurator module.
- </remarks>
-
- <example>
- The following example initializes the encrypted communication:
- <code>
- void SomeMethod() {
- SmartFox sfs = new SmartFox();
-
- sfs.AddEventListener(SFSEvent.CONNECTION, OnConnection);
- sfs.AddEventListener(SFSEvent.CRYPTO_INIT, OnEncryptionInitialized);
-
- sfs.Connect("mysecuredomain.com", 9933);
- }
-
- void OnConnection(BaseEvent evt) {
- if ((bool)evt.Params["success"])
- {
- Console.WriteLine("Connection was established");
-
- // Initialize encrypted connection
- #if UNITY_WINRT && !UNITY_EDITOR
- sfs.InitCrypto();
- #else
- StartCoroutine(sfs.InitCrypto());
- #endif
- }
- else
- {
- Console.WriteLine("Connection failed");
- }
- }
-
- void OnEncryptionInitialized(BaseEvent evt) {
- if ((bool)evt.Params["success"])
- {
- // Do login
- sfs.Send( new LoginRequest("FozzieTheBear", "", "SimpleChat") );
- }
- else
- {
- Console.WriteLine("Encryption initialization failed. Caused by: " + (string)evt.Params["errorMsg"]);
- }
- }
- </code>
- </example>
-
- <seealso cref="F:Sfs2X.Core.SFSEvent.CRYPTO_INIT"/>
- </member>
- <member name="P:Sfs2X.SmartFox.IsJoining">
- <exclude/>
- </member>
- <member name="P:Sfs2X.SmartFox.SessionToken">
- <summary>
- Returns the unique session token of the client.
- </summary>
-
- <remarks>
- The session token is a string sent by the server to the client after the initial handshake.
- It is required as mean of identification when uploading files to the server.
- </remarks>
-
- <seealso cref="P:Sfs2X.SmartFox.HttpUploadURI"/>
- </member>
- <member name="P:Sfs2X.SmartFox.Dispatcher">
- <exclude/>
- </member>
- <member name="P:Sfs2X.SmartFox.ThreadSafeMode">
- <summary>
- Sets the API to run with an event queue that needs to be processed by the client.
- </summary>
-
- <remarks>
- By default this property is set to <c>true</c> in the Unity DLL. Instead it is set to <c>false</c> in the Windows / Windows Phone Universal and .Net DLLs, for native usage of the SmartFoxServer 2X API.<br/>
- When using the API in Unity, this <b>must</b> be <c>true</c>, otherwise random crashes can happen.
- For this reason, when building an application/game for Windows / Windows Phone using Unity, always remember to set this property to <c>true</c> explicitly!
- </remarks>
-
- <seealso cref="M:Sfs2X.SmartFox.ProcessEvents"/>
- </member>
- <member name="M:Sfs2X.SmartFox.GetReconnectionSeconds">
- <exclude/>
- </member>
- <member name="M:Sfs2X.SmartFox.SetReconnectionSeconds(System.Int32)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.SmartFox.Send(Sfs2X.Requests.IRequest)">
- <summary>
- Sends a request to the server.
- </summary>
-
- <remarks>
- All the available request objects can be found under the <see cref="N:Sfs2X.Requests"/> namespace.
- </remarks>
-
- <param name="request">A request object.</param>
-
- <example>
- The following example sends a login request:
- <code>
- sfs.Send( new LoginRequest("KermitTheFrog", "KermitPass", "TheMuppetZone") );
- </code>
- </example>
-
- <example>
- The following example sends a login request:
- <code>
- sfs.Send( new JoinRoomRequest("Lobby") );
- </code>
- </example>
-
- <example>
- The following example creates an object containing some parameters and sends it to the server-side Extension.
- <code>
- ISFSObject parameters = SFSObject.NewInstance();
- parameters.SetInt("x", 10);
- parameters.SetInt("y", 37);
- sfs.Send( new ExtensionRequest("setPosition", parameters) );
- </code>
- </example>
- </member>
- <member name="M:Sfs2X.SmartFox.LoadConfig(System.String,System.Boolean)">
- <summary>
- Loads the client configuration file.
- </summary>
-
- <remarks>
- The SmartFox instance can be configured through an external xml configuration file loaded at run-time.
- By default, this method loads a file named "sfs-config.xml", placed in the same folder of the application file.<br/>
- If the <i>AutoConnect</i> parameter is set to <c>true</c>, on loading completion the <see cref="M:Sfs2X.SmartFox.Connect(System.String,System.Int32)"/> method is automatically called by the API, otherwise the <see cref="F:Sfs2X.Core.SFSEvent.CONFIG_LOAD_SUCCESS"/> event is dispatched.
- In case of loading error, the <see cref="F:Sfs2X.Core.SFSEvent.CONFIG_LOAD_FAILURE"/> event id fired.
- <para/>
- The external xml configuration file has the following structure; ip, port and zone parameters are mandatory, all other parameters are optional.
- <code>
- <SmartFoxConfig>
- <host>127.0.0.1</host>
- <port>9933</port>
- <udpHost>127.0.0.1</udpHost>
- <udpPort>9933</udpPort>
- <zone>simpleChat</zone>
- <debug>true</debug>
- <httpPort>8080</httpPort>
- <httpsPort>8443</httpsPort>
- <useBlueBox>true</useBlueBox>
- <blueBoxPollingRate>750</blueBoxPollingRate>
- </SmartFoxConfig>
- </code>
- </remarks>
-
- <param name="filePath">(default: sfs-config.xml) Filename of the external XML configuration, including its path relative to the folder of the application file.</param>
- <param name="connectOnSuccess">(default: true) A flag indicating if the connection to SmartFoxServer must be attempted upon configuration loading completion.</param>
-
- <example>
- The following example shows how to load an external configuration file:
- <code>
- void SomeMethod() {
- sfs.AddEventListener(SFSEvent.CONFIG_LOAD_SUCCESS, OnConfigLoadSuccessHandler);
- sfs.AddEventListener(SFSEvent.CONFIG_LOAD_FAILURE, OnConfigLoadFailureHandler);
-
- sfs.LoadConfig("testEnvironmentConfig.xml", false);
- }
-
- void OnConfigLoadSuccessHandler(BaseEvent evt) {
- Console.WriteLine("Config file loaded, now connecting...");
- sfs.Connect(sfs.IpAddress, sfs.Port);
- }
-
- void OnConfigLoadFailureHandler(BaseEvent evt) {
- Console.WriteLine("Failed loading config file: " + evt.Params["message"]);
- }
- </code>
- </example>
-
- <seealso cref="M:Sfs2X.SmartFox.Connect(System.String,System.Int32)"/>
- <seealso cref="F:Sfs2X.Core.SFSEvent.CONFIG_LOAD_SUCCESS"/>
- <seealso cref="F:Sfs2X.Core.SFSEvent.CONFIG_LOAD_FAILURE"/>
- </member>
- <member name="M:Sfs2X.SmartFox.LoadConfig(System.String)">
- <summary>
- See <see cref="M:Sfs2X.SmartFox.LoadConfig(System.String,System.Boolean)"/>.
- </summary>
- </member>
- <member name="M:Sfs2X.SmartFox.LoadConfig(System.Boolean)">
- <summary>
- See <see cref="M:Sfs2X.SmartFox.LoadConfig(System.String,System.Boolean)"/>.
- </summary>
- </member>
- <member name="M:Sfs2X.SmartFox.LoadConfig">
- <summary>
- See <see cref="M:Sfs2X.SmartFox.LoadConfig(System.String,System.Boolean)"/>.
- </summary>
- </member>
- <member name="M:Sfs2X.SmartFox.AddLogListener(Sfs2X.Logging.LogLevel,Sfs2X.Core.EventListenerDelegate)">
- <summary>
- Registers a delegate method for log messages callbacks.
- </summary>
-
- <remarks>
- Calling this method is just like calling the <see cref="M:Sfs2X.Logging.Logger.AddEventListener(Sfs2X.Logging.LogLevel,Sfs2X.Core.EventListenerDelegate)">Logger.AddEventListener</see> method directly,
- but in addition the <see cref="P:Sfs2X.Logging.Logger.EnableEventDispatching">Logger.EnableEventDispatching</see> property is automatically set to <c>true</c>.
- </remarks>
-
- <param name="logLevel">The level of the log events to register a listener for.</param>
- <param name="eventListener">The event listener to register.</param>
-
- <example>
- <code>
- void SomeMethod() {
- sfs.AddLogListener(LogLevel.INFO, OnInfoLogMessage);
- sfs.AddLogListener(LogLevel.WARN, OnWarnLogMessage);
- }
-
- void OnInfoLogMessage(BaseEvent evt) {
- string message = (string)evt.Params["message"];
- Console.WriteLine("[SFS2X INFO] " + message); // .Net / Unity
- System.Diagnostics.Debug.WriteLine("[SFS2X INFO] " + message); // Windows Universal
- }
-
- void OnWarnLogMessage(BaseEvent evt) {
- string message = (string)evt.Params["message"];
- Console.WriteLine("[SFS2X WARN] " + message); // .Net / Unity
- System.Diagnostics.Debug.WriteLine("[SFS2X WARN] " + message); // Windows Universal
- }
- </code>
- </example>
-
- <seealso cref="M:Sfs2X.Logging.Logger.AddEventListener(Sfs2X.Logging.LogLevel,Sfs2X.Core.EventListenerDelegate)"/>
- </member>
- <member name="M:Sfs2X.SmartFox.RemoveLogListener(Sfs2X.Logging.LogLevel,Sfs2X.Core.EventListenerDelegate)">
- <summary>
- Removes a delegate method for log messages callbacks.
- </summary>
-
- <remarks>
- Calling this method is just like calling the <see cref="M:Sfs2X.Logging.Logger.RemoveEventListener(Sfs2X.Logging.LogLevel,Sfs2X.Core.EventListenerDelegate)">Logger.RemoveEventListener</see> method directly.
- </remarks>
-
- <param name="logLevel">The level of the log events to remove the listener for.</param>
- <param name="eventListener">The event listener to remove.</param>
-
- <seealso cref="M:Sfs2X.Logging.Logger.RemoveEventListener(Sfs2X.Logging.LogLevel,Sfs2X.Core.EventListenerDelegate)"/>
- </member>
- <member name="M:Sfs2X.SmartFox.AddJoinedRoom(Sfs2X.Entities.Room)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.SmartFox.RemoveJoinedRoom(Sfs2X.Entities.Room)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.SmartFox.HandleHandShake(Sfs2X.Core.BaseEvent)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.SmartFox.HandleLogin(Sfs2X.Core.BaseEvent)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.SmartFox.HandleClientDisconnection(System.String)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.SmartFox.HandleLogout">
- <exclude/>
- </member>
- <member name="M:Sfs2X.SmartFox.HandleReconnectionFailure">
- <exclude/>
- </member>
- <member name="M:Sfs2X.SmartFox.ProcessEvents">
- <summary>
- Tells the API to process all event queues and execute the delegate callbacks.
- </summary>
-
- <remarks>
- This method must be called by the client application to maintain thread safety, in conjunction with the ThreadSafeMode property being set to <c>true</c>.<br/>
- Typically this method is called in Unity's MonoBehavior.Update method.
- </remarks>
-
- <example>
- <code>
- void FixedUpdate() {
- sfs.ProcessEvents();
- }
- </code>
- </example>
-
- <seealso cref="P:Sfs2X.SmartFox.ThreadSafeMode"/>
- </member>
- <member name="M:Sfs2X.SmartFox.AddEventListener(System.String,Sfs2X.Core.EventListenerDelegate)">
- <summary>
- Adds a delegate to a given API event type that will be used for callbacks.
- </summary>
-
- <param name="eventType">The name of the <see cref="T:Sfs2X.Core.SFSEvent"/> to get callbacks on.</param>
- <param name="listener">The delegate method to register.</param>
-
- <example>
- <code>
- void SomeMethod() {
- sfs.AddEventListener(SFSEvent.CONNECTION, OnConnection);
- }
-
- public void OnConnection(BaseEvent evt) {
- bool success = (bool)evt.Params["success"];
- string error = (string)evt.Params["error"];
- Debug.Log("On Connection callback got: " + success + " (error : " + error + ")");
- }
- </code>
- </example>
-
- <seealso cref="T:Sfs2X.Core.SFSEvent"/>
- <seealso cref="M:Sfs2X.SmartFox.RemoveEventListener(System.String,Sfs2X.Core.EventListenerDelegate)"/>
- </member>
- <member name="M:Sfs2X.SmartFox.RemoveEventListener(System.String,Sfs2X.Core.EventListenerDelegate)">
- <summary>
- Removes a delegate registration for a given API event.
- </summary>
-
- <param name="eventType">The SFSEvent to remove callbacks on.</param>
- <param name="listener">The delegate method to unregister.</param>
-
- <seealso cref="M:Sfs2X.SmartFox.RemoveAllEventListeners"/>
- <seealso cref="M:Sfs2X.SmartFox.AddEventListener(System.String,Sfs2X.Core.EventListenerDelegate)"/>
- </member>
- <member name="M:Sfs2X.SmartFox.RemoveAllEventListeners">
- <summary>
- Removes all event listeners.
- </summary>
-
- <remarks>
- Please note that log delegates need to be removed separately using the <see cref="M:Sfs2X.SmartFox.RemoveEventListener(System.String,Sfs2X.Core.EventListenerDelegate)"/> method.
- </remarks>
-
- <seealso cref="M:Sfs2X.SmartFox.RemoveEventListener(System.String,Sfs2X.Core.EventListenerDelegate)"/>
- </member>
- <member name="T:Sfs2X.Controllers.ExtensionController">
- @private
- </member>
- <member name="T:Sfs2X.Controllers.SystemController">
- @private
- </member>
- <member name="T:Sfs2X.Core.BaseEvent">
- <summary>
- This is the base class of all the events dispatched by the SmartFoxServer 2X C# API.
- </summary>
-
- <seealso cref="T:Sfs2X.Core.SFSEvent"/>
- <seealso cref="T:Sfs2X.Core.SFSBuddyEvent"/>
- </member>
- <member name="F:Sfs2X.Core.BaseEvent.arguments">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Core.BaseEvent.type">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Core.BaseEvent.target">
- <exclude/>
- </member>
- <member name="P:Sfs2X.Core.BaseEvent.Type">
- <exclude/>
- </member>
- <member name="P:Sfs2X.Core.BaseEvent.Params">
- <summary>
- An Dictionary (Windows Universal) or Hashtable (all other platforms) containing the event's parameters.
- </summary>
- </member>
- <member name="P:Sfs2X.Core.BaseEvent.Target">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Core.BaseEvent.ToString">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Core.BaseEvent.Clone">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Core.BaseEvent.#ctor(System.String)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Core.BaseEvent.#ctor(System.String,System.Collections.Hashtable)">
- <exclude/>
- </member>
- <member name="T:Sfs2X.Core.EventListenerDelegate">
- <exclude/>
- </member>
- <member name="T:Sfs2X.Core.EventDispatcher">
- <exclude/>
- </member>
- <member name="T:Sfs2X.Core.SFSBuddyEvent">
- <summary>
- This class represents all the events related to the Buddy List system dispatched by the SmartFoxServer 2X C# API.
- </summary>
-
- <seealso cref="M:Sfs2X.SmartFox.AddEventListener(System.String,Sfs2X.Core.EventListenerDelegate)"/>
- </member>
- <member name="F:Sfs2X.Core.SFSBuddyEvent.BUDDY_LIST_INIT">
- <summary>
- Dispatched if the Buddy List system is successfully initialized.
- </summary>
-
- <remarks>
- This event is fired in response to the <see cref="T:Sfs2X.Requests.Buddylist.InitBuddyListRequest"/> request in case the operation is executed successfully.
- <para/>
- After the Buddy List system initialization, the user returns to his previous custom state (if any - see <see cref="P:Sfs2X.Entities.Managers.IBuddyManager.MyState">IBuddyManager.MyState</see> property).
- His online/offline state, his nickname and his persistent Buddy Variables are all loaded and broadcast in the system.
- In particular, the online state (see <see cref="P:Sfs2X.Entities.Managers.IBuddyManager.MyOnlineState">IBuddyManager.MyOnlineState</see> property) determines if the user will appear online or not to other users who have him in their buddies list.
- <para/>
- The <see cref="P:Sfs2X.Core.BaseEvent.Params"/> object contains the following parameters:
- <list type="table">
- <listheader>
- <term>Parameter</term>
- <description>Description</description>
- </listheader>
- <item>
- <term>buddyList</term>
- <description>(<b>List<<see cref="T:Sfs2X.Entities.Buddy"/>></b>) A list of objects representing all the buddies in the current user's buddies list.</description>
- </item>
- <item>
- <term>myVariables</term>
- <description>(<b>List<<see cref="T:Sfs2X.Entities.Variables.BuddyVariable"/>></b>) The list of all <see cref="T:Sfs2X.Entities.Variables.BuddyVariable"/> objects associated with the current user.</description>
- </item>
- </list>
- </remarks>
-
- <example>See the <see cref="T:Sfs2X.Requests.Buddylist.InitBuddyListRequest"/> example.</example>
-
- <seealso cref="T:Sfs2X.Entities.Buddy"/>
- <seealso cref="T:Sfs2X.Entities.Variables.BuddyVariable"/>
- <seealso cref="T:Sfs2X.Requests.Buddylist.InitBuddyListRequest"/>
- </member>
- <member name="F:Sfs2X.Core.SFSBuddyEvent.BUDDY_ADD">
- <summary>
- Dispatched when a buddy is added successfully to the current user's buddies list.
- </summary>
-
- <remarks>
- This event is fired in response to the <see cref="T:Sfs2X.Requests.Buddylist.AddBuddyRequest"/> request in case the operation is executed successfully.
- <para/>
- The <see cref="P:Sfs2X.Core.BaseEvent.Params"/> object contains the following parameters:
- <list type="table">
- <listheader>
- <term>Parameter</term>
- <description>Description</description>
- </listheader>
- <item>
- <term>buddy</term>
- <description>(<b><see cref="T:Sfs2X.Entities.Buddy"/></b>) The object corresponding to the buddy that was added.</description>
- </item>
- </list>
- </remarks>
-
- <example>See the <see cref="T:Sfs2X.Requests.Buddylist.AddBuddyRequest"/> example.</example>
-
- <seealso cref="T:Sfs2X.Entities.SFSBuddy"/>
- <seealso cref="T:Sfs2X.Requests.Buddylist.AddBuddyRequest"/>
- </member>
- <member name="F:Sfs2X.Core.SFSBuddyEvent.BUDDY_REMOVE">
- <summary>
- Dispatched when a buddy is removed successfully from the current user's buddies list.
- </summary>
-
- <remarks>
- This event is fired in response to the <see cref="T:Sfs2X.Requests.Buddylist.RemoveBuddyRequest"/> request in case the operation is executed successfully.
- <para/>
- The <see cref="P:Sfs2X.Core.BaseEvent.Params"/> object contains the following parameters:
- <list type="table">
- <listheader>
- <term>Parameter</term>
- <description>Description</description>
- </listheader>
- <item>
- <term>buddy</term>
- <description>(<b><see cref="T:Sfs2X.Entities.Buddy"/></b>) The object corresponding to the buddy that was removed.</description>
- </item>
- </list>
- </remarks>
-
- <example>See the <see cref="T:Sfs2X.Requests.Buddylist.RemoveBuddyRequest"/> example.</example>
-
- <seealso cref="T:Sfs2X.Entities.Buddy"/>
- <seealso cref="T:Sfs2X.Requests.Buddylist.RemoveBuddyRequest"/>
- </member>
- <member name="F:Sfs2X.Core.SFSBuddyEvent.BUDDY_BLOCK">
- <summary>
- Dispatched when a buddy is blocked or unblocked successfully by the current user.
- </summary>
-
- <remarks>
- This event is fired in response to the <see cref="T:Sfs2X.Requests.Buddylist.BlockBuddyRequest"/> request in case the operation is executed successfully.
- <para/>
- The <see cref="P:Sfs2X.Core.BaseEvent.Params"/> object contains the following parameters:
- <list type="table">
- <listheader>
- <term>Parameter</term>
- <description>Description</description>
- </listheader>
- <item>
- <term>buddy</term>
- <description>(<b><see cref="T:Sfs2X.Entities.Buddy"/></b>) The object corresponding to the buddy that was blocked/unblocked.</description>
- </item>
- </list>
- </remarks>
-
- <example>See the <see cref="T:Sfs2X.Requests.Buddylist.BlockBuddyRequest"/> example.</example>
-
- <seealso cref="T:Sfs2X.Entities.Buddy"/>
- <seealso cref="T:Sfs2X.Requests.Buddylist.BlockBuddyRequest"/>
- </member>
- <member name="F:Sfs2X.Core.SFSBuddyEvent.BUDDY_ERROR">
- <summary>
- Dispatched if an error occurs while executing a request related to the Buddy List system.
- </summary>
-
- <remarks>
- For example, this event is fired in response to the <see cref="T:Sfs2X.Requests.Buddylist.AddBuddyRequest"/> request, the <see cref="T:Sfs2X.Requests.Buddylist.BlockBuddyRequest"/>, etc.
- <para/>
- The <see cref="P:Sfs2X.Core.BaseEvent.Params"/> object contains the following parameters:
- <list type="table">
- <listheader>
- <term>Parameter</term>
- <description>Description</description>
- </listheader>
- <item>
- <term>errorMessage</term>
- <description>(<b>string</b>) The message which describes the error.</description>
- </item>
- <item>
- <term>errorCode</term>
- <description>(<b>short</b>) The error code.</description>
- </item>
- </list>
- </remarks>
-
- <example>See the <see cref="T:Sfs2X.Requests.Buddylist.InitBuddyListRequest"/> example.</example>
- </member>
- <member name="F:Sfs2X.Core.SFSBuddyEvent.BUDDY_ONLINE_STATE_UPDATE">
- <summary>
- Dispatched when a buddy in the current user's buddies list changes his online state in the Buddy List system.
- </summary>
-
- <remarks>
- This event is fired in response to the <see cref="T:Sfs2X.Requests.Buddylist.GoOnlineRequest"/> request to those who have the user as a buddy, but also to the user himself.
- As in this case the value of the <em>buddy</em> parameter is <c>null</c> (because the user is not buddy to himself of course),
- the <em>isItMe</em> parameter should be used to check if the current user is the one who changed his own online state.
- <para/>
- The <see cref="P:Sfs2X.Core.BaseEvent.Params"/> object contains the following parameters:
- <list type="table">
- <listheader>
- <term>Parameter</term>
- <description>Description</description>
- </listheader>
- <item>
- <term>buddy</term>
- <description>(<b><see cref="T:Sfs2X.Entities.Buddy"/></b>) The object representing the buddy who changed his own online state. If the <em>isItMe</em> parameter is <c>true</c>, the value of this parameter is <c>null</c> (because a user is not buddy to himself).</description>
- </item>
- <item>
- <term>isItMe</term>
- <description>(<b>bool</b>) <c>true</c> if the online state was changed by the current user himself (in this case this event is a sort of state change confirmation).</description>
- </item>
- </list>
- </remarks>
-
- <example>See the <see cref="T:Sfs2X.Requests.Buddylist.GoOnlineRequest"/> example.</example>
-
- <seealso cref="T:Sfs2X.Entities.Buddy"/>
- <seealso cref="T:Sfs2X.Requests.Buddylist.GoOnlineRequest"/>
- </member>
- <member name="F:Sfs2X.Core.SFSBuddyEvent.BUDDY_VARIABLES_UPDATE">
- <summary>
- Dispatched when a buddy in the current user's buddies list updates one or more Buddy Variables.
- </summary>
-
- <remarks>
- This event is fired in response to the <see cref="T:Sfs2X.Requests.Buddylist.SetBuddyVariablesRequest"/> request to those who have the user as a buddy, but also to the user himself.
- As in this case the value of the <em>buddy</em> parameter is <c>null</c> (because the user is not buddy to himself of course),
- the <em>isItMe</em> parameter should be used to check if the current user is the one who updated his own Buddy Variables.
- <para/>
- The <see cref="P:Sfs2X.Core.BaseEvent.Params"/> object contains the following parameters:
- <list type="table">
- <listheader>
- <term>Parameter</term>
- <description>Description</description>
- </listheader>
- <item>
- <term>buddy</term>
- <description>(<b><see cref="T:Sfs2X.Entities.Buddy"/></b>) The object representing the buddy who updated his own Buddy Variables. If the <em>isItMe</em> parameter is <c>true</c>, the value of this parameter is <c>null</c> (because a user is not buddy to himself).</description>
- </item>
- <item>
- <term>changedVars</term>
- <description>(<b>IList<string></b>) The list of names of the Buddy Variables that were changed (or created for the first time).</description>
- </item>
- <item>
- <term>isItMe</term>
- <description>(<b>bool</b>) <c>true</c> if the Buddy Variables were updated by the current user himself (in this case this event is a sort of update confirmation).</description>
- </item>
- </list>
- </remarks>
-
- <example>See the <see cref="T:Sfs2X.Requests.Buddylist.SetBuddyVariablesRequest"/> example.</example>
-
- <seealso cref="T:Sfs2X.Entities.Buddy"/>
- <seealso cref="T:Sfs2X.Requests.Buddylist.SetBuddyVariablesRequest"/>
- </member>
- <member name="F:Sfs2X.Core.SFSBuddyEvent.BUDDY_MESSAGE">
- <summary>
- Dispatched when a message from a buddy is received by the current user.
- </summary>
-
- <remarks>
- This event is fired in response to the <see cref="T:Sfs2X.Requests.Buddylist.BuddyMessageRequest"/> request.
- <para/>
- The same event is fired by the sender's client too, so that the user is aware that the message was delivered successfully to the recipient, and it can be displayed in the chat area keeping the correct message ordering.
- As in this case the value of the buddy parameter is <c>null</c> (because, being the sender, the user is not buddy to himself of course), there is no default way to know who the message was originally sent to.
- As this information can be useful in scenarios where the sender is chatting with more than one buddy at the same time in separate windows or tabs (and we need to write his own message in the proper one),
- the data parameter can be used to store, for example, the id of the recipient buddy.
- <para/>
- The <see cref="P:Sfs2X.Core.BaseEvent.Params"/> object contains the following parameters:
- <list type="table">
- <listheader>
- <term>Parameter</term>
- <description>Description</description>
- </listheader>
- <item>
- <term>buddy</term>
- <description>(<b><see cref="T:Sfs2X.Entities.Buddy"/></b>) The object representing the message sender. If the <em>isItMe</em> parameter is <c>true</c>, the value of this parameter is <c>null</c> (because a user is not buddy to himself).</description>
- </item>
- <item>
- <term>isItMe</term>
- <description>(<b>bool</b>) <c>true</c> if the message sender is the current user himself (in this case this event is a sort of message delivery confirmation).</description>
- </item>
- <item>
- <term>message</term>
- <description>(<b>string</b>) The message text.</description>
- </item>
- <item>
- <term>data</term>
- <description>(<b><see cref="T:Sfs2X.Entities.Data.ISFSObject"/></b>) An object containing additional custom parameters (e.g. the message color, an emoticon id, etc).</description>
- </item>
- </list>
- </remarks>
-
- <example>See the <see cref="T:Sfs2X.Requests.Buddylist.BuddyMessageRequest"/> example.</example>
-
- <seealso cref="T:Sfs2X.Entities.SFSBuddy"/>
- <seealso cref="T:Sfs2X.Requests.Buddylist.BuddyMessageRequest"/>
- </member>
- <member name="M:Sfs2X.Core.SFSBuddyEvent.#ctor(System.String)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Core.SFSBuddyEvent.#ctor(System.String,System.Collections.Hashtable)">
- <exclude/>
- </member>
- <member name="T:Sfs2X.Core.SFSEvent">
- <summary>
- This class represents most of the events dispatched by the SmartFoxServer 2X C# API.
- </summary>
-
- <seealso cref="M:Sfs2X.SmartFox.AddEventListener(System.String,Sfs2X.Core.EventListenerDelegate)"/>
- <seealso cref="T:Sfs2X.Core.SFSBuddyEvent"/>
- </member>
- <member name="F:Sfs2X.Core.SFSEvent.HANDSHAKE">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Core.SFSEvent.UDP_INIT">
- <summary>
- Dispatched when the result of the UDP handshake is notified.
- </summary>
-
- <remarks>
- This event is fired in response to a call to the <see cref="M:Sfs2X.SmartFox.InitUDP(System.String,System.Int32)">SmartFox.InitUDP()</see> method.
- <para/>
- The <see cref="P:Sfs2X.Core.BaseEvent.Params"/> object contains the following parameters:
- <list type="table">
- <listheader>
- <term>Parameter</term>
- <description>Description</description>
- </listheader>
- <item>
- <term>success</term>
- <description>(<b>bool</b>) <c>true</c> if UDP connection initialization is successful, <c>false</c> otherwise.</description>
- </item>
- </list>
- </remarks>
-
- <example>See the <see cref="M:Sfs2X.SmartFox.InitUDP(System.String,System.Int32)"/> example.</example>
-
- <seealso cref="M:Sfs2X.SmartFox.InitUDP(System.String,System.Int32)"/>
- </member>
- <member name="F:Sfs2X.Core.SFSEvent.CONNECTION">
- <summary>
- Dispatched when a connection between the client and a SmartFoxServer 2X instance is attempted.
- </summary>
-
- <remarks>
- This event is fired in response to a call to the <see cref="M:Sfs2X.SmartFox.Connect(System.String,System.Int32)"/> method.
- <para/>
- The <see cref="P:Sfs2X.Core.BaseEvent.Params"/> object contains the following parameters:
- <list type="table">
- <listheader>
- <term>Parameter</term>
- <description>Description</description>
- </listheader>
- <item>
- <term>success</term>
- <description>(<b>bool</b>) The connection result: <c>true</c> if a connection was established, <c>false</c> otherwise.</description>
- </item>
- </list>
- </remarks>
-
- <example>See the <see cref="M:Sfs2X.SmartFox.Connect(System.String,System.Int32)"/> example.</example>
-
- <seealso cref="F:Sfs2X.Core.SFSEvent.CONNECTION_RETRY"/>
- <seealso cref="F:Sfs2X.Core.SFSEvent.CONNECTION_RESUME"/>
- <seealso cref="F:Sfs2X.Core.SFSEvent.CONNECTION_LOST"/>
- </member>
- <member name="F:Sfs2X.Core.SFSEvent.PING_PONG">
- <summary>
- Dispatched when a new lag value measurement is available.
- </summary>
-
- <remarks>
- This event is fired when the automatic lag monitoring is turned on by passing true to the <see cref="M:Sfs2X.SmartFox.EnableLagMonitor(System.Boolean,System.Int32,System.Int32)">SmartFox.EnableLagMonitor</see> method.
- <para/>
- The <see cref="P:Sfs2X.Core.BaseEvent.Params"/> object contains the following parameters:
- <list type="table">
- <listheader>
- <term>Parameter</term>
- <description>Description</description>
- </listheader>
- <item>
- <term>lagValue</term>
- <description>(<b>int</b>) The average of the last ten measured lag values, expressed in milliseconds.</description>
- </item>
- </list>
- </remarks>
-
- <seealso cref="M:Sfs2X.SmartFox.EnableLagMonitor(System.Boolean,System.Int32,System.Int32)"/>
- </member>
- <member name="F:Sfs2X.Core.SFSEvent.SOCKET_ERROR">
- <summary>
- Dispatched when a low level socket error is detected, for example bad/inconsistent data.
- </summary>
-
- <remarks>
- The <see cref="P:Sfs2X.Core.BaseEvent.Params"/> object contains the following parameters:
- <list type="table">
- <listheader>
- <term>Parameter</term>
- <description>Description</description>
- </listheader>
- <item>
- <term>errorMessage</term>
- <description>(<b>string</b>) The description of the error.</description>
- </item>
- </list>
- </remarks>
- </member>
- <member name="F:Sfs2X.Core.SFSEvent.CONNECTION_LOST">
- <summary>
- Dispatched when the connection between the client and the SmartFoxServer 2X instance is interrupted.
- </summary>
-
- <remarks>
- This event is fired in response to a call to the <see cref="M:Sfs2X.SmartFox.Disconnect"/> method or when the connection between the client and the server is interrupted for other reasons.
- <para/>
- The <see cref="P:Sfs2X.Core.BaseEvent.Params"/> object contains the following parameters.
- <list type="table">
- <listheader>
- <term>Parameter</term>
- <description>Description</description>
- </listheader>
- <item>
- <term>reason</term>
- <description>(<b>string</b>) The reason of the disconnection, among those available in the <see cref="T:Sfs2X.Util.ClientDisconnectionReason"/> class.</description>
- </item>
- </list>
- </remarks>
-
- <example>
- The following example handles a disconnection event:
- <code>
- void SomeMethod() {
- sfs.AddEventListener(SFSEvent.OnConnectionLost, OnConnectionLost);
- }
-
- void OnConnectionLost(BaseEvent evt) {
- Console.WriteLine("Connection was lost, Reason: " + (string)evt.Params["reason"]); // .Net / Unity
- System.Diagnostics.Debug.WriteLine("Connection was lost, Reason: " + (string)evt.Params["reason"]); // Windows Universal
- }
- </code>
- </example>
-
- <seealso cref="T:Sfs2X.Util.ClientDisconnectionReason"/>
- <seealso cref="F:Sfs2X.Core.SFSEvent.CONNECTION_RETRY"/>
- <seealso cref="F:Sfs2X.Core.SFSEvent.CONNECTION_RESUME"/>
- <seealso cref="F:Sfs2X.Core.SFSEvent.CONNECTION"/>
- </member>
- <member name="F:Sfs2X.Core.SFSEvent.CONNECTION_RETRY">
- <summary>
- Dispatched when the connection between the client and the SmartFoxServer 2X instance is interrupted abruptly while the SmartFoxServer 2X HRC system is available in the Zone.
- </summary>
-
- <remarks>
- The HRC system allows a broken connection to be re-established transparently within a certain amount of time, without losing any of the current application state.
- For example this allows any player to get back to a game without loosing the match because of a sloppy internet connection.<br/>
- When this event is dispatched the API enter a "freeze" mode where no new requests can be sent until the reconnection is successfully performed.
- It is highly recommended to handle this event and freeze the application interface accordingly until the <see cref="F:Sfs2X.Core.SFSEvent.CONNECTION_RESUME"/> event is fired,
- or the reconnection fails and the user is definitely disconnected and the <see cref="F:Sfs2X.Core.SFSEvent.CONNECTION_LOST"/> event is fired.
- <para/>
- No parameters are available for this event object.
- </remarks>
-
- <example>
- The following example shows how to handle a reconnection
- <code>
- void SomeMethod() {
- sfs.AddEventListener(SFSEvent.CONNECTION_RETRY, OnConnectionRetry);
- sfs.AddEventListener(SFSEvent.CONNECTION_RESUME, OnConnectionResume);
- sfs.AddEventListener(SFSEvent.CONNECTION_LOST, OnConnectionLost);
- }
-
- void OnConnectionRetry(BaseEvent evt) {
- // Freeze your GUI and provide some feedback to the Player
- ...
- }
-
- void OnConnectionResume(BaseEvent evt) {
- // Unfreeze the GUI and let the player continue with the game
- ...
- }
-
- void OnConnectionLost(BaseEvent evt) {
- Console.WriteLine("Ouch, connection was lost! Reason: " + (string)evt.Params["reason"]); // .Net / Unity
- System.Diagnostics.Debug.WriteLine("Ouch, connection was lost! Reason: " + (string)evt.Params["reason"]); // Windows Universal
- }
- </code>
- </example>
-
- <seealso cref="F:Sfs2X.Core.SFSEvent.CONNECTION_LOST"/>
- <seealso cref="F:Sfs2X.Core.SFSEvent.CONNECTION_RESUME"/>
- </member>
- <member name="F:Sfs2X.Core.SFSEvent.CONNECTION_RESUME">
- <summary>
- Dispatched when the connection between the client and the SmartFoxServer 2X instance is re-established after a temporary disconnection,
- while the SmartFoxServer 2X HRC system is available in the Zone.
- </summary>
-
- <remarks>
- The HRC system allows a broken connection to be re-established transparently within a certain amount of time, without losing any of the current application state.
- For example this allows any player to get back to a game without loosing the match because of a sloppy internet connection.<br/>
- When this event is dispatched the application interface should be reverted to the state it had before the disconnection.
- In case the reconnection attempt fails, the <see cref="F:Sfs2X.Core.SFSEvent.CONNECTION_LOST"/> event is fired.
- <para/>
- No parameters are available for this event object.
- </remarks>
-
- <example>See the <see cref="F:Sfs2X.Core.SFSEvent.CONNECTION_RETRY"/> example.</example>
-
- <seealso cref="F:Sfs2X.Core.SFSEvent.CONNECTION_LOST"/>
- <seealso cref="F:Sfs2X.Core.SFSEvent.CONNECTION_RETRY"/>
- </member>
- <member name="F:Sfs2X.Core.SFSEvent.CONNECTION_ATTEMPT_HTTP">
- <summary>
- Dispatched when the client cannot establish a socket connection to the server and the useBlueBox parameter is active in the configuration.
- </summary>
-
- <remarks>
- The event can be used to notify the user that a second connection attempt is running, using the BlueBox (HTTP tunnelling).
- <para/>
- No parameters are available for this event object.
- </remarks>
-
- <seealso cref="F:Sfs2X.Core.SFSEvent.CONNECTION"/>
- <seealso cref="F:Sfs2X.Core.SFSEvent.CONNECTION_LOST"/>
- </member>
- <member name="F:Sfs2X.Core.SFSEvent.CONFIG_LOAD_SUCCESS">
- <summary>
- Dispatched when the external client configuration file is loaded successfully.
- </summary>
-
- <remarks>
- This event is fired in response to a call to the <see cref="M:Sfs2X.SmartFox.LoadConfig(System.String,System.Boolean)"/> method, but only if the <em>connectOnSuccess</em> argument of that method is set to <c>false</c>;
- otherwise the connection is attempted and the related <see cref="F:Sfs2X.Core.SFSEvent.CONNECTION"/> event type is fired.
- <para/>
- No parameters are available for this event object.
- </remarks>
-
- <example>See the <see cref="M:Sfs2X.SmartFox.LoadConfig(System.String,System.Boolean)"/> example.</example>
-
- <seealso cref="F:Sfs2X.Core.SFSEvent.CONFIG_LOAD_FAILURE"/>
- <seealso cref="M:Sfs2X.SmartFox.LoadConfig(System.String,System.Boolean)"/>
- </member>
- <member name="F:Sfs2X.Core.SFSEvent.CONFIG_LOAD_FAILURE">
- <summary>
- Dispatched when an error occurs while loading the external SmartFox configuration file.
- </summary>
-
- <remarks>
- This event is fired in response to a call to the <see cref="M:Sfs2X.SmartFox.LoadConfig(System.String,System.Boolean)"/> method, typically when the configuration file is not found or it isn't accessible (no read permissions).
- <para/>
- No parameters are available for this event object.
- </remarks>
-
- <example>See the <see cref="M:Sfs2X.SmartFox.LoadConfig(System.String,System.Boolean)"/> example.</example>
-
- <seealso cref="F:Sfs2X.Core.SFSEvent.CONFIG_LOAD_SUCCESS"/>
- <seealso cref="M:Sfs2X.SmartFox.LoadConfig(System.String,System.Boolean)"/>
- </member>
- <member name="F:Sfs2X.Core.SFSEvent.LOGIN">
- <summary>
- Dispatched when the current user performs a successful login in a server Zone.
- </summary>
-
- <remarks>
- This event is fired in response to the <see cref="T:Sfs2X.Requests.LoginRequest"/> request.
- <para/>
- The <see cref="P:Sfs2X.Core.BaseEvent.Params"/> object contains the following parameters:
- <list type="table">
- <listheader>
- <term>Parameter</term>
- <description>Description</description>
- </listheader>
- <item>
- <term>user</term>
- <description>(<b><see cref="T:Sfs2X.Entities.User"/></b>) An object representing the user who performed the login.</description>
- </item>
- <item>
- <term>data</term>
- <description>(<b><see cref="T:Sfs2X.Entities.Data.ISFSObject"/></b>) An object containing custom parameters returned by a custom login system, if any.</description>
- </item>
- </list>
- </remarks>
-
- <example>See the <see cref="T:Sfs2X.Requests.LoginRequest"/> example.</example>
-
- <seealso cref="T:Sfs2X.Requests.LoginRequest"/>
- <seealso cref="F:Sfs2X.Core.SFSEvent.LOGIN_ERROR"/>
- </member>
- <member name="F:Sfs2X.Core.SFSEvent.LOGIN_ERROR">
- <summary>
- Dispatched if an error occurs while the user login is being performed.
- </summary>
-
- <remarks>
- This event is fired in response to the <see cref="T:Sfs2X.Requests.LoginRequest"/> request in case the operation failed.
- <para/>
- The <see cref="P:Sfs2X.Core.BaseEvent.Params"/> object contains the following parameters:
- <list type="table">
- <listheader>
- <term>Parameter</term>
- <description>Description</description>
- </listheader>
- <item>
- <term>errorMessage</term>
- <description>(<b>string</b>) A message containing the description of the error.</description>
- </item>
- <item>
- <term>errorCode</term>
- <description>(<b>short</b>) The error code.</description>
- </item>
- </list>
- </remarks>
-
- <example>See the <see cref="T:Sfs2X.Requests.LoginRequest"/> example.</example>
-
- <seealso cref="F:Sfs2X.Core.SFSEvent.LOGIN"/>
- <seealso cref="T:Sfs2X.Requests.LoginRequest"/>
- </member>
- <member name="F:Sfs2X.Core.SFSEvent.LOGOUT">
- <summary>
- Dispatched when the current user performs logs out of the server Zone.
- </summary>
-
- <remarks>
- This event is fired in response to the <see cref="T:Sfs2X.Requests.LogoutRequest"/> request.
- <para/>
- No parameters are available for this event object.
- </remarks>
-
- <example>See the <see cref="T:Sfs2X.Requests.LogoutRequest"/> example.</example>
-
- <seealso cref="T:Sfs2X.Requests.LogoutRequest"/>
- </member>
- <member name="F:Sfs2X.Core.SFSEvent.ROOM_ADD">
- <summary>
- Dispatched when a new Room is created inside the Zone under any of the Room Groups that the client subscribed.
- </summary>
-
- <remarks>
- This event is fired in response to the <see cref="T:Sfs2X.Requests.CreateRoomRequest"/> and <see cref="T:Sfs2X.Requests.Game.CreateSFSGameRequest"/> requests in case the operation is executed successfully.
- <para/>
- The <see cref="P:Sfs2X.Core.BaseEvent.Params"/> object contains the following parameters:
- <list type="table">
- <listheader>
- <term>Parameter</term>
- <description>Description</description>
- </listheader>
- <item>
- <term>room</term>
- <description>(<b><see cref="T:Sfs2X.Entities.Room"/></b>) An object representing the Room that was created.</description>
- </item>
- </list>
- </remarks>
-
- <example>See the <see cref="T:Sfs2X.Requests.CreateRoomRequest"/> example.</example>
-
- <seealso cref="F:Sfs2X.Core.SFSEvent.ROOM_CREATION_ERROR"/>
- <seealso cref="T:Sfs2X.Requests.CreateRoomRequest"/>
- <seealso cref="T:Sfs2X.Requests.Game.CreateSFSGameRequest"/>
- </member>
- <member name="F:Sfs2X.Core.SFSEvent.ROOM_REMOVE">
- <summary>
- Dispatched when a Room belonging to one of the Groups subscribed by the client is removed from the Zone.
- </summary>
-
- <remarks>
- The <see cref="P:Sfs2X.Core.BaseEvent.Params"/> object contains the following parameters:
- <list type="table">
- <listheader>
- <term>Parameter</term>
- <description>Description</description>
- </listheader>
- <item>
- <term>room</term>
- <description>(<b><see cref="T:Sfs2X.Entities.Room"/></b>) An object representing the Room that was removed.</description>
- </item>
- </list>
- </remarks>
- </member>
- <member name="F:Sfs2X.Core.SFSEvent.ROOM_CREATION_ERROR">
- <summary>
- Dispatched if an error occurs while creating a new Room.
- </summary>
-
- <remarks>
- This event is fired in response to the <see cref="T:Sfs2X.Requests.CreateRoomRequest"/> and <see cref="T:Sfs2X.Requests.Game.CreateSFSGameRequest"/> requests in case the operation failed.
- <para/>
- The <see cref="P:Sfs2X.Core.BaseEvent.Params"/> object contains the following parameters:
- <list type="table">
- <listheader>
- <term>Parameter</term>
- <description>Description</description>
- </listheader>
- <item>
- <term>errorMessage</term>
- <description>(<b>string</b>) A message containing the description of the error.</description>
- </item>
- <item>
- <term>errorCode</term>
- <description>(<b>short</b>) The error code.</description>
- </item>
- </list>
- </remarks>
-
- <example>See the <see cref="T:Sfs2X.Requests.CreateRoomRequest"/> example.</example>
-
- <seealso cref="F:Sfs2X.Core.SFSEvent.ROOM_ADD"/>
- <seealso cref="T:Sfs2X.Requests.CreateRoomRequest"/>
- <seealso cref="T:Sfs2X.Requests.Game.CreateSFSGameRequest"/>
- </member>
- <member name="F:Sfs2X.Core.SFSEvent.ROOM_JOIN">
- <summary>
- Dispatched when a Room is joined by the current user.
- </summary>
-
- <remarks>
- This event is fired in response to the <see cref="T:Sfs2X.Requests.JoinRoomRequest"/> and <see cref="T:Sfs2X.Requests.Game.QuickJoinGameRequest"/> requests in case the operation is executed successfully.
- <para/>
- The <see cref="P:Sfs2X.Core.BaseEvent.Params"/> object contains the following parameters:
- <list type="table">
- <listheader>
- <term>Parameter</term>
- <description>Description</description>
- </listheader>
- <item>
- <term>room</term>
- <description>(<b><see cref="T:Sfs2X.Entities.Room"/></b>) An object representing the Room that was joined.</description>
- </item>
- </list>
- </remarks>
-
- <example>See the <see cref="T:Sfs2X.Requests.JoinRoomRequest"/> example.</example>
-
- <seealso cref="F:Sfs2X.Core.SFSEvent.ROOM_JOIN_ERROR"/>
- <seealso cref="T:Sfs2X.Requests.JoinRoomRequest"/>
- <seealso cref="T:Sfs2X.Requests.Game.QuickJoinGameRequest"/>
- </member>
- <member name="F:Sfs2X.Core.SFSEvent.ROOM_JOIN_ERROR">
- <summary>
- Dispatched when an error occurs while the current user is trying to join a Room.
- </summary>
-
- <remarks>
- This event is fired in response to the <see cref="T:Sfs2X.Requests.JoinRoomRequest"/> request in case the operation failed.
- <para/>
- The <see cref="P:Sfs2X.Core.BaseEvent.Params"/> object contains the following parameters:
- <list type="table">
- <listheader>
- <term>Parameter</term>
- <description>Description</description>
- </listheader>
- <item>
- <term>errorMessage</term>
- <description>(<b>string</b>) A message containing the description of the error.</description>
- </item>
- <item>
- <term>errorCode</term>
- <description>(<b>short</b>) The error code.</description>
- </item>
- </list>
- </remarks>
-
- <example>See the <see cref="T:Sfs2X.Requests.JoinRoomRequest"/> example.</example>
-
- <seealso cref="F:Sfs2X.Core.SFSEvent.ROOM_JOIN"/>
- <seealso cref="T:Sfs2X.Requests.JoinRoomRequest"/>
- </member>
- <member name="F:Sfs2X.Core.SFSEvent.USER_ENTER_ROOM">
- <summary>
- Dispatched when one of the Rooms joined by the current user is entered by another user.
- </summary>
-
- <remarks>
- This event is caused by a <see cref="T:Sfs2X.Requests.JoinRoomRequest"/> request;
- it might be fired or not depending on the Room configuration defined upon its creation (see the <see cref="P:Sfs2X.Requests.RoomSettings.Events">RoomSettings.Events</see> setting).
- <para/>
- <b>NOTE</b>: if the Room is of type <see cref="T:Sfs2X.Entities.MMORoom">MMORoom</see>, this event is never fired and it is substituted by the <see cref="F:Sfs2X.Core.SFSEvent.PROXIMITY_LIST_UPDATE"/> event.
- <para/>
- The <see cref="P:Sfs2X.Core.BaseEvent.Params"/> object contains the following parameters:
- <list type="table">
- <listheader>
- <term>Parameter</term>
- <description>Description</description>
- </listheader>
- <item>
- <term>user</term>
- <description>(<b><see cref="T:Sfs2X.Entities.User"/></b>) An object representing the user who joined the Room.</description>
- </item>
- <item>
- <term>room</term>
- <description>(<b><see cref="T:Sfs2X.Entities.Room"/></b>) An object representing the Room that was joined by a user.</description>
- </item>
- </list>
- </remarks>
-
- <example>
- The following example shows how to handle this event type:
- <code>
- void SomeMethod() {
- sfs.AddEventListener(SFSEvent.USER_ENTER_ROOM, OnUserEnterRoom);
- }
-
- void OnUserEnterRoom(BaseEvent evt) {
- Room room = (Room)evt.Params["room"];
- User user = (User)evt.Params["user"];
-
- Console.WriteLine("User: " + user.Name + " has just joined Room: " + room.Name); // .Net / Unity
- System.Diagnostics.Debug.WriteLine("User: " + user.Name + " has just joined Room: " + room.Name); // Windows Universal
- }
- </code>
- </example>
-
- <seealso cref="F:Sfs2X.Core.SFSEvent.USER_EXIT_ROOM"/>
- <seealso cref="F:Sfs2X.Core.SFSEvent.ROOM_JOIN"/>
- <seealso cref="T:Sfs2X.Requests.JoinRoomRequest"/>
- </member>
- <member name="F:Sfs2X.Core.SFSEvent.USER_EXIT_ROOM">
- <summary>
- Dispatched when one of the Rooms joined by the current user is left by another user, or by the current user himself.
- </summary>
-
- <remarks>
- This event is caused by a <see cref="T:Sfs2X.Requests.LeaveRoomRequest"/> request;
- it might be fired or not depending on the Room configuration defined upon its creation (see the <see cref="P:Sfs2X.Requests.RoomSettings.Events">RoomSettings.Events</see> setting).
- <para/>
- <b>NOTE</b>: if the Room is of type <see cref="T:Sfs2X.Entities.MMORoom">MMORoom</see>, this event is never fired and it is substituted by the <see cref="F:Sfs2X.Core.SFSEvent.PROXIMITY_LIST_UPDATE"/> event.
- <para/>
- The <see cref="P:Sfs2X.Core.BaseEvent.Params"/> object contains the following parameters:
- <list type="table">
- <listheader>
- <term>Parameter</term>
- <description>Description</description>
- </listheader>
- <item>
- <term>user</term>
- <description>(<b><see cref="T:Sfs2X.Entities.User"/></b>) An object representing the user who left the Room.</description>
- </item>
- <item>
- <term>room</term>
- <description>(<b><see cref="T:Sfs2X.Entities.Room"/></b>) An object representing the Room that was left by the user.</description>
- </item>
- </list>
- </remarks>
-
- <example>
- The following example shows how to handle this event type:
- <code>
- void SomeMethod() {
- smartFox.AddEventListener(SFSEvent.USER_EXIT_ROOM, OnUserExitRoom);
- }
-
- void OnUserExitRoom(BaseEvent evt) {
- Room room = (Room)evt.Params["room"];
- User user = (User)evt.Params["user"];
-
- Console.WriteLine("User: " + user.Name + " has just left Room: " + room.Name); // .Net / Unity
- System.Diagnostics.Debug.WriteLine("User: " + user.Name + " has just left Room: " + room.Name); // Windows Universal
- }
- </code>
- </example>
-
- <seealso cref="F:Sfs2X.Core.SFSEvent.USER_ENTER_ROOM"/>
- <seealso cref="T:Sfs2X.Requests.LeaveRoomRequest"/>
- </member>
- <member name="F:Sfs2X.Core.SFSEvent.USER_COUNT_CHANGE">
- <summary>
- Dispatched when the number of users/players or spectators inside a Room changes.
- </summary>
-
- <remarks>
-
- This event is caused by a <see cref="T:Sfs2X.Requests.JoinRoomRequest"/> request or a <see cref="T:Sfs2X.Requests.LeaveRoomRequest"/> request.
- The Room must belong to one of the Groups subscribed by the current client; also this event might be fired or not depending on the
- Room configuration defined upon its creation (see the <see cref="P:Sfs2X.Requests.RoomSettings.Events">RoomSettings.Events</see> setting).
- <para/>
- The <see cref="P:Sfs2X.Core.BaseEvent.Params"/> object contains the following parameters:
- <list type="table">
- <listheader>
- <term>Parameter</term>
- <description>Description</description>
- </listheader>
- <item>
- <term>room</term>
- <description>(<b><see cref="T:Sfs2X.Entities.Room"/></b>) An object representing the Room in which the users count changed.</description>
- </item>
- <item>
- <term>uCount</term>
- <description>(<b>int</b>) The new users count (players in case of Game Room).</description>
- </item>
- <item>
- <term>sCount</term>
- <description>(<b>int</b>) The new spectators count (Game Rooms only).</description>
- </item>
- </list>
- </remarks>
-
- <example>
- The following example shows how to handle this event type:
- <code>
- void SomeMethod() {
- sfs.AddEventListener(SFSEvent.USER_COUNT_CHANGE, OnUserCountChange);
- }
-
- void OnUserCountChange(BaseEvent evt) {
- Room room = (Room)evt.Params["room"];
- int uCount = (int)evt.Params["uCount"];
- int sCount = (int)evt.Params["sCount"];
-
- Console.WriteLine("Room: " + room.Name + " contains " + uCount + " users and " + sCount + " spectators"); // .Net / Unity
- System.Diagnostics.Debug.WriteLine("Room: " + room.Name + " contains " + uCount + " users and " + sCount + " spectators"); // Windows Universal
- }
- </code>
- </example>
-
- <seealso cref="T:Sfs2X.Requests.JoinRoomRequest"/>
- <seealso cref="T:Sfs2X.Requests.LeaveRoomRequest"/>
- </member>
- <member name="F:Sfs2X.Core.SFSEvent.PUBLIC_MESSAGE">
- <summary>
- Dispatched when a public message is received by the current user.
- </summary>
-
- <remarks>
- This event is caused by a <see cref="T:Sfs2X.Requests.PublicMessageRequest"/> request sent by any user in the target Room, including the current user himself.
- <para/>
- The <see cref="P:Sfs2X.Core.BaseEvent.Params"/> object contains the following parameters:
- <list type="table">
- <listheader>
- <term>Parameter</term>
- <description>Description</description>
- </listheader>
- <item>
- <term>room</term>
- <description>(<b><see cref="T:Sfs2X.Entities.Room"/></b>) An object representing the Room at which the message is targeted.</description>
- </item>
- <item>
- <term>sender</term>
- <description>(<b><see cref="T:Sfs2X.Entities.User"/></b>) An object representing the user who sent the message.</description>
- </item>
- <item>
- <term>message</term>
- <description>(<b>string</b>) The message sent by the user.</description>
- </item>
- <item>
- <term>data</term>
- <description>(<b><see cref="T:Sfs2X.Entities.Data.ISFSObject"/></b>) An object containing custom parameters which might accompany the message.</description>
- </item>
- </list>
- </remarks>
-
- <example>See the <see cref="T:Sfs2X.Requests.PublicMessageRequest"/> example.</example>
-
- <seealso cref="T:Sfs2X.Requests.PublicMessageRequest"/>
- </member>
- <member name="F:Sfs2X.Core.SFSEvent.PRIVATE_MESSAGE">
- <summary>
- Dispatched when a private message is received by the current user.
- </summary>
-
- <remarks>
- This event is caused by a PrivateMessageRequest request sent by any user in the Zone.
- <para/>
- The same event is fired by the sender's client too, so that the user is aware that the message was delivered successfully to the recipient,
- and it can be displayed in the private chat area keeping the correct message ordering.
- In this case there is no default way to know who the message was originally sent to.
- As this information can be useful in scenarios where the sender is chatting privately with more than one user at the same time in separate windows or tabs
- (and we need to write his own message in the proper one), the data parameter can be used to store, for example, the id of the recipient user.
- <para/>
- The <see cref="P:Sfs2X.Core.BaseEvent.Params"/> object contains the following parameters:
- <list type="table">
- <listheader>
- <term>Parameter</term>
- <description>Description</description>
- </listheader>
- <item>
- <term>sender</term>
- <description>(<b><see cref="T:Sfs2X.Entities.User"/></b>) An object representing the user who sent the message.</description>
- </item>
- <item>
- <term>message</term>
- <description>(<b>string</b>) The message sent by the user.</description>
- </item>
- <item>
- <term>data</term>
- <description>(<b><see cref="T:Sfs2X.Entities.Data.ISFSObject"/></b>) An object containing custom parameters which might accompany the message.</description>
- </item>
- </list>
- </remarks>
-
- <example>See the <see cref="T:Sfs2X.Requests.PrivateMessageRequest"/> example.</example>
-
- <seealso cref="T:Sfs2X.Requests.PrivateMessageRequest"/>
- </member>
- <member name="F:Sfs2X.Core.SFSEvent.MODERATOR_MESSAGE">
- <summary>
- Dispatched when the current user receives a message from a moderator user.
- </summary>
-
- <remarks>
- This event can be caused by the <see cref="T:Sfs2X.Requests.ModeratorMessageRequest"/>, <see cref="T:Sfs2X.Requests.KickUserRequest"/> or <see cref="T:Sfs2X.Requests.BanUserRequest"/> requests sent by a user with at least moderation privileges.
- Also, this event can be caused by a kick/ban action performed through the SmartFoxServer 2X Administration Tool.
- <para/>
- The <see cref="P:Sfs2X.Core.BaseEvent.Params"/> object contains the following parameters:
- <list type="table">
- <listheader>
- <term>Parameter</term>
- <description>Description</description>
- </listheader>
- <item>
- <term>sender</term>
- <description>(<b><see cref="T:Sfs2X.Entities.User"/></b>) An object representing the moderator user who sent the message.</description>
- </item>
- <item>
- <term>message</term>
- <description>(<b>string</b>) The message sent by the moderator.</description>
- </item>
- <item>
- <term>data</term>
- <description>(<b><see cref="T:Sfs2X.Entities.Data.ISFSObject"/></b>) An object containing custom parameters which might accompany the message.</description>
- </item>
- </list>
- </remarks>
-
- <example>See the <see cref="T:Sfs2X.Requests.ModeratorMessageRequest"/> example.</example>
-
- <seealso cref="T:Sfs2X.Requests.ModeratorMessageRequest"/>
- </member>
- <member name="F:Sfs2X.Core.SFSEvent.ADMIN_MESSAGE">
- <summary>
- Dispatched when the current user receives a message from an administrator user.
- </summary>
-
- <remarks>
- This event is caused by the <see cref="T:Sfs2X.Requests.AdminMessageRequest"/> request sent by a user with administration privileges.
- <para/>
- The <see cref="P:Sfs2X.Core.BaseEvent.Params"/> object contains the following parameters:
- <list type="table">
- <listheader>
- <term>Parameter</term>
- <description>Description</description>
- </listheader>
- <item>
- <term>sender</term>
- <description>(<b><see cref="T:Sfs2X.Entities.User"/></b>) An object representing the administrator user who sent the message.</description>
- </item>
- <item>
- <term>message</term>
- <description>(<b>string</b>) The message sent by the administrator.</description>
- </item>
- <item>
- <term>data</term>
- <description>(<b><see cref="T:Sfs2X.Entities.Data.ISFSObject"/></b>) An object containing custom parameters which might accompany the message.</description>
- </item>
- </list>
- </remarks>
-
- <example>See the <see cref="T:Sfs2X.Requests.AdminMessageRequest"/> example.</example>
-
- <seealso cref="T:Sfs2X.Requests.AdminMessageRequest"/>
- </member>
- <member name="F:Sfs2X.Core.SFSEvent.OBJECT_MESSAGE">
- <summary>
- Dispatched when an object containing custom data is received by the current user.
- </summary>
-
- <remarks>
- This event is caused by an <see cref="T:Sfs2X.Requests.ObjectMessageRequest"/> request sent by any user in the target Room.
- <para/>
- The <see cref="P:Sfs2X.Core.BaseEvent.Params"/> object contains the following parameters:
- <list type="table">
- <listheader>
- <term>Parameter</term>
- <description>Description</description>
- </listheader>
- <item>
- <term>sender</term>
- <description>(<b><see cref="T:Sfs2X.Entities.User"/></b>) An object representing the user who sent the message.</description>
- </item>
- <item>
- <term>message</term>
- <description>(<b><see cref="T:Sfs2X.Entities.Data.ISFSObject"/></b>) The content of the message: an object containing the custom parameters sent by the sender.</description>
- </item>
- </list>
- </remarks>
-
- <example>See the <see cref="T:Sfs2X.Requests.ObjectMessageRequest"/> example.</example>
-
- <seealso cref="T:Sfs2X.Requests.ObjectMessageRequest"/>
- </member>
- <member name="F:Sfs2X.Core.SFSEvent.EXTENSION_RESPONSE">
- <summary>
- Dispatched when data coming from a server-side Extension is received by the current user.
- </summary>
-
- <remarks>
- Data is usually sent by the server to one or more clients in response to an ExtensionRequest request, but not necessarily.
- <para/>
- The <see cref="P:Sfs2X.Core.BaseEvent.Params"/> object contains the following parameters:
- <list type="table">
- <listheader>
- <term>Parameter</term>
- <description>Description</description>
- </listheader>
- <item>
- <term>cmd</term>
- <description>(<b>string</b>) The name of the command which identifies an action that should be executed by the client. If this event is fired in response to a request sent by the client, it is a common practice to use the same command name passed to the request also in the response.</description>
- </item>
- <item>
- <term>sourceRoom</term>
- <description>(<b>int</b>) <b>[DEPRECATED - Use <em>room</em> property]</b> The id of the Room which the Extension is attached to (for Room Extensions only).</description>
- </item>
- <item>
- <term>room</term>
- <description>(<b><see cref="T:Sfs2X.Entities.Room"/></b>) An object representing the Room which the Extension is attached to (for Room Extensions only).</description>
- </item>
- <item>
- <term>params</term>
- <description>(<b><see cref="T:Sfs2X.Entities.Data.ISFSObject"/></b>) An object containing custom data sent by the Extension.</description>
- </item>
- <item>
- <term>packetId</term>
- <description>(<b>long</b>) The id of the packet when the UDP protocol is used. As this is an auto-increment value generated by the server, it can be useful to detect UDP packets received in the wrong order (for UDP communication only).</description>
- </item>
- </list>
- </remarks>
-
- <example>See the <see cref="T:Sfs2X.Requests.ExtensionRequest"/> example.</example>
-
- <seealso cref="T:Sfs2X.Requests.ExtensionRequest"/>
- <seealso cref="T:Sfs2X.Entities.Data.SFSObject"/>
- </member>
- <member name="F:Sfs2X.Core.SFSEvent.ROOM_VARIABLES_UPDATE">
- <summary>
- Dispatched when a Room Variable is updated.
- </summary>
-
- <remarks>
- This event is caused by the <see cref="T:Sfs2X.Requests.SetRoomVariablesRequest"/> request. The request could have been sent by a user in the same Room of the current user or,
- in case of a global Room Variable, by a user in a Room belonging to one of the Groups subscribed by the current client.
- <para/>
- The <see cref="P:Sfs2X.Core.BaseEvent.Params"/> object contains the following parameters:
- <list type="table">
- <listheader>
- <term>Parameter</term>
- <description>Description</description>
- </listheader>
- <item>
- <term>room</term>
- <description>(<b><see cref="T:Sfs2X.Entities.Room"/></b>) An object representing the Room where the Room Variable update occurred.</description>
- </item>
- <item>
- <term>changedVars</term>
- <description>(<b>List<string></b>) the list of variable names that where modified or created</description>
- </item>
- </list>
- </remarks>
-
- <example>See the <see cref="T:Sfs2X.Requests.SetRoomVariablesRequest"/> example.</example>
-
- <seealso cref="T:Sfs2X.Requests.SetRoomVariablesRequest"/>
- <seealso cref="T:Sfs2X.Entities.Variables.RoomVariable"/>
- </member>
- <member name="F:Sfs2X.Core.SFSEvent.USER_VARIABLES_UPDATE">
- <summary>
- Dispatched when a User Variable is updated.
- </summary>
-
- <remarks>
- This event is caused by the <see cref="T:Sfs2X.Requests.SetUserVariablesRequest"/> request sent by a user in one of the Rooms joined by the current user.
- <para/>
- The <see cref="P:Sfs2X.Core.BaseEvent.Params"/> object contains the following parameters:
- <list type="table">
- <listheader>
- <term>Parameter</term>
- <description>Description</description>
- </listheader>
- <item>
- <term>user</term>
- <description>(<b><see cref="T:Sfs2X.Entities.User"/></b>) An object representing the user who updated his own User Variables.</description>
- </item>
- <item>
- <term>changedVars</term>
- <description>(<b>List<string></b>) The list of names of the User Variables that were changed (or created for the first time).</description>
- </item>
- </list>
- </remarks>
-
- <example>See the <see cref="T:Sfs2X.Requests.SetUserVariablesRequest"/> example.</example>
-
- <seealso cref="T:Sfs2X.Requests.SetUserVariablesRequest"/>
- <seealso cref="T:Sfs2X.Entities.Variables.UserVariable"/>
- </member>
- <member name="F:Sfs2X.Core.SFSEvent.ROOM_GROUP_SUBSCRIBE">
- <summary>
- Dispatched when a Group is subscribed by the current user.
- </summary>
-
- <remarks>
- This event is fired in response to the <see cref="T:Sfs2X.Requests.SubscribeRoomGroupRequest"/> request if the operation is executed successfully.
- <para/>
- The <see cref="P:Sfs2X.Core.BaseEvent.Params"/> object contains the following parameters:
- <list type="table">
- <listheader>
- <term>Parameter</term>
- <description>Description</description>
- </listheader>
- <item>
- <term>groupId</term>
- <description>(<b>string</b>) The name of the Group that was subscribed.</description>
- </item>
- <item>
- <term>newRooms</term>
- <description>(<b>List<<see cref="T:Sfs2X.Entities.Room"/>></b>) A list of objects representing the Rooms belonging to the subscribed Group.</description>
- </item>
- </list>
- </remarks>
-
- <example>See the <see cref="T:Sfs2X.Requests.SubscribeRoomGroupRequest"/> example.</example>
-
- <seealso cref="T:Sfs2X.Requests.SubscribeRoomGroupRequest"/>
- <seealso cref="F:Sfs2X.Core.SFSEvent.ROOM_GROUP_SUBSCRIBE_ERROR"/>
- <seealso cref="F:Sfs2X.Core.SFSEvent.ROOM_GROUP_UNSUBSCRIBE"/>
- </member>
- <member name="F:Sfs2X.Core.SFSEvent.ROOM_GROUP_UNSUBSCRIBE">
- <summary>
- Dispatched when a Group is unsubscribed by the current user.
- </summary>
-
- <remarks>
- This event is fired in response to the <see cref="T:Sfs2X.Requests.UnsubscribeRoomGroupRequest"/> request if the operation is executed successfully.
- <para/>
- The <see cref="P:Sfs2X.Core.BaseEvent.Params"/> object contains the following parameters:
- <list type="table">
- <listheader>
- <term>Parameter</term>
- <description>Description</description>
- </listheader>
- <item>
- <term>groupId</term>
- <description>(<b>string</b>) The name of the Group that was unsubscribed.</description>
- </item>
- </list>
- </remarks>
-
- <example>See the <see cref="T:Sfs2X.Requests.UnsubscribeRoomGroupRequest"/> example.</example>
-
- <seealso cref="T:Sfs2X.Requests.UnsubscribeRoomGroupRequest"/>
- <seealso cref="F:Sfs2X.Core.SFSEvent.ROOM_GROUP_UNSUBSCRIBE_ERROR"/>
- <seealso cref="F:Sfs2X.Core.SFSEvent.ROOM_GROUP_SUBSCRIBE"/>
- </member>
- <member name="F:Sfs2X.Core.SFSEvent.ROOM_GROUP_SUBSCRIBE_ERROR">
- <summary>
- Dispatched when an error occurs while a Room Group is being subscribed.
- </summary>
-
- <remarks>
- This event is fired in response to the <see cref="T:Sfs2X.Requests.SubscribeRoomGroupRequest"/> request in case the operation failed.
- <para/>
- The <see cref="P:Sfs2X.Core.BaseEvent.Params"/> object contains the following parameters:
- <list type="table">
- <listheader>
- <term>Parameter</term>
- <description>Description</description>
- </listheader>
- <item>
- <term>errorMessage</term>
- <description>(<b>string</b>) A message containing the description of the error.</description>
- </item>
- <item>
- <term>errorCode</term>
- <description>(<b>short</b>) The error code.</description>
- </item>
- </list>
- </remarks>
-
- <example>See the <see cref="T:Sfs2X.Requests.SubscribeRoomGroupRequest"/> example.</example>
-
- <seealso cref="T:Sfs2X.Requests.SubscribeRoomGroupRequest"/>
- <seealso cref="F:Sfs2X.Core.SFSEvent.ROOM_GROUP_SUBSCRIBE"/>
- </member>
- <member name="F:Sfs2X.Core.SFSEvent.ROOM_GROUP_UNSUBSCRIBE_ERROR">
- <summary>
- Dispatched when an error occurs while a Room Group is being unsubscribed.
- </summary>
-
- <remarks>
- This event is fired in response to the <see cref="T:Sfs2X.Requests.UnsubscribeRoomGroupRequest"/> request in case the operation failed.
- <para/>
- The <see cref="P:Sfs2X.Core.BaseEvent.Params"/> object contains the following parameters:
- <list type="table">
- <listheader>
- <term>Parameter</term>
- <description>Description</description>
- </listheader>
- <item>
- <term>errorMessage</term>
- <description>(<b>string</b>) A message containing the description of the error.</description>
- </item>
- <item>
- <term>errorCode</term>
- <description>(<b>short</b>) The error code.</description>
- </item>
- </list>
- </remarks>
-
- <example>See the <see cref="T:Sfs2X.Requests.UnsubscribeRoomGroupRequest"/> example.</example>
-
- <seealso cref="T:Sfs2X.Requests.UnsubscribeRoomGroupRequest"/>
- <seealso cref="F:Sfs2X.Core.SFSEvent.ROOM_GROUP_UNSUBSCRIBE"/>
- </member>
- <member name="F:Sfs2X.Core.SFSEvent.SPECTATOR_TO_PLAYER">
- <summary>
- Dispatched when a spectator is turned to a player inside a Game Room.
- </summary>
-
- <remarks>
- This event is fired in response to the <see cref="T:Sfs2X.Requests.SpectatorToPlayerRequest"/> request if the operation is executed successfully.
- <para/>
- The <see cref="P:Sfs2X.Core.BaseEvent.Params"/> object contains the following parameters:
- <list type="table">
- <listheader>
- <term>Parameter</term>
- <description>Description</description>
- </listheader>
- <item>
- <term>room</term>
- <description>(<b><see cref="T:Sfs2X.Entities.Room"/></b>) An object representing the Room in which the spectator is turned to player.</description>
- </item>
- <item>
- <term>user</term>
- <description>(<b><see cref="T:Sfs2X.Entities.User"/></b>) An object representing the spectator who was turned to player.</description>
- </item>
- <item>
- <term>playerId</term>
- <description>(<b>int</b>) The player id of the user.</description>
- </item>
- </list>
- </remarks>
-
- <example>See the <see cref="T:Sfs2X.Requests.SpectatorToPlayerRequest"/> example.</example>
-
- <seealso cref="T:Sfs2X.Requests.SpectatorToPlayerRequest"/>
- <seealso cref="F:Sfs2X.Core.SFSEvent.SPECTATOR_TO_PLAYER_ERROR"/>
- </member>
- <member name="F:Sfs2X.Core.SFSEvent.PLAYER_TO_SPECTATOR">
- <summary>
- Dispatched when a player is turned to a spectator inside a Game Room.
- </summary>
-
- <remarks>
- This event is fired in response to the <see cref="T:Sfs2X.Requests.PlayerToSpectatorRequest"/> request if the operation is executed successfully.
- <para/>
- The <see cref="P:Sfs2X.Core.BaseEvent.Params"/> object contains the following parameters:
- <list type="table">
- <listheader>
- <term>Parameter</term>
- <description>Description</description>
- </listheader>
- <item>
- <term>room</term>
- <description>(<b><see cref="T:Sfs2X.Entities.Room"/></b>) An object representing the Room in which the player is turned to spectator.</description>
- </item>
- <item>
- <term>user</term>
- <description>(<b><see cref="T:Sfs2X.Entities.User"/></b>) An object representing the player who was turned to spectator.</description>
- </item>
- </list>
- </remarks>
-
- <example>See the <see cref="T:Sfs2X.Requests.PlayerToSpectatorRequest"/> example.</example>
-
- <seealso cref="T:Sfs2X.Requests.PlayerToSpectatorRequest"/>
- <seealso cref="F:Sfs2X.Core.SFSEvent.PLAYER_TO_SPECTATOR_ERROR"/>
- </member>
- <member name="F:Sfs2X.Core.SFSEvent.SPECTATOR_TO_PLAYER_ERROR">
- <summary>
- Dispatched when an error occurs while the current user is being turned from spectator to player in a Game Room.
- </summary>
-
- <remarks>
- This event is fired in response to the <see cref="T:Sfs2X.Requests.SpectatorToPlayerRequest"/> request in case the operation failed.
- <para/>
- The <see cref="P:Sfs2X.Core.BaseEvent.Params"/> object contains the following parameters:
- <list type="table">
- <listheader>
- <term>Parameter</term>
- <description>Description</description>
- </listheader>
- <item>
- <term>errorMessage</term>
- <description>(<b>string</b>) A message containing the description of the error.</description>
- </item>
- <item>
- <term>errorCode</term>
- <description>(<b>short</b>) The error code.</description>
- </item>
- </list>
- </remarks>
-
- <example>See the <see cref="T:Sfs2X.Requests.SpectatorToPlayerRequest"/> example.</example>
-
- <seealso cref="T:Sfs2X.Requests.SpectatorToPlayerRequest"/>
- <seealso cref="F:Sfs2X.Core.SFSEvent.SPECTATOR_TO_PLAYER"/>
- </member>
- <member name="F:Sfs2X.Core.SFSEvent.PLAYER_TO_SPECTATOR_ERROR">
- <summary>
- Dispatched when an error occurs while the current user is being turned from player to spectator in a Game Room.
- </summary>
-
- <remarks>
- This event is fired in response to the <see cref="T:Sfs2X.Requests.PlayerToSpectatorRequest"/> request in case the operation failed.
- <para/>
- The <see cref="P:Sfs2X.Core.BaseEvent.Params"/> object contains the following parameters:
- <list type="table">
- <listheader>
- <term>Parameter</term>
- <description>Description</description>
- </listheader>
- <item>
- <term>errorMessage</term>
- <description>(<b>string</b>) A message containing the description of the error.</description>
- </item>
- <item>
- <term>errorCode</term>
- <description>(<b>short</b>) The error code.</description>
- </item>
- </list>
- </remarks>
-
- <example>See the <see cref="T:Sfs2X.Requests.PlayerToSpectatorRequest"/> example.</example>
-
- <seealso cref="T:Sfs2X.Requests.PlayerToSpectatorRequest"/>
- <seealso cref="F:Sfs2X.Core.SFSEvent.PLAYER_TO_SPECTATOR"/>
- </member>
- <member name="F:Sfs2X.Core.SFSEvent.ROOM_NAME_CHANGE">
- <summary>
- Dispatched when the name of a Room is changed.
- </summary>
-
- <remarks>
- This event is fired in response to the <see cref="T:Sfs2X.Requests.ChangeRoomNameRequest"/> request if the operation is executed successfully.
- <para/>
- The <see cref="P:Sfs2X.Core.BaseEvent.Params"/> object contains the following parameters:
- <list type="table">
- <listheader>
- <term>Parameter</term>
- <description>Description</description>
- </listheader>
- <item>
- <term>room</term>
- <description>(<b><see cref="T:Sfs2X.Entities.Room"/></b>) An object representing the Room which was renamed.</description>
- </item>
- <item>
- <term>oldName</term>
- <description>(<b>string</b>) The previous name of the Room.</description>
- </item>
- </list>
- </remarks>
-
- <example>See the <see cref="T:Sfs2X.Requests.ChangeRoomNameRequest"/> example.</example>
-
- <seealso cref="F:Sfs2X.Core.SFSEvent.ROOM_NAME_CHANGE_ERROR"/>
- <seealso cref="T:Sfs2X.Requests.ChangeRoomNameRequest"/>
- </member>
- <member name="F:Sfs2X.Core.SFSEvent.ROOM_NAME_CHANGE_ERROR">
- <summary>
- Dispatched when an error occurs while attempting to change the name of a Room.
- </summary>
-
- <remarks>
- This event is fired in response to the <see cref="T:Sfs2X.Requests.ChangeRoomNameRequest"/> request in case the operation failed.
- <para/>
- The <see cref="P:Sfs2X.Core.BaseEvent.Params"/> object contains the following parameters:
- <list type="table">
- <listheader>
- <term>Parameter</term>
- <description>Description</description>
- </listheader>
- <item>
- <term>errorMessage</term>
- <description>(<b>string</b>) A message containing the description of the error.</description>
- </item>
- <item>
- <term>errorCode</term>
- <description>(<b>short</b>) The error code.</description>
- </item>
- </list>
- </remarks>
-
- <example>See the <see cref="T:Sfs2X.Requests.ChangeRoomNameRequest"/> example.</example>
-
- <seealso cref="F:Sfs2X.Core.SFSEvent.ROOM_NAME_CHANGE"/>
- <seealso cref="T:Sfs2X.Requests.ChangeRoomNameRequest"/>
- </member>
- <member name="F:Sfs2X.Core.SFSEvent.ROOM_PASSWORD_STATE_CHANGE">
- <summary>
- Dispatched when the password of a Room is set, changed or removed.
- </summary>
-
- <remarks>
- This event is fired in response to the <see cref="T:Sfs2X.Requests.ChangeRoomPasswordStateRequest"/> request if the operation is executed successfully.
- <para/>
- The <see cref="P:Sfs2X.Core.BaseEvent.Params"/> object contains the following parameters:
- <list type="table">
- <listheader>
- <term>Parameter</term>
- <description>Description</description>
- </listheader>
- <item>
- <term>room</term>
- <description>(<b><see cref="T:Sfs2X.Entities.Room"/></b>) An object representing the Room whose password was changed.</description>
- </item>
- </list>
- </remarks>
-
- <example>See the <see cref="T:Sfs2X.Requests.ChangeRoomPasswordStateRequest"/> example.</example>
-
- <seealso cref="F:Sfs2X.Core.SFSEvent.ROOM_PASSWORD_STATE_CHANGE_ERROR"/>
- <seealso cref="T:Sfs2X.Requests.ChangeRoomPasswordStateRequest"/>
- </member>
- <member name="F:Sfs2X.Core.SFSEvent.ROOM_PASSWORD_STATE_CHANGE_ERROR">
- <summary>
- Dispatched when an error occurs while attempting to set, change or remove the password of a Room.
- </summary>
-
- <remarks>
- This event is fired in response to the <see cref="T:Sfs2X.Requests.ChangeRoomPasswordStateRequest"/> request in case the operation failed.
- <para/>
- The <see cref="P:Sfs2X.Core.BaseEvent.Params"/> object contains the following parameters:
- <list type="table">
- <listheader>
- <term>Parameter</term>
- <description>Description</description>
- </listheader>
- <item>
- <term>errorMessage</term>
- <description>(<b>string</b>) A message containing the description of the error.</description>
- </item>
- <item>
- <term>errorCode</term>
- <description>(<b>short</b>) The error code.</description>
- </item>
- </list>
- </remarks>
-
- <example>See the <see cref="T:Sfs2X.Requests.ChangeRoomPasswordStateRequest"/> example.</example>
-
- <seealso cref="F:Sfs2X.Core.SFSEvent.ROOM_PASSWORD_STATE_CHANGE"/>
- <seealso cref="T:Sfs2X.Requests.ChangeRoomPasswordStateRequest"/>
- </member>
- <member name="F:Sfs2X.Core.SFSEvent.ROOM_CAPACITY_CHANGE">
- <summary>
- Dispatched when the capacity of a Room is changed.
- </summary>
-
- <remarks>
- This event is fired in response to the <see cref="T:Sfs2X.Requests.ChangeRoomCapacityRequest"/> request if the operation is executed successfully.
- <para/>
- The <see cref="P:Sfs2X.Core.BaseEvent.Params"/> object contains the following parameters:
- <list type="table">
- <listheader>
- <term>Parameter</term>
- <description>Description</description>
- </listheader>
- <item>
- <term>room</term>
- <description>(<b><see cref="T:Sfs2X.Entities.Room"/></b>) An object representing the Room whose capacity was changed.</description>
- </item>
- </list>
- </remarks>
-
- <example>See the <see cref="T:Sfs2X.Requests.ChangeRoomCapacityRequest"/> example.</example>
-
- <seealso cref="T:Sfs2X.Requests.ChangeRoomCapacityRequest"/>
- </member>
- <member name="F:Sfs2X.Core.SFSEvent.ROOM_CAPACITY_CHANGE_ERROR">
- <summary>
- Dispatched when an error occurs while attempting to change the capacity of a Room.
- </summary>
-
- <remarks>
- This event is fired in response to the <see cref="T:Sfs2X.Requests.ChangeRoomCapacityRequest"/> request in case the operation failed.
- <para/>
- The <see cref="P:Sfs2X.Core.BaseEvent.Params"/> object contains the following parameters:
- <list type="table">
- <listheader>
- <term>Parameter</term>
- <description>Description</description>
- </listheader>
- <item>
- <term>errorMessage</term>
- <description>(<b>string</b>) A message containing the description of the error.</description>
- </item>
- <item>
- <term>errorCode</term>
- <description>(<b>short</b>) The error code.</description>
- </item>
- </list>
- </remarks>
-
- <example>See the <see cref="T:Sfs2X.Requests.ChangeRoomCapacityRequest"/> example.</example>
-
- <seealso cref="T:Sfs2X.Requests.ChangeRoomCapacityRequest"/>
- </member>
- <member name="F:Sfs2X.Core.SFSEvent.ROOM_FIND_RESULT">
- <summary>
- Dispatched when a Rooms search is completed.
- </summary>
-
- <remarks>
- This event is fired in response to the <see cref="T:Sfs2X.Requests.FindRoomsRequest"/> request to return the search result.
- <para/>
- The <see cref="P:Sfs2X.Core.BaseEvent.Params"/> object contains the following parameters:
- <list type="table">
- <listheader>
- <term>Parameter</term>
- <description>Description</description>
- </listheader>
- <item>
- <term>rooms</term>
- <description>(<b>List<<see cref="T:Sfs2X.Entities.Room"/>></b>) A list of Room objects representing the Rooms matching the search criteria. If no Room is found, the list is empty.</description>
- </item>
- </list>
- </remarks>
-
- <example>See the <see cref="T:Sfs2X.Requests.FindRoomsRequest"/> example.</example>
-
- <seealso cref="T:Sfs2X.Requests.FindRoomsRequest"/>
- </member>
- <member name="F:Sfs2X.Core.SFSEvent.USER_FIND_RESULT">
- <summary>
- Dispatched when a users search is completed
- </summary>
-
- <remarks>
- This event is fired in response to the <see cref="T:Sfs2X.Requests.FindUsersRequest"/> request to return the search result.
- <para/>
- The <see cref="P:Sfs2X.Core.BaseEvent.Params"/> object contains the following parameters:
- <list type="table">
- <listheader>
- <term>Parameter</term>
- <description>Description</description>
- </listheader>
- <item>
- <term>rooms</term>
- <description>(<b>List<<see cref="T:Sfs2X.Entities.User"/>></b>) A list of objects representing the users matching the search criteria. If no user is found, the list is empty.</description>
- </item>
- </list>
- </remarks>
-
- <example>See the <see cref="T:Sfs2X.Requests.FindUsersRequest"/> example.</example>
-
- <seealso cref="T:Sfs2X.Requests.FindUsersRequest"/>
- </member>
- <member name="F:Sfs2X.Core.SFSEvent.INVITATION">
- <summary>
- Dispatched when the current user receives an invitation from another user.
- </summary>
-
- <remarks>
- This event is caused by the <see cref="T:Sfs2X.Requests.Game.InviteUsersRequest"/> request; the user is supposed to reply using the <see cref="T:Sfs2X.Requests.Game.InvitationReplyRequest"/> request.
- <para/>
- The <see cref="P:Sfs2X.Core.BaseEvent.Params"/> object contains the following parameters:
- <list type="table">
- <listheader>
- <term>Parameter</term>
- <description>Description</description>
- </listheader>
- <item>
- <term>invitation</term>
- <description>(<b><see cref="T:Sfs2X.Entities.Invitation.Invitation"/></b>) An object representing the invitation received by the current user.</description>
- </item>
- </list>
- </remarks>
-
- <example>See the <see cref="T:Sfs2X.Requests.Game.InvitationReplyRequest"/> example.</example>
-
- <seealso cref="T:Sfs2X.Requests.Game.InviteUsersRequest"/>
- <seealso cref="T:Sfs2X.Requests.Game.InvitationReplyRequest"/>
- <seealso cref="T:Sfs2X.Entities.Invitation.Invitation"/>
- </member>
- <member name="F:Sfs2X.Core.SFSEvent.INVITATION_REPLY">
- <summary>
- Dispatched when the current user receives a reply to an invitation he sent previously.
- </summary>
-
- <remarks>
- This event is caused by the <see cref="T:Sfs2X.Requests.Game.InvitationReplyRequest"/> request sent by the invitee.
- <para/>
- The <see cref="P:Sfs2X.Core.BaseEvent.Params"/> object contains the following parameters:
- <list type="table">
- <listheader>
- <term>Parameter</term>
- <description>Description</description>
- </listheader>
- <item>
- <term>invitee</term>
- <description>(<b><see cref="T:Sfs2X.Entities.User"/></b>) An object representing the user who replied to the invitation.</description>
- </item>
- <item>
- <term>reply</term>
- <description>(<b>int</b>) The answer to the invitation among those available as constants in the <see cref="T:Sfs2X.Entities.Invitation.InvitationReply"/> class.</description>
- </item>
- <item>
- <term>data</term>
- <description>(<b><see cref="T:Sfs2X.Entities.Data.ISFSObject"/></b>) An object containing custom parameters, for example a message describing the reason of refusal.</description>
- </item>
- </list>
- </remarks>
-
- <example>See the <see cref="T:Sfs2X.Requests.Game.InviteUsersRequest"/> example.</example>
-
- <seealso cref="T:Sfs2X.Entities.Invitation.InvitationReply"/>
- <seealso cref="T:Sfs2X.Requests.Game.InviteUsersRequest"/>
- <seealso cref="T:Sfs2X.Requests.Game.InvitationReplyRequest"/>
- </member>
- <member name="F:Sfs2X.Core.SFSEvent.INVITATION_REPLY_ERROR">
- <summary>
- Dispatched when an error occurs while the current user is sending a reply to an invitation he received.
- </summary>
- <remarks>
- This event is fired in response to the <see cref="T:Sfs2X.Requests.Game.InvitationReplyRequest"/> request in case the operation failed.
- <para/>
- The <see cref="P:Sfs2X.Core.BaseEvent.Params"/> object contains the following parameters:
- <list type="table">
- <listheader>
- <term>Parameter</term>
- <description>Description</description>
- </listheader>
- <item>
- <term>errorMessage</term>
- <description>(<b>string</b>) A message containing the description of the error.</description>
- </item>
- <item>
- <term>errorCode</term>
- <description>(<b>short</b>) The error code.</description>
- </item>
- </list>
- </remarks>
-
- <example>See the <see cref="T:Sfs2X.Requests.Game.InvitationReplyRequest"/> example.</example>
-
- <seealso cref="T:Sfs2X.Requests.Game.InvitationReplyRequest"/>
- </member>
- <member name="F:Sfs2X.Core.SFSEvent.PROXIMITY_LIST_UPDATE">
- <summary>
- Dispatched when one more users or one or more MMOItem objects enter/leave the current user's Area of Interest in MMORooms.
- </summary>
- <remarks>
- This event is fired after an MMORoom is joined and the <see cref="T:Sfs2X.Requests.MMO.SetUserPositionRequest"/> request is sent at least one time.
- <para/>
- <b>NOTE</b>: this event substitutes the default <see cref="F:Sfs2X.Core.SFSEvent.USER_ENTER_ROOM"/> and <see cref="F:Sfs2X.Core.SFSEvent.USER_EXIT_ROOM"/> events available in regular Rooms.
- <para/>
- The <see cref="P:Sfs2X.Core.BaseEvent.Params"/> object contains the following parameters:
- <list type="table">
- <listheader>
- <term>Parameter</term>
- <description>Description</description>
- </listheader>
- <item>
- <term>room</term>
- <description>(<b>Room</b>) The Room where the event occurred</description>
- </item>
- <item>
- <term>addedUsers</term>
- <description>(<b>List<User></b>) A list of User objects representing the users who entered the current user's Area of Interest.</description>
- </item>
- <item>
- <term>removedUsers</term>
- <description>(<b>List<User></b>) A list of User objects representing the users who left the current user's Area of Interest.</description>
- </item>
- <item>
- <term>addedItems</term>
- <description>(<b>List<IMMOItem></b>) A list of MMOItem objects which entered the current user's Area of Interest.</description>
- </item>
- <item>
- <term>removedItems</term>
- <description>(<b>List<IMMOItem></b>) A list of MMOItem objects which left the current user's Area of Interest.</description>
- </item>
- </list>
- </remarks>
-
- <example>See the <see cref="T:Sfs2X.Requests.MMO.SetUserPositionRequest"/> example.</example>
-
- <seealso cref="T:Sfs2X.Requests.MMO.SetUserPositionRequest"/>
- <seealso cref="T:Sfs2X.Entities.MMORoom"/>
- <seealso cref="T:Sfs2X.Entities.MMOItem"/>
- </member>
- <member name="F:Sfs2X.Core.SFSEvent.MMOITEM_VARIABLES_UPDATE">
- <summary>
- Dispatched when an MMOItem Variable is updated in an MMORoom.
- </summary>
- <remarks>
- This event is caused by an MMOItem Variable being set, updated or deleted in a server side Extension, and it is received only if the current user has the related MMOItem in his Area of Interest.
- <para/>
- The <see cref="P:Sfs2X.Core.BaseEvent.Params"/> object contains the following parameters:
- <list type="table">
- <listheader>
- <term>Parameter</term>
- <description>Description</description>
- </listheader>
- <item>
- <term>room</term>
- <description>(<b><see cref="T:Sfs2X.Entities.MMORoom"/></b>) The MMORoom where the MMOItem whose Variables have been updated is located.</description>
- </item>
- <item>
- <term>mmoItem</term>
- <description>(<b><see cref="T:Sfs2X.Entities.MMOItem"/></b>) The MMOItem whose variables have been updated.</description>
- </item>
- <item>
- <term>changedVars</term>
- <description>(<b>List<string></b>) The list of names of the MMOItem Variables that were changed (or created for the first time).</description>
- </item>
- </list>
- </remarks>
-
- <example>
- The following example shows how to handle the MMOItem Variable update:
- <code>
- void SomeMethod() {
- sfs.AddEventListener(SFSEvent.MMOITEM_VARIABLES_UPDATE, OnMMOItemVarsUpdate);
- }
-
- void OnMMOItemVarsUpdate(BaseEvent evt) {
- var changedVars = (List<String>)evt.Params["changedVars"];
- var item = (IMMOItem) evt.Params["mmoItem"];
-
- // Check if the MMOItem was moved
- if (changedVars.Contains("x") || changedVars.Contains("y"))
- {
- // Move the sprite representing the MMOItem
- ...
- }
- }
- </code>
- </example>
-
- <seealso cref="T:Sfs2X.Entities.Variables.MMOItemVariable"/>
- <seealso cref="T:Sfs2X.Entities.MMOItem"/>
- <seealso cref="T:Sfs2X.Entities.MMORoom"/>
- </member>
- <member name="F:Sfs2X.Core.SFSEvent.CRYPTO_INIT">
- <summary>
- Dispatched in return to the initialization of an encrypted connection.
- </summary>
-
- <remarks>
- This event is fired in response to a call to the <see cref="M:Sfs2X.SmartFox.InitCrypto">SmartFox.InitCrypto()</see> method.
- <para/>
- The <see cref="P:Sfs2X.Core.BaseEvent.Params"/> object contains the following parameters:
- <list type="table">
- <listheader>
- <term>Parameter</term>
- <description>Description</description>
- </listheader>
- <item>
- <term>success</term>
- <description>(<b>bool</b>) <c>true</c> if a unique encryption key was successfully retrieved via HTTPS, <c>false</c> if the transaction failed.</description>
- </item>
- <item>
- <term>errorMessage</term>
- <description>(<b>string</b>) If <em>success</em> is <c>false</c>, provides additional details on the occurred error.</description>
- </item>
- </list>
- </remarks>
-
- <example>See the <see cref="M:Sfs2X.SmartFox.InitCrypto"/> example.</example>
-
- <seealso cref="M:Sfs2X.SmartFox.InitCrypto"/>
- </member>
- <member name="M:Sfs2X.Core.SFSEvent.#ctor(System.String,System.Collections.Hashtable)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Core.SFSEvent.#ctor(System.String)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Core.Sockets.WebSocketLayer.ProcessState">
- <summary>
- This method is called whenever the SmartFox.ProcessEvents is called, to run the logic processing the errors and queues in the WebSocketHelper class.
- </summary>
- </member>
- <member name="T:Sfs2X.Entities.Buddy">
- <summary>
- The Buddy interface defines all the methods and properties that an object representing a SmartFoxServer Buddy entity exposes.
- </summary>
-
- <remarks>
- In the SmartFoxServer 2X client API this interface is implemented by the <see cref="T:Sfs2X.Entities.SFSBuddy"/> class. Read the class description for additional informations.
- </remarks>
-
- <seealso cref="T:Sfs2X.Entities.SFSBuddy"/>
- </member>
- <member name="P:Sfs2X.Entities.Buddy.Id">
- <summary>
- Indicates the id of this buddy.
- </summary>
-
- <remarks>
- This is equal to the id assigned by SmartFoxServer to the corresponding user.
- </remarks>
-
- <seealso cref="P:Sfs2X.Entities.User.Id"/>
- </member>
- <member name="P:Sfs2X.Entities.Buddy.Name">
- <summary>
- Indicates the name of this buddy.
- </summary>
-
- <remarks>
- This is equal to the name of the corresponding user.
- </remarks>
-
- <seealso cref="P:Sfs2X.Entities.User.Name"/>
- </member>
- <member name="P:Sfs2X.Entities.Buddy.IsBlocked">
- <summary>
- Indicates whether this buddy is blocked in the current user's buddies list or not.
- </summary>
-
- <remarks>
- A buddy can be blocked by means of a <see cref="T:Sfs2X.Requests.Buddylist.BlockBuddyRequest"/> request.
- </remarks>
-
- <seealso cref="T:Sfs2X.Requests.Buddylist.BlockBuddyRequest"/>
- </member>
- <member name="P:Sfs2X.Entities.Buddy.IsOnline">
- <summary>
- Indicates whether this buddy is online in the Buddy List system or not.
- </summary>
-
- <seealso cref="T:Sfs2X.Requests.Buddylist.GoOnlineRequest"/>
- </member>
- <member name="P:Sfs2X.Entities.Buddy.IsTemp">
- <summary>
- Indicates whether this buddy is temporary (non-persistent) in the current user's buddies list or not.
- </summary>
- </member>
- <member name="P:Sfs2X.Entities.Buddy.State">
- <summary>
- Returns the custom state of this buddy.
- </summary>
-
- <remarks>
- Examples of custom states are "Available", "Busy", "Be right back", etc. If the custom state is not set, <c>null</c> is returned.<br/>
- The list of available custom states is returned by the <see cref="P:Sfs2X.Entities.Managers.IBuddyManager.BuddyStates">IBuddyManager.BuddyStates</see> property.
- </remarks>
-
- <seealso cref="P:Sfs2X.Entities.Managers.IBuddyManager.BuddyStates"/>
- </member>
- <member name="P:Sfs2X.Entities.Buddy.NickName">
- <summary>
- Returns the nickname of this buddy.
- </summary>
-
- <remarks>
- If the nickname is not set, <c>null</c> is returned.
- </remarks>
- </member>
- <member name="P:Sfs2X.Entities.Buddy.Variables">
- <summary>
- Returns a list of BuddyVariable objects associated with the buddy.
- </summary>
-
- <seealso cref="T:Sfs2X.Requests.Buddylist.SetBuddyVariablesRequest"/>
- </member>
- <member name="M:Sfs2X.Entities.Buddy.GetVariable(System.String)">
- <summary>
- Retrieves a Buddy Variable from its name.
- </summary>
-
- <param name="varName">The name of the Buddy Variable to be retrieved.</param>
-
- <returns>The object representing the Buddy Variable, or <c>null</c> if no Buddy Variable with the passed name is associated with this buddy.</returns>
-
- <seealso cref="T:Sfs2X.Requests.Buddylist.SetBuddyVariablesRequest"/>
- </member>
- <member name="M:Sfs2X.Entities.Buddy.ContainsVariable(System.String)">
- <summary>
- Indicates whether this buddy has the specified Buddy Variable set or not.
- </summary>
-
- <param name="varName">The name of the Buddy Variable whose existance must be checked.</param>
-
- <returns><c>true</c> if a Buddy Variable with the passed name is set for this buddy.</returns>
- </member>
- <member name="M:Sfs2X.Entities.Buddy.GetOfflineVariables">
- <summary>
- Retrieves the list of persistent Buddy Variables of this buddy.
- </summary>
-
- <returns>A list of objects representing the offline Buddy Variables.</returns>
-
- <seealso cref="P:Sfs2X.Entities.Variables.BuddyVariable.IsOffline"/>
- <seealso cref="T:Sfs2X.Requests.Buddylist.SetBuddyVariablesRequest"/>
- </member>
- <member name="M:Sfs2X.Entities.Buddy.GetOnlineVariables">
- <summary>
- Retrieves the list of non-persistent Buddy Variables of this buddy.
- </summary>
-
- <returns>A list of objects representing the online Buddy Variables.</returns>
-
- <seealso cref="P:Sfs2X.Entities.Variables.BuddyVariable.IsOffline"/>
- <seealso cref="T:Sfs2X.Requests.Buddylist.SetBuddyVariablesRequest"/>
- </member>
- <member name="M:Sfs2X.Entities.Buddy.SetVariable(Sfs2X.Entities.Variables.BuddyVariable)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Buddy.SetVariables(System.Collections.Generic.ICollection{Sfs2X.Entities.Variables.BuddyVariable})">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Buddy.RemoveVariable(System.String)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Buddy.ClearVolatileVariables">
- <exclude/>
- </member>
- <member name="T:Sfs2X.Entities.IMMOItem">
- <summary>
- The IMMOItem interface defines all the methods and properties that an object representing a SmartFoxServer MMOItem entity exposes.
- </summary>
-
- <remarks>
- In the SmartFoxServer 2X client API this interface is implemented by the <see cref="T:Sfs2X.Entities.MMOItem"/> class. Read the class description for additional informations.
- </remarks>
-
- <seealso cref="T:Sfs2X.Entities.MMOItem"/>
- </member>
- <member name="P:Sfs2X.Entities.IMMOItem.Id">
- <summary>
- Indicates the id of this item.
- </summary>
-
- <remarks>
- The id is unique and it is generated by the server when the item is created.
- </remarks>
- </member>
- <member name="M:Sfs2X.Entities.IMMOItem.GetVariables">
- <summary>
- Retrieves all the MMOItem Variables of this item.
- </summary>
-
- <returns>A list of objects representing the MMOItem Variables associated to this item.</returns>
- </member>
- <member name="M:Sfs2X.Entities.IMMOItem.GetVariable(System.String)">
- <summary>
- Retrieves an MMOItem Variable from its name.
- </summary>
-
- <param name="name">The name of the MMOItem Variable to be retrieved.</param>
-
- <returns> The object representing the MMOItem Variable, or <c>null</c> if no MMOItem Variable with the passed name is associated to this item.</returns>
- </member>
- <member name="M:Sfs2X.Entities.IMMOItem.SetVariable(Sfs2X.Entities.Variables.IMMOItemVariable)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.IMMOItem.SetVariables(System.Collections.Generic.List{Sfs2X.Entities.Variables.IMMOItemVariable})">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.IMMOItem.ContainsVariable(System.String)">
- <summary>
- Indicates whether this item has the specified MMOItem Variable set or not.
- </summary>
-
- <param name="name"> The name of the MMOItem Variable whose existance must be checked.</param>
-
- <returns><c>true</c> if a MMOItem Variable with the passed name is set for this item.</returns>
-
- <seealso cref="T:Sfs2X.Entities.Variables.MMOItemVariable"/>
- </member>
- <member name="P:Sfs2X.Entities.IMMOItem.AOIEntryPoint">
- <summary>
- Returns the entry point of this item in the current user's AoI.
- </summary>
-
- <remarks>
- The returned coordinates are those that the item had when its presence in the current user's Area of Interest was last notified by a <see cref="F:Sfs2X.Core.SFSEvent.PROXIMITY_LIST_UPDATE">PROXIMITY_LIST_UPDATE</see> event.
- This field is populated only if the MMORoom in which the item exists is configured to receive such data.
- </remarks>
-
- <seealso cref="P:Sfs2X.Requests.MMO.MMORoomSettings.SendAOIEntryPoint"/>
- <seealso cref="F:Sfs2X.Core.SFSEvent.PROXIMITY_LIST_UPDATE"/>
- </member>
- <member name="T:Sfs2X.Entities.MMOItem">
- <summary>
- An MMOItem object represents an active non-player entity inside an MMORoom.
- </summary>
-
- <remarks>
- MMOItems can be used to represent bonuses, triggers, bullets, etc, or any other non-player entity that will be handled using the MMORoom's rules of visibility.
- This means that whenever one or more MMOItems fall within the Area of Interest of a user, their presence will be notified to that user by means of the
- <see cref="F:Sfs2X.Core.SFSEvent.PROXIMITY_LIST_UPDATE">PROXIMITY_LIST_UPDATE</see> event.
- <para/>
- MMOItems are identified by a unique ID and can have one or more MMOItem Variables associated to store custom data.
- <para/>
- <b>NOTE:</b> MMOItems can be created in a server side Extension only; client side creation is not allowed.
- </remarks>
-
- <seealso cref="T:Sfs2X.Entities.MMORoom"/>
- <seealso cref="T:Sfs2X.Entities.Variables.MMOItemVariable"/>
- </member>
- <member name="M:Sfs2X.Entities.MMOItem.FromSFSArray(Sfs2X.Entities.Data.ISFSArray)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.MMOItem.#ctor(System.Int32)">
- <exclude/>
- </member>
- <member name="P:Sfs2X.Entities.MMOItem.Id">
- <inheritdoc />
- </member>
- <member name="P:Sfs2X.Entities.MMOItem.AOIEntryPoint">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.MMOItem.GetVariables">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.MMOItem.GetVariable(System.String)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.MMOItem.SetVariable(Sfs2X.Entities.Variables.IMMOItemVariable)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.MMOItem.SetVariables(System.Collections.Generic.List{Sfs2X.Entities.Variables.IMMOItemVariable})">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.MMOItem.ContainsVariable(System.String)">
- <inheritdoc />
- </member>
- <member name="T:Sfs2X.Entities.MMORoom">
- <summary>
- The MMORoom object represents a specialized type of Room entity on the client.
- </summary>
-
- <remarks>
- The MMORoom is ideal for huge virtual worlds and MMO games because it works with proximity lists instead of "regular" users lists.
- This allows thousands of users to interact with each other based on their Area of Interest (AoI). The AoI represents a range around the user
- that is affected by server and user events, outside which no other events are received.
- <para/>
- The size of the AoI is set at Room creation time and it is the same for all users who joined it.
- Supposing that the MMORoom hosts a 3D virtual world, setting an AoI of (x=100, y=100, z=40) for the Room tells the server to transmit updates and broadcast
- events to and from those users that fall within the AoI range around the current user; this means the area within +/- 100 units on the X axis, +/- 100 units on the Y axis and +/- 40 units on the Z axis.
- <para/>
- As the user moves around in the virtual environment, he can update his position in the corresponding MMORoom and thus continuously receive events
- about other users (and items - see below) entering and leaving his AoI.
- The player will be able to update his position via the <em>SetUserPositionRequest</em> request and receive updates on his current proximity list by means of the
- <see cref="F:Sfs2X.Core.SFSEvent.PROXIMITY_LIST_UPDATE">PROXIMITY_LIST_UPDATE</see> event.
- <para/>
- Finally, MMORooms can also host any number of "MMOItems" which represent dynamic non-player objects that users can interact with.
- They are handled by the MMORoom using the same rules of visibility described before.
- </remarks>
-
- <seealso cref="T:Sfs2X.Requests.CreateRoomRequest"/>
- <seealso cref="T:Sfs2X.Requests.MMO.MMORoomSettings"/>
- <seealso cref="T:Sfs2X.Requests.MMO.SetUserPositionRequest"/>
- <seealso cref="F:Sfs2X.Core.SFSEvent.PROXIMITY_LIST_UPDATE"/>
- <seealso cref="T:Sfs2X.Entities.MMOItem"/>
- </member>
- <member name="M:Sfs2X.Entities.MMORoom.#ctor(System.Int32,System.String,System.String)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.MMORoom.#ctor(System.Int32,System.String)">
- <exclude/>
- </member>
- <member name="P:Sfs2X.Entities.MMORoom.DefaultAOI">
- <summary>
- Returns the default Area of Interest (AoI) of this MMORoom.
- </summary>
-
- <seealso cref="P:Sfs2X.Requests.MMO.MMORoomSettings.DefaultAOI"/>
- </member>
- <member name="P:Sfs2X.Entities.MMORoom.LowerMapLimit">
- <summary>
- Returns the lower coordinates limit of the virtual environment represented by the MMORoom along the X,Y,Z axes.
- </summary>
-
- <remarks>
- If <c>null</c> is returned, then no limits were set at Room creation time.
- </remarks>
-
- <seealso cref="P:Sfs2X.Requests.MMO.MMORoomSettings.MapLimits"/>
- </member>
- <member name="P:Sfs2X.Entities.MMORoom.HigherMapLimit">
- <summary>
- Returns the higher coordinates limit of the virtual environment represented by the MMORoom along the X,Y,Z axes.
- </summary>
-
- <remarks>
- If <c>null</c> is returned, then no limits were set at Room creation time.
- </remarks>
-
- <seealso cref="P:Sfs2X.Requests.MMO.MMORoomSettings.MapLimits"/>
- </member>
- <member name="M:Sfs2X.Entities.MMORoom.GetMMOItem(System.Int32)">
- <summary>
- Retrieves an <em>MMOItem</em> object from its <em>id</em> property.
- </summary>
-
- <remarks>
- The item is available to the current user if it falls within his Area of Interest only.
- </remarks>
-
- <param name="id">The id of the item to be retrieved.</param>
-
- <returns>An <em>MMOItem</em> object, or <c>null</c> if the item with the passed id is not in proximity of the current user.</returns>
- </member>
- <member name="M:Sfs2X.Entities.MMORoom.GetMMOItems">
- <summary>
- Retrieves all <em>MMOItem</em> object in the MMORoom that fall within the current user's Area of Interest.
- </summary>
-
- <returns>A list of <em>MMOItem</em> objects, or an empty list if no item is in proximity of the current user.</returns>
- </member>
- <member name="M:Sfs2X.Entities.MMORoom.AddMMOItem(Sfs2X.Entities.IMMOItem)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.MMORoom.RemoveItem(System.Int32)">
- <exclude/>
- </member>
- <member name="T:Sfs2X.Entities.Room">
- <summary>
- The Room interface defines all the methods and properties that an object representing a SmartFoxServer Room entity exposes.
- </summary>
-
- <remarks>
- In the SmartFoxServer 2X client API this interface is implemented by the <see cref="T:Sfs2X.Entities.SFSRoom"/> class. Read the class description for additional informations.
- </remarks>
-
- <seealso cref="T:Sfs2X.Entities.SFSRoom"/>
- </member>
- <member name="P:Sfs2X.Entities.Room.Id">
- <summary>
- Indicates the id of this Room.
- </summary>
-
- <remarks>
- The id is unique and it is generated by the server when the Room is created.
- </remarks>
- </member>
- <member name="P:Sfs2X.Entities.Room.Name">
- <summary>
- Indicates the name of this Room.
- </summary>
-
- <remarks>
- Two Rooms in the same Zone can't have the same name.
- <para/>
- <b>NOTE</b>: setting this property manually has no effect on the server and can disrupt the API functioning. Use the <see cref="T:Sfs2X.Requests.ChangeRoomNameRequest"/> request instead.
- </remarks>
-
- <seealso cref="T:Sfs2X.Requests.ChangeRoomNameRequest"/>
- </member>
- <member name="P:Sfs2X.Entities.Room.GroupId">
- <summary>
- Returns the Room Group name.
- </summary>
-
- <remarks>
- Each Group is identified by a unique string (its name or id) and it represents a different "container" for Rooms.
- <para/>
- Room Groups enable developers to organize Rooms under different types or categories and let clients select only those Groups they are interested in,
- in order to receive their events only. This is done via the <see cref="T:Sfs2X.Requests.SubscribeRoomGroupRequest"/> and <see cref="T:Sfs2X.Requests.UnsubscribeRoomGroupRequest"/> requests.
- <para/>
- The default value is <c>default</c>.
- </remarks>
-
- <seealso cref="T:Sfs2X.Requests.SubscribeRoomGroupRequest"/>
- <seealso cref="T:Sfs2X.Requests.UnsubscribeRoomGroupRequest"/>
- </member>
- <member name="P:Sfs2X.Entities.Room.IsJoined">
- <summary>
- Indicates whether the client joined this Room or not.
- </summary>
-
- <remarks>
- <b>NOTE</b>: setting this property manually has no effect on the server and can disrupt the API functioning. Use the <see cref="T:Sfs2X.Requests.JoinRoomRequest"/> request to join a new Room instead.
- </remarks>
-
- <seealso cref="T:Sfs2X.Requests.JoinRoomRequest"/>
- </member>
- <member name="P:Sfs2X.Entities.Room.IsGame">
- <summary>
- Indicates whether this is a Game Room or not.
- </summary>
-
- <remarks>
- <b>NOTE</b>: setting this property manually has no effect on the server and can disrupt the API functioning. This flag must be set when creating the Room.
- </remarks>
- </member>
- <member name="P:Sfs2X.Entities.Room.IsHidden">
- <summary>
- Indicates whether this Room is hidden or not.
- </summary>
-
- <remarks>
- This is a utility flag that can be used by developers to hide certain Rooms from the interface of their application.
- <para/>
- <b>NOTE</b>: setting this property manually has no effect on the server and can disrupt the API functioning. This flag must be set when creating the Room.
- </remarks>
- </member>
- <member name="P:Sfs2X.Entities.Room.IsPasswordProtected">
- <summary>
- Indicates whether this Room requires a password to be joined or not.
- </summary>
-
- <remarks>
- <b>NOTE</b>: setting this property manually has no effect on the server and can disrupt the API functioning.
- This flag depends on the Room's password set when the Room is created or by means of the <seealso cref="T:Sfs2X.Requests.ChangeRoomPasswordStateRequest"/> request.
- </remarks>
-
- <seealso cref="T:Sfs2X.Requests.ChangeRoomPasswordStateRequest"/>
- </member>
- <member name="P:Sfs2X.Entities.Room.IsManaged">
- <exclude/>
- </member>
- <member name="P:Sfs2X.Entities.Room.UserCount">
- <summary>
- Returns the current number of users in this Room.
- </summary>
-
- <remarks>
- In case of Game Rooms, this is the number of players.
- <para/>
- <b>NOTE</b>: setting this property manually has no effect on the server and can disrupt the API functioning. This flag depends on the Room state.
- </remarks>
- </member>
- <member name="P:Sfs2X.Entities.Room.MaxUsers">
- <summary>
- Returns the maximum number of users allowed in this Room.
- </summary>
-
- <remarks>
- In case of Game Rooms, this is the maximum number of players.
- <para/>
- <b>NOTE</b>: setting this property manually has no effect on the server and can disrupt the API functioning. This flag must be set when creating the Room.
- </remarks>
- </member>
- <member name="P:Sfs2X.Entities.Room.SpectatorCount">
- <summary>
- Returns the current number of spectators in this Room (Game Rooms only).
- </summary>
-
- <remarks>
- <b>NOTE</b>: setting this property manually has no effect on the server and can disrupt the API functioning. This flag depends on the Room state.
- </remarks>
- </member>
- <member name="P:Sfs2X.Entities.Room.MaxSpectators">
- <summary>
- Returns the maximum number of spectators allowed in this Room (Game Rooms only).
- </summary>
-
- <remarks>
- <b>NOTE</b>: setting this property manually has no effect on the server and can disrupt the API functioning. This flag must be set when creating the Game Room.
- </remarks>
- </member>
- <member name="P:Sfs2X.Entities.Room.Capacity">
- <summary>
- Returns the maximum amount of users, including spectators, that can be contained in this Room.
- </summary>
- </member>
- <member name="M:Sfs2X.Entities.Room.AddUser(Sfs2X.Entities.User)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Room.RemoveUser(Sfs2X.Entities.User)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Room.ContainsUser(Sfs2X.Entities.User)">
- <summary>
- Indicates whether the specified user is currently inside this Room or not.
- </summary>
-
- <param name="user">The object representing the user whose presence in this Room must be checked.</param>
-
- <returns><c>true</c> if the user is inside this Room; false otherwise.</returns>
- </member>
- <member name="M:Sfs2X.Entities.Room.GetUserByName(System.String)">
- <summary>
- Retrieves a User object from its name property.
- </summary>
-
- <param name="name">The name of the user to be found.</param>
-
- <returns>The object representing the user, or <c>null</c> if no user with the passed name exists in this Room.</returns>
- </member>
- <member name="M:Sfs2X.Entities.Room.GetUserById(System.Int32)">
- <summary>
- Retrieves a User object from its id property.
- </summary>
-
- <param name="id">The id of the user to be found.</param>
-
- <returns>The object representing the user, or <c>null</c> if no user with the passed id exists in this Room.</returns>
- </member>
- <member name="P:Sfs2X.Entities.Room.UserList">
- <summary>
- Returns a list of User objects representing all the users currently inside this Room.
- </summary>
- </member>
- <member name="P:Sfs2X.Entities.Room.PlayerList">
- <summary>
- Returns a list of User objects representing the players currently inside this Room (Game Rooms only).
- </summary>
- </member>
- <member name="P:Sfs2X.Entities.Room.SpectatorList">
- <summary>
- Returns a list of User objects representing the spectators currently inside this Room (Game Rooms only).
- </summary>
- </member>
- <member name="M:Sfs2X.Entities.Room.GetVariable(System.String)">
- <summary>
- Retrieves a Room Variable from its name.
- </summary>
-
- <param name="name">The name of the Room Variable to be retrieved.</param>
-
- <returns>The object representing the Room Variable, or <c>null</c> if no Room Variable with the passed name exists in this Room.</returns>
-
- <seealso cref="T:Sfs2X.Requests.SetRoomVariablesRequest"/>
- </member>
- <member name="M:Sfs2X.Entities.Room.GetVariables">
- <summary>
- Retrieves all the Room Variables of this Room.
- </summary>
-
- <returns>A list of objects representing the Room Variables associated with this Room.</returns>
-
- <seealso cref="T:Sfs2X.Requests.SetRoomVariablesRequest"/>
- </member>
- <member name="M:Sfs2X.Entities.Room.SetVariable(Sfs2X.Entities.Variables.RoomVariable)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Room.SetVariables(System.Collections.Generic.ICollection{Sfs2X.Entities.Variables.RoomVariable})">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Room.ContainsVariable(System.String)">
- <summary>
- Indicates whether this Room has the specified Room Variable set or not.
- </summary>
-
- <param name="name"> The name of the Room Variable whose existance in this Room must be checked.</param>
-
- <returns><c>true</c> if a Room Variable with the passed name exists in this Room.</returns>
-
- <seealso cref="T:Sfs2X.Entities.Variables.RoomVariable"/>
- </member>
- <member name="P:Sfs2X.Entities.Room.Properties">
- <summary>
- Defines a generic utility object that can be used to store custom Room data.
- </summary>
-
- <remarks>
- The values added to this object are for client-side use only and are never transmitted to the server or to the other clients.
- </remarks>
- </member>
- <member name="P:Sfs2X.Entities.Room.RoomManager">
- <summary>
- Returns a reference to the Room Manager which manages this Room.
- </summary>
-
- <remarks>
- <b>NOTE</b>: setting this property manually has no effect on the server and can disrupt the API functioning.
- </remarks>
- </member>
- <member name="M:Sfs2X.Entities.Room.Merge(Sfs2X.Entities.Room)">
- <exclude/>
- </member>
- <member name="T:Sfs2X.Entities.SFSBuddy">
- <summary>
- The SFSBuddy object represents a buddy in the current user's buddies list.
- </summary>
-
- <remarks>
- A buddy is marked out by the following characteristics.
- <ul>
- <li><b>Nickname</b>: a buddy can have an optional nickname, which differs from the username used during the login process.</li>
- <li><b>Online/offline state</b>: users can be online or offline as buddies in the Buddy List system. By default a buddy is online every time he joins a Zone, but the user can also switch the state to offline at runtime, and disappear from other user's buddies list. This state is persistent and it is based on a reserved Buddy Variable.</li>
- <li><b>Custom state</b>: each user can have a typical IM state such as "Available", "Away", "Occupied", etc. State can be selected among the custom ones defined in the Zone configuration, which can be changed or enriched at any time. This state is persistent and it is based on a reserved Buddy Variable.</li>
- <li><b>Blocked buddy</b>: buddies that are blocked in a user's buddies list won't be able to send messages to that user; also they won't be able to see if the user is online or offline in the Buddy List system.</li>
- <li><b>Temporary buddy</b>: a temporary buddy is added to the current user's buddies list whenever another user adds him to his own buddies list. In this way users can "see" each other and exchange messages. If the current user doesn't add that temporary buddy to his buddies list voluntarily, that buddy won't be persisted and will be lost upon disconnection.</li>
- <li><b>Variables</b>: Buddy Variables enable each user to show (and send updates on) specific custom informations to each user to whom he is a buddy. For example one could send realtime updates on his last activity, or post the title of the song he's listening right now, or scores, rankings and whatnot.</li>
- </ul>
- </remarks>
-
- <seealso cref="P:Sfs2X.SmartFox.BuddyManager"/>
- <seealso cref="T:Sfs2X.Entities.Variables.BuddyVariable"/>
- </member>
- <member name="F:Sfs2X.Entities.SFSBuddy.name">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Entities.SFSBuddy.id">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Entities.SFSBuddy.isBlocked">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Entities.SFSBuddy.variables">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Entities.SFSBuddy.isTemp">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.SFSBuddy.FromSFSArray(Sfs2X.Entities.Data.ISFSArray)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.SFSBuddy.#ctor(System.Int32,System.String)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.SFSBuddy.#ctor(System.Int32,System.String,System.Boolean)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.SFSBuddy.#ctor(System.Int32,System.String,System.Boolean,System.Boolean)">
- <exclude/>
- </member>
- <member name="P:Sfs2X.Entities.SFSBuddy.Id">
- <inheritdoc />
- </member>
- <member name="P:Sfs2X.Entities.SFSBuddy.IsBlocked">
- <inheritdoc />
- </member>
- <member name="P:Sfs2X.Entities.SFSBuddy.IsTemp">
- <inheritdoc />
- </member>
- <member name="P:Sfs2X.Entities.SFSBuddy.Name">
- <inheritdoc />
- </member>
- <member name="P:Sfs2X.Entities.SFSBuddy.IsOnline">
- <inheritdoc />
- </member>
- <member name="P:Sfs2X.Entities.SFSBuddy.State">
- <inheritdoc />
- </member>
- <member name="P:Sfs2X.Entities.SFSBuddy.NickName">
- <inheritdoc />
- </member>
- <member name="P:Sfs2X.Entities.SFSBuddy.Variables">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.SFSBuddy.GetVariable(System.String)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.SFSBuddy.GetOfflineVariables">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.SFSBuddy.GetOnlineVariables">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.SFSBuddy.ContainsVariable(System.String)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.SFSBuddy.SetVariable(Sfs2X.Entities.Variables.BuddyVariable)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.SFSBuddy.SetVariables(System.Collections.Generic.ICollection{Sfs2X.Entities.Variables.BuddyVariable})">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.SFSBuddy.RemoveVariable(System.String)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.SFSBuddy.ClearVolatileVariables">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.SFSBuddy.ToString">
- <summary>
- Returns a string that contains the buddy name and id.
- </summary>
-
- <returns>
- The string representation of the <see cref="T:Sfs2X.Entities.SFSBuddy"/> object.
- </returns>
- </member>
- <member name="T:Sfs2X.Entities.SFSConstants">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Entities.SFSConstants.DEFAULT_GROUP_ID">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Entities.SFSConstants.REQUEST_UDP_PACKET_ID">
- <exclude/>
- </member>
- <member name="T:Sfs2X.Entities.SFSRoom">
- <summary>
- The SFSRoom object represents a SmartFoxServer Room entity on the client.
- </summary>
-
- <remarks>
- The SmartFoxServer 2X client API are not aware of all the Rooms which exist on the server side, but only of those that are joined by the user
- and those in the Room Groups that have been subscribed. Subscribing to one or more Groups allows the client to listen to Room events in specific "areas" of the Zone,
- without having to retrieve and keep synchronized the details of all available Rooms, thus reducing the traffic between the client and the server considerably.
- <para/>
- The list of available Rooms is created after a successful login and it is kept updated continuously by the server.
- </remarks>
-
- <seealso cref="P:Sfs2X.SmartFox.RoomManager"/>
- <seealso cref="T:Sfs2X.Requests.CreateRoomRequest"/>
- <seealso cref="T:Sfs2X.Requests.JoinRoomRequest"/>
- <seealso cref="T:Sfs2X.Requests.SubscribeRoomGroupRequest"/>
- <seealso cref="T:Sfs2X.Requests.UnsubscribeRoomGroupRequest"/>
- <seealso cref="T:Sfs2X.Requests.ChangeRoomNameRequest"/>
- <seealso cref="T:Sfs2X.Requests.ChangeRoomPasswordStateRequest"/>
- <seealso cref="T:Sfs2X.Requests.ChangeRoomCapacityRequest"/>
- </member>
- <member name="F:Sfs2X.Entities.SFSRoom.id">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Entities.SFSRoom.name">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Entities.SFSRoom.groupId">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Entities.SFSRoom.isGame">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Entities.SFSRoom.isHidden">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Entities.SFSRoom.isJoined">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Entities.SFSRoom.isPasswordProtected">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Entities.SFSRoom.isManaged">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Entities.SFSRoom.variables">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Entities.SFSRoom.properties">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Entities.SFSRoom.userManager">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Entities.SFSRoom.maxUsers">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Entities.SFSRoom.maxSpectators">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Entities.SFSRoom.userCount">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Entities.SFSRoom.specCount">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Entities.SFSRoom.roomManager">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.SFSRoom.FromSFSArray(Sfs2X.Entities.Data.ISFSArray)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.SFSRoom.#ctor(System.Int32,System.String)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.SFSRoom.#ctor(System.Int32,System.String,System.String)">
- <exclude/>
- </member>
- <member name="P:Sfs2X.Entities.SFSRoom.Id">
- <inheritdoc />
- </member>
- <member name="P:Sfs2X.Entities.SFSRoom.Name">
- <inheritdoc />
- </member>
- <member name="P:Sfs2X.Entities.SFSRoom.GroupId">
- <inheritdoc />
- </member>
- <member name="P:Sfs2X.Entities.SFSRoom.IsGame">
- <inheritdoc />
- </member>
- <member name="P:Sfs2X.Entities.SFSRoom.IsHidden">
- <inheritdoc />
- </member>
- <member name="P:Sfs2X.Entities.SFSRoom.IsJoined">
- <inheritdoc />
- </member>
- <member name="P:Sfs2X.Entities.SFSRoom.IsPasswordProtected">
- <inheritdoc />
- </member>
- <member name="P:Sfs2X.Entities.SFSRoom.IsManaged">
- <exclude/>
- </member>
- <member name="P:Sfs2X.Entities.SFSRoom.MaxSpectators">
- <inheritdoc />
- </member>
- <member name="P:Sfs2X.Entities.SFSRoom.Properties">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.SFSRoom.GetVariables">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.SFSRoom.GetVariable(System.String)">
- <inheritdoc />
- </member>
- <member name="P:Sfs2X.Entities.SFSRoom.UserCount">
- <inheritdoc />
- </member>
- <member name="P:Sfs2X.Entities.SFSRoom.MaxUsers">
- <inheritdoc />
- </member>
- <member name="P:Sfs2X.Entities.SFSRoom.Capacity">
- <inheritdoc />
- </member>
- <member name="P:Sfs2X.Entities.SFSRoom.SpectatorCount">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.SFSRoom.GetUserByName(System.String)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.SFSRoom.GetUserById(System.Int32)">
- <inheritdoc />
- </member>
- <member name="P:Sfs2X.Entities.SFSRoom.UserList">
- <inheritdoc />
- </member>
- <member name="P:Sfs2X.Entities.SFSRoom.PlayerList">
- <inheritdoc />
- </member>
- <member name="P:Sfs2X.Entities.SFSRoom.SpectatorList">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.SFSRoom.RemoveUser(Sfs2X.Entities.User)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.SFSRoom.SetVariable(Sfs2X.Entities.Variables.RoomVariable)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.SFSRoom.SetVariables(System.Collections.Generic.ICollection{Sfs2X.Entities.Variables.RoomVariable})">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.SFSRoom.ContainsVariable(System.String)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.SFSRoom.RemoveUserVariable(System.String)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.SFSRoom.AddUser(Sfs2X.Entities.User)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.SFSRoom.ContainsUser(Sfs2X.Entities.User)">
- <inheritdoc />
- </member>
- <member name="P:Sfs2X.Entities.SFSRoom.RoomManager">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.SFSRoom.ToString">
- <summary>
- Returns a string that contains the Room id, name and id of the Group to which it belongs.
- </summary>
-
- <returns>
- The string representation of the <see cref="T:Sfs2X.Entities.SFSRoom"/> object.
- </returns>
- </member>
- <member name="M:Sfs2X.Entities.SFSRoom.Merge(Sfs2X.Entities.Room)">
- <exclude/>
- </member>
- <member name="T:Sfs2X.Entities.SFSUser">
- <summary>
- The SFSUser object represents a client logged in SmartFoxServer.
- </summary>
-
- <remarks>
- The SmartFoxServer 2X client API are not aware of all the clients (users) connected to the server, but only of those that are in the same Rooms joined by the current client;
- this reduces the traffic between the client and the server considerably. In order to interact with other users the client should join other Rooms
- or use the Buddy List system to keep track of and interact with friends.
- </remarks>
-
- <seealso cref="P:Sfs2X.SmartFox.UserManager"/>
- </member>
- <member name="F:Sfs2X.Entities.SFSUser.id">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Entities.SFSUser.privilegeId">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Entities.SFSUser.name">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Entities.SFSUser.isItMe">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Entities.SFSUser.variables">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Entities.SFSUser.properties">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Entities.SFSUser.isModerator">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Entities.SFSUser.playerIdByRoomId">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Entities.SFSUser.userManager">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Entities.SFSUser.aoiEntryPoint">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.SFSUser.FromSFSArray(Sfs2X.Entities.Data.ISFSArray,Sfs2X.Entities.Room)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.SFSUser.FromSFSArray(Sfs2X.Entities.Data.ISFSArray)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.SFSUser.#ctor(System.Int32,System.String)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.SFSUser.#ctor(System.Int32,System.String,System.Boolean)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.SFSUser.Init(System.Int32,System.String,System.Boolean)">
- <exclude/>
- </member>
- <member name="P:Sfs2X.Entities.SFSUser.Id">
- <inheritdoc />
- </member>
- <member name="P:Sfs2X.Entities.SFSUser.Name">
- <inheritdoc />
- </member>
- <member name="P:Sfs2X.Entities.SFSUser.PlayerId">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.SFSUser.IsJoinedInRoom(Sfs2X.Entities.Room)">
- <inheritdoc />
- </member>
- <member name="P:Sfs2X.Entities.SFSUser.PrivilegeId">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.SFSUser.IsGuest">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.SFSUser.IsStandardUser">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.SFSUser.IsModerator">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.SFSUser.IsAdmin">
- <inheritdoc />
- </member>
- <member name="P:Sfs2X.Entities.SFSUser.IsPlayer">
- <inheritdoc />
- </member>
- <member name="P:Sfs2X.Entities.SFSUser.IsSpectator">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.SFSUser.GetPlayerId(Sfs2X.Entities.Room)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.SFSUser.SetPlayerId(System.Int32,Sfs2X.Entities.Room)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.SFSUser.RemovePlayerId(Sfs2X.Entities.Room)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.SFSUser.IsPlayerInRoom(Sfs2X.Entities.Room)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.SFSUser.IsSpectatorInRoom(Sfs2X.Entities.Room)">
- <inheritdoc />
- </member>
- <member name="P:Sfs2X.Entities.SFSUser.IsItMe">
- <inheritdoc />
- </member>
- <member name="P:Sfs2X.Entities.SFSUser.UserManager">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.SFSUser.GetVariables">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.SFSUser.GetVariable(System.String)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.SFSUser.SetVariable(Sfs2X.Entities.Variables.UserVariable)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.SFSUser.SetVariables(System.Collections.Generic.ICollection{Sfs2X.Entities.Variables.UserVariable})">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.SFSUser.ContainsVariable(System.String)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.SFSUser.RemoveUserVariable(System.String)">
- <exclude/>
- </member>
- <member name="P:Sfs2X.Entities.SFSUser.Properties">
- <inheritdoc />
- </member>
- <member name="P:Sfs2X.Entities.SFSUser.AOIEntryPoint">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.SFSUser.ToString">
- <summary>
- Returns a string that contains the user id, name and a boolean indicating if the this object represents the current client.
- </summary>
-
- <returns>
- The string representation of the <see cref="T:Sfs2X.Entities.SFSUser"/> object.
- </returns>
- </member>
- <member name="T:Sfs2X.Entities.User">
- <summary>
- The User interface defines all the methods and properties that an object representing a SmartFoxServer User entity exposes.
- </summary>
-
- <remarks>
- In the SmartFoxServer 2X client API this interface is implemented by the <see cref="T:Sfs2X.Entities.SFSUser"/> class. Read the class description for additional informations.
- </remarks>
-
- <seealso cref="T:Sfs2X.Entities.SFSUser"/>
- </member>
- <member name="P:Sfs2X.Entities.User.Id">
- <summary>
- Indicates the id of this user.
- </summary>
-
- <remarks>
- The id is unique and it is generated by the server when the user is created.
- </remarks>
- </member>
- <member name="P:Sfs2X.Entities.User.Name">
- <summary>
- Indicates the name of this user.
- </summary>
-
- <remarks>
- Two users in the same Zone can't have the same name.
- </remarks>
- </member>
- <member name="P:Sfs2X.Entities.User.PlayerId">
- <summary>
- Returns the id of this user as a player in a Game Room.
- </summary>
-
- <remarks>
- This property differs from <see cref="P:Sfs2X.Entities.User.Id"/> property and it used to indicate which player number is assigned to a user inside a Game Room.
- For example, in a Game Room for 5 players the first client joining it will have its <em>playerId</em> equal to 1, the second will have it equal to 2 and so forth.
- When a user leaves the Room the player slot is freed up and the next user joining the Room will take it.
- <para/>
- This property applies to Game Rooms only; in standard Rooms it is always 0. Also, in Game Rooms a <em>playerId</em> value lower than 0 indicates that the user is a spectator.
- <para/>
- If the user is inside multiple Game Rooms at the same time, a different <em>playerId</em> value will be assigned to him in each Room.
- In this case this property returns the value corresponding to the last joined Room; in order to obtain the <em>playerId</em> value in a specific Room, use the <see cref="M:Sfs2X.Entities.User.GetPlayerId(Sfs2X.Entities.Room)"/> method.
- </remarks>
-
- <seealso cref="M:Sfs2X.Entities.User.GetPlayerId(Sfs2X.Entities.Room)"/>
- </member>
- <member name="P:Sfs2X.Entities.User.IsPlayer">
- <summary>
- Indicates whether this user is a player (playerId greater than 0) in the last joined Room or not.
- </summary>
-
- <remarks>
- Non-Game Rooms always return <c>false</c>.
- <para/>
- If the user is inside multiple Game Rooms at the same time, use the <see cref="M:Sfs2X.Entities.User.IsPlayerInRoom(Sfs2X.Entities.Room)"/> method.
- </remarks>
-
- <seealso cref="M:Sfs2X.Entities.User.IsPlayerInRoom(Sfs2X.Entities.Room)"/>
- <seealso cref="P:Sfs2X.Entities.User.PlayerId"/>
- <seealso cref="P:Sfs2X.Entities.User.IsSpectator"/>
- </member>
- <member name="P:Sfs2X.Entities.User.IsSpectator">
- <summary>
- Indicates whether this user is a spectator (playerId lower than 0) in the last joined Room or not.
- </summary>
-
- <remarks>
- Non-Game Rooms always return <c>false</c>.
- <para/>
- If the user is inside multiple Game Rooms at the same time, use the <see cref="M:Sfs2X.Entities.User.IsSpectatorInRoom(Sfs2X.Entities.Room)"/> method.
- </remarks>
-
- <seealso cref="M:Sfs2X.Entities.User.IsSpectatorInRoom(Sfs2X.Entities.Room)"/>
- <seealso cref="P:Sfs2X.Entities.User.IsPlayer"/>
- </member>
- <member name="M:Sfs2X.Entities.User.GetPlayerId(Sfs2X.Entities.Room)">
- <summary>
- Returns the playerId value of this user in the passed Room.
- </summary>
-
- <remarks>
- See the <see cref="P:Sfs2X.Entities.User.PlayerId"/> property description for more informations.
- </remarks>
-
- <param name="room">The object representing the Room to retrieve the player id from.</param>
-
- <returns>The player id of this user in the passed Room.</returns>
-
- <seealso cref="P:Sfs2X.Entities.User.PlayerId"/>
- </member>
- <member name="M:Sfs2X.Entities.User.SetPlayerId(System.Int32,Sfs2X.Entities.Room)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.User.RemovePlayerId(Sfs2X.Entities.Room)">
- <exclude/>
- </member>
- <member name="P:Sfs2X.Entities.User.PrivilegeId">
- <summary>
- Returns the id which identifies the privilege level of this user.
- </summary>
-
- <remarks>
- <b>NOTE</b>: setting this property manually has no effect on the server and can disrupt the API functioning. Privileges are assigned to the user by the server when the user logs in.
- </remarks>
-
- <seealso cref="T:Sfs2X.Entities.UserPrivileges"/>
- </member>
- <member name="P:Sfs2X.Entities.User.UserManager">
- <summary>
- Returns a reference to the User Manager which manages this user.
- </summary>
-
- <remarks>
- <b>NOTE</b>: setting this property manually has no effect on the server and can disrupt the API functioning.
- </remarks>
- </member>
- <member name="M:Sfs2X.Entities.User.IsGuest">
- <summary>
- Indicates whether this user logged in as a guest or not.
- </summary>
-
- <remarks>
- Guest users have this property set to <see cref="F:Sfs2X.Entities.UserPrivileges.GUEST"/>.
- </remarks>
-
- <returns><c>true</c> if this user is a guest.</returns>
-
- <seealso cref="P:Sfs2X.Entities.User.PrivilegeId"/>
- </member>
- <member name="M:Sfs2X.Entities.User.IsStandardUser">
- <summary>
- Indicates whether this user logged in as a standard user or not.
- </summary>
-
- <remarks>
- Standard users have this property set to <see cref="F:Sfs2X.Entities.UserPrivileges.STANDARD"/>.
- </remarks>
-
- <returns><c>true</c> if this user is a standard user.</returns>
-
- <seealso cref="P:Sfs2X.Entities.User.PrivilegeId"/>
- </member>
- <member name="M:Sfs2X.Entities.User.IsModerator">
- <summary>
- Indicates whether this user logged in as a moderator or not.
- </summary>
-
- <remarks>
- Moderator users have this property set to <see cref="F:Sfs2X.Entities.UserPrivileges.MODERATOR"/>.
- </remarks>
-
- <returns><c>true</c> if this user is a moderator.</returns>
-
- <seealso cref="P:Sfs2X.Entities.User.PrivilegeId"/>
- </member>
- <member name="M:Sfs2X.Entities.User.IsAdmin">
- <summary>
- Indicates whether this user logged in as an administrator or not.
- </summary>
-
- <remarks>
- Administrator users have this property set to <see cref="F:Sfs2X.Entities.UserPrivileges.ADMINISTRATOR"/>.
- </remarks>
-
- <returns><c>true</c> if this user is an administrator.</returns>
-
- <seealso cref="P:Sfs2X.Entities.User.PrivilegeId"/>
- </member>
- <member name="M:Sfs2X.Entities.User.IsPlayerInRoom(Sfs2X.Entities.Room)">
- <summary>
- Indicates whether this user is a player (playerId greater than 0) in the passed Room or not.
- </summary>
-
- <remarks>
- Non-Game Rooms always return <c>false</c>.
- <para/>
- If a user can join one Game Room at a time only, use the <see cref="P:Sfs2X.Entities.User.IsPlayer"/> property.
- </remarks>
-
- <param name="room">The object representing the Room where to check if this user is a player.</param>
-
- <returns><c>true</c> if this user is a player in the passed Room.</returns>
- </member>
- <member name="M:Sfs2X.Entities.User.IsSpectatorInRoom(Sfs2X.Entities.Room)">
- <summary>
- Indicates whether this user is a spectator (playerId lower than 0) in the passed Room or not.
- </summary>
-
- <remarks>
- Non-Game Rooms always return <c>false</c>.
- <para/>
- If a user can join one Game Room at a time only, use the <see cref="P:Sfs2X.Entities.User.IsSpectator"/> property.
- </remarks>
-
- <param name="room">The object representing the Room where to check if this user is a spectator.</param>
- <returns><c>true</c> if this user is a spectator in the passed Room.</returns>
- </member>
- <member name="M:Sfs2X.Entities.User.IsJoinedInRoom(Sfs2X.Entities.Room)">
- <summary>
- Indicates whether this user joined the passed Room or not.
- </summary>
-
- <param name="room">The object representing the Room where to check the user presence.</param>
-
- <returns><c>true</c> if this user is inside the passed Room.</returns>
- </member>
- <member name="P:Sfs2X.Entities.User.IsItMe">
- <summary>
- Indicates if this User object represents the current client.
- </summary>
-
- <seealso cref="P:Sfs2X.SmartFox.MySelf"/>
- </member>
- <member name="M:Sfs2X.Entities.User.GetVariables">
- <summary>
- Retrieves all the User Variables of this user.
- </summary>
-
- <returns>A list of objects representing the User Variables associated with this user.</returns>
-
- <seealso cref="T:Sfs2X.Requests.SetUserVariablesRequest"/>
- </member>
- <member name="M:Sfs2X.Entities.User.GetVariable(System.String)">
- <summary>
- Retrieves a User Variable from its name.
- </summary>
-
- <param name="varName">The name of the User Variable to be retrieved.</param>
-
- <returns>The object representing the User Variable, or <c>null</c> if no User Variable with the passed name is associated with this user.</returns>
-
- <seealso cref="T:Sfs2X.Requests.SetUserVariablesRequest"/>
- </member>
- <member name="M:Sfs2X.Entities.User.SetVariable(Sfs2X.Entities.Variables.UserVariable)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.User.SetVariables(System.Collections.Generic.ICollection{Sfs2X.Entities.Variables.UserVariable})">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.User.ContainsVariable(System.String)">
- <summary>
- Indicates whether this user has the specified User Variable set or not.
- </summary>
-
- <param name="name">The name of the User Variable whose existance must be checked.</param>
-
- <returns><c>true</c> if a User Variable with the passed name is set for this user.</returns>
-
- <seealso cref="T:Sfs2X.Entities.Variables.UserVariable"/>
- </member>
- <member name="P:Sfs2X.Entities.User.Properties">
- <summary>
- Defines a generic utility object that can be used to store custom user data.
- </summary>
-
- <remarks>
- The values added to this object are for client-side use only and are never transmitted to the server or to the other clients.
- </remarks>
- </member>
- <member name="P:Sfs2X.Entities.User.AOIEntryPoint">
- <summary>
- Returns the entry point of this user in the current user's AoI.
- </summary>
-
- <remarks>
- The returned coordinates are those that the user had when his presence in the current user's Area of Interest was last notified by a <see cref="F:Sfs2X.Core.SFSEvent.PROXIMITY_LIST_UPDATE">PROXIMITY_LIST_UPDATE</see> event.
- This field is populated only if the user joined a Room of type MMORoom and this is configured to receive such data from the server.
- </remarks>
-
- <seealso cref="P:Sfs2X.Requests.MMO.MMORoomSettings.SendAOIEntryPoint"/>
- <seealso cref="F:Sfs2X.Core.SFSEvent.PROXIMITY_LIST_UPDATE"/>
- </member>
- <member name="T:Sfs2X.Entities.UserPrivileges">
- <summary>
- This class contains the costants describing the default user types known by SmartFoxServer.
- </summary>
-
- <remarks>
- The server assigns one of these values or a custom-defined one to the <see cref="P:Sfs2X.Entities.User.PrivilegeId">User.PrivilegeId</see> property whenever a user logs in.
- <para/>
- Read the SmartFoxServer 2X documentation for more informations about privilege profiles and their permissions.
- </remarks>
-
- <seealso cref="P:Sfs2X.Entities.User.PrivilegeId"/>
- </member>
- <member name="F:Sfs2X.Entities.UserPrivileges.GUEST">
- <summary>
- The Guest user is usually the lowest level in the privilege profiles scale.
- </summary>
- </member>
- <member name="F:Sfs2X.Entities.UserPrivileges.STANDARD">
- <summary>
- The standard user is usually registered in the application custom login system; uses a unique name and password to login.
- </summary>
- </member>
- <member name="F:Sfs2X.Entities.UserPrivileges.MODERATOR">
- <summary>
- The moderator user can send dedicated "moderator messages", kick and ban users.
- </summary>
-
- <seealso cref="T:Sfs2X.Requests.ModeratorMessageRequest"/>
- <seealso cref="T:Sfs2X.Requests.KickUserRequest"/>
- <seealso cref="T:Sfs2X.Requests.BanUserRequest"/>
- </member>
- <member name="F:Sfs2X.Entities.UserPrivileges.ADMINISTRATOR">
- <summary>
- The administrator user can send dedicated "administrator messages", kick and ban users.
- </summary>
-
- <seealso cref="T:Sfs2X.Requests.AdminMessageRequest"/>
- <seealso cref="T:Sfs2X.Requests.KickUserRequest"/>
- <seealso cref="T:Sfs2X.Requests.BanUserRequest"/>
- </member>
- <member name="T:Sfs2X.Entities.Data.ISFSArray">
- <summary>
- The ISFSArray interface defines all the public methods and properties of the SFSArray class used by SmartFoxServer in client-server data transfer.
- </summary>
-
- <remarks>
- Read the implementor class description for additional informations.
- <para/>
- Check the <see cref="T:Sfs2X.Entities.Data.SFSDataType"/> enumeration for more informations on supported data types.
- </remarks>
-
- <seealso cref="T:Sfs2X.Entities.Data.SFSArray"/>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSArray.Contains(System.Object)">
- <summary>
- Indicates whether this array contains the specified object or not.
- </summary>
-
- <param name="obj">The object whose presence in this array is to be tested.</param>
-
- <returns><c>true</c> if the specified object is present.</returns>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSArray.GetElementAt(System.Int32)">
- <summary>
- Returns the element at the specified position in this array.
- </summary>
-
- <param name="index">The position of the element to return.</param>
-
- <returns>The element at the specified index in this array.</returns>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSArray.GetWrappedElementAt(System.Int32)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSArray.RemoveElementAt(System.Int32)">
- <summary>
- Removes the element at the specified position in this array.
- </summary>
-
- <param name="index">The position of the element to be removed.</param>
-
- <returns>The element that was removed.</returns>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSArray.Size">
- <summary>
- Indicates the number of elements in this array.
- </summary>
-
- <returns>The number of elements in this array.</returns>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSArray.ToBinary">
- <summary>
- Provides the binary form of this array.
- </summary>
-
- <returns>The binary data representing this array.</returns>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSArray.ToJson">
- <summary>
- Provides the JSON representation of this array.
- </summary>
-
- <remarks>
- This method is not available in Windows / Windows Phone.
- </remarks>
-
- <returns>The JSON string representing this array.</returns>
-
- <remarks>This method is not available in Windows 8 / Windows Phone 8.</remarks>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSArray.GetDump(System.Boolean)">
- <summary>
- Provides a formatted string representing this array.
- </summary>
-
- <remarks>
- The returned string can be logged or traced in the console for debugging purposes.
- </remarks>
-
- <param name="format">If <c>true</c>, the output is formatted in a human-readable way.</param>
-
- <returns>The string representation of this array.</returns>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSArray.GetDump">
- <summary>
- See <see cref="M:Sfs2X.Entities.Data.ISFSArray.GetDump(System.Boolean)"/>.
- </summary>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSArray.GetHexDump">
- <summary>
- Provides a detailed hexadecimal representation of this array.
- </summary>
-
- <remarks>
- The returned string can be logged or traced in the console for debugging purposes.
- </remarks>
-
- <returns>The hexadecimal string representation of this array.</returns>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSArray.AddNull">
- <summary>
- Appends a <c>null</c> value to the end of this array.
- </summary>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSArray.AddBool(System.Boolean)">
- <summary>
- Appends a boolean value to the end of this array.
- </summary>
-
- <param name="val">The value to be appended to this array.</param>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSArray.AddByte(System.Byte)">
- <summary>
- Appends a byte (8 bits) value to the end of this array.
- </summary>
-
- <param name="val">The value to be appended to this array.</param>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSArray.AddShort(System.Int16)">
- <summary>
- Appends a short integer (16 bits) value to the end of this array.
- </summary>
-
- <param name="val">The value to be appended to this array.</param>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSArray.AddInt(System.Int32)">
- <summary>
- Appends an integer (32 bits) value to the end of this array.
- </summary>
- <param name="val">The value to be appended to this array.</param>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSArray.AddLong(System.Int64)">
- <summary>
- Appends a long integer (64 bits) value to the end of this array.
- </summary>
-
- <param name="val">The value to be appended to this array.</param>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSArray.AddFloat(System.Single)">
- <summary>
- Appends a floating point number (32 bits) value to the end of this array.
- </summary>
-
- <param name="val">The value to be appended to this array.</param>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSArray.AddDouble(System.Double)">
- <summary>
- Appends a double precision number (64 bits) value to the end of this array.
- </summary>
-
- <param name="val">The value to be appended to this array.</param>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSArray.AddUtfString(System.String)">
- <summary>
- Appends a UTF-8 string (with max length of 32 KBytes) value to the end of this array.
- </summary>
-
- <param name="val">The value to be appended to this array.</param>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSArray.AddText(System.String)">
- <summary>
- Appends a UTF-8 string (with max length of 2 GBytes) value to the end of this array.
- </summary>
-
- <param name="val">The value to be appended to this array.</param>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSArray.AddBoolArray(System.Boolean[])">
- <summary>
- Appends an array of boolean values to the end of this array.
- </summary>
-
- <param name="val">The array of booleans to be appended to this array.</param>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSArray.AddByteArray(Sfs2X.Util.ByteArray)">
- <summary>
- Appends a ByteArray object to the end of this array.
- </summary>
-
- <remarks>
- <b>IMPORTANT</b>: ByteArrays transmission is not supported in Unity WebGL.
- </remarks>
-
- <param name="val">The ByteArray object to be appended to this array.</param>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSArray.AddShortArray(System.Int16[])">
- <summary>
- Appends an array of short integer values to the end of this array.
- </summary>
-
- <param name="val">The array of shorts to be appended to this array.</param>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSArray.AddIntArray(System.Int32[])">
- <summary>
- Appends an array of integer values to the end of this array.
- </summary>
-
- <param name="val">The array of ints to be appended to this array.</param>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSArray.AddLongArray(System.Int64[])">
- <summary>
- Appends an array of long integer values to the end of this array.
- </summary>
-
- <param name="val">The array of longs to be appended to this array.</param>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSArray.AddFloatArray(System.Single[])">
- <summary>
- Appends an array of floating point number values to the end of this array.
- </summary>
-
- <param name="val">The array of floats to be appended to this array.</param>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSArray.AddDoubleArray(System.Double[])">
- <summary>
- Appends an array of double precision number values to the end of this array.
- </summary>
-
- <param name="val">The array of doubles to be appended to this array.</param>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSArray.AddUtfStringArray(System.String[])">
- <summary>
- Appends an array of UTF-8 string values to the end of this array.
- </summary>
-
- <param name="val">The array of strings to be appended to this array.</param>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSArray.AddSFSArray(Sfs2X.Entities.Data.ISFSArray)">
- <summary>
- Appends an ISFSArray object to the end of this array.
- </summary>
-
- <param name="val">The object implementing the ISFSArray interface to be appended to this array.</param>
-
- <seealso cref="T:Sfs2X.Entities.Data.SFSArray"/>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSArray.AddSFSObject(Sfs2X.Entities.Data.ISFSObject)">
- <summary>
- Appends a ISFSObject object to the end of this array.
- </summary>
-
- <param name="val">The object implementing the ISFSObject interface to be appended to this array.</param>
-
- <seealso cref="T:Sfs2X.Entities.Data.SFSObject"/>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSArray.AddClass(System.Object)">
- <summary>
- Appends the passed custom class instance to the end of this array.
- </summary>
-
- <remarks>
- Read the <see cref="M:Sfs2X.Entities.Data.ISFSArray.GetClass(System.Int32)"/> method description for more informations.
- <para/>
- <b>IMPORTANT</b>: class serialization is not supported in Unity WebGL.
- </remarks>
-
- <param name="val">The custom class instance to be appended to this array.</param>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSArray.Add(Sfs2X.Entities.Data.SFSDataWrapper)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSArray.IsNull(System.Int32)">
- <summary>
- Indicates if the element at the specified position in this array is <c>null</c>.
- </summary>
-
- <param name="index">The position of the element to be checked.</param>
-
- <returns><c>true</c> if the element of this array at the specified position is <c>null</c>.</returns>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSArray.GetBool(System.Int32)">
- <summary>
- Returns the element at the specified position as a boolean.
- </summary>
-
- <param name="index">The position of the element to return.</param>
-
- <returns>The element of this array at the specified index.</returns>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSArray.GetByte(System.Int32)">
- <summary>
- Returns the element at the specified position as a signed byte (8 bits).
- </summary>
-
- <param name="index">The position of the element to return.</param>
-
- <returns>The element of this array at the specified index.</returns>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSArray.GetShort(System.Int32)">
- <summary>
- Returns the element at the specified position as a short integer (16 bits).
- </summary>
-
- <param name="index">The position of the element to return.</param>
-
- <returns>The element of this array at the specified index.</returns>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSArray.GetInt(System.Int32)">
- <summary>
- Returns the element at the specified position as an integer (32 bits).
- </summary>
-
- <param name="index">The position of the element to return.</param>
-
- <returns>The element of this array at the specified index.</returns>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSArray.GetLong(System.Int32)">
- <summary>
- Returns the element at the specified position as a long integer (64 bits).
- </summary>
-
- <param name="index">The position of the element to return.</param>
-
- <returns>The element of this array at the specified index.</returns>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSArray.GetFloat(System.Int32)">
- <summary>
- Returns the element at the specified position as a floating point number.
- </summary>
-
- <param name="index">The position of the element to return.</param>
-
- <returns>The element of this array at the specified index.</returns>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSArray.GetDouble(System.Int32)">
- <summary>
- Returns the element at the specified position as a double precision number.
- </summary>
-
- <param name="index">The position of the element to return.</param>
-
- <returns>The element of this array at the specified index.</returns>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSArray.GetUtfString(System.Int32)">
- <summary>
- Returns the element at the specified position as an UTF-8 string, with max length of 32 KBytes.
- </summary>
-
- <param name="index">The position of the element to return.</param>
-
- <returns>The element of this array at the specified index.</returns>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSArray.GetText(System.Int32)">
- <summary>
- Returns the element at the specified position as an UTF-8 string, with max length of 2 GBytes.
- </summary>
-
- <param name="index">The position of the element to return.</param>
-
- <returns>The element of this array at the specified index.</returns>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSArray.GetBoolArray(System.Int32)">
- <summary>
- Returns the element at the specified position as an array of booleans.
- </summary>
-
- <param name="index">The position of the element to return.</param>
-
- <returns>The element of this array as an array of booleans.</returns>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSArray.GetByteArray(System.Int32)">
- <summary>
- Returns the element at the specified position as a ByteArray object.
- </summary>
-
- <remarks>
- <b>IMPORTANT</b>: ByteArrays transmission is not supported in Unity WebGL.
- </remarks>
-
- <param name="index">The position of the element to return.</param>
-
- <returns>The element of this array as a ByteArray object.</returns>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSArray.GetShortArray(System.Int32)">
- <summary>
- Returns the element at the specified position as an array of shorts.
- </summary>
-
- <param name="index">The position of the element to return.</param>
-
- <returns>The element of this array as an array of shorts.</returns>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSArray.GetIntArray(System.Int32)">
- <summary>
- Returns the element at the specified position as an array of integers.
- </summary>
-
- <param name="index">The position of the element to return.</param>
-
- <returns>The element of this array as an array of integers.</returns>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSArray.GetLongArray(System.Int32)">
- <summary>
- Returns the element at the specified position as an array of longs.
- </summary>
-
- <param name="index">The position of the element to return.</param>
-
- <returns>The element of this array as an array of longs.</returns>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSArray.GetFloatArray(System.Int32)">
- <summary>
- Returns the element at the specified position as an array of floats.
- </summary>
-
- <param name="index">The position of the element to return.</param>
-
- <returns>The element of this array as an array of floats.</returns>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSArray.GetDoubleArray(System.Int32)">
- <summary>
- Returns the element at the specified position as an array of doubles.
- </summary>
-
- <param name="index">The position of the element to return.</param>
-
- <returns>The element of this array as an array of doubles.</returns>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSArray.GetUtfStringArray(System.Int32)">
- <summary>
- Returns the element at the specified position as an array of UTF-8 strings.
- </summary>
-
- <param name="index">The position of the element to return.</param>
-
- <returns>The element of this array as an array of UTF-8 strings.</returns>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSArray.GetSFSArray(System.Int32)">
- <summary>
- Returns the element at the specified position as an ISFSArray object.
- </summary>
-
- <param name="index">The position of the element to return.</param>
-
- <returns>The element of this array as an object implementing the ISFSArray interface.</returns>
-
- <seealso cref="T:Sfs2X.Entities.Data.SFSArray"/>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSArray.GetSFSObject(System.Int32)">
- <summary>
- Returns the element at the specified position as an ISFSObject object.
- </summary>
-
- <param name="index">The position of the element to return.</param>
-
- <returns>The element of this array as an object implementing the ISFSObject interface.</returns>
-
- <seealso cref="T:Sfs2X.Entities.Data.SFSObject"/>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSArray.GetClass(System.Int32)">
- <summary>
- Returns the element at the specified position as an instance of a custom class.
- </summary>
-
- <remarks>
- This advanced feature allows the transmission of specific object instances between client-side C# and server-side Java provided that:<br/>
- - the respective class definitions on both sides have the same package name<br/>
- - the class implements the SerializableSFSType interface on both sides<br/>
- - the following code is executed right after creating the SmartFox object: <c>DefaultSFSDataSerializer.RunningAssembly = Assembly.GetExecutingAssembly();</c> (requires <c>System.Reflection</c> and <c>Sfs2X.Protocol.Serialization</c>)
- <para/>
- <b>IMPORTANT</b>: class serialization is not supported in Unity WebGL.
- </remarks>
-
- <param name="index">The position of the element to return.</param>
-
- <returns>The element of this array as a generic object type to be casted to the target class definition.</returns>
-
- <example>
- The following example shows the same class on the client and server sides, which can be transferred back and forth with the <see cref="M:Sfs2X.Entities.Data.ISFSArray.GetClass(System.Int32)"/> and <see cref="M:Sfs2X.Entities.Data.ISFSArray.AddClass(System.Object)"/> methods.
- <para/>
- The server-side Java definition of a SpaceShip class is:
- <code>
- package my.game.spacecombat
-
- public class SpaceShip implements SerializableSFSType
- {
- private String type;
- private String name;
- private int firePower;
- private int maxSpeed;
- private List<String> weapons;
-
- public SpaceShip(String name, String type)
- {
- this.name = name;
- this.type = type;
- }
-
- // ... Getters / Setters ...
- }
- </code>
- <para/>
- The client-side C# definition of the SpaceShip class is:
- <code>
- namespace my.game.spacecombat
- {
- public class SpaceShip : SerializableSFSType
- {
- private string _type;
- private string _name;
- private int _firePower;
- private int _maxSpeed;
- private Array _weapons;
-
- public SpaceShip(string name, string type)
- {
- _name = name
- _type = type
- }
-
- // ... Getters / Setters ...
- }
- }
- </code>
- <para/>
- A SpaceShip instance is sent by the server to the client in the first position of an array. This is how to retrieve it:
- <code>
- SpaceShip myShipData = (SpaceShip)sfsArray.GetClass(0);
- </code>
- </example>
- </member>
- <member name="T:Sfs2X.Entities.Data.ISFSObject">
- <summary>
- The ISFSObject interface defines all the public methods and properties of the SFSObject class used by SmartFoxServer in client-server data transfer.
- </summary>
-
- <remarks>
- Read the implementor class description for additional informations.
- <para/>
- Check the <see cref="T:Sfs2X.Entities.Data.SFSDataType"/> enumeration for more informations on supported data types.
- </remarks>
-
- <seealso cref="T:Sfs2X.Entities.Data.SFSObject"/>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSObject.IsNull(System.String)">
- <summary>
- Indicates if the value mapped by the specified key is <c>null</c>.
- </summary>
-
- <param name="key">The key to be checked.</param>
-
- <returns><c>true</c> if the value mapped by the passed key is <c>null</c> or the mapping doesn't exist for that key.</returns>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSObject.ContainsKey(System.String)">
- <summary>
- Indicates whether this object contains a mapping for the specified key or not.
- </summary>
-
- <param name="key">The key whose presence in this object is to be tested.</param>
-
- <returns><c>true</c> if this object contains a mapping for the specified key.</returns>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSObject.RemoveElement(System.String)">
- <summary>
- Removes the element corresponding to the passed key from this object.
- </summary>
-
- <param name="key">The key of the element to be removed.</param>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSObject.GetKeys">
- <summary>
- Retrieves a list of all the keys contained in this object.
- </summary>
-
- <returns>The list of all the keys in this object.</returns>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSObject.Size">
- <summary>
- Indicates the number of elements in this object.
- </summary>
-
- <returns>The number of elements in this object.</returns>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSObject.ToBinary">
- <summary>
- Provides the binary form of this object.
- </summary>
-
- <returns>The binary data representing this object.</returns>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSObject.ToJson">
- <summary>
- Provides the JSON representation of this object.
- </summary>
-
- <remarks>
- This method is not available in Windows / Windows Phone.
- </remarks>
-
- <returns>The JSON string representing this object.</returns>
-
- <remarks>This method is not available in Windows 8 / Windows Phone 8.</remarks>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSObject.GetDump(System.Boolean)">
- <summary>
- Provides a formatted string representing this object.
- </summary>
-
- <remarks>
- The returned string can be logged or traced in the console for debugging purposes.
- </remarks>
-
- <param name="format">If <c>true</c>, the output is formatted in a human-readable way.</param>
-
- <returns>The string representation of this object.</returns>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSObject.GetDump">
- <summary>
- See <see cref="M:Sfs2X.Entities.Data.ISFSObject.GetDump(System.Boolean)"/>.
- </summary>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSObject.GetHexDump">
- <summary>
- Provides a detailed hexadecimal representation of this object.
- </summary>
-
- <remarks>
- The returned string can be logged or traced in the console for debugging purposes.
- </remarks>
-
- <returns>The hexadecimal string representation of this object.</returns>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSObject.GetData(System.String)">
- <exclude />
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSObject.GetBool(System.String)">
- <summary>
- Returns the element corresponding to the specified key as a boolean.
- </summary>
-
- <param name="key">The key whose associated value is to be returned.</param>
-
- <returns>The element of this object associated with the specified key; <c>false</c> if a mapping for the passed key doesn't exist.</returns>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSObject.GetByte(System.String)">
- <summary>
- Returns the element corresponding to the specified key as a signed byte (8 bits).
- </summary>
-
- <param name="key">The key whose associated value is to be returned.</param>
-
- <returns>The element of this object associated with the specified key; <c>0</c> if a mapping for the passed key doesn't exist.</returns>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSObject.GetShort(System.String)">
- <summary>
- Returns the element corresponding to the specified key as a short integer (16 bits).
- </summary>
-
- <param name="key">The key whose associated value is to be returned.</param>
-
- <returns>The element of this object associated with the specified key; <c>0</c> if a mapping for the passed key doesn't exist.</returns>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSObject.GetInt(System.String)">
- <summary>
- Returns the element corresponding to the specified key as an integer (32 bits).
- </summary>
-
- <param name="key">The key whose associated value is to be returned.</param>
-
- <returns>The element of this object associated with the specified key; <c>0</c> if a mapping for the passed key doesn't exist.</returns>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSObject.GetLong(System.String)">
- <summary>
- Returns the element corresponding to the specified key as a long integer (64 bits).
- </summary>
-
- <param name="key">The key whose associated value is to be returned.</param>
-
- <returns>The element of this object associated with the specified key; <c>0</c> if a mapping for the passed key doesn't exist.</returns>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSObject.GetFloat(System.String)">
- <summary>
- Returns the element corresponding to the specified key as a floating point number.
- </summary>
-
- <param name="key">The key whose associated value is to be returned.</param>
-
- <returns>The element of this object associated with the specified key; <c>0</c> if a mapping for the passed key doesn't exist.</returns>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSObject.GetDouble(System.String)">
- <summary>
- Returns the element corresponding to the specified key as a double precision number.
- </summary>
-
- <param name="key">The key whose associated value is to be returned.</param>
-
- <returns>The element of this object associated with the specified key; <c>0</c> if a mapping for the passed key doesn't exist.</returns>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSObject.GetUtfString(System.String)">
- <summary>
- Returns the element corresponding to the specified key as an UTF-8 string, with max length of 32 KBytes.
- </summary>
-
- <param name="key">The key whose associated value is to be returned.</param>
-
- <returns>The element of this object associated with the specified key; <c>null</c> if a mapping for the passed key doesn't exist.</returns>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSObject.GetText(System.String)">
- <summary>
- Returns the element corresponding to the specified key as an UTF-8 string, with max length of 2 GBytes.
- </summary>
-
- <param name="key">The key whose associated value is to be returned.</param>
-
- <returns>The element of this object associated with the specified key; <c>null</c> if a mapping for the passed key doesn't exist.</returns>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSObject.GetBoolArray(System.String)">
- <summary>
- Returns the element corresponding to the specified key as an array of booleans.
- </summary>
-
- <param name="key">The key whose associated value is to be returned.</param>
-
- <returns>The element of this object as an array of booleans; <c>null</c> if a mapping for the passed key doesn't exist.</returns>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSObject.GetByteArray(System.String)">
- <summary>
- Returns the element corresponding to the specified key as a ByteArray object.
- </summary>
-
- <remarks>
- <b>IMPORTANT</b>: ByteArrays transmission is not supported in Unity WebGL.
- </remarks>
-
- <param name="key">The key whose associated value is to be returned.</param>
-
- <returns>The element of this object as a ByteArray object; <c>null</c> if a mapping for the passed key doesn't exist.</returns>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSObject.GetShortArray(System.String)">
- <summary>
- Returns the element corresponding to the specified key as an array of shorts.
- </summary>
-
- <param name="key">The key whose associated value is to be returned.</param>
-
- <returns>The element of this object as an array of shorts; <c>null</c> if a mapping for the passed key doesn't exist.</returns>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSObject.GetIntArray(System.String)">
- <summary>
- Returns the element corresponding to the specified key as an array of integers.
- </summary>
-
- <param name="key">The key whose associated value is to be returned.</param>
-
- <returns>The element of this object as an array of integers; <c>null</c> if a mapping for the passed key doesn't exist.</returns>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSObject.GetLongArray(System.String)">
- <summary>
- Returns the element corresponding to the specified key as an array of longs.
- </summary>
-
- <param name="key">The key whose associated value is to be returned.</param>
-
- <returns>The element of this object as an array of longs; <c>null</c> if a mapping for the passed key doesn't exist.</returns>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSObject.GetFloatArray(System.String)">
- <summary>
- Returns the element corresponding to the specified key as an array of floats.
- </summary>
-
- <param name="key">The key whose associated value is to be returned.</param>
-
- <returns>The element of this object as an array of floats; <c>null</c> if a mapping for the passed key doesn't exist.</returns>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSObject.GetDoubleArray(System.String)">
- <summary>
- Returns the element corresponding to the specified key as an array of doubles.
- </summary>
-
- <param name="key">The key whose associated value is to be returned.</param>
-
- <returns>The element of this object as an array of doubles; <c>null</c> if a mapping for the passed key doesn't exist.</returns>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSObject.GetUtfStringArray(System.String)">
- <summary>
- Returns the element corresponding to the specified key as an array of UTF-8 strings.
- </summary>
-
- <param name="key">The key whose associated value is to be returned.</param>
-
- <returns>The element of this object as an array of UTF-8 strings; <c>null</c> if a mapping for the passed key doesn't exist.</returns>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSObject.GetSFSArray(System.String)">
- <summary>
- Returns the element corresponding to the specified key as an ISFSArray object.
- </summary>
-
- <param name="key">The key whose associated value is to be returned.</param>
-
- <returns>The element of this object as an object implementing the ISFSArray interface; <c>null</c> if a mapping for the passed key doesn't exist.</returns>
-
- <seealso cref="T:Sfs2X.Entities.Data.SFSArray"/>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSObject.GetSFSObject(System.String)">
- <summary>
- Returns the element corresponding to the specified key as an ISFSObject object.
- </summary>
-
- <param name="key">The key whose associated value is to be returned.</param>
-
- <returns>The element of this object as an object implementing the ISFSObject interface; <c>null</c> if a mapping for the passed key doesn't exist.</returns>
-
- <seealso cref="T:Sfs2X.Entities.Data.SFSObject"/>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSObject.GetClass(System.String)">
- <summary>
- Returns the element corresponding to the specified key as an instance of a custom class.
- </summary>
-
- <remarks>
- This advanced feature allows the transmission of specific object instances between client-side C# and server-side Java provided that:<br/>
- - the respective class definitions on both sides have the same package/namespace name<br/>
- - the class implements the SerializableSFSType interface on both sides<br/>
- - the following code is executed right after creating the SmartFox object: <c>DefaultSFSDataSerializer.RunningAssembly = Assembly.GetExecutingAssembly();</c> (requires <c>System.Reflection</c> and <c>Sfs2X.Protocol.Serialization</c>)
- <para/>
- <b>IMPORTANT</b>: class serialization is not supported in Unity WebGL.
- </remarks>
-
- <param name="key">The key whose associated value is to be returned.</param>
-
- <returns>The element of this object as a generic object type to be casted to the target class definition; <c>null</c> if a mapping for the passed key doesn't exist.</returns>
-
- <example>
- The following example shows the same class on the client and server sides, which can be transferred back and forth with the <see cref="M:Sfs2X.Entities.Data.ISFSObject.GetClass(System.String)"/> and <see cref="M:Sfs2X.Entities.Data.ISFSObject.PutClass(System.String,System.Object)"/> methods.
- <para/>
- The server-side Java definition of a SpaceShip class is:
- <code>
- package my.game.spacecombat
-
- public class SpaceShip implements SerializableSFSType
- {
- private String type;
- private String name;
- private int firePower;
- private int maxSpeed;
- private List<String> weapons;
-
- public SpaceShip(String name, String type)
- {
- this.name = name;
- this.type = type;
- }
-
- // ... Getters / Setters ...
- }
- </code>
- <para/>
- The client-side C# definition of the SpaceShip class is:
- <code>
- namespace my.game.spacecombat
- {
- public class SpaceShip : SerializableSFSType
- {
- private string _type;
- private string _name;
- private int _firePower;
- private int _maxSpeed;
- private Array _weapons;
-
- public SpaceShip(string name, string type)
- {
- _name = name
- _type = type
- }
-
- // ... Getters / Setters ...
- }
- }
- </code>
- <para/>
- The SpaceShip instance is sent by the server to the client. This is how to retrieve it:
- <code>
- SpaceShip myShipData = (SpaceShip)sfsObject.GetClass(key);
- </code>
- </example>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSObject.PutNull(System.String)">
- <exclude />
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSObject.PutBool(System.String,System.Boolean)">
- <summary>
- Associates the passed boolean value with the specified key in this object.
- </summary>
-
- <param name="key">The key with which the specified value is to be associated.</param>
- <param name="val">The value to be associated with the specified key.</param>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSObject.PutByte(System.String,System.Byte)">
- <summary>
- Associates the passed byte value with the specified key in this object.
- </summary>
-
- <param name="key">The key with which the specified value is to be associated.</param>
- <param name="val">The value to be associated with the specified key.</param>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSObject.PutShort(System.String,System.Int16)">
- <summary>
- Associates the passed short value with the specified key in this object.
- </summary>
-
- <param name="key">The key with which the specified value is to be associated.</param>
- <param name="val">The value to be associated with the specified key.</param>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSObject.PutInt(System.String,System.Int32)">
- <summary>
- Associates the passed integer value with the specified key in this object.
- </summary>
-
- <param name="key">The key with which the specified value is to be associated.</param>
- <param name="val">The value to be associated with the specified key.</param>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSObject.PutLong(System.String,System.Int64)">
- <summary>
- Associates the passed long value with the specified key in this object.
- </summary>
-
- <param name="key">The key with which the specified value is to be associated.</param>
- <param name="val">The value to be associated with the specified key.</param>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSObject.PutFloat(System.String,System.Single)">
- <summary>
- Associates the passed float value with the specified key in this object.
- </summary>
-
- <param name="key">The key with which the specified value is to be associated.</param>
- <param name="val">The value to be associated with the specified key.</param>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSObject.PutDouble(System.String,System.Double)">
- <summary>
- Associates the passed double value with the specified key in this object.
- </summary>
-
- <param name="key">The key with which the specified value is to be associated.</param>
- <param name="val">The value to be associated with the specified key.</param>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSObject.PutUtfString(System.String,System.String)">
- <summary>
- Associates the passed UTF-8 string value (max length: 32 KBytes) with the specified key in this object.
- </summary>
-
- <param name="key">The key with which the specified value is to be associated.</param>
- <param name="val">The value to be associated with the specified key.</param>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSObject.PutText(System.String,System.String)">
- <summary>
- Associates the passed UTF-8 string value (max length: 2 GBytes) with the specified key in this object.
- </summary>
-
- <param name="key">The key with which the specified value is to be associated.</param>
- <param name="val">The value to be associated with the specified key.</param>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSObject.PutBoolArray(System.String,System.Boolean[])">
- <summary>
- Associates the passed array of booleans with the specified key in this object.
- </summary>
-
- <param name="key">The key with which the specified array is to be associated.</param>
- <param name="val">The array of booleans to be associated with the specified key.</param>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSObject.PutByteArray(System.String,Sfs2X.Util.ByteArray)">
- <summary>
- Associates the passed ByteArray object with the specified key in this object.
- </summary>
-
- <remarks>
- <b>IMPORTANT</b>: ByteArrays transmission is not supported in Unity WebGL.
- </remarks>
-
- <param name="key">The key with which the specified object is to be associated.</param>
- <param name="val">The object to be associated with the specified key.</param>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSObject.PutShortArray(System.String,System.Int16[])">
- <summary>
- Associates the passed array of shorts with the specified key in this object.
- </summary>
-
- <param name="key">The key with which the specified array is to be associated.</param>
- <param name="val">The array of shorts to be associated with the specified key.</param>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSObject.PutIntArray(System.String,System.Int32[])">
- <summary>
- Associates the passed array of integers with the specified key in this object.
- </summary>
-
- <param name="key">The key with which the specified array is to be associated.</param>
- <param name="val">The array of integers to be associated with the specified key.</param>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSObject.PutLongArray(System.String,System.Int64[])">
- <summary>
- Associates the passed array of longs with the specified key in this object.
- </summary>
-
- <param name="key">The key with which the specified array is to be associated.</param>
- <param name="val">The array of longs to be associated with the specified key.</param>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSObject.PutFloatArray(System.String,System.Single[])">
- <summary>
- Associates the passed array of floats with the specified key in this object.
- </summary>
-
- <param name="key">The key with which the specified array is to be associated.</param>
- <param name="val">The array of floats to be associated with the specified key.</param>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSObject.PutDoubleArray(System.String,System.Double[])">
- <summary>
- Associates the passed array of doubles with the specified key in this object.
- </summary>
-
- <param name="key">The key with which the specified array is to be associated.</param>
- <param name="val">The array of doubles to be associated with the specified key.</param>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSObject.PutUtfStringArray(System.String,System.String[])">
- <summary>
- Associates the passed array of UTF-8 strings with the specified key in this object.
- </summary>
-
- <param name="key">The key with which the specified array is to be associated.</param>
- <param name="val">The array of UTF-8 strings to be associated with the specified key.</param>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSObject.PutSFSArray(System.String,Sfs2X.Entities.Data.ISFSArray)">
- <summary>
- Associates the passed ISFSArray object with the specified key in this object.
- </summary>
-
- <param name="key">The key with which the specified object is to be associated.</param>
- <param name="val">The object to be associated with the specified key.</param>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSObject.PutSFSObject(System.String,Sfs2X.Entities.Data.ISFSObject)">
- <summary>
- Associates the passed ISFSObject object with the specified key in this object.
- </summary>
-
- <param name="key">The key with which the specified object is to be associated.</param>
- <param name="val">The object to be associated with the specified key.</param>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSObject.PutClass(System.String,System.Object)">
- <summary>
- Associates the passed custom class instance with the specified key in this object.
- </summary>
-
- <remarks>
- Read the <see cref="M:Sfs2X.Entities.Data.ISFSObject.GetClass(System.String)"/> method description for more informations.
- <para/>
- <b>IMPORTANT</b>: class serialization is not supported in Unity WebGL.
- </remarks>
-
- <param name="key">The key with which the specified custom class instance is to be associated.</param>
- <param name="val">The custom class instance to be associated with the specified key.</param>
-
- <seealso cref="M:Sfs2X.Entities.Data.ISFSObject.GetClass(System.String)"/>
- </member>
- <member name="M:Sfs2X.Entities.Data.ISFSObject.Put(System.String,Sfs2X.Entities.Data.SFSDataWrapper)">
- <exclude/>
- </member>
- <member name="T:Sfs2X.Entities.Data.SFSArray">
- <summary>
- The SFSArray class is used by SmartFoxServer in client-server data transfer.
- </summary>
-
- <remarks>
- This class can be thought of as a specialized Array/List object that can contain any type of data.
- <para/>
- The advantage of using the SFSArray class (for example as a nested object inside a <see cref="T:Sfs2X.Entities.Data.SFSObject"/> object) is that you can fine tune the way your data is transmitted over the network.
- For instance, when transmitting a list of numbers between 0 and 100, those values can be treated as normal integers (which take 32 bits each), but also as shorts (16 bit) or even as bytes (8 bit).
- <para/>
- SFSArray supports many primitive data types and related arrays of primitives (see the <see cref="T:Sfs2X.Entities.Data.SFSDataType"/> class). It also allows to serialize class instances and rebuild them on the other side (client or server).
- Check the SmartFoxServer 2X documentation for more informations on this advanced topic.
- </remarks>
-
- <seealso cref="T:Sfs2X.Entities.Data.SFSObject"/>
- <seealso cref="T:Sfs2X.Entities.Data.SFSDataType"/>
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSArray.NewFromBinaryData(Sfs2X.Util.ByteArray)">
- <summary>
- Returns a new SFSArray instance.
- </summary>
-
- <remarks>
- This is an alternative static constructor that builds an SFSArray from a valid SFSArray binary representation.
- </remarks>
-
- <param name="ba">The ByteArray representation of a SFSArray.</param>
-
- <returns>A new SFSArray instance.</returns>
-
- <seealso cref="M:Sfs2X.Entities.Data.SFSArray.#ctor"/>
- <seealso cref="M:Sfs2X.Entities.Data.SFSArray.NewInstance"/>
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSArray.NewFromJsonData(System.String)">
- <summary>
- Returns a new ISFSArray instance.
- </summary>
-
- <remarks>
- This is an alternative static constructor that builds an ISFSArray from a valid JSON string representation.<br/>
- This method is not available in Windows / Windows Phone.
- </remarks>
-
- <param name="js">The JSON representation of a SFSArray.</param>
-
- <returns>A new ISFSArray instance.</returns>
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSArray.NewInstance">
- <summary>
- Returns a new SFSArray instance.
- </summary>
-
- <remarks>
- This method is a static alternative to the standard class constructor.
- </remarks>
-
- <returns>A new SFSArray instance.</returns>
-
- <seealso cref="M:Sfs2X.Entities.Data.SFSArray.#ctor"/>
- <seealso cref="M:Sfs2X.Entities.Data.SFSArray.NewFromBinaryData(Sfs2X.Util.ByteArray)"/>
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSArray.#ctor">
- <summary>
- Returns a new SFSArray instance.
- </summary>
-
- <seealso cref="M:Sfs2X.Entities.Data.SFSArray.NewInstance"/>
- <seealso cref="M:Sfs2X.Entities.Data.SFSArray.NewFromBinaryData(Sfs2X.Util.ByteArray)"/>
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSArray.Contains(System.Object)">
- <inheritdoc />
-
- <remarks>Checking if this object contains an inner SFSObject or SFSArray is not supported.</remarks>
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSArray.GetWrappedElementAt(System.Int32)">
- <exclude />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSArray.GetElementAt(System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSArray.RemoveElementAt(System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSArray.Size">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSArray.ToBinary">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSArray.ToJson">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSArray.GetDump">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSArray.GetDump(System.Boolean)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSArray.GetHexDump">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSArray.AddNull">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSArray.AddBool(System.Boolean)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSArray.AddByte(System.Byte)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSArray.AddShort(System.Int16)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSArray.AddInt(System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSArray.AddLong(System.Int64)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSArray.AddFloat(System.Single)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSArray.AddDouble(System.Double)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSArray.AddUtfString(System.String)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSArray.AddText(System.String)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSArray.AddBoolArray(System.Boolean[])">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSArray.AddByteArray(Sfs2X.Util.ByteArray)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSArray.AddShortArray(System.Int16[])">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSArray.AddIntArray(System.Int32[])">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSArray.AddLongArray(System.Int64[])">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSArray.AddFloatArray(System.Single[])">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSArray.AddDoubleArray(System.Double[])">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSArray.AddUtfStringArray(System.String[])">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSArray.AddSFSArray(Sfs2X.Entities.Data.ISFSArray)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSArray.AddSFSObject(Sfs2X.Entities.Data.ISFSObject)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSArray.AddClass(System.Object)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSArray.Add(Sfs2X.Entities.Data.SFSDataWrapper)">
- <exclude />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSArray.IsNull(System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSArray.GetBool(System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSArray.GetByte(System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSArray.GetShort(System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSArray.GetInt(System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSArray.GetLong(System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSArray.GetFloat(System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSArray.GetDouble(System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSArray.GetUtfString(System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSArray.GetText(System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSArray.GetBoolArray(System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSArray.GetByteArray(System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSArray.GetShortArray(System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSArray.GetIntArray(System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSArray.GetLongArray(System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSArray.GetFloatArray(System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSArray.GetDoubleArray(System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSArray.GetUtfStringArray(System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSArray.GetSFSArray(System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSArray.GetClass(System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSArray.GetSFSObject(System.Int32)">
- <inheritdoc />
- </member>
- <member name="T:Sfs2X.Entities.Data.SFSArrayEnumerator">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSArrayEnumerator.#ctor(System.Collections.Generic.List{Sfs2X.Entities.Data.SFSDataWrapper})">
- <exclude/>
- </member>
- <member name="T:Sfs2X.Entities.Data.SFSArrayLite">
- <summary>
- The "lite" version of SFSObject, supporting proper type conversions for dynamic languages such as JavaScript.
- </summary>
-
- <exclude/>
- </member>
- <member name="T:Sfs2X.Entities.Data.SFSDataType">
- <summary>
- The SFSDataType class contains the costants defining the data types supported by SFSObject and SFSArray classes.
- </summary>
-
- <seealso cref="T:Sfs2X.Entities.Data.SFSObject"/>
- <seealso cref="T:Sfs2X.Entities.Data.SFSArray"/>
- </member>
- <member name="F:Sfs2X.Entities.Data.SFSDataType.NULL">
- <summary>
- Null value.
- </summary>
- </member>
- <member name="F:Sfs2X.Entities.Data.SFSDataType.BOOL">
- <summary>
- Boolean.
- </summary>
- </member>
- <member name="F:Sfs2X.Entities.Data.SFSDataType.BYTE">
- <summary>
- Byte, signed 8 bits.
- </summary>
- </member>
- <member name="F:Sfs2X.Entities.Data.SFSDataType.SHORT">
- <summary>
- Short integer, signed 16 bits.
- </summary>
- </member>
- <member name="F:Sfs2X.Entities.Data.SFSDataType.INT">
- <summary>
- Integer, signed 32 bits.
- </summary>
- </member>
- <member name="F:Sfs2X.Entities.Data.SFSDataType.LONG">
- <summary>
- Long integer, signed 64 bits.
- </summary>
- </member>
- <member name="F:Sfs2X.Entities.Data.SFSDataType.FLOAT">
- <summary>
- Floating point decimal, signed 32 bits.
- </summary>
- </member>
- <member name="F:Sfs2X.Entities.Data.SFSDataType.DOUBLE">
- <summary>
- Double precision decimal, signed 64 bits.
- </summary>
- </member>
- <member name="F:Sfs2X.Entities.Data.SFSDataType.UTF_STRING">
- <summary>
- UTF-8 encoded string, with length up to 32 KBytes.
- </summary>
- </member>
- <member name="F:Sfs2X.Entities.Data.SFSDataType.BOOL_ARRAY">
- <summary>
- Array of booleans.
- </summary>
- </member>
- <member name="F:Sfs2X.Entities.Data.SFSDataType.BYTE_ARRAY">
- <summary>
- Array of bytes (treated as ByteArray).
- </summary>
- </member>
- <member name="F:Sfs2X.Entities.Data.SFSDataType.SHORT_ARRAY">
- <summary>
- Array of shorts.
- </summary>
- </member>
- <member name="F:Sfs2X.Entities.Data.SFSDataType.INT_ARRAY">
- <summary>
- Array of integers.
- </summary>
- </member>
- <member name="F:Sfs2X.Entities.Data.SFSDataType.LONG_ARRAY">
- <summary>
- Array of long integers.
- </summary>
- </member>
- <member name="F:Sfs2X.Entities.Data.SFSDataType.FLOAT_ARRAY">
- <summary>
- Array of floats.
- </summary>
- </member>
- <member name="F:Sfs2X.Entities.Data.SFSDataType.DOUBLE_ARRAY">
- <summary>
- Array of Doubles.
- </summary>
- </member>
- <member name="F:Sfs2X.Entities.Data.SFSDataType.UTF_STRING_ARRAY">
- <summary>
- Array of UTF-8 strings.
- </summary>
- </member>
- <member name="F:Sfs2X.Entities.Data.SFSDataType.SFS_ARRAY">
- <summary>
- SFSArray.
- </summary>
-
- <seealso cref="T:Sfs2X.Entities.Data.SFSArray"/>
- </member>
- <member name="F:Sfs2X.Entities.Data.SFSDataType.SFS_OBJECT">
- <summary>
- SFSObject.
- </summary>
-
- <seealso cref="T:Sfs2X.Entities.Data.SFSObject"/>
- </member>
- <member name="F:Sfs2X.Entities.Data.SFSDataType.CLASS">
- <summary>
- Serialized class instance.
- </summary>
- </member>
- <member name="F:Sfs2X.Entities.Data.SFSDataType.TEXT">
- <summary>
- UTF-8 encoded string, with length up to 2 GBytes.
- </summary>
- </member>
- <member name="T:Sfs2X.Entities.Data.SFSDataWrapper">
- <summary>
- A wrapper object used by SFSObject and SFSArray to encapsulate data and relative types
- </summary>
-
- <exclude/>
- </member>
- <member name="P:Sfs2X.Entities.Data.SFSDataWrapper.Type">
- <exclude/>
- </member>
- <member name="P:Sfs2X.Entities.Data.SFSDataWrapper.Data">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSDataWrapper.#ctor(System.Int32,System.Object)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSDataWrapper.#ctor(Sfs2X.Entities.Data.SFSDataType,System.Object)">
- <exclude/>
- </member>
- <member name="T:Sfs2X.Entities.Data.SFSObject">
- <summary>
- The SFSObject class is used by SmartFoxServer in client-server data transfer.
- </summary>
-
- <remarks>
- This class can be thought of as a specialized Dictionary/Map object that can contain any type of data.
- <para/>
- The advantage of using the SFSObject class (for example when sending an <see cref="T:Sfs2X.Requests.ExtensionRequest"/> request) is that you can fine tune the way your data is transmitted over the network.
- For instance, a number like 100 can be transmitted as a normal integer (which takes 32 bits), but also a short (16 bit) or even a byte (8 bit).
- <para/>
- SFSObject supports many primitive data types and related arrays of primitives (see the <see cref="T:Sfs2X.Entities.Data.SFSDataType"/> class). It also allows to serialize class instances and rebuild them on the other side (client or server).
- Check the SmartFoxServer 2X documentation for more informations on this advanced topic.
- </remarks>
-
- <seealso cref="T:Sfs2X.Entities.Data.SFSDataType"/>
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSObject.NewFromBinaryData(Sfs2X.Util.ByteArray)">
- <summary>
- Returns a new SFSObject instance.
- </summary>
-
- <remarks>
- This is an alternative static constructor that builds an SFSObject from a valid SFSObject binary representation.
- </remarks>
-
- <param name="ba">The ByteArray representation of a SFSObject.</param>
-
- <returns>A new SFSObject instance.</returns>
-
- <seealso cref="M:Sfs2X.Entities.Data.SFSObject.#ctor"/>
- <seealso cref="M:Sfs2X.Entities.Data.SFSObject.NewInstance"/>
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSObject.NewFromJsonData(System.String)">
- <summary>
- Returns a new ISFSObject instance.
- </summary>
-
- <remarks>
- This is an alternative static constructor that builds an ISFSObject from a valid JSON string representation.<br/>
- This method is not available in Windows / Windows Phone.
- </remarks>
-
- <param name="js">The JSON representation of a SFSObject.</param>
-
- <returns>A new ISFSObject instance.</returns>
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSObject.NewInstance">
- <summary>
- Returns a new SFSObject instance.
- </summary>
-
- <remarks>
- This method is a static alternative to the standard class constructor.
- </remarks>
-
- <returns>A new SFSObject instance.</returns>
-
- <seealso cref="M:Sfs2X.Entities.Data.SFSObject.#ctor"/>
- <seealso cref="M:Sfs2X.Entities.Data.SFSObject.NewFromBinaryData(Sfs2X.Util.ByteArray)"/>
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSObject.#ctor">
- <summary>
- Returns a new SFSObject instance.
- </summary>
-
- <seealso cref="M:Sfs2X.Entities.Data.SFSObject.NewInstance"/>
- <seealso cref="M:Sfs2X.Entities.Data.SFSObject.NewFromBinaryData(Sfs2X.Util.ByteArray)"/>
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSObject.GetData(System.String)">
- <exclude />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSObject.IsNull(System.String)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSObject.GetBool(System.String)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSObject.GetByte(System.String)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSObject.GetShort(System.String)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSObject.GetInt(System.String)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSObject.GetLong(System.String)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSObject.GetFloat(System.String)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSObject.GetDouble(System.String)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSObject.GetUtfString(System.String)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSObject.GetText(System.String)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSObject.GetBoolArray(System.String)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSObject.GetByteArray(System.String)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSObject.GetShortArray(System.String)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSObject.GetIntArray(System.String)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSObject.GetLongArray(System.String)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSObject.GetFloatArray(System.String)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSObject.GetDoubleArray(System.String)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSObject.GetUtfStringArray(System.String)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSObject.GetSFSArray(System.String)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSObject.GetSFSObject(System.String)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSObject.GetClass(System.String)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSObject.PutNull(System.String)">
- <exclude />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSObject.PutBool(System.String,System.Boolean)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSObject.PutByte(System.String,System.Byte)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSObject.PutShort(System.String,System.Int16)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSObject.PutInt(System.String,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSObject.PutLong(System.String,System.Int64)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSObject.PutFloat(System.String,System.Single)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSObject.PutDouble(System.String,System.Double)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSObject.PutUtfString(System.String,System.String)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSObject.PutText(System.String,System.String)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSObject.PutBoolArray(System.String,System.Boolean[])">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSObject.PutByteArray(System.String,Sfs2X.Util.ByteArray)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSObject.PutShortArray(System.String,System.Int16[])">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSObject.PutIntArray(System.String,System.Int32[])">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSObject.PutLongArray(System.String,System.Int64[])">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSObject.PutFloatArray(System.String,System.Single[])">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSObject.PutDoubleArray(System.String,System.Double[])">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSObject.PutUtfStringArray(System.String,System.String[])">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSObject.PutSFSArray(System.String,Sfs2X.Entities.Data.ISFSArray)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSObject.PutSFSObject(System.String,Sfs2X.Entities.Data.ISFSObject)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSObject.PutClass(System.String,System.Object)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSObject.Put(System.String,Sfs2X.Entities.Data.SFSDataWrapper)">
- <exclude />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSObject.ContainsKey(System.String)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSObject.GetDump(System.Boolean)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSObject.GetDump">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSObject.GetHexDump">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSObject.GetKeys">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSObject.RemoveElement(System.String)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSObject.Size">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSObject.ToBinary">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Data.SFSObject.ToJson">
- <inheritdoc />
- </member>
- <member name="T:Sfs2X.Entities.Data.SFSObjectLite">
- <summary>
- The "lite" version of SFSObject, supporting proper type conversions for dynamic languages such as JavaScript.
- </summary>
-
- <exclude/>
- </member>
- <member name="T:Sfs2X.Entities.Data.Vec3D">
- <summary>
- The Vec3D object represents a position in a 2D or 3D space.
- </summary>
-
- <remarks>
- This class is used to express a position inside a virtual environment with no specific unit of measure (could be pixels, feet, meters, etc).
- <para/>
- Positions along the X,Y,Z axes can be expressed as Integers or Floats, based on the game's coordinate system requirements.
- </remarks>
- </member>
- <member name="M:Sfs2X.Entities.Data.Vec3D.fromArray(System.Object)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Data.Vec3D.#ctor(System.Int32,System.Int32,System.Int32)">
- <summary>
- Creates a new Vec3D instance for a 3D coordinates system with integer values.
- </summary>
-
- <param name="px">The position along the X axis.</param>
- <param name="py">The position along the Y axis.</param>
- <param name="pz">The position along the Z axis.</param>
- </member>
- <member name="M:Sfs2X.Entities.Data.Vec3D.#ctor(System.Int32,System.Int32)">
- <summary>
- Creates a new Vec3D instance for a 2D coordinates system with integer values.
- </summary>
-
- <param name="px">The position along the X axis.</param>
- <param name="py">The position along the Y axis.</param>
- </member>
- <member name="M:Sfs2X.Entities.Data.Vec3D.#ctor(System.Single,System.Single,System.Single)">
- <summary>
- Creates a new Vec3D instance for a 3D coordinates system with float values.
- </summary>
-
- <param name="px">The position along the X axis.</param>
- <param name="py">The position along the Y axis.</param>
- <param name="pz">The position along the Z axis.</param>
- </member>
- <member name="M:Sfs2X.Entities.Data.Vec3D.#ctor(System.Single,System.Single)">
- <summary>
- Creates a new Vec3D instance for a 2D coordinates system with float values.
- </summary>
-
- <param name="px">The position along the X axis.</param>
- <param name="py">The position along the Y axis.</param>
- </member>
- <member name="M:Sfs2X.Entities.Data.Vec3D.IsFloat">
- <summary>
- Indicates whether the position is expressed using floating point values or not.
- </summary>
-
- <returns><c>true</c> if the position is expressed using floating point values.</returns>
- </member>
- <member name="P:Sfs2X.Entities.Data.Vec3D.FloatX">
- <summary>
- Returns the position along the X axis as a float value.
- </summary>
- </member>
- <member name="P:Sfs2X.Entities.Data.Vec3D.FloatY">
- <summary>
- Returns the position along the Y axis as a float value.
- </summary>
- </member>
- <member name="P:Sfs2X.Entities.Data.Vec3D.FloatZ">
- <summary>
- Returns the position along the Z axis as a float value.
- </summary>
- </member>
- <member name="P:Sfs2X.Entities.Data.Vec3D.IntX">
- <summary>
- Returns the position along the X axis as an integer value.
- </summary>
- </member>
- <member name="P:Sfs2X.Entities.Data.Vec3D.IntY">
- <summary>
- Returns the position along the Y axis as an integer value.
- </summary>
- </member>
- <member name="P:Sfs2X.Entities.Data.Vec3D.IntZ">
- <summary>
- Returns the position along the Z axis as an integer value.
- </summary>
- </member>
- <member name="M:Sfs2X.Entities.Data.Vec3D.ToIntArray">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Data.Vec3D.ToFloatArray">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Data.Vec3D.ToString">
- <exclude/>
- </member>
- <member name="T:Sfs2X.Entities.Invitation.Invitation">
- <summary>
- The Invitation interface defines all the methods and properties that an object representing an invitation entity exposes.
- </summary>
-
- <remarks>
- In the SmartFoxServer 2X client API this interface is implemented by the <see cref="T:Sfs2X.Entities.Invitation.SFSInvitation"/> class. Read the class description for additional informations.
- </remarks>
-
- <seealso cref="T:Sfs2X.Entities.Invitation.SFSInvitation"/>
- </member>
- <member name="P:Sfs2X.Entities.Invitation.Invitation.Id">
- <summary>
- Indicates the id of this invitation.
- </summary>
-
- <remarks>
- It is generated by the server when the invitation is sent.
- <para/>
- <b>NOTE</b>: setting the id property manually has no effect on the server and can disrupt the API functioning.
- </remarks>
- </member>
- <member name="P:Sfs2X.Entities.Invitation.Invitation.Inviter">
- <summary>
- Returns the User object corresponding to the user who sent the invitation.
- </summary>
- </member>
- <member name="P:Sfs2X.Entities.Invitation.Invitation.Invitee">
- <summary>
- Returns the User object corresponding to the user who received the invitation.
- </summary>
- </member>
- <member name="P:Sfs2X.Entities.Invitation.Invitation.SecondsForAnswer">
- <summary>
- Returns the number of seconds available to the invitee to reply to the invitation, after which the invitation expires.
- </summary>
- </member>
- <member name="P:Sfs2X.Entities.Invitation.Invitation.Params">
- <summary>
- Returns an instance of SFSObject containing a custom set of parameters.
- </summary>
-
- <remarks>
- This usually stores invitation details, like a message to the invitee and any other relevant data.
- </remarks>
- </member>
- <member name="T:Sfs2X.Entities.Invitation.InvitationReply">
- <summary>
- The InvitationReply enumeration contains the costants describing the possible replies to an invitation.
- </summary>
-
- <seealso cref="T:Sfs2X.Requests.Game.InvitationReplyRequest"/>
- </member>
- <member name="F:Sfs2X.Entities.Invitation.InvitationReply.ACCEPT">
- <summary>
- Invitation is accepted.
- </summary>
- </member>
- <member name="F:Sfs2X.Entities.Invitation.InvitationReply.REFUSE">
- <summary>
- Invitation is refused.
- </summary>
- </member>
- <member name="F:Sfs2X.Entities.Invitation.InvitationReply.EXPIRED">
- <summary>
- Invitation expired.
- </summary>
- </member>
- <member name="T:Sfs2X.Entities.Invitation.SFSInvitation">
- <summary>
- The SFSInvitation object contains all the informations about an invitation received by the current user.
- </summary>
-
- <remarks>
- An invitation is sent through the <see cref="T:Sfs2X.Requests.Game.InviteUsersRequest"/> request and it is received as an invitation event.
- Clients can reply to an invitation using the <see cref="T:Sfs2X.Requests.Game.InvitationReplyRequest"/> request.
- </remarks>
-
- <seealso cref="T:Sfs2X.Requests.Game.InviteUsersRequest"/>
- <seealso cref="T:Sfs2X.Requests.Game.InvitationReplyRequest"/>
- <seealso cref="F:Sfs2X.Core.SFSEvent.INVITATION"/>
- </member>
- <member name="F:Sfs2X.Entities.Invitation.SFSInvitation.id">
- <exclude/>
- The id is only used when the Invitation is built from a Server Side Invitation
- </member>
- <member name="F:Sfs2X.Entities.Invitation.SFSInvitation.inviter">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Entities.Invitation.SFSInvitation.invitee">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Entities.Invitation.SFSInvitation.secondsForAnswer">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Entities.Invitation.SFSInvitation.parameters">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Invitation.SFSInvitation.#ctor(Sfs2X.Entities.User,Sfs2X.Entities.User)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Invitation.SFSInvitation.#ctor(Sfs2X.Entities.User,Sfs2X.Entities.User,System.Int32)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Invitation.SFSInvitation.#ctor(Sfs2X.Entities.User,Sfs2X.Entities.User,System.Int32,Sfs2X.Entities.Data.ISFSObject)">
- <exclude/>
- </member>
- <member name="P:Sfs2X.Entities.Invitation.SFSInvitation.Id">
- <inheritdoc />
- </member>
- <member name="P:Sfs2X.Entities.Invitation.SFSInvitation.Inviter">
- <inheritdoc />
- </member>
- <member name="P:Sfs2X.Entities.Invitation.SFSInvitation.Invitee">
- <inheritdoc />
- </member>
- <member name="P:Sfs2X.Entities.Invitation.SFSInvitation.SecondsForAnswer">
- <inheritdoc />
- </member>
- <member name="P:Sfs2X.Entities.Invitation.SFSInvitation.Params">
- <inheritdoc />
- </member>
- <member name="T:Sfs2X.Entities.Managers.IBuddyManager">
- <summary>
- The IBuddyManager interface defines all the methods and properties exposed by the client-side manager of the SmartFoxServer Buddy List system.
- </summary>
-
- <remarks>
- In the SmartFoxServer 2X client API this interface is implemented by the <see cref="T:Sfs2X.Entities.Managers.SFSBuddyManager"/> class. Read the class description for additional informations.
- </remarks>
-
- <seealso cref="T:Sfs2X.Entities.Managers.SFSBuddyManager"/>
- </member>
- <member name="P:Sfs2X.Entities.Managers.IBuddyManager.Inited">
- <summary>
- Indicates whether the client's Buddy List system is initialized or not.
- </summary>
-
- <remarks>
- If not initialized, an <see cref="T:Sfs2X.Requests.Buddylist.InitBuddyListRequest"/> request should be sent to the server in order to retrieve the persistent Buddy List data.
- </remarks>
-
- <seealso cref="T:Sfs2X.Requests.Buddylist.InitBuddyListRequest"/>
- </member>
- <member name="M:Sfs2X.Entities.Managers.IBuddyManager.AddBuddy(Sfs2X.Entities.Buddy)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Managers.IBuddyManager.RemoveBuddyById(System.Int32)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Managers.IBuddyManager.RemoveBuddyByName(System.String)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Managers.IBuddyManager.ContainsBuddy(System.String)">
- <summary>
- Indicates whether a buddy exists in user's buddies list or not.
- </summary>
-
- <param name="name">The name of the buddy whose presence in the buddies list is to be tested.</param>
-
- <returns><c>true</c> if the specified buddy exists in the buddies list.</returns>
-
- <seealso cref="P:Sfs2X.Entities.Buddy.Name"/>
- </member>
- <member name="M:Sfs2X.Entities.Managers.IBuddyManager.GetBuddyById(System.Int32)">
- <summary>
- Retrieves a Buddy object from its id property.
- </summary>
-
- <param name="id">The id of the buddy to be found.</param>
-
- <returns>The object representing the buddy, or <c>null</c> if no buddy with the passed id exists in the buddies list.</returns>
-
- <seealso cref="P:Sfs2X.Entities.Buddy.Id"/>
- <seealso cref="M:Sfs2X.Entities.Managers.IBuddyManager.GetBuddyByName(System.String)"/>
- <seealso cref="M:Sfs2X.Entities.Managers.IBuddyManager.GetBuddyByNickName(System.String)"/>
- </member>
- <member name="M:Sfs2X.Entities.Managers.IBuddyManager.GetBuddyByName(System.String)">
- <summary>
- Retrieves a Buddy object from its name property.
- </summary>
-
- <param name="name">The name of the buddy to be found.</param>
-
- <returns>The object representing the buddy, or <c>null</c> if no buddy with the passed name exists in the buddies list.</returns>
-
- <seealso cref="P:Sfs2X.Entities.Buddy.Name"/>
- <seealso cref="M:Sfs2X.Entities.Managers.IBuddyManager.GetBuddyById(System.Int32)"/>
- <seealso cref="M:Sfs2X.Entities.Managers.IBuddyManager.GetBuddyByNickName(System.String)"/>
- </member>
- <member name="M:Sfs2X.Entities.Managers.IBuddyManager.GetBuddyByNickName(System.String)">
- <summary>
- Retrieves a Buddy object from its nickName property (if set).
- </summary>
-
- <param name="nickName">The nickName of the buddy to be found.</param>
-
- <returns>The object representing the buddy, or <c>null</c> if no buddy with the passed nickName exists in the buddies list.</returns>
-
- <seealso cref="P:Sfs2X.Entities.Buddy.NickName"/>
- <seealso cref="M:Sfs2X.Entities.Managers.IBuddyManager.GetBuddyById(System.Int32)"/>
- <seealso cref="M:Sfs2X.Entities.Managers.IBuddyManager.GetBuddyByName(System.String)"/>
- </member>
- <member name="P:Sfs2X.Entities.Managers.IBuddyManager.OfflineBuddies">
- <summary>
- Returns a list of Buddy objects representing all the offline buddies in the user's buddies list.
- </summary>
-
- <seealso cref="P:Sfs2X.Entities.Buddy.IsOnline"/>
- </member>
- <member name="P:Sfs2X.Entities.Managers.IBuddyManager.OnlineBuddies">
- <summary>
- Returns a list of Buddy objects representing all the online buddies in the user's buddies list.
- </summary>
-
- <seealso cref="P:Sfs2X.Entities.Buddy.IsOnline"/>
- </member>
- <member name="P:Sfs2X.Entities.Managers.IBuddyManager.BuddyList">
- <summary>
- Returns a list of Buddy objects representing all the buddies in the user's buddies list.
- </summary>
-
- <remarks>
- The list is <c>null</c> if the Buddy List system is not initialized.
- </remarks>
-
- <seealso cref="T:Sfs2X.Requests.Buddylist.InitBuddyListRequest"/>
- </member>
- <member name="P:Sfs2X.Entities.Managers.IBuddyManager.BuddyStates">
- <summary>
- Returns a list of strings representing the available custom buddy states.
- </summary>
-
- <remarks>
- The custom states are received by the client upon initialization of the Buddy List system. They can be configured by means of the SmartFoxServer 2X Administration Tool.
- </remarks>
-
- <seealso cref="P:Sfs2X.Entities.Buddy.State"/>
- </member>
- <member name="M:Sfs2X.Entities.Managers.IBuddyManager.GetMyVariable(System.String)">
- <summary>
- Retrieves a Buddy Variable from its name.
- </summary>
-
- <param name="varName">The name of the Buddy Variable to be retrieved.</param>
-
- <returns>The object representing the Buddy Variable, or <c>null</c> if no Buddy Variable with the passed name is associated with the current user.</returns>
-
- <seealso cref="T:Sfs2X.Requests.Buddylist.SetBuddyVariablesRequest"/>
- <seealso cref="P:Sfs2X.Entities.Managers.IBuddyManager.MyVariables"/>
- </member>
- <member name="P:Sfs2X.Entities.Managers.IBuddyManager.MyVariables">
- <summary>
- Returns all the Buddy Variables associated with the current user.
- </summary>
-
- <seealso cref="T:Sfs2X.Entities.Variables.BuddyVariable"/>
- <seealso cref="M:Sfs2X.Entities.Managers.IBuddyManager.GetMyVariable(System.String)"/>
- </member>
- <member name="P:Sfs2X.Entities.Managers.IBuddyManager.MyOnlineState">
- <summary>
- Returns the current user's online/offline state.
- </summary>
-
- <remarks>
- If <c>true</c>, the user appears to be online in the buddies list of other users who have him as a buddy.
- <para/>
- The online state of a user in a buddy list is handled by means of a reserved Buddy Variable (see <see cref="T:Sfs2X.Entities.Variables.ReservedBuddyVariables"/> class);
- it can be changed using the dedicated <see cref="T:Sfs2X.Requests.Buddylist.GoOnlineRequest"/> request.
- </remarks>
-
- <seealso cref="P:Sfs2X.Entities.Buddy.IsOnline"/>
- <seealso cref="T:Sfs2X.Entities.Variables.ReservedBuddyVariables"/>
- <seealso cref="T:Sfs2X.Requests.Buddylist.GoOnlineRequest"/>
- </member>
- <member name="P:Sfs2X.Entities.Managers.IBuddyManager.MyNickName">
- <summary>
- Returns the current user's nickname (if set).
- </summary>
-
- <remarks>
- If the nickname was never set before, <c>null</c> is returned.
- <para/>
- As the nickname of a user in a buddy list is handled by means of a reserved Buddy Variable (see <see cref="T:Sfs2X.Entities.Variables.ReservedBuddyVariables"/> class),
- it can be set using the <see cref="T:Sfs2X.Requests.Buddylist.SetBuddyVariablesRequest"/> request.
- </remarks>
-
- <seealso cref="P:Sfs2X.Entities.Buddy.NickName"/>
- <seealso cref="T:Sfs2X.Entities.Variables.ReservedBuddyVariables"/>
- <seealso cref="T:Sfs2X.Requests.Buddylist.SetBuddyVariablesRequest"/>
- </member>
- <member name="P:Sfs2X.Entities.Managers.IBuddyManager.MyState">
- <summary>
- Returns the current user's custom state (if set).
- </summary>
-
- <remarks>
- Examples of custom states are "Available", "Busy", "Be right back", etc. If the custom state was never set before, <c>null</c> is returned.
- <para/>
- As the custom state of a user in a buddy list is handled by means of a reserved Buddy Variable (see <see cref="T:Sfs2X.Entities.Variables.ReservedBuddyVariables"/> class),
- it can be set using the <see cref="T:Sfs2X.Requests.Buddylist.SetBuddyVariablesRequest"/> request.
- </remarks>
-
- <seealso cref="P:Sfs2X.Entities.Buddy.State"/>
- <seealso cref="T:Sfs2X.Entities.Variables.ReservedBuddyVariables"/>
- <seealso cref="T:Sfs2X.Requests.Buddylist.SetBuddyVariablesRequest"/>
- </member>
- <member name="M:Sfs2X.Entities.Managers.IBuddyManager.SetMyVariable(Sfs2X.Entities.Variables.BuddyVariable)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Managers.IBuddyManager.ClearAll">
- <exclude/>
- </member>
- <member name="T:Sfs2X.Entities.Managers.IRoomManager">
- <summary>
- The IRoomManager interface defines all the methods and properties exposed by the client-side manager of the SmartFoxServer Room entities.
- </summary>
-
- <remarks>
- In the SmartFoxServer 2X client API this interface is implemented by the <see cref="T:Sfs2X.Entities.Managers.SFSRoomManager"/> class. Read the class description for additional informations.
- </remarks>
-
- <seealso cref="T:Sfs2X.Entities.Managers.SFSRoomManager"/>
- </member>
- <member name="P:Sfs2X.Entities.Managers.IRoomManager.OwnerZone">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Managers.IRoomManager.AddRoom(Sfs2X.Entities.Room,System.Boolean)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Managers.IRoomManager.AddRoom(Sfs2X.Entities.Room)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Managers.IRoomManager.AddGroup(System.String)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Managers.IRoomManager.ReplaceRoom(Sfs2X.Entities.Room,System.Boolean)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Managers.IRoomManager.ReplaceRoom(Sfs2X.Entities.Room)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Managers.IRoomManager.RemoveGroup(System.String)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Managers.IRoomManager.ContainsGroup(System.String)">
- <summary>
- Indicates whether the specified Group has been subscribed by the client or not.
- </summary>
-
- <param name="groupId">The name of the Group.</param>
-
- <returns><c>true</c> if the client subscribed the passed Group.</returns>
- </member>
- <member name="M:Sfs2X.Entities.Managers.IRoomManager.ContainsRoom(System.Object)">
- <summary>
- Indicates whether a Room exists in the Rooms list or not.
- </summary>
-
- <param name="idOrName">The id or name of the Room object whose presence in the Rooms list is to be tested.</param>
-
- <returns><c>true</c> if the passed Room exists in the Rooms list.</returns>
-
- <seealso cref="P:Sfs2X.Entities.Room.Id"/>
- </member>
- <member name="M:Sfs2X.Entities.Managers.IRoomManager.ContainsRoomInGroup(System.Object,System.String)">
- <summary>
- Indicates whether the Rooms list contains a Room belonging to the specified Group or not.
- </summary>
-
- <param name="idOrName">The id or name of the Room object whose presence in the Rooms list is to be tested.</param>
- <param name="groupId">The name of the Group to which the specified Room must belong.</param>
-
- <returns><c>true</c> if the Rooms list contains the passed Room and it belongs to the specified Group.</returns>
- </member>
- <member name="M:Sfs2X.Entities.Managers.IRoomManager.ChangeRoomName(Sfs2X.Entities.Room,System.String)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Managers.IRoomManager.ChangeRoomPasswordState(Sfs2X.Entities.Room,System.Boolean)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Managers.IRoomManager.ChangeRoomCapacity(Sfs2X.Entities.Room,System.Int32,System.Int32)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Managers.IRoomManager.GetRoomById(System.Int32)">
- <summary>
- Retrieves a Room object from its id.
- </summary>
-
- <param name="id">The id of the Room.</param>
-
- <returns>An object representing the requested Room; <c>null</c> if no Room object with the passed id exists in the Rooms list.</returns>
-
- <seealso cref="M:Sfs2X.Entities.Managers.IRoomManager.GetRoomByName(System.String)"/>
- </member>
- <member name="M:Sfs2X.Entities.Managers.IRoomManager.GetRoomByName(System.String)">
- <summary>
- Retrieves a Room object from its name.
- </summary>
-
- <param name="name">The name of the Room.</param>
-
- <returns>An object representing the requested Room; <c>null</c> if no Room object with the passed name exists in the Rooms list.</returns>
-
- <seealso cref="M:Sfs2X.Entities.Managers.IRoomManager.GetRoomById(System.Int32)"/>
- </member>
- <member name="M:Sfs2X.Entities.Managers.IRoomManager.GetRoomList">
- <summary>
- Returns a list of Rooms currently "known" by the client.
- </summary>
-
- <remarks>
- The list contains all the Rooms that are currently joined and all the Rooms belonging to the Room Groups that have been subscribed.
- <para/>
- At login time, the client automatically subscribes all the Room Groups specified in the Zone's <b>Default Room Groups</b> setting.
- </remarks>
-
- <returns>The list of the available Room objects.</returns>
-
- <seealso cref="T:Sfs2X.Requests.JoinRoomRequest"/>
- <seealso cref="T:Sfs2X.Requests.SubscribeRoomGroupRequest"/>
- <seealso cref="T:Sfs2X.Requests.UnsubscribeRoomGroupRequest"/>
- </member>
- <member name="M:Sfs2X.Entities.Managers.IRoomManager.GetRoomCount">
- <summary>
- Returns the current number of Rooms in the Rooms list.
- </summary>
-
- <returns>The number of Rooms in the Rooms list.</returns>
- </member>
- <member name="M:Sfs2X.Entities.Managers.IRoomManager.GetRoomGroups">
- <summary>
- Returns the names of Groups currently subscribed by the client.
- </summary>
-
- <remarks>
- At login time, the client automatically subscribes all the Room Groups specified in the Zone's <b>Default Room Groups</b> setting.
- </remarks>
-
- <returns>A list of Group names.</returns>
-
- <seealso cref="P:Sfs2X.Entities.Room.GroupId"/>
- <seealso cref="T:Sfs2X.Requests.SubscribeRoomGroupRequest"/>
- <seealso cref="T:Sfs2X.Requests.UnsubscribeRoomGroupRequest"/>
- </member>
- <member name="M:Sfs2X.Entities.Managers.IRoomManager.GetRoomListFromGroup(System.String)">
- <summary>
- Retrieves the list of Rooms which are part of the specified Room Group.
- </summary>
-
- <param name="groupId">The name of the Group.</param>
-
- <returns>The list of Room objects belonging to the passed Group.</returns>
- </member>
- <member name="M:Sfs2X.Entities.Managers.IRoomManager.GetJoinedRooms">
- <summary>
- Returns a list of Rooms currently joined by the client.
- </summary>
-
- <returns>The list of objects representing the Rooms currently joined by the client.</returns>
- </member>
- <member name="M:Sfs2X.Entities.Managers.IRoomManager.GetUserRooms(Sfs2X.Entities.User)">
- <summary>
- Retrieves a list of Rooms joined by the specified user.
- </summary>
-
- <remarks>
- The list contains only those Rooms "known" by the Room Manager; the user might have joined others the client is not aware of.
- </remarks>
-
- <param name="user">The object representing the user to look for in the current Rooms list.</param>
-
- <returns>The list of Rooms joined by the passed user.</returns>
- </member>
- <member name="M:Sfs2X.Entities.Managers.IRoomManager.RemoveRoom(Sfs2X.Entities.Room)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Managers.IRoomManager.RemoveRoomById(System.Int32)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Managers.IRoomManager.RemoveRoomByName(System.String)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Managers.IRoomManager.RemoveUser(Sfs2X.Entities.User)">
- <exclude/>
- </member>
- <member name="P:Sfs2X.Entities.Managers.IRoomManager.SmartFoxClient">
- <exclude/>
- </member>
- <member name="T:Sfs2X.Entities.Managers.IUserManager">
- <summary>
- The IUserManager interface defines all the methods and properties exposed by the client-side manager of the SmartFoxServer User entities.
- </summary>
-
- <remarks>
- In the SmartFoxServer 2X client API this interface is implemented by the <see cref="T:Sfs2X.Entities.Managers.SFSUserManager"/> class. Read the class description for additional informations.
- </remarks>
-
- <seealso cref="T:Sfs2X.Entities.Managers.SFSUserManager"/>
- </member>
- <member name="M:Sfs2X.Entities.Managers.IUserManager.ContainsUserName(System.String)">
- <summary>
- Indicates whether a user exists in the local users list or not from the name.
- </summary>
-
- <param name="userName">The name of the user whose presence in the users list is to be tested.</param>
-
- <returns><c>true</c> if a user with the passed name exists in the users list.</returns>
- </member>
- <member name="M:Sfs2X.Entities.Managers.IUserManager.ContainsUserId(System.Int32)">
- <summary>
- Indicates whether a user exists in the local users list or not from the id.
- </summary>
-
- <param name="userId">The id of the user whose presence in the users list is to be tested.</param>
-
- <returns><c>true</c> if a user corresponding to the passed id exists in the users list.</returns>
- </member>
- <member name="M:Sfs2X.Entities.Managers.IUserManager.ContainsUser(Sfs2X.Entities.User)">
- <summary>
- Indicates whether a user exists in the local users list or not.
- </summary>
-
- <param name="user">The object representing the user whose presence in the users list is to be tested.</param>
-
- <returns><c>true</c> if the passed user exists in the users list.</returns>
- </member>
- <member name="M:Sfs2X.Entities.Managers.IUserManager.GetUserByName(System.String)">
- <summary>
- Retrieves a User object from its name property.
- </summary>
-
- <param name="userName">The name of the user to be found.</param>
-
- <returns>The object representing the user, or <c>null</c> if no user with the passed name exists in the local users list.</returns>
- </member>
- <member name="M:Sfs2X.Entities.Managers.IUserManager.GetUserById(System.Int32)">
- <summary>
- Retrieves a User object from its id property.
- </summary>
-
- <param name="userId">The id of the user to be found.</param>
-
- <returns>The object representing the user, or <c>null</c> if no user with the passed id exists in the local users list.</returns>
- </member>
- <member name="M:Sfs2X.Entities.Managers.IUserManager.AddUser(Sfs2X.Entities.User)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Managers.IUserManager.RemoveUser(Sfs2X.Entities.User)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Managers.IUserManager.RemoveUserById(System.Int32)">
- <exclude/>
- </member>
- <member name="P:Sfs2X.Entities.Managers.IUserManager.UserCount">
- <summary>
- Returns the total number of users in the local users list.
- </summary>
- </member>
- <member name="M:Sfs2X.Entities.Managers.IUserManager.GetUserList">
- <summary>
- Get the whole list of users inside the Rooms joined by the client.
- </summary>
-
- <returns>The list of User objects representing the users in the local users list.</returns>
- </member>
- <member name="P:Sfs2X.Entities.Managers.IUserManager.SmartFoxClient">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Managers.IUserManager.ClearAll">
- <exclude/>
- </member>
- <member name="T:Sfs2X.Entities.Managers.SFSBuddyManager">
- <summary>
- The SFSBuddyManager class is the entity in charge of managing the current user's Buddy List system.
- </summary>
-
- <remarks>
- This manager keeps track of all the user's buddies, their state and their Buddy Variables. It also provides utility methods to set the user's properties when he is part of the buddies list of other users.
- </remarks>
-
- <seealso cref="P:Sfs2X.SmartFox.BuddyManager"/>
- </member>
- <member name="F:Sfs2X.Entities.Managers.SFSBuddyManager.buddiesByName">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Entities.Managers.SFSBuddyManager.myVariables">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Entities.Managers.SFSBuddyManager.myOnlineState">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Entities.Managers.SFSBuddyManager.inited">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Managers.SFSBuddyManager.#ctor(Sfs2X.SmartFox)">
- <exclude/>
- </member>
- <member name="P:Sfs2X.Entities.Managers.SFSBuddyManager.Inited">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Managers.SFSBuddyManager.AddBuddy(Sfs2X.Entities.Buddy)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Managers.SFSBuddyManager.ClearAll">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Managers.SFSBuddyManager.RemoveBuddyById(System.Int32)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Managers.SFSBuddyManager.RemoveBuddyByName(System.String)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Managers.SFSBuddyManager.GetBuddyById(System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Managers.SFSBuddyManager.ContainsBuddy(System.String)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Managers.SFSBuddyManager.GetBuddyByName(System.String)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Managers.SFSBuddyManager.GetBuddyByNickName(System.String)">
- <inheritdoc />
- </member>
- <member name="P:Sfs2X.Entities.Managers.SFSBuddyManager.OfflineBuddies">
- <inheritdoc />
- </member>
- <member name="P:Sfs2X.Entities.Managers.SFSBuddyManager.OnlineBuddies">
- <inheritdoc />
- </member>
- <member name="P:Sfs2X.Entities.Managers.SFSBuddyManager.BuddyList">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Managers.SFSBuddyManager.GetMyVariable(System.String)">
- <inheritdoc />
- </member>
- <member name="P:Sfs2X.Entities.Managers.SFSBuddyManager.MyVariables">
- <inheritdoc />
- </member>
- <member name="P:Sfs2X.Entities.Managers.SFSBuddyManager.MyOnlineState">
- <inheritdoc />
- </member>
- <member name="P:Sfs2X.Entities.Managers.SFSBuddyManager.MyNickName">
- <inheritdoc />
- </member>
- <member name="P:Sfs2X.Entities.Managers.SFSBuddyManager.MyState">
- <inheritdoc />
- </member>
- <member name="P:Sfs2X.Entities.Managers.SFSBuddyManager.BuddyStates">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Managers.SFSBuddyManager.SetMyVariable(Sfs2X.Entities.Variables.BuddyVariable)">
- <exclude />
- </member>
- <member name="T:Sfs2X.Entities.Managers.SFSGlobalUserManager">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Managers.SFSGlobalUserManager.#ctor(Sfs2X.SmartFox)">
- <summary>
- Initializes a new instance of the <see cref="T:Sfs2X.Entities.Managers.SFSGlobalUserManager"/> class.
- </summary>
- <param name='sfs'>
- Sfs.
- </param>
- </member>
- <member name="M:Sfs2X.Entities.Managers.SFSGlobalUserManager.#ctor(Sfs2X.Entities.Room)">
- <summary>
- Initializes a new instance of the <see cref="T:Sfs2X.Entities.Managers.SFSGlobalUserManager"/> class.
- </summary>
- <param name='room'>
- Room.
- </param>
- </member>
- <member name="M:Sfs2X.Entities.Managers.SFSGlobalUserManager.AddUser(Sfs2X.Entities.User)">
- <summary>
- Does not allow duplicates and keeps a reference count
- </summary>
- <param name="user">
- A <see cref="T:Sfs2X.Entities.User"/>
- </param>
- </member>
- <member name="M:Sfs2X.Entities.Managers.SFSGlobalUserManager.RemoveUser(Sfs2X.Entities.User)">
- <summary>
- Removes the user.
- </summary>
- <param name='user'>
- User.
- </param>
- </member>
- <member name="T:Sfs2X.Entities.Managers.SFSRoomManager">
- <summary>
- The SFSRoomManager class is the entity in charge of managing the client-side Rooms list.
- </summary>
-
- <remarks>
- This manager keeps track of all the Rooms available in the client-side Rooms list and of subscriptions to multiple Room Groups. It also provides various utility methods to look for Rooms by name and id, retrieve Rooms belonging to a specific Group, etc.
- </remarks>
-
- <seealso cref="P:Sfs2X.SmartFox.RoomManager"/>
- </member>
- <member name="F:Sfs2X.Entities.Managers.SFSRoomManager.smartFox">
- <exclude/>
- </member>
- <member name="P:Sfs2X.Entities.Managers.SFSRoomManager.OwnerZone">
- <exclude/>
- </member>
- <member name="P:Sfs2X.Entities.Managers.SFSRoomManager.SmartFoxClient">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Managers.SFSRoomManager.#ctor(Sfs2X.SmartFox)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Managers.SFSRoomManager.AddRoom(Sfs2X.Entities.Room)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Managers.SFSRoomManager.AddRoom(Sfs2X.Entities.Room,System.Boolean)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Managers.SFSRoomManager.ReplaceRoom(Sfs2X.Entities.Room)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Managers.SFSRoomManager.ReplaceRoom(Sfs2X.Entities.Room,System.Boolean)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Managers.SFSRoomManager.ChangeRoomName(Sfs2X.Entities.Room,System.String)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Managers.SFSRoomManager.ChangeRoomPasswordState(Sfs2X.Entities.Room,System.Boolean)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Managers.SFSRoomManager.ChangeRoomCapacity(Sfs2X.Entities.Room,System.Int32,System.Int32)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Managers.SFSRoomManager.GetRoomGroups">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Managers.SFSRoomManager.AddGroup(System.String)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Managers.SFSRoomManager.RemoveGroup(System.String)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Managers.SFSRoomManager.ContainsGroup(System.String)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Managers.SFSRoomManager.ContainsRoom(System.Object)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Managers.SFSRoomManager.ContainsRoomInGroup(System.Object,System.String)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Managers.SFSRoomManager.GetRoomById(System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Managers.SFSRoomManager.GetRoomByName(System.String)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Managers.SFSRoomManager.GetRoomList">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Managers.SFSRoomManager.GetRoomCount">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Managers.SFSRoomManager.GetRoomListFromGroup(System.String)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Managers.SFSRoomManager.RemoveRoom(Sfs2X.Entities.Room)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Managers.SFSRoomManager.RemoveRoomById(System.Int32)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Managers.SFSRoomManager.RemoveRoomByName(System.String)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Managers.SFSRoomManager.GetJoinedRooms">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Managers.SFSRoomManager.GetUserRooms(Sfs2X.Entities.User)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Managers.SFSRoomManager.RemoveUser(Sfs2X.Entities.User)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Managers.SFSRoomManager.RemoveRoom(System.Int32,System.String)">
- <exclude/>
- </member>
- <member name="T:Sfs2X.Entities.Managers.SFSUserManager">
- <summary>
- The SFSUserManager class is the entity in charge of managing the local (client-side) users list.
- </summary>
-
- <remarks>
- This manager keeps track of all the users that are currently joined in the same Rooms of the current user. It also provides utility methods to look for users by name and id.
- </remarks>
-
- <seealso cref="P:Sfs2X.SmartFox.UserManager"/>
- </member>
- <member name="F:Sfs2X.Entities.Managers.SFSUserManager.room">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Entities.Managers.SFSUserManager.sfs">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Managers.SFSUserManager.LogWarn(System.String)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Managers.SFSUserManager.#ctor(Sfs2X.SmartFox)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Managers.SFSUserManager.#ctor(Sfs2X.Entities.Room)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Managers.SFSUserManager.ContainsUserName(System.String)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Managers.SFSUserManager.ContainsUserId(System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Managers.SFSUserManager.ContainsUser(Sfs2X.Entities.User)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Managers.SFSUserManager.GetUserByName(System.String)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Managers.SFSUserManager.GetUserById(System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Managers.SFSUserManager.AddUser(Sfs2X.Entities.User)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Managers.SFSUserManager.AddUserInternal(Sfs2X.Entities.User)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Managers.SFSUserManager.RemoveUser(Sfs2X.Entities.User)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Managers.SFSUserManager.RemoveUserById(System.Int32)">
- <exclude/>
- </member>
- <member name="P:Sfs2X.Entities.Managers.SFSUserManager.UserCount">
- <inheritdoc />
- </member>
- <member name="P:Sfs2X.Entities.Managers.SFSUserManager.SmartFoxClient">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Managers.SFSUserManager.GetUserList">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Managers.SFSUserManager.ClearAll">
- <exclude/>
- </member>
- <member name="T:Sfs2X.Entities.Match.BoolMatch">
- <summary>
- The BoolMatch class is used in matching expressions to check boolean conditions.
- </summary>
-
- <seealso cref="T:Sfs2X.Entities.Match.MatchExpression"/>
- </member>
- <member name="F:Sfs2X.Entities.Match.BoolMatch.EQUALS">
- <summary>
- An instance of BoolMatch representing the following condition: <em>bool1 == bool2</em>.
- </summary>
- </member>
- <member name="F:Sfs2X.Entities.Match.BoolMatch.NOT_EQUALS">
- <summary>
- An instance of BoolMatch representing the following condition: <em>bool1 != bool2</em>.
- </summary>
- </member>
- <member name="M:Sfs2X.Entities.Match.BoolMatch.#ctor(System.String)">
- <exclude/>
- </member>
- <member name="P:Sfs2X.Entities.Match.BoolMatch.Symbol">
- <inheritdoc />
- </member>
- <member name="P:Sfs2X.Entities.Match.BoolMatch.Type">
- <inheritdoc />
- </member>
- <member name="T:Sfs2X.Entities.Match.IMatcher">
- <summary>
- The IMatcher interface defines the properties that an object representing a condition to be used in a matching expression exposes.
- </summary>
-
- <seealso cref="T:Sfs2X.Entities.Match.MatchExpression"/>
- </member>
- <member name="P:Sfs2X.Entities.Match.IMatcher.Symbol">
- <summary>
- Returns the condition symbol of this matcher.
- </summary>
- </member>
- <member name="P:Sfs2X.Entities.Match.IMatcher.Type">
- <summary>
- Returns the type id of this matcher.
- </summary>
- </member>
- <member name="T:Sfs2X.Entities.Match.LogicOperator">
- <summary>
- The LogicOperator class is used to concatenate two matching expressions using the <b>AND</b> or <b>OR</b> logical operator.
- </summary>
-
- <seealso cref="T:Sfs2X.Entities.Match.MatchExpression"/>
- </member>
- <member name="F:Sfs2X.Entities.Match.LogicOperator.AND">
- <summary>
- An instance of LogicOperator representing the <em>AND</em> logical operator.
- </summary>
- </member>
- <member name="F:Sfs2X.Entities.Match.LogicOperator.OR">
- <summary>
- An instance of LogicOperator representing the <em>OR</em> logical operator.
- </summary>
- </member>
- <member name="M:Sfs2X.Entities.Match.LogicOperator.#ctor(System.String)">
- <exclude/>
- </member>
- <member name="P:Sfs2X.Entities.Match.LogicOperator.Id">
- <summary>
- Returns the id of the current LogicOperator instance. It can be the string "AND" or "OR".
- </summary>
- </member>
- <member name="T:Sfs2X.Entities.Match.MatchExpression">
- <summary>
- The MatchExpression class represents a matching expression used to compare custom variables or predefined properties when searching for users or Rooms.
- </summary>
-
- <remarks>
- The matching expressions are built like "if" statements in any common programming language. They work like queries in a database and can be used to search for Rooms
- or users using custom criteria: in fact a matching expression can compare predefined properties of the Room and user entities
- (see the <see cref="T:Sfs2X.Entities.Match.RoomProperties"/> and <see cref="T:Sfs2X.Entities.Match.UserProperties"/> classes),but also custom Room or User Variables.
- <para/>
- These expressions are easy to create and concatenate, and they can be used for many different filtering operations within the SmartFoxServer 2X framework,
- for example to invite players to join a game (see the <see cref="T:Sfs2X.Requests.Game.CreateSFSGameRequest"/> request description),
- to look for specific Rooms or users (see the <see cref="T:Sfs2X.Requests.FindRoomsRequest"/> and <see cref="T:Sfs2X.Requests.FindUsersRequest"/> requests descriptions), etc.
- <para/>
- Additionally (see the examples for more informations):
- <ul>
- <li>any number of expressions can be linked together with the logical <b>AND</b> and <b>OR</b> operators to create complex queries;</li>
- <li>searching through nested data structures such as <see cref="T:Sfs2X.Entities.Data.SFSObject"/> and <see cref="T:Sfs2X.Entities.Data.SFSArray"/> can be done via a very simple dot-syntax.</li>
- </ul>
- </remarks>
-
- <example>
- The following example shows how to create a simple matching expression made of two concatenated conditions: it compares the custom "rank" and "country"
- User Variables to the passed values. This expression could be used during the creation of a Game Room, to filter the users that the server should take
- into account when sending the invitations to join the game (only italian users with a ranking greater than 5 - whatever this number means to our game):
- <code>
- MatchExpression exp = new MatchExpression('rank', NumberMatch.GREATER_THAN, 5).And('country', StringMatch.EQUALS, 'Italy');
- </code>
-
- The following example creates a matching expression made of three concatenated conditions which compare two predefined Room properties and the custom "isGameStarted"
- Room Variable to the passed values; this expression could be used to retrieve all the Game Rooms still waiting for players to join them:
- <code>
- MatchExpression exp = new MatchExpression(RoomProperties.IS_GAME, BoolMatch.EQUALS, true)
- .And(RoomProperties.HAS_FREE_PLAYER_SLOTS, BoolMatch.EQUALS, true)
- .And("isGameStarted", BoolMatch.EQUALS, false);
- </code>
-
- The following example creates a matching expression which compares a nested property in a complex data structure; an SFSObject called "avatarData" (could be a User Variable for example)
- contains the "shield" object (a nested SFSObject) which in turn contains, among others, the "inUse" property which could be used to retrieve all user
- whose avatars are currently equipped with a shield:
- <code>
- MatchExpression exp = new MatchExpression("avatarData.shield.inUse", BoolMatch.EQUALS, true);
- </code>
-
- The following example is similar to the previous one, but it involves an SFSArray. The "avatarData" object contains the "weapons" SFSArray, from which the expression retrieves
- the third element (that .3 means "give me the element at index == 3") that we know being the weapon the user avatar has in his right hand. Again, this element is an SFSObject containing,
- among the others, the "name" property which can be compared to the passed string. This example could be used to retrieve all users whose avatars have the Narsil sword in the right hand:
- <code>
- MatchExpression exp = new MatchExpression("avatarData.weapons.3.name", StringMatch.EQUALS, "Narsil");
- </code>
- </example>
-
- <seealso cref="T:Sfs2X.Entities.Match.RoomProperties"/>
- <seealso cref="T:Sfs2X.Entities.Match.UserProperties"/>
- <seealso cref="T:Sfs2X.Requests.Game.CreateSFSGameRequest"/>
- <seealso cref="T:Sfs2X.Requests.FindRoomsRequest"/>
- <seealso cref="T:Sfs2X.Requests.FindUsersRequest"/>
- </member>
- <member name="M:Sfs2X.Entities.Match.MatchExpression.ChainedMatchExpression(System.String,Sfs2X.Entities.Match.IMatcher,System.Object,Sfs2X.Entities.Match.LogicOperator,Sfs2X.Entities.Match.MatchExpression)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Match.MatchExpression.#ctor(System.String,Sfs2X.Entities.Match.IMatcher,System.Object)">
- <summary>
- Creates a new MatchExpression instance.
- </summary>
-
- <param name="varName">Name of the variable or property to match.</param>
- <param name="condition">The matching condition.</param>
- <param name="varValue">The value to compare against the variable or property during the matching.</param>
- </member>
- <member name="M:Sfs2X.Entities.Match.MatchExpression.And(System.String,Sfs2X.Entities.Match.IMatcher,System.Object)">
- <summary>
- Concatenates the current expression with a new one using the logical <b>AND</b> operator.
- </summary>
-
- <param name="varName">The name of the additional variable or property to match.</param>
- <param name="condition">The additional matching condition.</param>
- <param name="varValue">The value to compare against the additional variable or property during the matching.</param>
-
- <returns>A new MatchExpression resulting from the concatenation of the current expression with a new one generated from the specified parameters.</returns>
-
- <seealso cref="P:Sfs2X.Entities.Match.MatchExpression.VarName"/>
- <seealso cref="P:Sfs2X.Entities.Match.MatchExpression.Condition"/>
- <seealso cref="P:Sfs2X.Entities.Match.MatchExpression.VarValue"/>
- <seealso cref="F:Sfs2X.Entities.Match.LogicOperator.AND"/>
- </member>
- <member name="M:Sfs2X.Entities.Match.MatchExpression.Or(System.String,Sfs2X.Entities.Match.IMatcher,System.Object)">
- <summary>
- Concatenates the current expression with a new one using the logical <b>OR</b> operator.
- </summary>
-
- <param name="varName">The name of the additional variable or property to match.</param>
- <param name="condition">The additional matching condition.</param>
- <param name="varValue">The value to compare against the additional variable or property during the matching.</param>
-
- <returns>A new MatchExpression resulting from the concatenation of the current expression with a new one generated from the specified parameters.</returns>
-
- <seealso cref="P:Sfs2X.Entities.Match.MatchExpression.VarName"/>
- <seealso cref="P:Sfs2X.Entities.Match.MatchExpression.Condition"/>
- <seealso cref="P:Sfs2X.Entities.Match.MatchExpression.VarValue"/>
- <seealso cref="F:Sfs2X.Entities.Match.LogicOperator.OR"/>
- </member>
- <member name="P:Sfs2X.Entities.Match.MatchExpression.VarName">
- <summary>
- Returns the name of the variable or property against which the comparison is made.
- </summary>
-
- <remarks>
- Depending what the matching expression is used for (searching a <see cref="T:Sfs2X.Entities.User"/> or a <see cref="T:Sfs2X.Entities.Room"/>),
- this can be the name of a <see cref="T:Sfs2X.Entities.Variables.UserVariable"/> or a <see cref="T:Sfs2X.Entities.Variables.RoomVariable"/>,
- or it can be one of the constants contained in the <see cref="T:Sfs2X.Entities.Match.UserProperties"/> or <see cref="T:Sfs2X.Entities.Match.RoomProperties"/> classes,
- representing some of the predefined properties of the user and Room entities respectively.
- </remarks>
-
- <seealso cref="T:Sfs2X.Entities.Match.RoomProperties"/>
- <seealso cref="T:Sfs2X.Entities.Match.UserProperties"/>
- <seealso cref="T:Sfs2X.Entities.Variables.RoomVariable"/>
- <seealso cref="T:Sfs2X.Entities.Variables.UserVariable"/>
- <seealso cref="T:Sfs2X.Entities.User"/>
- <seealso cref="T:Sfs2X.Entities.Room"/>
- </member>
- <member name="P:Sfs2X.Entities.Match.MatchExpression.Condition">
- <summary>
- Returns the matching criteria used during values comparison.
- </summary>
-
- <remarks>
- Different objects implementing the <seealso cref="T:Sfs2X.Entities.Match.IMatcher"/> interface can be used, depending on the type of the variable or property to check.
- </remarks>
-
- <seealso cref="T:Sfs2X.Entities.Match.BoolMatch"/>
- <seealso cref="T:Sfs2X.Entities.Match.NumberMatch"/>
- <seealso cref="T:Sfs2X.Entities.Match.StringMatch"/>
- </member>
- <member name="P:Sfs2X.Entities.Match.MatchExpression.VarValue">
- <summary>
- Returns the value against which the variable or property corresponding to varName is compared.
- </summary>
- </member>
- <member name="P:Sfs2X.Entities.Match.MatchExpression.LogicOp">
- <summary>
- In case of concatenated expressions, returns the current logical operator.
- </summary>
-
- <remarks>
- The default value is <c>null</c>.
- </remarks>
-
- <seealso cref="T:Sfs2X.Entities.Match.LogicOperator"/>
- </member>
- <member name="M:Sfs2X.Entities.Match.MatchExpression.HasNext">
- <summary>
- Checks if the current matching expression is concatenated to another one through a logical operator.
- </summary>
-
- <returns><c>true</c> if the current matching expression is concatenated to another one.</returns>
-
- <seealso cref="T:Sfs2X.Entities.Match.LogicOperator"/>
- </member>
- <member name="M:Sfs2X.Entities.Match.MatchExpression.Next">
- <summary>
- Get the next matching expression concatenated to the current one.
- </summary>
-
- <returns>The next expression concatenated to the current one.</returns>
- </member>
- <member name="M:Sfs2X.Entities.Match.MatchExpression.Rewind">
- <summary>
- Moves the iterator cursor to the first matching expression in the chain.
- </summary>
-
- <returns>The MatchExpression object at the top of the chain of matching expressions.</returns>
- </member>
- <member name="M:Sfs2X.Entities.Match.MatchExpression.AsString">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Match.MatchExpression.ToString">
- <summary>
- Returns a string representation of the matching expression.
- </summary>
-
- <returns>
- A string that represents the current <see cref="T:Sfs2X.Entities.Match.MatchExpression"/>.
- </returns>
- </member>
- <member name="M:Sfs2X.Entities.Match.MatchExpression.ToSFSArray">
- <exclude/>
- </member>
- <member name="T:Sfs2X.Entities.Match.NumberMatch">
- <summary>
- The NumberMatch class is used in matching expressions to check numeric conditions.
- </summary>
-
- <seealso cref="T:Sfs2X.Entities.Match.MatchExpression"/>
- </member>
- <member name="F:Sfs2X.Entities.Match.NumberMatch.EQUALS">
- <summary>
- An instance of NumberMatch representing the following condition: <em>number1 == number2.</em>
- </summary>
- </member>
- <member name="F:Sfs2X.Entities.Match.NumberMatch.NOT_EQUALS">
- <summary>
- An instance of NumberMatch representing the following condition: <em>number1 != number2.</em>
- </summary>
- </member>
- <member name="F:Sfs2X.Entities.Match.NumberMatch.GREATER_THAN">
- <summary>
- An instance of NumberMatch representing the following condition: <em>number1 > number2.</em>
- </summary>
- </member>
- <member name="F:Sfs2X.Entities.Match.NumberMatch.GREATER_OR_EQUAL_THAN">
- <summary>
- An instance of NumberMatch representing the following condition: <em>number1 >= number2.</em>
- </summary>
- </member>
- <member name="F:Sfs2X.Entities.Match.NumberMatch.LESS_THAN">
- <summary>
- An instance of NumberMatch representing the following condition: <em>number1 < number2.</em>
- </summary>
- </member>
- <member name="F:Sfs2X.Entities.Match.NumberMatch.LESS_OR_EQUAL_THAN">
- <summary>
- An instance of NumberMatch representing the following condition: <em>number1 <= number2.</em>
- </summary>
- </member>
- <member name="M:Sfs2X.Entities.Match.NumberMatch.#ctor(System.String)">
- <exclude/>
- </member>
- <member name="P:Sfs2X.Entities.Match.NumberMatch.Symbol">
- <inheritdoc />
- </member>
- <member name="P:Sfs2X.Entities.Match.NumberMatch.Type">
- <inheritdoc />
- </member>
- <member name="T:Sfs2X.Entities.Match.RoomProperties">
- <summary>
- The RoomProperties class contains the names of predefined properties that can be used in matching expressions to search/filter Rooms.
- </summary>
-
- <seealso cref="T:Sfs2X.Entities.Match.MatchExpression"/>
- <seealso cref="T:Sfs2X.Entities.Room"/>
- </member>
- <member name="F:Sfs2X.Entities.Match.RoomProperties.NAME">
- <summary>
- The Room name.
- </summary>
-
- <remarks>
- Requires a <see cref="T:Sfs2X.Entities.Match.StringMatch"/> to be used for values comparison.
- </remarks>
- </member>
- <member name="F:Sfs2X.Entities.Match.RoomProperties.GROUP_ID">
- <summary>
- The name of the Group to which the Room belongs.
- </summary>
-
- <remarks>
- Requires a <see cref="T:Sfs2X.Entities.Match.StringMatch"/> to be used for values comparison.
- </remarks>
- </member>
- <member name="F:Sfs2X.Entities.Match.RoomProperties.MAX_USERS">
- <summary>
- The maximum number of users allowed in the Room (players in Game Rooms).
- </summary>
-
- <remarks>
- Requires a <see cref="T:Sfs2X.Entities.Match.NumberMatch"/> to be used for values comparison.
- </remarks>
- </member>
- <member name="F:Sfs2X.Entities.Match.RoomProperties.MAX_SPECTATORS">
- <summary>
- The maximum number of spectators allowed in the Room (Game Rooms only).
- </summary>
-
- <remarks>
- Requires a <see cref="T:Sfs2X.Entities.Match.NumberMatch"/> to be used for values comparison.
- </remarks>
- </member>
- <member name="F:Sfs2X.Entities.Match.RoomProperties.USER_COUNT">
- <summary>
- The Room users count (players in Game Rooms).
- </summary>
-
- <remarks>
- Requires a <see cref="T:Sfs2X.Entities.Match.NumberMatch"/> to be used for values comparison.
- </remarks>
- </member>
- <member name="F:Sfs2X.Entities.Match.RoomProperties.SPECTATOR_COUNT">
- <summary>
- The Room spectators count (Game Rooms only).
- </summary>
-
- <remarks>
- Requires a <see cref="T:Sfs2X.Entities.Match.NumberMatch"/> to be used for values comparison.
- </remarks>
- </member>
- <member name="F:Sfs2X.Entities.Match.RoomProperties.IS_GAME">
- <summary>
- The Room is a Game Room.
- </summary>
-
- <remarks>
- Requires a <see cref="T:Sfs2X.Entities.Match.BoolMatch"/> to be used for values comparison.
- </remarks>
- </member>
- <member name="F:Sfs2X.Entities.Match.RoomProperties.IS_PRIVATE">
- <summary>
- The Room is private.
- </summary>
-
- <remarks>
- Requires a <see cref="T:Sfs2X.Entities.Match.BoolMatch"/> to be used for values comparison.
- </remarks>
- </member>
- <member name="F:Sfs2X.Entities.Match.RoomProperties.HAS_FREE_PLAYER_SLOTS">
- <summary>
- The Room has at least one free player slot.
- </summary>
-
- <remarks>
- Requires a <see cref="T:Sfs2X.Entities.Match.BoolMatch"/> to be used for values comparison.
- </remarks>
- </member>
- <member name="F:Sfs2X.Entities.Match.RoomProperties.IS_TYPE_SFSGAME">
- <summary>
- The Room is an <em>SFSGame</em> on the server-side.
- </summary>
-
- <remarks>
- Requires a <see cref="T:Sfs2X.Entities.Match.BoolMatch"/> to be used for values comparison.
- </remarks>
- </member>
- <member name="M:Sfs2X.Entities.Match.RoomProperties.#ctor">
- <exclude/>
- </member>
- <member name="T:Sfs2X.Entities.Match.StringMatch">
- <summary>
- The StringMatch class is used in matching expressions to check string conditions.
- </summary>
-
- <seealso cref="T:Sfs2X.Entities.Match.MatchExpression"/>
- </member>
- <member name="F:Sfs2X.Entities.Match.StringMatch.EQUALS">
- <summary>
- An instance of StringMatch representing the following condition: <em>string1 == string2</em>.
- </summary>
- </member>
- <member name="F:Sfs2X.Entities.Match.StringMatch.NOT_EQUALS">
- <summary>
- An instance of StringMatch representing the following condition: <em>string1 != string2</em>.
- </summary>
- </member>
- <member name="F:Sfs2X.Entities.Match.StringMatch.CONTAINS">
- <summary>
- An instance of StringMatch representing the following condition: <em>string1.indexOf(string2) != -1</em>.
- </summary>
- </member>
- <member name="F:Sfs2X.Entities.Match.StringMatch.STARTS_WITH">
- <summary>
- An instance of StringMatch representing the following condition: <em>string1</em> starts with characters contained in <em>string2</em>.
- </summary>
- </member>
- <member name="F:Sfs2X.Entities.Match.StringMatch.ENDS_WITH">
- <summary>
- An instance of StringMatch representing the following condition: <em>string1</em> ends with characters contained in <em>string2</em>.
- </summary>
- </member>
- <member name="M:Sfs2X.Entities.Match.StringMatch.#ctor(System.String)">
- <exclude/>
- </member>
- <member name="P:Sfs2X.Entities.Match.StringMatch.Symbol">
- <inheritdoc />
- </member>
- <member name="P:Sfs2X.Entities.Match.StringMatch.Type">
- <inheritdoc />
- </member>
- <member name="T:Sfs2X.Entities.Match.UserProperties">
- <summary>
- The UserProperties class contains the names of predefined properties that can be used in matching expressions to search/filter users.
- </summary>
-
- <seealso cref="T:Sfs2X.Entities.Match.MatchExpression"/>
- <seealso cref="T:Sfs2X.Entities.User"/>
- </member>
- <member name="F:Sfs2X.Entities.Match.UserProperties.NAME">
- <summary>
- The user name.
- </summary>
-
- <remarks>
- Requires a <see cref="T:Sfs2X.Entities.Match.StringMatch"/> to be used for values comparison.
- </remarks>
- </member>
- <member name="F:Sfs2X.Entities.Match.UserProperties.IS_PLAYER">
- <summary>
- The user is a player in a Game Room.
- </summary>
-
- <remarks>
- Requires a <see cref="T:Sfs2X.Entities.Match.BoolMatch"/> to be used for values comparison.
- </remarks>
- </member>
- <member name="F:Sfs2X.Entities.Match.UserProperties.IS_SPECTATOR">
- <summary>
- The user is a spectator in a Game Room.
- </summary>
-
- <remarks>
- Requires a <see cref="T:Sfs2X.Entities.Match.BoolMatch"/> to be used for values comparison.
- </remarks>
- </member>
- <member name="F:Sfs2X.Entities.Match.UserProperties.IS_NPC">
- <summary>
- The user is a Non-Player Character (NPC).
- </summary>
-
- <remarks>
- Requires a <see cref="T:Sfs2X.Entities.Match.BoolMatch"/> to be used for values comparison.
- </remarks>
- </member>
- <member name="F:Sfs2X.Entities.Match.UserProperties.PRIVILEGE_ID">
- <summary>
- The user privilege id.
- </summary>
-
- <remarks>
- Requires a <see cref="T:Sfs2X.Entities.Match.NumberMatch"/> to be used for values comparison.
- </remarks>
- </member>
- <member name="F:Sfs2X.Entities.Match.UserProperties.IS_IN_ANY_ROOM">
- <summary>
- The user joined at least one Room.
- </summary>
-
- <remarks>
- Requires a <see cref="T:Sfs2X.Entities.Match.BoolMatch"/> to be used for values comparison.
- </remarks>
- </member>
- <member name="M:Sfs2X.Entities.Match.UserProperties.#ctor">
- <exclude/>
- </member>
- <member name="T:Sfs2X.Entities.Variables.BuddyVariable">
- <summary>
- The BuddyVariable interface defines all the public methods and properties that an object representing a SmartFoxServer Buddy Variable exposes.
- </summary>
-
- <remarks>
- In the SmartFoxServer 2X client API this interface is implemented by the <see cref="T:Sfs2X.Entities.Variables.SFSBuddyVariable"/> class. Read the class description for additional informations.
- </remarks>
-
- <seealso cref="T:Sfs2X.Entities.Variables.SFSBuddyVariable"/>
- </member>
- <member name="P:Sfs2X.Entities.Variables.BuddyVariable.IsOffline">
- <summary>
- Indicates whether the Buddy Variable is persistent or not.
- </summary>
-
- <remarks>
- By convention any Buddy Variable whose name starts with the dollar sign ($) will be regarded as persistent and stored locally by the server.
- Persistent Buddy Variables are also referred to as "offline variables" because they are available to all users who have the owner in their Buddy Lists, whether that Buddy is online or not.
- </remarks>
- </member>
- <member name="T:Sfs2X.Entities.Variables.IMMOItemVariable">
- <summary>
- The IMMOItemVariable interface defines all the public methods and properties that an object representing a SmartFoxServer MMOItem Variable exposes.
- </summary>
-
- <remarks>
- In the SmartFoxServer 2X client API this interface is implemented by the <see cref="T:Sfs2X.Entities.Variables.MMOItemVariable"/> class. Read the class description for additional informations.
- </remarks>
-
- <seealso cref="T:Sfs2X.Entities.Variables.MMOItemVariable"/>
- </member>
- <member name="T:Sfs2X.Entities.Variables.MMOItemVariable">
- <summary>
- The MMOItemVariable object represents a SmartFoxServer MMOItem Variable entity on the client.
- </summary>
-
- <remarks>
- An MMOItem Variable is a custom value attached to an MMOItem object that gets automatically synchronized between client and server on every change, provided that the MMOItem is inside the Area of Interest of the current user in a MMORoom.
- <para />
- <b>NOTE:</b> MMOItem Variables behave exactly like User Variables and support the same data types, but they can be created, updated and deleted on the server side only.
- </remarks>
-
- <seealso cref="T:Sfs2X.Entities.MMOItem"/>
- <seealso cref="T:Sfs2X.Entities.MMORoom"/>
- </member>
- <member name="M:Sfs2X.Entities.Variables.MMOItemVariable.FromSFSArray(Sfs2X.Entities.Data.ISFSArray)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Variables.MMOItemVariable.#ctor(System.String,System.Object,System.Int32)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Variables.MMOItemVariable.#ctor(System.String,System.Object)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Variables.MMOItemVariable.ToString">
- <summary>
- Returns a string that contains the MMOItem Variable name, type and value.
- </summary>
-
- <returns>
- The string representation of the <see cref="T:Sfs2X.Entities.Variables.MMOItemVariable"/> object.
- </returns>
- </member>
- <member name="T:Sfs2X.Entities.Variables.ReservedBuddyVariables">
- <summary>
- The ReservedBuddyVariables class contains the costants describing the SmartFoxServer API reserved Buddy Variable names.
- </summary>
-
- <remarks>
- Reserved Buddy Variables are used to store specific buddy-related informations.
- </remarks>
- </member>
- <member name="F:Sfs2X.Entities.Variables.ReservedBuddyVariables.BV_ONLINE">
- <summary>
- The Buddy Variable with this name keeps track of the online/offline state of the user in a buddy list.
- </summary>
-
- <remarks>
- This variable is persistent, which means that the online/offline state is preserved upon disconnection.
- </remarks>
-
- <seealso cref="P:Sfs2X.Entities.Buddy.IsOnline"/>
- <seealso cref="P:Sfs2X.Entities.Managers.IBuddyManager.MyOnlineState"/>
- </member>
- <member name="F:Sfs2X.Entities.Variables.ReservedBuddyVariables.BV_STATE">
- <summary>
- The Buddy Variable with this name stores the custom state of the user in a buddy list.
- </summary>
-
- <remarks>
- This variable is persistent, which means that the custom state is preserved upon disconnection.
- </remarks>
-
- <seealso cref="P:Sfs2X.Entities.Buddy.State"/>
- <seealso cref="P:Sfs2X.Entities.Managers.IBuddyManager.MyState"/>
- </member>
- <member name="F:Sfs2X.Entities.Variables.ReservedBuddyVariables.BV_NICKNAME">
- <summary>
- The Buddy Variable with this name stores the optional nickname of the user in a buddy list.
- </summary>
-
- <remarks>
- This variable is persistent, which means that the nickname is preserved upon disconnection.
- </remarks>
-
- <seealso cref="P:Sfs2X.Entities.Buddy.NickName"/>
- <seealso cref="P:Sfs2X.Entities.Managers.IBuddyManager.MyNickName"/>
- </member>
- <member name="T:Sfs2X.Entities.Variables.ReservedRoomVariables">
- <summary>
- The ReservedRoomVariables class contains the costants describing the SmartFoxServer API reserved Room Variable names.
- </summary>
- </member>
- <member name="F:Sfs2X.Entities.Variables.ReservedRoomVariables.RV_GAME_STARTED">
- <summary>
- The Room Variable with this name keeps track of the state (started or stopped) of a game created with the <see cref="T:Sfs2X.Requests.Game.CreateSFSGameRequest"/> request.
- </summary>
-
- <seealso cref="T:Sfs2X.Requests.Game.CreateSFSGameRequest"/>
- <seealso cref="P:Sfs2X.Requests.Game.SFSGameSettings.NotifyGameStarted"/>
- </member>
- <member name="T:Sfs2X.Entities.Variables.RoomVariable">
- <summary>
- The RoomVariable interface defines all the public methods and properties that an object representing a SmartFoxServer Room Variable exposes.
- </summary>
-
- <remarks>
- In the SmartFoxServer 2X client API this interface is implemented by the <see cref="T:Sfs2X.Entities.Variables.SFSRoomVariable"/> class. Read the class description for additional informations.
- </remarks>
-
- <seealso cref="T:Sfs2X.Entities.Variables.SFSRoomVariable"/>
- </member>
- <member name="P:Sfs2X.Entities.Variables.RoomVariable.IsPrivate">
- <summary>
- Indicates whether this Room Variable is private or not.
- </summary>
-
- <remarks>
- A private Room Variable is visible to all users in the same Room, but it can be modified by its owner only (the user that created it).
- <para/>
- <b>NOTE</b>: setting this property manually on an existing Room Variable returned by the API has no effect on the server and can disrupt the API functioning.
- This flag can be set when the Room Variable object is created by the developer only (using the <em>new</em> keyword).
- </remarks>
- </member>
- <member name="P:Sfs2X.Entities.Variables.RoomVariable.IsPersistent">
- <summary>
- Indicates whether this Room Variable is persistent or not.
- </summary>
-
- <remarks>
- A persistent Room Variable continues to exist in the Room after the user who created it has left it and until he disconnects.
- <para/>
- <b>NOTE</b>: setting this property manually on an existing Room Variable returned by the API has no effect on the server and can disrupt the API functioning.
- This flag can be set when the Room Variable object is created by the developer only (using the <em>new</em> keyword).
- </remarks>
- </member>
- <member name="T:Sfs2X.Entities.Variables.SFSBuddyVariable">
- <summary>
- The SFSBuddyVariable object represents a SmartFoxServer Buddy Variable entity on the client.
- </summary>
-
- <remarks>
- The Buddy Variable is a custom value attached to a Buddy object in a Buddy List that gets automatically synchronized between client and server on every change.
- <para/>
- Buddy Variables work with the same principle of the User and Room Variables. The only difference is the logic by which they get propagated to other users.
- While Room and User Variables are usually broadcast to all clients in the same Room, Buddy Variables updates are sent to all users who have the owner of the Buddy Variable in their Buddy Lists.
- <para/>
- Buddy Variables are particularly useful to store custom user data that must be "visible" to the buddies only, such as a profile, a score, a status message, etc.
- Buddy Variables can be set by means of the <see cref="T:Sfs2X.Requests.Buddylist.SetBuddyVariablesRequest"/> request; they support the data types listed in the <seealso cref="T:Sfs2X.Entities.Variables.VariableType"/> class (also nested). A Buddy Variable can also be <c>null</c>.
- <para/>
- There is also a special convention that allows Buddy Variables to be set as "offline". Offline Buddy Variables are persistent values which are made available to all users
- who have the owner in their Buddy Lists, whether that Buddy is online or not. In order to make a Buddy Variable persistent, its name should start with a dollar sign ($).
- This conventional character is contained in the <see cref="F:Sfs2X.Entities.Variables.SFSBuddyVariable.OFFLINE_PREFIX"/> constant.
- </remarks>
-
- <seealso cref="T:Sfs2X.Entities.SFSBuddy"/>
- <seealso cref="T:Sfs2X.Requests.Buddylist.SetBuddyVariablesRequest"/>
- <seealso cref="F:Sfs2X.Core.SFSBuddyEvent.BUDDY_VARIABLES_UPDATE"/>
- </member>
- <member name="F:Sfs2X.Entities.Variables.SFSBuddyVariable.OFFLINE_PREFIX">
- <summary>
- The prefix to be added to a Buddy Variable name to make it persistent.
- </summary>
-
- <remarks>
- A persistent Buddy Variable is made available to all users who have the owner in their Buddy Lists, whether that Buddy is online or not.
- </remarks>
- </member>
- <member name="M:Sfs2X.Entities.Variables.SFSBuddyVariable.FromSFSArray(Sfs2X.Entities.Data.ISFSArray)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Variables.SFSBuddyVariable.#ctor(System.String,System.Object,System.Int32)">
- <summary>
- Creates a new SFSBuddyVariable instance.
- </summary>
-
- <param name="name">The name of the Buddy Variable.</param>
- <param name="val">The value of the Buddy Variable.</param>
- <param name="type">The type of the Buddy Variable among those available in the <see cref="T:Sfs2X.Entities.Variables.VariableType"/> class. Usually it is not necessary to pass this parameter, as the type is auto-detected from the value.</param>
- </member>
- <member name="M:Sfs2X.Entities.Variables.SFSBuddyVariable.#ctor(System.String,System.Object)">
- <summary>
- See <see cref="M:Sfs2X.Entities.Variables.SFSBuddyVariable.#ctor(System.String,System.Object,System.Int32)"/>.
- </summary>
- </member>
- <member name="P:Sfs2X.Entities.Variables.SFSBuddyVariable.IsOffline">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Variables.SFSBuddyVariable.ToString">
- <summary>
- Returns a string that contains the Buddy Variable name, type and value.
- </summary>
-
- <returns>
- The string representation of the <see cref="T:Sfs2X.Entities.Variables.SFSBuddyVariable"/> object.
- </returns>
- </member>
- <member name="T:Sfs2X.Entities.Variables.SFSRoomVariable">
- <summary>
- The SFSRoomVariable object represents a SmartFoxServer Room Variable entity on the client.
- </summary>
-
- <remarks>
- This is a custom value attached to a Room object that gets automatically synchronized between client and server on every change.
- <para/>
- Room Variables are particularly useful to store custom Room data such as a game status and other Room-level informations.
- Room Variables can be set by means of the <see cref="T:Sfs2X.Requests.SetRoomVariablesRequest"/> request; they support the data types listed in the <seealso cref="T:Sfs2X.Entities.Variables.VariableType"/> class (also nested). A Room Variable can also be <c>null</c>.
- <para/>
- Room Variables also support a number of specific flags:
- <ul>
- <li><b>Private</b>: a private Room Variable can only be modified by its creator.</li>
- <li><b>Persistent</b>: a persistent Room Variable will continue to exist even if its creator has left the Room (but will be deleted when the creator will get disconnected).</li>
- <li><b>Global</b>: a global Room Variable will fire update events not only to all users in the Room, but also to all users in the Group to which the Room belongs (NOTE: this flag is not available on the client-side because clients are not allowed to create global Room Variables).</li>
- </ul>
- </remarks>
-
- <seealso cref="T:Sfs2X.Entities.Room"/>
- <seealso cref="T:Sfs2X.Requests.SetRoomVariablesRequest"/>
- </member>
- <member name="M:Sfs2X.Entities.Variables.SFSRoomVariable.FromSFSArray(Sfs2X.Entities.Data.ISFSArray)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Variables.SFSRoomVariable.#ctor(System.String,System.Object,System.Int32)">
- <summary>
- Creates a new SFSRoomVariable instance.
- </summary>
-
- <param name="name">The name of the Room Variable.</param>
- <param name="val">The value of the Room Variable.</param>
- <param name="type">The type of the Room Variable among those available in the <see cref="T:Sfs2X.Entities.Variables.VariableType"/> class. Usually it is not necessary to pass this parameter, as the type is auto-detected from the value.</param>
- </member>
- <member name="M:Sfs2X.Entities.Variables.SFSRoomVariable.#ctor(System.String,System.Object)">
- <summary>
- See <see cref="M:Sfs2X.Entities.Variables.SFSRoomVariable.#ctor(System.String,System.Object,System.Int32)"/>.
- </summary>
- </member>
- <member name="P:Sfs2X.Entities.Variables.SFSRoomVariable.IsPrivate">
- <inheritdoc />
- </member>
- <member name="P:Sfs2X.Entities.Variables.SFSRoomVariable.IsPersistent">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Variables.SFSRoomVariable.ToSFSArray">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Variables.SFSRoomVariable.ToString">
- <summary>
- Returns a string that contains the Room Variable name, type, value and <em>isPrivate</em> flag.
- </summary>
-
- <returns>
- The string representation of the <see cref="T:Sfs2X.Entities.Variables.SFSRoomVariable"/> object.
- </returns>
- </member>
- <member name="T:Sfs2X.Entities.Variables.SFSUserVariable">
- <summary>
- The SFSUserVariable object represents a SmartFoxServer User Variable entity on the client.
- </summary>
-
- <remarks>
- This is a custom value attached to a User object that gets automatically synchronized between client and server on every change.
- <para/>
- User Variables are particularly useful to store custom user data that must be "visible" to the other users, such as a profile, a score, a status message, etc.
- User Variables can be set by means of the <see cref="T:Sfs2X.Requests.SetUserVariablesRequest"/> request; they support the data types listed in the <seealso cref="T:Sfs2X.Entities.Variables.VariableType"/> class (also nested). A User Variable can also be <c>null</c>.
- <para/>
- User Variables can be 'private' (starting from SFS2X v2.12 with client API v1.7): this flag allows to limit the visibility of variables to their owner only.
- In other words User Variables marked as private are not sent to other users, even if located in the same Room.
- </remarks>
-
- <seealso cref="T:Sfs2X.Entities.User"/>
- <seealso cref="T:Sfs2X.Requests.SetUserVariablesRequest"/>
- </member>
- <member name="M:Sfs2X.Entities.Variables.SFSUserVariable.FromSFSArray(Sfs2X.Entities.Data.ISFSArray)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Variables.SFSUserVariable.newPrivateVariable(System.String,System.Object)">
- <summary>
- Creates a new private User Variable.
- </summary>
-
- <remarks>
- Private User Variables are not broadcast to other users: they are only visible on the server side and in the owner's client application.
- </remarks>
-
- <param name="name">The name of the User Variable.</param>
- <param name="val">The value of the User Variable.</param>
- </member>
- <member name="M:Sfs2X.Entities.Variables.SFSUserVariable.#ctor(System.String,System.Object,System.Int32)">
- <summary>
- Creates a new SFSUserVariable instance.
- </summary>
-
- <param name="name">The name of the User Variable.</param>
- <param name="val">The value of the User Variable.</param>
- <param name="type">The type of the User Variable among those available in the <see cref="T:Sfs2X.Entities.Variables.VariableType"/> class. Usually it is not necessary to pass this parameter, as the type is auto-detected from the value.</param>
- </member>
- <member name="M:Sfs2X.Entities.Variables.SFSUserVariable.#ctor(System.String,System.Object)">
- <summary>
- See <see cref="M:Sfs2X.Entities.Variables.SFSUserVariable.#ctor(System.String,System.Object,System.Int32)"/>.
- </summary>
- </member>
- <member name="P:Sfs2X.Entities.Variables.SFSUserVariable.IsPrivate">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Variables.SFSUserVariable.ToSFSArray">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Variables.SFSUserVariable.ToString">
- <summary>
- Returns a string that contains the User Variable name, type, value and <em>IsPrivate</em> flag.
- </summary>
-
- <returns>
- The string representation of the <see cref="T:Sfs2X.Entities.Variables.SFSUserVariable"/> object.
- </returns>
- </member>
- <member name="T:Sfs2X.Entities.Variables.UserVariable">
- <summary>
- The UserVariable interface defines all the public methods and properties that an object representing a SmartFoxServer User Variable exposes.
- </summary>
-
- <remarks>
- In the SmartFoxServer 2X client API this interface is implemented by the <see cref="T:Sfs2X.Entities.Variables.SFSUserVariable"/> class. Read the class description for additional informations.
- </remarks>
-
- <seealso cref="T:Sfs2X.Entities.Variables.Variable"/>
- </member>
- <member name="P:Sfs2X.Entities.Variables.UserVariable.IsPrivate">
- <summary>
- Indicates whether this User Variable is private or not.
- </summary>
-
- <remarks>
- A private User Variable is visible only to its owner; any changes made to the variable will be transmitted to the owner only.
- <para/>
- <b>NOTE</b>: setting this property manually on an existing User Variable returned by the API has no effect on the server and can disrupt the API functioning.
- This flag can be set when the User Variable object is created by the developer only (using the <em>new</em> keyword).
- </remarks>
- </member>
- <member name="T:Sfs2X.Entities.Variables.VariableType">
- <summary>
- The VariableType class contains the costants defining the valid types of User and Room Variables to be passed to their constructors.
- </summary>
- </member>
- <member name="F:Sfs2X.Entities.Variables.VariableType.NULL">
- <summary>
- The User/Room Variable is <c>null</c>.
- </summary>
- </member>
- <member name="F:Sfs2X.Entities.Variables.VariableType.BOOL">
- <summary>
- The type of the User/Room Variable is boolean.
- </summary>
- </member>
- <member name="F:Sfs2X.Entities.Variables.VariableType.INT">
- <summary>
- The type of the User/Room Variable is integer.
- </summary>
- </member>
- <member name="F:Sfs2X.Entities.Variables.VariableType.DOUBLE">
- <summary>
- The type of the User/Room Variable is double.
- </summary>
- </member>
- <member name="F:Sfs2X.Entities.Variables.VariableType.STRING">
- <summary>
- The type of the User/Room Variable is string.
- </summary>
- </member>
- <member name="F:Sfs2X.Entities.Variables.VariableType.OBJECT">
- <summary>
- The type of the User/Room Variable is <em>SFSObject</em>.
- </summary>
-
- <seealso cref="T:Sfs2X.Entities.Data.SFSObject"/>
- </member>
- <member name="F:Sfs2X.Entities.Variables.VariableType.ARRAY">
- <summary>
- The type of the User/Room Variable is <em>SFSArray</em>.
- </summary>
-
- <seealso cref="T:Sfs2X.Entities.Data.SFSArray"/>
- </member>
- <member name="T:Sfs2X.Entities.Variables.Variable">
- <summary>
- The Variable interface defines all the default public methods and properties that an object representing a SmartFoxServer Variable exposes.
- </summary>
- </member>
- <member name="P:Sfs2X.Entities.Variables.Variable.Name">
- <summary>
- Indicates the name of this variable.
- </summary>
- </member>
- <member name="P:Sfs2X.Entities.Variables.Variable.Type">
- <summary>
- Indicates the type of this variable.
- </summary>
-
- <seealso cref="T:Sfs2X.Entities.Variables.VariableType"/>
- </member>
- <member name="P:Sfs2X.Entities.Variables.Variable.Value">
- <summary>
- Returns the untyped value of this variable.
- </summary>
- </member>
- <member name="M:Sfs2X.Entities.Variables.Variable.GetBoolValue">
- <summary>
- Retrieves the value of a boolean variable.
- </summary>
-
- <returns>The variable value as a boolean.</returns>
- </member>
- <member name="M:Sfs2X.Entities.Variables.Variable.GetIntValue">
- <summary>
- Retrieves the value of an integer variable.
- </summary>
-
- <returns>The variable value as an integer.</returns>
- </member>
- <member name="M:Sfs2X.Entities.Variables.Variable.GetDoubleValue">
- <summary>
- Retrieves the value of a double precision variable.
- </summary>
-
- <returns>The variable value as a double.</returns>
- </member>
- <member name="M:Sfs2X.Entities.Variables.Variable.GetStringValue">
- <summary>
- Retrieves the value of a string variable.
- </summary>
-
- <returns>The variable value as a string.</returns>
- </member>
- <member name="M:Sfs2X.Entities.Variables.Variable.GetSFSObjectValue">
- <summary>
- Retrieves the value of a SFSObject variable.
- </summary>
-
- <returns>The variable value as an object implementing the <see cref="T:Sfs2X.Entities.Data.ISFSObject"/> interface.</returns>
-
- <seealso cref="T:Sfs2X.Entities.Data.SFSObject"/>
- </member>
- <member name="M:Sfs2X.Entities.Variables.Variable.GetSFSArrayValue">
- <summary>
- Retrieves the value of a SFSArray variable.
- </summary>
-
- <returns>The variable value as an object implementing the <see cref="T:Sfs2X.Entities.Data.ISFSArray"/> interface.</returns>
-
- <seealso cref="T:Sfs2X.Entities.Data.SFSArray"/>
- </member>
- <member name="M:Sfs2X.Entities.Variables.Variable.IsNull">
- <summary>
- Indicates if the variable is <c>null</c>.
- </summary>
-
- <returns><c>true</c> if the variable has a <c>null</c> value.</returns>
- </member>
- <member name="M:Sfs2X.Entities.Variables.Variable.ToSFSArray">
- <exclude/>
- </member>
- <member name="T:Sfs2X.Entities.Variables.BaseVariable">
- <summary>
- The BaseVariable object is the base class for all SmartFoxServer Variable entities on the client.
- </summary>
-
- <seealso cref="T:Sfs2X.Entities.Variables.SFSUserVariable"/>
- <seealso cref="T:Sfs2X.Entities.Variables.SFSRoomVariable"/>
- <seealso cref="T:Sfs2X.Entities.Variables.SFSBuddyVariable"/>
- <seealso cref="T:Sfs2X.Entities.Variables.MMOItemVariable"/>
- </member>
- <member name="F:Sfs2X.Entities.Variables.BaseVariable.name">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Entities.Variables.BaseVariable.type">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Entities.Variables.BaseVariable.val">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Variables.BaseVariable.#ctor(System.String,System.Object,System.Int32)">
- <summary>
- Creates a new BaseVariable instance.
- </summary>
-
- <param name="name">The name of the Variable.</param>
- <param name="val">The value of the Variable.</param>
- <param name="type">The type of the Variable among those available in the <see cref="T:Sfs2X.Entities.Variables.VariableType"/> class. Usually it is not necessary to pass this parameter, as the type is auto-detected from the value.</param>
-
- <exclude/>
- </member>
- <member name="M:Sfs2X.Entities.Variables.BaseVariable.#ctor(System.String,System.Object)">
- <summary>
- See <see cref="M:Sfs2X.Entities.Variables.BaseVariable.#ctor(System.String,System.Object,System.Int32)"/>.
- </summary>
-
- <exclude/>
- </member>
- <member name="P:Sfs2X.Entities.Variables.BaseVariable.Name">
- <inheritdoc />
- </member>
- <member name="P:Sfs2X.Entities.Variables.BaseVariable.Type">
- <inheritdoc />
- </member>
- <member name="P:Sfs2X.Entities.Variables.BaseVariable.Value">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Variables.BaseVariable.GetBoolValue">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Variables.BaseVariable.GetIntValue">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Variables.BaseVariable.GetDoubleValue">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Variables.BaseVariable.GetStringValue">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Variables.BaseVariable.GetSFSObjectValue">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Variables.BaseVariable.GetSFSArrayValue">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Variables.BaseVariable.IsNull">
- <inheritdoc />
- </member>
- <member name="M:Sfs2X.Entities.Variables.BaseVariable.ToSFSArray">
- <exclude/>
- </member>
- <member name="T:Sfs2X.Logging.LogLevel">
- <summary>
- The LogLevel enumeration contains the costants describing the importance levels of logged messages.
- </summary>
-
- <seealso cref="M:Sfs2X.SmartFox.AddLogListener(Sfs2X.Logging.LogLevel,Sfs2X.Core.EventListenerDelegate)"/>
- </member>
- <member name="F:Sfs2X.Logging.LogLevel.DEBUG">
- <summary>
- A DEBUG message is a fine-grained information on the client activity.
- </summary>
- </member>
- <member name="F:Sfs2X.Logging.LogLevel.INFO">
- <summary>
- An INFO message contains informations on the standard client activities.
- </summary>
- </member>
- <member name="F:Sfs2X.Logging.LogLevel.WARN">
- <summary>
- A WARN message is a warning caused by an unexpected behavior of the client.
- </summary>
-
- <remarks>
- Client operations are not compromised when a warning is raised.
- </remarks>
- </member>
- <member name="F:Sfs2X.Logging.LogLevel.ERROR">
- <summary>
- An ERROR message contains informations on a problem that occurred during the client activities.
- </summary>
-
- <remarks>
- Client operations might be compromised when an error is raised.
- </remarks>
- </member>
- <member name="T:Sfs2X.Logging.Logger">
- <summary>
- The internal logger used by the SmartFoxServer 2X client API.
- </summary>
-
- <remarks>
- You can get a reference to the Logger by means of the <see cref="P:Sfs2X.SmartFox.Logger">SmartFox.Logger</see> property.
- Accessing the logger can be useful to control the client-side logging level, enable or disable the output towards the console and enable or disable the events dispatching.
- When logger events are enabled, you can add your own listners to this class, in order to have a lower access to logged messages (for example you could display them in a dedicated panel in the application interface).
- </remarks>
-
- <seealso cref="T:Sfs2X.Logging.LoggerEvent"/>
- <seealso cref="P:Sfs2X.SmartFox.Logger"/>
- </member>
- <member name="M:Sfs2X.Logging.Logger.#ctor(Sfs2X.SmartFox)">
- <exclude/>
- </member>
- <member name="P:Sfs2X.Logging.Logger.EnableConsoleTrace">
- <summary>
- Indicates whether or not the output of logged messages to the console is enabled.
- </summary>
-
- <remarks>
- If <c>true</c>, logged messages are displayed using the <c>Console.WriteLine()</c> method for unity or <c>System.Diagnostics.Debug.WriteLine</c> for win8 and win phone.
- </remarks>
- </member>
- <member name="P:Sfs2X.Logging.Logger.EnableEventDispatching">
- <summary>
- Indicates whether dispatching of log events is enabled or not.
- </summary>
-
- <seealso cref="T:Sfs2X.Logging.LoggerEvent"/>
- </member>
- <member name="P:Sfs2X.Logging.Logger.LoggingLevel">
- <summary>
- Determines the current logging level.
- </summary>
-
- <remarks>
- Messages with a level lower than this value are not logged. The available log levels are contained in the <see cref="T:Sfs2X.Logging.LogLevel"/> class.
- </remarks>
-
- <seealso cref="T:Sfs2X.Logging.LogLevel"/>
- </member>
- <member name="M:Sfs2X.Logging.Logger.Debug(System.String[])">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Logging.Logger.Info(System.String[])">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Logging.Logger.Warn(System.String[])">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Logging.Logger.Error(System.String[])">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Logging.Logger.AddEventListener(Sfs2X.Logging.LogLevel,Sfs2X.Core.EventListenerDelegate)">
- <summary>
- Registers a delegate method for log messages callbacks.
- </summary>
-
- <remarks>
- Calling this method is just like calling the <see cref="M:Sfs2X.SmartFox.AddLogListener(Sfs2X.Logging.LogLevel,Sfs2X.Core.EventListenerDelegate)">SmartFox.AddLogListener</see> method.
- </remarks>
-
- <param name="level">The level of the log events to register a listener for.</param>
- <param name="listener">The event listener to register.</param>
-
- <example>
- <code>
- void SomeMethod() {
- sfs.logger.EnableEventDispatching = true;
- sfs.Logger.AddEventListener(LogLevel.INFO, OnInfoLogMessage);
- sfs.Logger.AddEventListener(LogLevel.WARN, OnWarnLogMessage);
- }
-
- void OnInfoLogMessage(BaseEvent evt) {
- string message = (string)evt.Params["message"];
- Console.WriteLine("[SFS2X INFO] " + message); // .Net / Unity
- System.Diagnostics.Debug.WriteLine("[SFS2X INFO] " + message); // Windows Universal
- }
-
- void OnWarnLogMessage(BaseEvent evt) {
- string message = (string)evt.Params["message"];
- Console.WriteLine("[SFS2X WARN] " + message); // .Net / Unity
- System.Diagnostics.Debug.WriteLine("[SFS2X WARN] " + message); // Windows Universal
- }
- </code>
- </example>
-
- <seealso cref="M:Sfs2X.SmartFox.AddLogListener(Sfs2X.Logging.LogLevel,Sfs2X.Core.EventListenerDelegate)"/>
- </member>
- <member name="M:Sfs2X.Logging.Logger.RemoveEventListener(Sfs2X.Logging.LogLevel,Sfs2X.Core.EventListenerDelegate)">
- <summary>
- Removes a delegate method for log messages callbacks.
- </summary>
-
- <remarks>
- Calling this method is just like calling the <see cref="M:Sfs2X.SmartFox.RemoveLogListener(Sfs2X.Logging.LogLevel,Sfs2X.Core.EventListenerDelegate)">Sfs2X.SmartFox.RemoveLogListener</see> method.
- </remarks>
-
- <param name="logLevel">The level of the log events to remove the listener for.</param>
- <param name="listener">The event listener to remove.</param>
-
- <seealso cref="M:Sfs2X.SmartFox.RemoveLogListener(Sfs2X.Logging.LogLevel,Sfs2X.Core.EventListenerDelegate)"/>
- </member>
- <member name="T:Sfs2X.Logging.LoggerEvent">
- <summary>
- LoggerEvent is the class representing all the events dispatched by the SmartFoxServer 2X C# API internal logger.
- </summary>
- </member>
- <member name="M:Sfs2X.Logging.LoggerEvent.#ctor(Sfs2X.Logging.LogLevel,System.Collections.Hashtable)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Logging.LoggerEvent.LogEventType(Sfs2X.Logging.LogLevel)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Logging.LoggerEvent.ToString">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Logging.LoggerEvent.Clone">
- <exclude/>
- </member>
- <member name="P:Sfs2X.Protocol.Serialization.DefaultSFSDataSerializer.RunningAssembly">
- <summary>
- Set this to specify the assembly you want to use when serializing/deserializing the .NET classes
- If null (default) - will look for the Type in the current assembly.
- </summary>
- </member>
- <member name="T:Sfs2X.Requests.AdminMessageRequest">
- <summary>
- Sends an administrator message to a specific user or a group of users.
- </summary>
-
- <remarks>
- The current user must have administration privileges to be able to send the message (see the <see cref="P:Sfs2X.Entities.User.PrivilegeId">User.PrivilegeId</see> property).
- <para/>
- The <em>recipientMode</em> parameter in the class constructor is used to determine the message recipients: a single user or all the users in a Room,
- a Group or the entire Zone. Upon message delivery, the clients of the recipient users dispatch the <see cref="F:Sfs2X.Core.SFSEvent.ADMIN_MESSAGE"/> event.
- </remarks>
-
- <example>
- The following example sends an administration message to all the users in the Zone; it also shows how to handle the related event:
- <code>
- void SomeMethod() {
- sfs.AddEventListener(SFSEvent.ADMIN_MESSAGE, OnAdminMessage);
-
- // Set the message recipients: all users in the Zone
- MessageRecipientMode recipMode = new MessageRecipientMode(MessageRecipientMode.TO_ZONE, null);
-
- // Send the administrator message
- sfs.Send( new AdminMessageRequest("Hello to everybody from the Administrator!", recipMode) );
- }
-
- void OnAdminMessage(BaseEvent evt) {
- Console.WriteLine("The administrator sent the following message: " + (string)evt.Params["message"]); // .Net / Unity
- System.Diagnostics.Debug.WriteLine("The administrator sent the following message: " + (string)evt.Params["message"]); // Windows Universal
- }
- </code>
- </example>
-
- <seealso cref="T:Sfs2X.Requests.MessageRecipientMode"/>
- <seealso cref="F:Sfs2X.Core.SFSEvent.ADMIN_MESSAGE"/>
- <seealso cref="T:Sfs2X.Requests.ModeratorMessageRequest"/>
- </member>
- <member name="M:Sfs2X.Requests.AdminMessageRequest.#ctor(System.String,Sfs2X.Requests.MessageRecipientMode,Sfs2X.Entities.Data.ISFSObject)">
- <summary>
- Creates a new AdminMessageRequest instance.
- </summary>
-
- <remarks>
- The instance must be passed to the <see cref="M:Sfs2X.SmartFox.Send(Sfs2X.Requests.IRequest)">SmartFox.Send</see> method for the request to be performed.
- </remarks>
-
- <param name="message">The message of the administrator to be sent to the target user/s defined by the <em>recipientMode</em> parameter.</param>
- <param name="recipientMode">An instance of MessageRecipientMode containing the target to which the message should be delivered.</param>
- <param name="parameters">An instance of <see cref="T:Sfs2X.Entities.Data.SFSObject"/> containing custom parameters to be sent to the recipient user/s (default = <c>null</c>).</param>
- </member>
- <member name="M:Sfs2X.Requests.AdminMessageRequest.#ctor(System.String,Sfs2X.Requests.MessageRecipientMode)">
- <summary>
- See <em>AdminMessageRequest(string, MessageRecipientMode, ISFSObject)</em> constructor.
- </summary>
- </member>
- <member name="T:Sfs2X.Requests.BanMode">
- <summary>
- The BanMode enumeration contains the costants describing the possible banning modalities for a BanUserRequest.
- </summary>
-
- <seealso cref="T:Sfs2X.Requests.BanUserRequest"/>
- </member>
- <member name="F:Sfs2X.Requests.BanMode.BY_ADDRESS">
- <summary>
- User is banned by IP address.
- </summary>
- </member>
- <member name="F:Sfs2X.Requests.BanMode.BY_NAME">
- <summary>
- User is banned by name.
- </summary>
- </member>
- <member name="T:Sfs2X.Requests.BanUserRequest">
- <summary>
- Banishes a user from the server.
- </summary>
-
- <remarks>
- The current user must have administration or moderation privileges in order to be able to ban another user (see the <see cref="P:Sfs2X.Entities.User.PrivilegeId">User.PrivilegeId</see> property).
- The user can be banned by name or by IP address (see the <see cref="T:Sfs2X.Requests.BanMode"/> class). Also, the request allows sending a message to the banned user
- (to make clear the reason of the following disconnection) which is delivered by means of the <see cref="F:Sfs2X.Core.SFSEvent.MODERATOR_MESSAGE"/> event.
- <para/>
- Differently from the user being kicked (see the <see cref="T:Sfs2X.Requests.KickUserRequest"/> request), a banned user won't be able to connect to the SmartFoxServer instance
- until the banishment expires (after 24 hours for client-side banning) or an administrator removes his name/IP address from the list of banned users by means
- of the SmartFoxServer 2X Administration Tool.
- </remarks>
-
- <example>
- The following example bans the user Jack from the system:
- <code>
- User userToBan = sfs.UserManager.GetUserByName("Jack");
- sfs.Send( new BanUserRequest(userToBan.Id) );
- </code>
- </example>
-
- <seealso cref="F:Sfs2X.Core.SFSEvent.MODERATOR_MESSAGE"/>
- <seealso cref="T:Sfs2X.Requests.KickUserRequest"/>
- <seealso cref="T:Sfs2X.Requests.BanMode"/>
- </member>
- <member name="F:Sfs2X.Requests.BanUserRequest.KEY_USER_ID">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.BanUserRequest.KEY_MESSAGE">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.BanUserRequest.KEY_DELAY">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.BanUserRequest.KEY_BAN_MODE">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.BanUserRequest.KEY_BAN_DURATION_HOURS">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Requests.BanUserRequest.#ctor(System.Int32,System.String,Sfs2X.Requests.BanMode,System.Int32,System.Int32)">
- <summary>
- Creates a new BanUserRequest instance.
- </summary>
-
- <remarks>
- The instance must be passed to the <see cref="M:Sfs2X.SmartFox.Send(Sfs2X.Requests.IRequest)">SmartFox.Send</see> method for the request to be performed.
- </remarks>
-
- <param name="userId">The id of the user to be banned.</param>
- <param name="message">A custom message to be delivered to the user before banning him; if <c>null</c>, the default message configured in the SmartFoxServer 2X Administration Tool is used (default = <c>null</c>).</param>
- <param name="banMode">One of the ban modes defined in the <see cref="T:Sfs2X.Requests.BanMode"/> class (default = <c>BanMode.BY_NAME</c>).</param>
- <param name="delaySeconds">The number of seconds after which the user is banned after receiving the ban message (default = <c>5</c>).</param>
- <param name="durationHours">The duration of the banishment, expressed in hours (default = <c>24</c>).</param>
-
- <seealso cref="T:Sfs2X.Requests.BanMode"/>
- </member>
- <member name="M:Sfs2X.Requests.BanUserRequest.#ctor(System.Int32)">
- <summary>
- See <em>BanUserRequest(int, string, BanMode, int, int)</em> constructor.
- </summary>
- </member>
- <member name="M:Sfs2X.Requests.BanUserRequest.#ctor(System.Int32,System.String)">
- <summary>
- See <em>BanUserRequest(int, string, BanMode, int, int)</em> constructor.
- </summary>
- </member>
- <member name="M:Sfs2X.Requests.BanUserRequest.#ctor(System.Int32,System.String,Sfs2X.Requests.BanMode)">
- <summary>
- See <em>BanUserRequest(int, string, BanMode, int, int)</em> constructor.
- </summary>
- </member>
- <member name="M:Sfs2X.Requests.BanUserRequest.#ctor(System.Int32,System.String,Sfs2X.Requests.BanMode,System.Int32)">
- <summary>
- See <em>BanUserRequest(int, string, BanMode, int, int)</em> constructor.
- </summary>
- </member>
- <member name="M:Sfs2X.Requests.BanUserRequest.Validate(Sfs2X.SmartFox)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Requests.BanUserRequest.Execute(Sfs2X.SmartFox)">
- <exclude/>
- </member>
- <member name="T:Sfs2X.Requests.BaseRequest">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.BaseRequest.KEY_ERROR_CODE">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.BaseRequest.KEY_ERROR_PARAMS">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.BaseRequest.sfso">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.BaseRequest.targetController">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Requests.BaseRequest.#ctor(Sfs2X.Requests.RequestType)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Requests.BaseRequest.#ctor(System.Int32)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Requests.BaseRequest.Validate(Sfs2X.SmartFox)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Requests.BaseRequest.Execute(Sfs2X.SmartFox)">
- <exclude/>
- </member>
- <member name="P:Sfs2X.Requests.BaseRequest.TargetController">
- <exclude/>
- </member>
- <member name="P:Sfs2X.Requests.BaseRequest.IsEncrypted">
- <exclude/>
- </member>
- <member name="P:Sfs2X.Requests.BaseRequest.Message">
- <exclude/>
- </member>
- <member name="P:Sfs2X.Requests.BaseRequest.Id">
- <exclude/>
- </member>
- <member name="P:Sfs2X.Requests.BaseRequest.Type">
- <exclude/>
- </member>
- <member name="T:Sfs2X.Requests.ChangeRoomCapacityRequest">
- <summary>
- Changes the maximum number of users and/or spectators who can join a Room.
- </summary>
-
- <remarks>
- If the operation is successful, the <see cref="F:Sfs2X.Core.SFSEvent.ROOM_CAPACITY_CHANGE"/> event is dispatched to all the users who subscribed the Group to which the target Room belongs,
- including the requester user himself. If the user is not the creator (owner) of the Room, the <see cref="F:Sfs2X.Core.SFSEvent.ROOM_CAPACITY_CHANGE_ERROR"/> event is fired.
- An administrator or moderator can override this constrain (he is not requested to be the Room's owner).
- <para/>
- Please note that some limitations are applied to the passed values (i.e. a client can't set the max users to more than 200, or the max spectators to more than 32).<br/>
- Alos, if the Room was configured so that resizing is not allowed (see the <see cref="P:Sfs2X.Requests.RoomSettings.Permissions">RoomSettings.Permissions</see> parameter), the request is ignored and no error is fired.
- <para/>
- In case the Room's capacity is reduced to a value less than the current number of users/spectators inside the Room, exceeding users are NOT disconnected.
- </remarks>
-
- <example>
- The following example changes the capacity of an existing Room:
- <code>
- void SomeMethod() {
- sfs.AddEventListener(SFSEvent.ROOM_CAPACITY_CHANGE, OnRoomCapacityChange);
- sfs.AddEventListener(SFSEvent.ROOM_CAPACITY_CHANGE_ERROR, OnRoomCapacityChangeError);
-
- Room theRoom = sfs.GetRoomByName("Gonzo's Room");
-
- // Resize the Room so that it allows a maximum of 100 users and zero spectators
- sfs.Send( new ChangeRoomCapacityRequest(theRoom, 100, 0) );
- }
-
- void OnRoomCapacityChange(BaseEvent evt) {
- Room room = (Room)evt.Params["room"];
- Console.WriteLine("The capacity of Room " + room.Name + " was changed successfully"); // .Net / Unity
- System.Diagnostics.Debug.WriteLine("The capacity of Room " + room.Name + " was changed successfully"); // Windows Universal
- }
-
- void OnRoomCapacityChangeError(BaseEvent evt) {
- Console.WriteLine("Room capacity change failed: " + (string)evt.Params["errorMessage"]); // .Net / Unity
- System.Diagnostics.Debug.WriteLine("Room capacity change failed: " + (string)evt.Params["errorMessage"]); // Windows Universal
- }
- </code>
- </example>
-
- <seealso cref="F:Sfs2X.Core.SFSEvent.ROOM_CAPACITY_CHANGE"/>
- <seealso cref="F:Sfs2X.Core.SFSEvent.ROOM_CAPACITY_CHANGE_ERROR"/>
- <seealso cref="P:Sfs2X.Requests.RoomSettings.Permissions"/>
- <seealso cref="T:Sfs2X.Requests.ChangeRoomNameRequest"/>
- <seealso cref="T:Sfs2X.Requests.ChangeRoomPasswordStateRequest"/>
- </member>
- <member name="F:Sfs2X.Requests.ChangeRoomCapacityRequest.KEY_ROOM">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.ChangeRoomCapacityRequest.KEY_USER_SIZE">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.ChangeRoomCapacityRequest.KEY_SPEC_SIZE">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Requests.ChangeRoomCapacityRequest.#ctor(Sfs2X.Entities.Room,System.Int32,System.Int32)">
- <summary>
- Creates a new ChangeRoomCapacityRequest instance.
- </summary>
-
- <remarks>
- The instance must be passed to the <see cref="M:Sfs2X.SmartFox.Send(Sfs2X.Requests.IRequest)">SmartFox.Send</see> method for the request to be performed.
- </remarks>
-
- <param name="room">The object corresponding to the Room whose capacity should be changed.</param>
- <param name="newMaxUsers">The new maximum number of users/players who can join the Room.</param>
- <param name="newMaxSpect">The new maximum number of spectators who can join the Room (for Game Rooms only).</param>
- </member>
- <member name="M:Sfs2X.Requests.ChangeRoomCapacityRequest.Validate(Sfs2X.SmartFox)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Requests.ChangeRoomCapacityRequest.Execute(Sfs2X.SmartFox)">
- <exclude/>
- </member>
- <member name="T:Sfs2X.Requests.ChangeRoomNameRequest">
- <summary>
- Changes the name of a Room.
- </summary>
-
- <remarks>
- If the renaming operation is successful, the <see cref="F:Sfs2X.Core.SFSEvent.ROOM_NAME_CHANGE"/> event is dispatched to all the users who subscribed the Group to which the target Room belongs,
- including the user who renamed it. If the user is not the creator (owner) of the Room, or if the new name doesn't match the related criteria in Zone configuration, the
- <see cref="F:Sfs2X.Core.SFSEvent.ROOM_NAME_CHANGE_ERROR"/> event is fired. An administrator or moderator can override this constrain (he is not requested to be the Room's owner).<br/>
- If the Room was configured so that renaming is not allowed (see the <see cref="P:Sfs2X.Requests.RoomSettings.Permissions">RoomSettings.Permissions</see> parameter), the request is ignored and no error is fired.
- </remarks>
-
- <example>
- The following example renames an existing Room:
- <code>
- void SomeMethod() {
- sfs.AddEventListener(SFSEvent.ROOM_NAME_CHANGE, OnRoomNameChange);
- sfs.AddEventListener(SFSEvent.ROOM_NAME_CHANGE_ERROR, OnRoomNameChangeError);
-
- Room theRoom = sfs.GetRoomByName("Gonzo's Room");
- sfs.Send( new ChangeRoomNameRequest(theRoom, "Gonzo The Great's Room") );
- }
-
- void OnRoomNameChange(BaseEvent evt) {
- Room theRoom = (Room)evt.Params["room"];
- Console.WriteLine("Room " + (string)evt.Params["oldName"] + " was successfully renamed to " + theRoom.Name); // .Net / Unity
- System.Diagnostics.Debug.WriteLine("Room " + (string)evt.Params["oldName"] + " was successfully renamed to " + theRoom.Name); // Windows Universal
- }
-
- void OnRoomNameChangeError(BaseEvent evt) {
- Console.WriteLine("Room name change failed: " + (string)evt.Params["errorMessage"]); // .Net / Unity
- System.Diagnostics.Debug.WriteLine("Room name change failed: " + (string)evt.Params["errorMessage"]); // Windows Universal
- }
- </code>
- </example>
-
- <seealso cref="F:Sfs2X.Core.SFSEvent.ROOM_NAME_CHANGE"/>
- <seealso cref="F:Sfs2X.Core.SFSEvent.ROOM_NAME_CHANGE_ERROR"/>
- <seealso cref="P:Sfs2X.Requests.RoomSettings.Permissions"/>
- <seealso cref="T:Sfs2X.Requests.ChangeRoomCapacityRequest"/>
- <seealso cref="T:Sfs2X.Requests.ChangeRoomPasswordStateRequest"/>
- </member>
- <member name="F:Sfs2X.Requests.ChangeRoomNameRequest.KEY_ROOM">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.ChangeRoomNameRequest.KEY_NAME">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Requests.ChangeRoomNameRequest.#ctor(Sfs2X.Entities.Room,System.String)">
- <summary>
- Creates a new ChangeRoomNameRequest instance.
- </summary>
-
- <remarks>
- The instance must be passed to the <see cref="M:Sfs2X.SmartFox.Send(Sfs2X.Requests.IRequest)">SmartFox.Send</see> method for the request to be performed.
- </remarks>
-
- <param name="room">The object corresponding to the Room whose name should be changed.</param>
- <param name="newName">The new name to be assigned to the Room.</param>
- </member>
- <member name="M:Sfs2X.Requests.ChangeRoomNameRequest.Validate(Sfs2X.SmartFox)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Requests.ChangeRoomNameRequest.Execute(Sfs2X.SmartFox)">
- <exclude/>
- </member>
- <member name="T:Sfs2X.Requests.ChangeRoomPasswordStateRequest">
- <summary>
- Changes the password of a Room.
- </summary>
-
- <remarks>
- This request not only changes the password of a Room, but also its "password state", which indicates if the Room is password protected or not.
- <para/>
- If the operation is successful, the <see cref="F:Sfs2X.Core.SFSEvent.ROOM_PASSWORD_STATE_CHANGE"/> event is dispatched to all the users who subscribed the Group
- to which the target Room belongs, including the requester user himself. If the user is not the creator (owner) of the Room, the <see cref="F:Sfs2X.Core.SFSEvent.ROOM_PASSWORD_STATE_CHANGE_ERROR"/> event is fired.
- An administrator or moderator can override this constrain (he is not requested to be the Room's owner).<br/>
- If the Room was configured so that password change is not allowed (see the <see cref="P:Sfs2X.Requests.RoomSettings.Permissions">RoomSettings.Permissions</see> parameter), the request is ignored and no error is fired.
- </remarks>
-
- <example>
- The following example changes the password of an existing Room:
- <code>
- void SomeMethod() {
- sfs.AddEventListener(SFSEvent.ROOM_PASSWORD_STATE_CHANGE, OnRoomPasswordStateChange);
- sfs.AddEventListener(SFSEvent.ROOM_PASSWORD_STATE_CHANGE_ERROR, OnRoomPasswordStateChangeError);
-
- Room theRoom = sfs.GetRoomByName("Gonzo's Room");
- sfs.Send( new ChangeRoomPasswordStateRequest(theRoom, "mammamia") );
- }
-
- void OnRoomPasswordStateChange(BaseEvent evt) {
- Room theRoom = (Room)evt.Params["room"];
- Console.WriteLine("The password of Room " + theRoom.Name + " was changed successfully"); // .Net / Unity
- System.Diagnostics.Debug.WriteLine("The password of Room " + theRoom.Name + " was changed successfully"); // Windows Universal
- }
-
- void OnRoomPasswordStateChangeError(BaseEvent evt) {
- Console.WriteLine("Room password change failed: " + (string)evt.Params["errorMessage"]); // .Net / Unity
- System.Diagnostics.Debug.WriteLine("Room password change failed: " + (string)evt.Params["errorMessage"]); // Windows Universal
- }
- </code>
- </example>
-
- <seealso cref="F:Sfs2X.Core.SFSEvent.ROOM_PASSWORD_STATE_CHANGE"/>
- <seealso cref="F:Sfs2X.Core.SFSEvent.ROOM_PASSWORD_STATE_CHANGE_ERROR"/>
- <seealso cref="P:Sfs2X.Requests.RoomSettings.Permissions"/>
- <seealso cref="T:Sfs2X.Requests.ChangeRoomNameRequest"/>
- <seealso cref="T:Sfs2X.Requests.ChangeRoomPasswordStateRequest"/>
- </member>
- <member name="F:Sfs2X.Requests.ChangeRoomPasswordStateRequest.KEY_ROOM">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.ChangeRoomPasswordStateRequest.KEY_PASS">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Requests.ChangeRoomPasswordStateRequest.#ctor(Sfs2X.Entities.Room,System.String)">
- <summary>
- Creates a new ChangeRoomPasswordStateRequest instance.
- </summary>
-
- <remarks>
- The instance must be passed to the <see cref="M:Sfs2X.SmartFox.Send(Sfs2X.Requests.IRequest)">SmartFox.Send</see> method for the request to be performed.
- </remarks>
-
- <param name="room">The object corresponding to the Room whose password should be changed.</param>
- <param name="newPass">The new password to be assigned to the Room; an empty string or a <c>null</c> value can be passed to remove the Room's password.</param>
- </member>
- <member name="M:Sfs2X.Requests.ChangeRoomPasswordStateRequest.Validate(Sfs2X.SmartFox)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Requests.ChangeRoomPasswordStateRequest.Execute(Sfs2X.SmartFox)">
- <exclude/>
- </member>
- <member name="T:Sfs2X.Requests.CreateRoomRequest">
- <summary>
- Creates a new Room in the current Zone.
- </summary>
-
- <remarks>
- If the creation is successful, a <see cref="F:Sfs2X.Core.SFSEvent.ROOM_ADD"/> event is dispatched to all the users who subscribed the Group to which the Room is associated,
- including the Room creator. Otherwise, a <see cref="F:Sfs2X.Core.SFSEvent.ROOM_CREATION_ERROR"/> event is returned to the creator's client.
- </remarks>
-
- <example>
- The following example creates a new chat room:
- <code>
- void SomeMethod() {
- sfs.AddEventListener(SFSEvent.ROOM_ADDED, OnRoomAdded);
- sfs.AddEventListener(SFSEvent.ROOM_CREATION_ERROR, OnRoomCreationError);
-
- // Create a new Chat Room
- RoomSettings settings = new RoomSettings("My Chat Room");
- settings.MaxUsers = 40;
- settings.GroupId = "chats";
-
- sfs.Send( new CreateRoomRequest(settings) );
- }
-
- void OnRoomAdded(BaseEvent evt) {
- Console.WriteLine("Room created: " + (Room)evt.Params["room"]); // .Net / Unity
- System.Diagnostics.Debug.WriteLine("Room created: " + (Room)evt.Params["room"]); // Windows Universal
- }
-
- void OnRoomCreationError(BaseEvent evt) {
- Console.WriteLine("Room creation failed: " + (string)evt.Params["errorMessage"]); // .Net / Unity
- System.Diagnostics.Debug.WriteLine("Room creation failed: " + (string)evt.Params["errorMessage"]); // Windows Universal
- }
- </code>
- </example>
-
- <seealso cref="F:Sfs2X.Core.SFSEvent.ROOM_ADD"/>
- <seealso cref="F:Sfs2X.Core.SFSEvent.ROOM_CREATION_ERROR"/>
- </member>
- <member name="F:Sfs2X.Requests.CreateRoomRequest.KEY_ROOM">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.CreateRoomRequest.KEY_NAME">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.CreateRoomRequest.KEY_PASSWORD">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.CreateRoomRequest.KEY_GROUP_ID">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.CreateRoomRequest.KEY_ISGAME">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.CreateRoomRequest.KEY_MAXUSERS">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.CreateRoomRequest.KEY_MAXSPECTATORS">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.CreateRoomRequest.KEY_MAXVARS">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.CreateRoomRequest.KEY_ROOMVARS">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.CreateRoomRequest.KEY_PERMISSIONS">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.CreateRoomRequest.KEY_EVENTS">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.CreateRoomRequest.KEY_EXTID">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.CreateRoomRequest.KEY_EXTCLASS">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.CreateRoomRequest.KEY_EXTPROP">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.CreateRoomRequest.KEY_AUTOJOIN">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.CreateRoomRequest.KEY_ROOM_TO_LEAVE">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.CreateRoomRequest.KEY_ALLOW_JOIN_INVITATION_BY_OWNER">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.CreateRoomRequest.KEY_MMO_DEFAULT_AOI">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.CreateRoomRequest.KEY_MMO_MAP_LOW_LIMIT">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.CreateRoomRequest.KEY_MMO_MAP_HIGH_LIMIT">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.CreateRoomRequest.KEY_MMO_USER_MAX_LIMBO_SECONDS">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.CreateRoomRequest.KEY_MMO_PROXIMITY_UPDATE_MILLIS">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.CreateRoomRequest.KEY_MMO_SEND_ENTRY_POINT">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Requests.CreateRoomRequest.#ctor(Sfs2X.Requests.RoomSettings,System.Boolean,Sfs2X.Entities.Room)">
- <summary>
- Creates a new CreateRoomRequest instance.
- </summary>
-
- <remarks>
- The instance must be passed to the <see cref="M:Sfs2X.SmartFox.Send(Sfs2X.Requests.IRequest)">SmartFox.Send</see> method for the request to be performed.
- </remarks>
-
- <param name="settings">An object containing the Room configuration settings.</param>
- <param name="autoJoin">If <c>true</c>, the Room is joined as soon as it is created (default = <c>false</c>).</param>
- <param name="roomToLeave">An object representing the Room that should be left if the new Room is auto-joined (default = <c>null</c>).</param>
-
- <seealso cref="T:Sfs2X.Requests.RoomSettings"/>
- <seealso cref="T:Sfs2X.Requests.Game.SFSGameSettings"/>
- <seealso cref="T:Sfs2X.Requests.MMO.MMORoomSettings"/>
- </member>
- <member name="M:Sfs2X.Requests.CreateRoomRequest.#ctor(Sfs2X.Requests.RoomSettings,System.Boolean)">
- <summary>
- See <em>CreateRoomRequest(RoomSettings, bool, Room)</em> constructor.
- </summary>
- </member>
- <member name="M:Sfs2X.Requests.CreateRoomRequest.#ctor(Sfs2X.Requests.RoomSettings)">
- <summary>
- See <em>CreateRoomRequest(RoomSettings, bool, Room)</em> constructor.
- </summary>
- </member>
- <member name="M:Sfs2X.Requests.CreateRoomRequest.Validate(Sfs2X.SmartFox)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Requests.CreateRoomRequest.Execute(Sfs2X.SmartFox)">
- <exclude/>
- </member>
- <member name="T:Sfs2X.Requests.ExtensionRequest">
- <summary>
- Sends a command to the server-side Extension attached to the Zone or to a Room.
- </summary>
-
- <remarks>
- This request is used to send custom commands from the client to a server-side Extension, be it a Zone-level or Room-level Extension.
- Viceversa, the <see cref="F:Sfs2X.Core.SFSEvent.EXTENSION_RESPONSE"/> event is used by the server to send Extension commands/responses to the client.
- <para/>
- Read the SmartFoxServer 2X documentation about server-side Extension for more informations.
- <para/>
- The <em>ExtensionRequest</em> request can be sent using the UDP protocol too: this allows sending fast stream of packets to the server in real-time type games,
- typically for position/transformation updates, etc.
- </remarks>
-
- <example>
- The following example sends a command to the Zone Extension; it also handles responses coming from the Extension by implementing the <see cref="F:Sfs2X.Core.SFSEvent.EXTENSION_RESPONSE"/> event listener (the same command name is used in both the request and the response):
- <code>
- void SomeMethod() {
- sfs.addEventListener(SFSEvent.EXTENSION_RESPONSE, OnExtensionResponse);
-
- // Send two integers to the Zone extension and get their sum in return
- ISFSObject params = SFSObject.NewInstance();
- params.PutInt("n1", 26);
- params.PutInt("n2", 16);
-
- sfs.Send( new ExtensionRequest("add", params) );
- }
-
- void OnExtensionResponse(BaseEvent evt) {
- String cmd = (String)evt.Params["cmd"];
- if (cmd == "add") {
- ISFSObject responseParams = (SFSObject)evt.Params["params"];
-
- // We expect an int parameter called "sum"
- Console.WriteLine("The sum is: " + responseParams.GetInt("sum")); // .Net / Unity
- System.Diagnostics.Debug.WriteLine("The sum is: " + responseParams.GetInt("sum")); // Windows Universal
- }
- }
- </code>
- </example>
-
- <seealso cref="F:Sfs2X.Core.SFSEvent.EXTENSION_RESPONSE"/>
- </member>
- <member name="F:Sfs2X.Requests.ExtensionRequest.KEY_CMD">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.ExtensionRequest.KEY_PARAMS">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.ExtensionRequest.KEY_ROOM">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Requests.ExtensionRequest.#ctor(System.String,Sfs2X.Entities.Data.ISFSObject,Sfs2X.Entities.Room,System.Boolean)">
- <summary>
- Creates a new ExtensionRequest instance.
- </summary>
-
- <remarks>
- The instance must be passed to the <see cref="M:Sfs2X.SmartFox.Send(Sfs2X.Requests.IRequest)">SmartFox.Send</see> method for the request to be performed.
- </remarks>
-
- <param name="extCmd">The name of the command which identifies an action that should be executed by the server-side Extension.</param>
- <param name="parameters">An instance of <see cref="T:Sfs2X.Entities.Data.SFSObject"/> containing custom data to be sent to the Extension (default = <c>null</c>). Can be <c>null</c> if no data needs to be sent.</param>
- <param name="room">If <c>null</c>, the specified command is sent to the current Zone server-side Extension; if not <c>null</c>, the command is sent to the server-side Extension attached to the passed Room (default = <c>null</c>).</param>
- <param name="useUDP">If true, the UDP protocol is used to send the request to the server (default = <c>false</c>).</param>
- </member>
- <member name="M:Sfs2X.Requests.ExtensionRequest.#ctor(System.String,Sfs2X.Entities.Data.ISFSObject,Sfs2X.Entities.Room)">
- <summary>
- See <em>ExtensionRequest(string, ISFSObject, Room, bool)</em> constructor.
- </summary>
- </member>
- <member name="M:Sfs2X.Requests.ExtensionRequest.#ctor(System.String,Sfs2X.Entities.Data.ISFSObject)">
- <summary>
- See <em>ExtensionRequest(string, ISFSObject, Room, bool)</em> constructor.
- </summary>
- </member>
- <member name="P:Sfs2X.Requests.ExtensionRequest.UseUDP">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Requests.ExtensionRequest.Validate(Sfs2X.SmartFox)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Requests.ExtensionRequest.Execute(Sfs2X.SmartFox)">
- <exclude/>
- </member>
- <member name="T:Sfs2X.Requests.FindRoomsRequest">
- <summary>
- Retrieves a list of Rooms from the server which match the specified criteria.
- </summary>
-
- <remarks>
- By providing a matching expression and a search scope (a Group or the entire Zone), SmartFoxServer can find those Rooms matching the passed criteria
- and return them by means of the <see cref="F:Sfs2X.Core.SFSEvent.ROOM_FIND_RESULT"/> event.
- </remarks>
-
- <example>
- The following example looks for all the server Rooms whose "country" Room Variable is set to Sweden:
- <code>
- void SomeMethod() {
- sfs.AddEventListener(SFSEvent.ROOM_FIND_RESULT, OnRoomFindResult);
-
- // Create a matching expression to find Rooms with a "country" variable equal to "Sweden"
- MatchExpression expr = new MatchExpression('country', StringMatch.EQUALS, 'Sweden');
-
- // Find the Rooms
- sfs.Send( new FindRoomRequest(expr) );
- }
-
- void OnRoomFindResult(BaseEvent evt) {
- Console.WriteLine("Rooms found: " + (List<Room>)evt.Params["rooms"]); // .Net / Unity
- System.Diagnostics.Debug.WriteLine("Rooms found: " + (List<Room>)evt.Params["rooms"]); // Windows Universal
- }
- </code>
- </example>
-
- <seealso cref="F:Sfs2X.Core.SFSEvent.ROOM_FIND_RESULT"/>
- <seealso cref="T:Sfs2X.Entities.Match.MatchExpression"/>
- </member>
- <member name="F:Sfs2X.Requests.FindRoomsRequest.KEY_EXPRESSION">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.FindRoomsRequest.KEY_GROUP">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.FindRoomsRequest.KEY_LIMIT">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.FindRoomsRequest.KEY_FILTERED_ROOMS">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Requests.FindRoomsRequest.#ctor(Sfs2X.Entities.Match.MatchExpression,System.String,System.Int32)">
- <summary>
- Creates a new FindRoomsRequest instance.
- </summary>
-
- <remarks>
- The instance must be passed to the <see cref="M:Sfs2X.SmartFox.Send(Sfs2X.Requests.IRequest)">SmartFox.Send</see> method for the request to be performed.
- </remarks>
-
- <param name="expr">A matching expression that the system will use to retrieve the Rooms.</param>
- <param name="groupId">The name of the Group where to search for matching Rooms; if <c>null</c>, the search is performed in the whole Zone (default = <c>null</c>).</param>
- <param name="limit">The maximum size of the list of Rooms that will be returned by the roomFindResult event. If <c>0</c>, all the found Rooms are returned (default = <c>0</c>).</param>
- </member>
- <member name="M:Sfs2X.Requests.FindRoomsRequest.#ctor(Sfs2X.Entities.Match.MatchExpression)">
- <summary>
- See <em>FindRoomsRequest(MatchExpression, string, int)</em> constructor.
- </summary>
- </member>
- <member name="M:Sfs2X.Requests.FindRoomsRequest.#ctor(Sfs2X.Entities.Match.MatchExpression,System.String)">
- <summary>
- See <em>FindRoomsRequest(MatchExpression, string, int)</em> constructor.
- </summary>
- </member>
- <member name="M:Sfs2X.Requests.FindRoomsRequest.Validate(Sfs2X.SmartFox)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Requests.FindRoomsRequest.Execute(Sfs2X.SmartFox)">
- <exclude/>
- </member>
- <member name="T:Sfs2X.Requests.FindUsersRequest">
- <summary>
- Retrieves a list of users from the server which match the specified criteria.
- </summary>
-
- <remarks>
- By providing a matching expression and a search scope (a Room, a Group or the entire Zone), SmartFoxServer can find
- those users matching the passed criteria and return them by means of the <see cref="F:Sfs2X.Core.SFSEvent.USER_FIND_RESULT"/> event.
- </remarks>
-
- <example>
- The following example looks for all the users whose "age" User Variable is greater than 29:
- <code>
- void SomeMethod() {
- sfs.AddEventListener(SFSEvent.USER_FIND_RESULT, OnUserFindResult);
-
- // Create a matching expression to find users with an "age" variable greater than 29:
- MatchExpression expr = new MatchExpression("age", NumberMatch.GREATER_THAN, 29);
-
- // Find the users
- sfs.Send( new FindUsersRequest(expr) );
- }
-
- void OnUserFindResult(BaseEvent evt) {
- Console.WriteLine("Users found: " + (List<User>)evt.Params["users"]); // .Net / Unity
- System.Diagnostics.Debug.WriteLine("Users found: " + (List<User>)evt.Params["users"]); // Windows Universal
- }
- </code>
- </example>
-
- <seealso cref="F:Sfs2X.Core.SFSEvent.USER_FIND_RESULT"/>
- <seealso cref="T:Sfs2X.Entities.Match.MatchExpression"/>
- </member>
- <member name="F:Sfs2X.Requests.FindUsersRequest.KEY_EXPRESSION">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.FindUsersRequest.KEY_GROUP">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.FindUsersRequest.KEY_ROOM">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.FindUsersRequest.KEY_LIMIT">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.FindUsersRequest.KEY_FILTERED_USERS">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Requests.FindUsersRequest.#ctor(Sfs2X.Entities.Match.MatchExpression,System.String,System.Int32)">
- <summary>
- Creates a new FindUsersRequest instance.
- </summary>
-
- <remarks>
- The instance must be passed to the <see cref="M:Sfs2X.SmartFox.Send(Sfs2X.Requests.IRequest)">SmartFox.Send</see> method for the request to be performed.
- </remarks>
-
- <param name="expr">A matching expression that the system will use to retrieve the users.</param>
- <param name="target">The name of a Group or a single Room object where to search for matching users; if <c>null</c>, the search is performed in the whole Zone (default = <c>null</c>).</param>
- <param name="limit">The maximum size of the list of users that will be returned by the userFindResult event. If <c>0</c>, all the found users are returned (default = <c>0</c>).</param>
- </member>
- <member name="M:Sfs2X.Requests.FindUsersRequest.#ctor(Sfs2X.Entities.Match.MatchExpression)">
- <summary>
- See <em>FindUsersRequest(MatchExpression, string, int)</em> constructor.
- </summary>
- </member>
- <member name="M:Sfs2X.Requests.FindUsersRequest.#ctor(Sfs2X.Entities.Match.MatchExpression,Sfs2X.Entities.Room)">
- <summary>
- See <em>FindUsersRequest(MatchExpression, string, int)</em> constructor.
- </summary>
- </member>
- <member name="M:Sfs2X.Requests.FindUsersRequest.#ctor(Sfs2X.Entities.Match.MatchExpression,Sfs2X.Entities.Room,System.Int32)">
- <summary>
- See <em>FindUsersRequest(MatchExpression, string, int)</em> constructor.
- </summary>
- </member>
- <member name="M:Sfs2X.Requests.FindUsersRequest.#ctor(Sfs2X.Entities.Match.MatchExpression,System.String)">
- <summary>
- See <em>FindUsersRequest(MatchExpression, string, int)</em> constructor.
- </summary>
- </member>
- <member name="M:Sfs2X.Requests.FindUsersRequest.Validate(Sfs2X.SmartFox)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Requests.FindUsersRequest.Execute(Sfs2X.SmartFox)">
- <exclude/>
- </member>
- <member name="T:Sfs2X.Requests.GenericMessageRequest">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.GenericMessageRequest.KEY_ROOM_ID">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.GenericMessageRequest.KEY_USER_ID">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.GenericMessageRequest.KEY_MESSAGE">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.GenericMessageRequest.KEY_MESSAGE_TYPE">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.GenericMessageRequest.KEY_RECIPIENT">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.GenericMessageRequest.KEY_RECIPIENT_MODE">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.GenericMessageRequest.KEY_XTRA_PARAMS">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.GenericMessageRequest.KEY_SENDER_DATA">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Requests.GenericMessageRequest.Validate(Sfs2X.SmartFox)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Requests.GenericMessageRequest.Execute(Sfs2X.SmartFox)">
- <exclude/>
- </member>
- <member name="T:Sfs2X.Requests.GenericMessageType">
- <exclude/>
- </member>
- <member name="T:Sfs2X.Requests.HandshakeRequest">
- <summary>
- This request is used by the API sub-system at connection time. It's not intended for other uses.
- </summary>
-
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.HandshakeRequest.KEY_SESSION_TOKEN">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.HandshakeRequest.KEY_API">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.HandshakeRequest.KEY_COMPRESSION_THRESHOLD">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.HandshakeRequest.KEY_RECONNECTION_TOKEN">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.HandshakeRequest.KEY_CLIENT_TYPE">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.HandshakeRequest.KEY_MAX_MESSAGE_SIZE">
- <exclude/>
- </member>
- <member name="T:Sfs2X.Requests.IRequest">
- <exclude/>
- </member>
- <member name="T:Sfs2X.Requests.JoinRoomRequest">
- <summary>
- Joins the current user in a Room.
- </summary>
-
- <remarks>
- If the operation is successful, the current user receives a <see cref="F:Sfs2X.Core.SFSEvent.ROOM_JOIN"/> event; otherwise the <see cref="F:Sfs2X.Core.SFSEvent.ROOM_JOIN_ERROR"/> event is fired.
- This usually happens when the Room is full, or the password is wrong in case of password protected Rooms.
- <para/>
- Depending on the Room configuration defined upon its creation (see the <see cref="P:Sfs2X.Requests.RoomSettings.Events">RoomSettings.Events</see> setting), when the current user joins it,
- the following events might be fired: <see cref="F:Sfs2X.Core.SFSEvent.USER_ENTER_ROOM"/>, dispatched to the other users inside the Room to warn them that a new user has arrived;
- <see cref="F:Sfs2X.Core.SFSEvent.USER_COUNT_CHANGE"/>, dispatched to all clients which subscribed the Group to which the Room belongs, to update the count of users inside the Room.
- </remarks>
-
- <example>
- The following example makes the user join an existing Room:
- <code>
- void SomeMethod() {
- sfs.AddEventListener(SFSEvent.ROOM_JOIN, OnJoinRoom);
- sfs.AddEventListener(SFSEvent.ROOM_JOIN_ERROR, OnJoinRoomError);
-
- // Join a Room called "Lobby"
- sfs.Send( new JoinRoomRequest("Lobby") );
- }
-
- void OnJoinRoom(BaseEvent evt) {
- Console.WriteLine("Room joined successfully: " + (Room)evt.Params["room"]); // .Net / Unity
- System.Diagnostics.Debug.WriteLine("Room joined successfully: " + (Room)evt.Params["room"]); // Windows Universal
- }
-
- void OnJoinRoomError(BaseEvent evt) {
- Console.WriteLine("Room joining failed: " + (string)evt.Params["errorMessage"]); // .Net / Unity
- System.Diagnostics.Debug.WriteLine("Room joining failed: " + (string)evt.Params["errorMessage"]); // Windows Universal
- }
- </code>
- </example>
-
- <seealso cref="F:Sfs2X.Core.SFSEvent.ROOM_JOIN"/>
- <seealso cref="F:Sfs2X.Core.SFSEvent.ROOM_JOIN_ERROR"/>
- <seealso cref="F:Sfs2X.Core.SFSEvent.USER_ENTER_ROOM"/>
- <seealso cref="F:Sfs2X.Core.SFSEvent.USER_COUNT_CHANGE"/>
- <seealso cref="P:Sfs2X.Requests.RoomSettings.Events"/>
- <seealso cref="T:Sfs2X.Requests.LeaveRoomRequest"/>
- </member>
- <member name="F:Sfs2X.Requests.JoinRoomRequest.KEY_ROOM">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.JoinRoomRequest.KEY_USER_LIST">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.JoinRoomRequest.KEY_ROOM_NAME">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.JoinRoomRequest.KEY_ROOM_ID">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.JoinRoomRequest.KEY_PASS">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.JoinRoomRequest.KEY_ROOM_TO_LEAVE">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.JoinRoomRequest.KEY_AS_SPECTATOR">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Requests.JoinRoomRequest.#ctor(System.Object,System.String,System.Nullable{System.Int32},System.Boolean)">
- <summary>
- Creates a new JoinRoomRequest instance.
- </summary>
-
- <remarks>
- The instance must be passed to the <see cref="M:Sfs2X.SmartFox.Send(Sfs2X.Requests.IRequest)">SmartFox.Send</see> method for the request to be performed.
- </remarks>
-
- <param name="id">The id or the name of the Room to be joined.</param>
- <param name="pass">The password of the Room, in case it is password protected (default = <c>null</c>).</param>
- <param name="roomIdToLeave">The id of a previously joined Room that the user should leave when joining the new Room. By default, the last joined Room is left; if a negative number is passed, no previous Room is left (default = <c>null</c>).</param>
- <param name="asSpectator"><c>true</c> to join the Room as a spectator (in Game Rooms only) (default = <c>false</c>).</param>
- </member>
- <member name="M:Sfs2X.Requests.JoinRoomRequest.#ctor(System.Object,System.String,System.Nullable{System.Int32})">
- <summary>
- See <em>JoinRoomRequest(object, string, int?, bool)</em> constructor.
- </summary>
- </member>
- <member name="M:Sfs2X.Requests.JoinRoomRequest.#ctor(System.Object,System.String)">
- <summary>
- See <em>JoinRoomRequest(object, string, int?, bool)</em> constructor.
- </summary>
- </member>
- <member name="M:Sfs2X.Requests.JoinRoomRequest.#ctor(System.Object)">
- <summary>
- See <em>JoinRoomRequest(object, string, int?, bool)</em> constructor.
- </summary>
- </member>
- <member name="M:Sfs2X.Requests.JoinRoomRequest.Validate(Sfs2X.SmartFox)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Requests.JoinRoomRequest.Execute(Sfs2X.SmartFox)">
- <exclude/>
- </member>
- <member name="T:Sfs2X.Requests.KickUserRequest">
- <summary>
- Kicks a user out of the server.
- </summary>
-
- <remarks>
- The current user must have administration or moderation privileges in order to be able to kick another user (see the <see cref="P:Sfs2X.Entities.User.PrivilegeId">User.PrivilegeId</see> property).
- The request allows sending a message to the kicked user (to make clear the reason of the following disconnection) which is delivered by means of the <see cref="F:Sfs2X.Core.SFSEvent.MODERATOR_MESSAGE"/> event.
- <para/>
- Differently from the user being banned (see the <see cref="T:Sfs2X.Requests.BanUserRequest"/> request), a kicked user will be able to reconnect to the SmartFoxServer instance immediately.
- </remarks>
-
- <example>
- The following example kicks the user Jack from the system:
- <code>
- User userToKick = sfs.UserManager.GetUserByName("Jack");
- sfs.Send( new KickUserRequest(userToKick.Id) );
- </code>
- </example>
-
- <seealso cref="F:Sfs2X.Core.SFSEvent.MODERATOR_MESSAGE"/>
- <seealso cref="T:Sfs2X.Requests.BanUserRequest"/>
- </member>
- <member name="F:Sfs2X.Requests.KickUserRequest.KEY_USER_ID">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.KickUserRequest.KEY_MESSAGE">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.KickUserRequest.KEY_DELAY">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Requests.KickUserRequest.#ctor(System.Int32,System.String,System.Int32)">
- <summary>
- Creates a new KickUserRequest instance.
- </summary>
-
- <remarks>
- The instance must be passed to the <see cref="M:Sfs2X.SmartFox.Send(Sfs2X.Requests.IRequest)">SmartFox.Send</see> method for the request to be performed.
- </remarks>
-
- <param name="userId">The id of the user to be kicked.</param>
- <param name="message">A custom message to be delivered to the user before kicking him; if <c>null</c>, the default message configured in the SmartFoxServer 2X Administration Tool is used (default = <c>null</c>).</param>
- <param name="delaySeconds">The number of seconds after which the user is kicked after receiving the kick message (default = <c>5</c>).</param>
- </member>
- <member name="M:Sfs2X.Requests.KickUserRequest.#ctor(System.Int32)">
- <summary>
- See <em>KickUserRequest(int, string, int)</em> constructor.
- </summary>
- </member>
- <member name="M:Sfs2X.Requests.KickUserRequest.#ctor(System.Int32,System.String)">
- <summary>
- See <em>KickUserRequest(int, string, int)</em> constructor.
- </summary>
- </member>
- <member name="M:Sfs2X.Requests.KickUserRequest.Validate(Sfs2X.SmartFox)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Requests.KickUserRequest.Execute(Sfs2X.SmartFox)">
- <exclude/>
- </member>
- <member name="T:Sfs2X.Requests.LeaveRoomRequest">
- <summary>
- Leaves one of the Rooms joined by the current user.
- </summary>
-
- <remarks>
- Depending on the Room configuration defined upon its creation (see the <see cref="P:Sfs2X.Requests.RoomSettings.Events">RoomSettings.Events</see> setting), when the current user leaves it,
- the following events might be fired: <see cref="F:Sfs2X.Core.SFSEvent.USER_EXIT_ROOM"/>, dispatched to all the users inside the Room (including the current user then)
- to warn them that a user has gone away; <see cref="F:Sfs2X.Core.SFSEvent.USER_COUNT_CHANGE"/>, dispatched to all clients which subscribed the Group to which the Room belongs,
- to update the count of users inside the Room.
- </remarks>
-
- <example>
- The following example makes the user leave the currently joined Room and handles the respective event:
- <code>
- void SomeMethod() {
- sfs.AddEventListener(SFSEvent.USER_EXIT_ROOM, OnUserExitRoom);
-
- // Leave the last joined Room
- sfs.Send( new LeaveRoomRequest() );
- }
-
- void OnUserExitRoom(BaseEvent evt) {
- User user = (User)evt.Params["user"];
- Room room = (Room)evt.Params["room"];
-
- Console.WriteLine(""User " + user.Name + " just left Room " + room.Name); // .Net / Unity
- System.Diagnostics.Debug.WriteLine(""User " + user.Name + " just left Room " + room.Name); // Windows Universal
- }
- </code>
- </example>
-
- <seealso cref="F:Sfs2X.Core.SFSEvent.USER_EXIT_ROOM"/>
- <seealso cref="F:Sfs2X.Core.SFSEvent.USER_COUNT_CHANGE"/>
- <seealso cref="P:Sfs2X.Requests.RoomSettings.Events"/>
- <seealso cref="T:Sfs2X.Requests.JoinRoomRequest"/>
- </member>
- <member name="F:Sfs2X.Requests.LeaveRoomRequest.KEY_ROOM_ID">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Requests.LeaveRoomRequest.#ctor(Sfs2X.Entities.Room)">
- <summary>
- Creates a new LeaveRoomRequest instance.
- </summary>
-
- <remarks>
- The instance must be passed to the <see cref="M:Sfs2X.SmartFox.Send(Sfs2X.Requests.IRequest)">SmartFox.Send</see> method for the request to be performed.
- </remarks>
-
- <param name="room">The Room object corresponding to the Room that the current user must leave. If <c>null</c>, the last Room joined by the user is left (default = <c>null</c>).</param>
- </member>
- <member name="M:Sfs2X.Requests.LeaveRoomRequest.#ctor">
- <summary>
- See <em>LeaveRoomRequest(Room)</em> constructor.
- </summary>
- </member>
- <member name="M:Sfs2X.Requests.LeaveRoomRequest.Validate(Sfs2X.SmartFox)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Requests.LeaveRoomRequest.Execute(Sfs2X.SmartFox)">
- <exclude/>
- </member>
- <member name="T:Sfs2X.Requests.LoginRequest">
- <summary>
- Logs the current user in one of the server Zones.
- </summary>
-
- <remarks>
- Each Zone represent an indipendent multiuser application governed by SmartFoxServer. In order to join a Zone, a user name and password are usually required.
- In order to validate the user credentials, a custom login process should be implemented in the Zone's server-side Extension.
- <para/>
- Read the SmartFoxServer 2X documentation about the login process for more informations.
- <para/>
- If the login operation is successful, the current user receives a <see cref="F:Sfs2X.Core.SFSEvent.LOGIN"/> event; otherwise the <see cref="F:Sfs2X.Core.SFSEvent.LOGIN_ERROR"/> event is fired.
- </remarks>
-
- <example>
- The following example performs a login in the "SimpleChat" Zone:
- <code>
- void SomeMethod() {
- sfs.AddEventListener(SFSEvent.LOGIN, OnLogin);
- sfs.AddEventListener(SFSEvent.LOGIN_ERROR, OnLoginError);
-
- // Login
- sfs.Send( new LoginRequest("FozzieTheBear", "", "SimpleChat") );
- }
-
- void OnLogin(BaseEvent evt) {
- Console.WriteLine("Login successful!"); // .Net / Unity
- System.Diagnostics.Debug.WriteLine("Login successful!"); // Windows Universal
- }
-
- void OnLoginError(BaseEvent evt) {
- Console.WriteLine("Login failure: " + (string)evt.Params["errorMessage"]); // .Net / Unity
- System.Diagnostics.Debug.WriteLine("Login failure: " + (string)evt.Params["errorMessage"]); // Windows Universal
- }
- </code>
- </example>
-
- <seealso cref="F:Sfs2X.Core.SFSEvent.LOGIN"/>
- <seealso cref="F:Sfs2X.Core.SFSEvent.LOGIN_ERROR"/>
- <seealso cref="T:Sfs2X.Requests.LogoutRequest"/>
- </member>
- <member name="F:Sfs2X.Requests.LoginRequest.KEY_ZONE_NAME">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.LoginRequest.KEY_USER_NAME">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.LoginRequest.KEY_PASSWORD">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.LoginRequest.KEY_PARAMS">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.LoginRequest.KEY_PRIVILEGE_ID">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.LoginRequest.KEY_ID">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.LoginRequest.KEY_ROOMLIST">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.LoginRequest.KEY_RECONNECTION_SECONDS">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Requests.LoginRequest.#ctor(System.String,System.String,System.String,Sfs2X.Entities.Data.ISFSObject)">
- <summary>
- Creates a new LoginRequest instance.
- </summary>
-
- <remarks>
- The instance must be passed to the <see cref="M:Sfs2X.SmartFox.Send(Sfs2X.Requests.IRequest)">SmartFox.Send</see> method for the request to be performed.
- </remarks>
-
- <param name="userName">The name to be assigned to the user. If an empty string is passed and the Zone allows guest users, the name is generated automatically by the server.</param>
- <param name="password">The user password to access the system. SmartFoxServer doesn't offer a default authentication system, so the password must be validated implementing a custom login system in the Zone's server-side Extension.</param>
- <param name="zoneName">The name (case-sensitive) of the server Zone to login to; if a Zone name is not specified, the client will use the setting loaded via <see cref="M:Sfs2X.SmartFox.LoadConfig"/> method.</param>
- <param name="parameters">An instance of <see cref="T:Sfs2X.Entities.Data.SFSObject"/> containing custom parameters to be passed to the Zone Extension (requires a custom login system to be in place). Default value is <c>null</c>.</param>
- </member>
- <member name="M:Sfs2X.Requests.LoginRequest.#ctor(System.String,System.String,System.String)">
- <summary>
- See <em>LoginRequest(string, string, string, ISFSObject)</em> constructor.
- </summary>
- </member>
- <member name="M:Sfs2X.Requests.LoginRequest.#ctor(System.String,System.String)">
- <summary>
- See <em>LoginRequest(string, string, string, ISFSObject)</em> constructor.
- </summary>
- </member>
- <member name="M:Sfs2X.Requests.LoginRequest.#ctor(System.String)">
- <summary>
- See <em>LoginRequest(string, string, string, ISFSObject)</em> constructor.
- </summary>
- </member>
- <member name="M:Sfs2X.Requests.LoginRequest.Execute(Sfs2X.SmartFox)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Requests.LoginRequest.Validate(Sfs2X.SmartFox)">
- <exclude/>
- </member>
- <member name="T:Sfs2X.Requests.LogoutRequest">
- <summary>
- Logs the user out of the current server Zone.
- </summary>
-
- <remarks>
- The user is notified of the logout operation by means of the <see cref="F:Sfs2X.Core.SFSEvent.LOGOUT"/> event. This doesn't shut down the connection,
- so the user will be able to login again in the same Zone or in a different one right after the confirmation event.
- </remarks>
-
- <example>
- The following example performs a logout from the current Zone:
- <code>
- void SomeMethod() {
- sfs.AddEventListener(SFSEvent.LOGOUT, onLogout);
-
- // Logout
- sfs.Send( new LogoutRequest() );
- }
-
- void onLogout(BaseEvent evt) {
- Console.WriteLine("Logout executed!"); // .Net / Unity
- System.Diagnostics.Debug.WriteLine("Logout executed!"); // Windows Universal
- }
- </code>
- </example>
-
- <seealso cref="F:Sfs2X.Core.SFSEvent.LOGOUT"/>
- <seealso cref="T:Sfs2X.Requests.LoginRequest"/>
- </member>
- <member name="F:Sfs2X.Requests.LogoutRequest.KEY_ZONE_NAME">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Requests.LogoutRequest.#ctor">
- <summary>
- Creates a new LogoutRequest instance.
- </summary>
-
- <remarks>
- The instance must be passed to the <see cref="M:Sfs2X.SmartFox.Send(Sfs2X.Requests.IRequest)">SmartFox.Send</see> method for the request to be performed.
- </remarks>
- </member>
- <member name="M:Sfs2X.Requests.LogoutRequest.Validate(Sfs2X.SmartFox)">
- <exclude/>
- </member>
- <member name="T:Sfs2X.Requests.ManualDisconnectionRequest">
- <summary>
- This is used by the system. Never send this directly.
- </summary>
-
- <exclude/>
- </member>
- <member name="M:Sfs2X.Requests.ManualDisconnectionRequest.#ctor">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Requests.ManualDisconnectionRequest.Validate(Sfs2X.SmartFox)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Requests.ManualDisconnectionRequest.Execute(Sfs2X.SmartFox)">
- <exclude/>
- </member>
- <member name="T:Sfs2X.Requests.MessageRecipientType">
- <summary>
- The possible message recipient modes for ModeratorMessageRequest and AdminMessageRequest requests.
- </summary>
- </member>
- <member name="F:Sfs2X.Requests.MessageRecipientType.TO_USER">
- <summary>
- The moderator/administrator message will be sent to a specific user.
- </summary>
-
- <remarks>
- A User instance must be passed as <em>target</em> parameter to the <see cref="T:Sfs2X.Requests.MessageRecipientMode"/> class constructor.
- </remarks>
-
- <seealso cref="T:Sfs2X.Entities.User"/>
- </member>
- <member name="F:Sfs2X.Requests.MessageRecipientType.TO_ROOM">
- <summary>
- The moderator/administrator message will be sent to all the users in a specific Room.
- </summary>
-
- <remarks>
- A Room instance must be passed as <em>target</em> parameter to the <see cref="T:Sfs2X.Requests.MessageRecipientMode"/> class constructor.
- </remarks>
-
- <seealso cref="T:Sfs2X.Entities.Room"/>
- </member>
- <member name="F:Sfs2X.Requests.MessageRecipientType.TO_GROUP">
- <summary>
- The moderator/administrator message will be sent to all the clients who subscribed a specific Room Group.
- </summary>
-
- <remarks>
- A Group id must be passed as <em>target</em> parameter to the <see cref="T:Sfs2X.Requests.MessageRecipientMode"/> class constructor.
- </remarks>
-
- <seealso cref="P:Sfs2X.Entities.Room.GroupId"/>
- </member>
- <member name="F:Sfs2X.Requests.MessageRecipientType.TO_ZONE">
- <summary>
- The moderator/administrator message will be sent to all the users in the Zone.
- </summary>
-
- <remarks>
- <c>null</c> can be passed as <em>target</em> parameter to the <see cref="T:Sfs2X.Requests.MessageRecipientMode"/> class, in fact it will be ignored.
- </remarks>
- </member>
- <member name="T:Sfs2X.Requests.MessageRecipientMode">
- <summary>
- The MessageRecipientMode class is used to specify the recipient/s of moderator and administrator messages.
- </summary>
-
- <remarks>
- Read the constants descriptions in the <see cref="T:Sfs2X.Requests.MessageRecipientType"/> enumeration for more informations.
- </remarks>
-
- <seealso cref="T:Sfs2X.Requests.ModeratorMessageRequest"/>
- <seealso cref="T:Sfs2X.Requests.AdminMessageRequest"/>
- </member>
- <member name="P:Sfs2X.Requests.MessageRecipientMode.Target">
- <summary>
- Returns the moderator/administrator message target, according to the selected recipient mode.
- </summary>
- </member>
- <member name="P:Sfs2X.Requests.MessageRecipientMode.Mode">
- <summary>
- Returns the selected recipient mode.
- </summary>
- </member>
- <member name="M:Sfs2X.Requests.MessageRecipientMode.#ctor(System.Int32,System.Object)">
- <summary>
- Creates a new MessageRecipientMode instance.
- </summary>
-
- <remarks>
- The instance must be passed as <em>recipientMode</em> parameter to the <see cref="T:Sfs2X.Requests.ModeratorMessageRequest"/> and <see cref="T:Sfs2X.Requests.AdminMessageRequest"/> classes constructors.
- </remarks>
-
- <param name="mode">One of the costants contained in the <see cref="T:Sfs2X.Requests.MessageRecipientType"/> enumerator, describing the recipient mode.</param>
- <param name="target">The moderator/administrator message recipient/s, according to the selected recipient mode.</param>
- </member>
- <member name="T:Sfs2X.Requests.ModeratorMessageRequest">
- <summary>
- Sends a moderator message to a specific user or a group of users.
- </summary>
-
- <remarks>
- The current user must have moderation privileges to be able to send the message (see the <see cref="P:Sfs2X.Entities.User.PrivilegeId">User.PrivilegeId</see> property).
- <para/>
- The <em>recipientMode</em> parameter in the class constructor is used to determine the message recipients: a single user or all the users in a Room,
- a Group or the entire Zone. Upon message delivery, the clients of the recipient users dispatch the <see cref="F:Sfs2X.Core.SFSEvent.MODERATOR_MESSAGE"/> event.
- </remarks>
-
- <example>
- The following example sends a moderator message to all the users in the last joned Room; it also shows how to handle the related event:
- <code>
- void SomeMethod() {
- sfs.AddEventListener(SFSEvent.MODERATOR_MESSAGE, OnModeratorMessage);
-
- // Set the message recipients: all users in the current Room
- MessageRecipientMode recipMode = new MessageRecipientMode(MessageRecipientMode.TO_ROOM, sfs.LastJoinedRoom);
-
- // Send the moderator message
- sfs.Send( new ModeratorMessageRequest("Hello everybody, I'm the Moderator!", recipMode) );
- }
-
- void OnModeratorMessage(BaseEvent evt) {
- Console.WriteLine("The moderator sent the following message: " + (string)evt.Params["message"]); // .Net / Unity
- System.Diagnostics.Debug.WriteLine("The moderator sent the following message: " + (string)evt.Params["message"]); // Windows Universal
- }
- </code>
- </example>
-
- <seealso cref="T:Sfs2X.Requests.MessageRecipientMode"/>
- <seealso cref="F:Sfs2X.Core.SFSEvent.MODERATOR_MESSAGE"/>
- <seealso cref="T:Sfs2X.Requests.AdminMessageRequest"/>
- </member>
- <member name="M:Sfs2X.Requests.ModeratorMessageRequest.#ctor(System.String,Sfs2X.Requests.MessageRecipientMode,Sfs2X.Entities.Data.ISFSObject)">
- <summary>
- Creates a new ModeratorMessageRequest instance.
- </summary>
-
- <remarks>
- The instance must be passed to the <see cref="M:Sfs2X.SmartFox.Send(Sfs2X.Requests.IRequest)">SmartFox.Send</see> method for the request to be performed.
- </remarks>
-
- <param name="message">The message of the moderator to be sent to the target user/s defined by the <em>recipientMode</em> parameter.</param>
- <param name="recipientMode">An instance of MessageRecipientMode containing the target to which the message should be delivered.</param>
- <param name="parameters">An instance of <see cref="T:Sfs2X.Entities.Data.SFSObject"/> containing custom parameters to be sent to the recipient user/s (default = <c>null</c>).</param>
- </member>
- <member name="M:Sfs2X.Requests.ModeratorMessageRequest.#ctor(System.String,Sfs2X.Requests.MessageRecipientMode)">
- <summary>
- See <em>ModeratorMessageRequest(string, MessageRecipientMode, ISFSObject)</em> constructor.
- </summary>
- </member>
- <member name="T:Sfs2X.Requests.ObjectMessageRequest">
- <summary>
- Sends an object containing custom data to all users in a Room, or a subset of them.
- </summary>
-
- <remarks>
- The data object is delivered to the selected users (or all users excluding the sender) inside the target Room by means of the <see cref="F:Sfs2X.Core.SFSEvent.OBJECT_MESSAGE"/> event.
- It can be useful to send game data, like for example the target coordinates of the user's avatar in a virtual world.
- </remarks>
-
- <example>
- The following example sends the player's character movement coordinates and handles the respective event:
- <code>
- void SomeMethod() {
- sfs.AddEventListener(SFSEvent.OBJECT_MESSAGE, OnObjectMessage);
-
- // Send a game move to all players
- ISFSObject dataObj = new SFSObject();
- dataObj.PutInt("x", myAvatar.x);
- dataObj.PutInt("y", myAvatar.y);
- sfs.Send( new ObjectMessageRequest(dataObj) );
- }
-
- void OnObjectMessage(BaseEvent evt) {
- ISFSObject dataObj = (SFSObject)evt.Params["message"];
- int x = dataObj.GetInt("x");
- int y = dataObj.GetInt("y");
-
- // etc...
- }
- </code>
- </example>
-
- <seealso cref="F:Sfs2X.Core.SFSEvent.OBJECT_MESSAGE"/>
- </member>
- <member name="M:Sfs2X.Requests.ObjectMessageRequest.#ctor(Sfs2X.Entities.Data.ISFSObject,Sfs2X.Entities.Room,System.Collections.Generic.ICollection{Sfs2X.Entities.User})">
- <summary>
- Creates a new ObjectMessageRequest instance.
- </summary>
-
- <remarks>
- The instance must be passed to the <see cref="M:Sfs2X.SmartFox.Send(Sfs2X.Requests.IRequest)">SmartFox.Send</see> method for the request to be performed.
- </remarks>
-
- <param name="obj">An instance of <see cref="T:Sfs2X.Entities.Data.SFSObject"/> containing custom parameters to be sent to the message recipients.</param>
- <param name="targetRoom">The Room object corresponding to the Room where the message should be dispatched; if null, the last Room joined by the user is used (default = <c>null</c>).</param>
- <param name="recipients">A collection of User objects corresponding to the message recipients (default = <c>null</c>); if <c>null</c>, the message is sent to all users in the target Room (except the sender himself).</param>
- </member>
- <member name="M:Sfs2X.Requests.ObjectMessageRequest.#ctor(Sfs2X.Entities.Data.ISFSObject,Sfs2X.Entities.Room)">
- <summary>
- See <em>ObjectMessageRequest(ISFSObject, Room, ICollection<User>)</em> constructor.
- </summary>
- </member>
- <member name="M:Sfs2X.Requests.ObjectMessageRequest.#ctor(Sfs2X.Entities.Data.ISFSObject)">
- <summary>
- See <em>ObjectMessageRequest(ISFSObject, Room, ICollection<User>)</em> constructor.
- </summary>
- </member>
- <member name="T:Sfs2X.Requests.PingPongRequest">
- <summary>
- Sends a ping-pong request in order to measure the current lag
- </summary>
-
- <exclude/>
- </member>
- <member name="M:Sfs2X.Requests.PingPongRequest.Validate(Sfs2X.SmartFox)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Requests.PingPongRequest.Execute(Sfs2X.SmartFox)">
- <exclude/>
- </member>
- <member name="T:Sfs2X.Requests.PlayerToSpectatorRequest">
- <summary>
- Turns the current user from player to spectator in a Game Room.
- </summary>
-
- <remarks>
- If the operation is successful, all the users in the target Room are notified with the <see cref="F:Sfs2X.Core.SFSEvent.PLAYER_TO_SPECTATOR"/> event.
- The operation could fail if no spectator slots are available in the Game Room at the time of the request;
- in this case the <see cref="F:Sfs2X.Core.SFSEvent.PLAYER_TO_SPECTATOR_ERROR"/> event is dispatched to the requester's client.
- </remarks>
-
- <example>
- The following example turns the current user from player to spectator in the last joined Game Room:
- <code>
- void SomeMethod() {
- sfs.AddEventListener(SFSEvent.PLAYER_TO_SPECTATOR, OnPlayerToSpectatorSwitch);
- sfs.AddEventListener(SFSEvent.PLAYER_TO_SPECTATOR_ERROR, OnPlayerToSpectatorSwitchError);
-
- // Switch player to spectator
- sfs.Send( new PlayerToSpectatorRequest() );
- }
-
- void OnPlayerToSpectatorSwitch(BaseEvent evt) {
- User user = (User)evt.Params["user"];
- Console.WriteLine("Player " + user.Name + " is now a spectator"); // .Net / Unity
- System.Diagnostics.Debug.WriteLine("Player " + user.Name + " is now a spectator"); // Windows Universal
- }
-
- void OnPlayerToSpectatorSwitchError(BaseEvent evt) {
- Console.WriteLine("Unable to become a spectator due to the following error: " + (string)evt.Params["errorMessage"]); // .Net / Unity
- System.Diagnostics.Debug.WriteLine("Unable to become a spectator due to the following error: " + (string)evt.Params["errorMessage"]); // Windows Universal
- }
- </code>
- </example>
-
- <seealso cref="F:Sfs2X.Core.SFSEvent.PLAYER_TO_SPECTATOR"/>
- <seealso cref="F:Sfs2X.Core.SFSEvent.PLAYER_TO_SPECTATOR_ERROR"/>
- <seealso cref="T:Sfs2X.Requests.SpectatorToPlayerRequest"/>
- </member>
- <member name="F:Sfs2X.Requests.PlayerToSpectatorRequest.KEY_ROOM_ID">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.PlayerToSpectatorRequest.KEY_USER_ID">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Requests.PlayerToSpectatorRequest.#ctor(Sfs2X.Entities.Room)">
- <summary>
- Creates a new PlayerToSpectatorRequest instance.
- </summary>
-
- <remarks>
- The instance must be passed to the <see cref="M:Sfs2X.SmartFox.Send(Sfs2X.Requests.IRequest)">SmartFox.Send</see> method for the request to be performed.
- </remarks>
-
- <param name="targetRoom">The object corresponding to the Room in which the player should be turned to spectator. If <c>null</c>, the last Room joined by the user is used (default = <c>null</c>).</param>
- </member>
- <member name="M:Sfs2X.Requests.PlayerToSpectatorRequest.#ctor">
- <summary>
- See <em>PlayerToSpectatorRequest(Room)</em> constructor.
- </summary>
- </member>
- <member name="M:Sfs2X.Requests.PlayerToSpectatorRequest.Validate(Sfs2X.SmartFox)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Requests.PlayerToSpectatorRequest.Execute(Sfs2X.SmartFox)">
- <exclude/>
- </member>
- <member name="T:Sfs2X.Requests.PrivateMessageRequest">
- <summary>
- Sends a private chat message.
- </summary>
-
- <remarks>
- The private message is dispatched to a specific user, who can be in any server Room, or even in no Room at all. The message is delivered by means of the <see cref="F:Sfs2X.Core.SFSEvent.PRIVATE_MESSAGE"/> event.
- It is also returned to the sender: this allows showing the messages in the correct order in the application interface. It is also possible to send an optional object together with the message:
- it can contain custom parameters useful to transmit, for example, additional informations related to the message, like the text font or color, or other formatting details.
- </remarks>
-
- <example>
- The following example sends a private message and handles the respective event:
- <code>
- void SomeMethod() {
- sfs.AddEventListener(SFSEvent.PRIVATE_MESSAGE, OnPrivateMessage);
-
- // Send a private message to Jack
- User messageRecipient = sfs.UserManager.GetUserByName("Jack");
- sfs.Send( new PrivateMessageRequest("Hello Jack!", messageRecipient.Id) );
- }
-
- void OnPrivateMessage(BaseEvent evt) {
- // As messages are forwarded to the sender too, I have to check if I am the sender
- User sender = (User)evt.Params["sender"];
-
- if (sender != sfs.MySelf)
- {
- Console.WriteLine("User " + sender.Name + " sent me this PM: " + (string)evt.Params["message"]); // .Net / Unity
- System.Diagnostics.Debug.WriteLine("User " + sender.Name + " sent me this PM: " + (string)evt.Params["message"]); // Windows Universal
- }
- }
- </code>
- </example>
-
- <seealso cref="F:Sfs2X.Core.SFSEvent.PRIVATE_MESSAGE"/>
- <seealso cref="T:Sfs2X.Requests.PublicMessageRequest"/>
- </member>
- <member name="M:Sfs2X.Requests.PrivateMessageRequest.#ctor(System.String,System.Int32,Sfs2X.Entities.Data.ISFSObject)">
- <summary>
- Creates a new PrivateMessageRequest instance.
- </summary>
-
- <remarks>
- The instance must be passed to the <see cref="M:Sfs2X.SmartFox.Send(Sfs2X.Requests.IRequest)">SmartFox.Send</see> method for the request to be performed.
- </remarks>
-
- <param name="message">The message to be sent to to the recipient user.</param>
- <param name="recipientId">The id of the user to which the message is to be sent.</param>
- <param name="parameters">An instance of <see cref="T:Sfs2X.Entities.Data.SFSObject"/> containing additional custom parameters to be sent to the message recipient (for example the color of the text, etc). Default value is <c>null</c>.</param>
- </member>
- <member name="M:Sfs2X.Requests.PrivateMessageRequest.#ctor(System.String,System.Int32)">
- <summary>
- See <em>PrivateMessageRequest(string, int, ISFSObject)</em> constructor.
- </summary>
- </member>
- <member name="T:Sfs2X.Requests.PublicMessageRequest">
- <summary>
- Sends a public chat message.
- </summary>
-
- <remarks>
- A public message is dispatched to all the users in the specified Room, including the message sender (this allows showing messages in the correct order in the application interface);
- the corresponding event is the <see cref="F:Sfs2X.Core.SFSEvent.PUBLIC_MESSAGE"/> event. It is also possible to send an optional object together with the message: it can contain
- custom parameters useful to transmit, for example, additional informations related to the message, like the text font or color, or other formatting details.
- <para/>
- In case the target Room is not specified, the message is sent in the last Room joined by the sender.
- <para/>
- <b>NOTE</b>: the <see cref="F:Sfs2X.Core.SFSEvent.PUBLIC_MESSAGE"/> event is dispatched if the Room is configured
- to allow public messaging only (see the <see cref="P:Sfs2X.Requests.RoomSettings.Permissions">RoomSettings.Permissions</see> parameter).
- </remarks>
-
- <example>
- The following example sends a public message and handles the respective event:
- <code>
- void SomeMethod() {
- sfs.AddEventListener(SFSEvent.PUBLIC_MESSAGE, OnPublicMessage);
-
- // Send a public message
- sfs.Send( new PublicMessageRequest("Hello everyone!") );
- }
-
- void OnPublicMessage(BaseEvent evt) {
- // As messages are forwarded to the sender too, I have to check if I am the sender
- User sender = (User)evt.Params["sender"];
-
- if (sender == sfs.MySelf)
- {
- Console.WriteLine("I said " + (string)evt.Params["message"]); // .Net / Unity
- System.Diagnostics.Debug.WriteLine("I said " + (string)evt.Params["message"]); // Windows Universal
- }
- else
- {
- Console.WriteLine("User " + sender.Name + " said: " + (string)evt.Params["message"]); // .Net / Unity
- System.Diagnostics.Debug.WriteLine("User " + sender.Name + " said: " + (string)evt.Params["message"]); // Windows Universal
- }
- }
- </code>
- </example>
-
- <seealso cref="F:Sfs2X.Core.SFSEvent.PUBLIC_MESSAGE"/>
- <seealso cref="T:Sfs2X.Requests.PrivateMessageRequest"/>
- </member>
- <member name="M:Sfs2X.Requests.PublicMessageRequest.#ctor(System.String,Sfs2X.Entities.Data.ISFSObject,Sfs2X.Entities.Room)">
- <summary>
- Creates a new PublicMessageRequest instance.
- </summary>
-
- <remarks>
- The instance must be passed to the <see cref="M:Sfs2X.SmartFox.Send(Sfs2X.Requests.IRequest)">SmartFox.Send</see> method for the request to be performed.
- </remarks>
-
- <param name="message">The message to be sent to all the users in the target Room.</param>
- <param name="parameters">An instance of <see cref="T:Sfs2X.Entities.Data.SFSObject"/> containing additional custom parameters to be sent to the message recipients (for example the color of the text, etc). Default value is <c>null</c>.</param>
- <param name="targetRoom">The object corresponding to the Room where the message should be dispatched; if <c>null</c>, the last Room joined by the user is used (default = <c>null</c>).</param>
- </member>
- <member name="M:Sfs2X.Requests.PublicMessageRequest.#ctor(System.String,Sfs2X.Entities.Data.ISFSObject)">
- <summary>
- See <em>PublicMessageRequest(string, ISFSObject, Room)</em> constructor.
- </summary>
- </member>
- <member name="M:Sfs2X.Requests.PublicMessageRequest.#ctor(System.String)">
- <summary>
- See <em>PublicMessageRequest(string, ISFSObject, Room)</em> constructor.
- </summary>
- </member>
- <member name="T:Sfs2X.Requests.RequestType">
- <exclude/>
- </member>
- <member name="T:Sfs2X.Requests.RoomEvents">
- <summary>
- The RoomEvents class contains a specific subset of the RoomSettings required to create a Room.
- </summary>
-
- <remarks>
- This class defines which events related to the Room will be fired by the SmartFox client.
- </remarks>
-
- <seealso cref="P:Sfs2X.Requests.RoomSettings.Events"/>
- <seealso cref="T:Sfs2X.Requests.CreateRoomRequest"/>
- </member>
- <member name="M:Sfs2X.Requests.RoomEvents.#ctor">
- <summary>
- Creates a new RoomEvents instance.
- </summary>
-
- <remarks>
- The <see cref="P:Sfs2X.Requests.RoomSettings.Events">RoomSettings.Events</see> property must be set to this instance during Room creation.
- </remarks>
-
- <seealso cref="P:Sfs2X.Requests.RoomSettings.Events"/>
- </member>
- <member name="P:Sfs2X.Requests.RoomEvents.AllowUserEnter">
- <summary>
- Indicates whether the <see cref="F:Sfs2X.Core.SFSEvent.USER_ENTER_ROOM"/> event should be dispatched whenever a user joins the Room or not.
- </summary>
-
- <remarks>
- The default value is <c>false</c>.
- </remarks>
-
- <seealso cref="F:Sfs2X.Core.SFSEvent.USER_ENTER_ROOM"/>
- </member>
- <member name="P:Sfs2X.Requests.RoomEvents.AllowUserExit">
- <summary>
- Indicates whether the <see cref="F:Sfs2X.Core.SFSEvent.USER_EXIT_ROOM"/> event should be dispatched whenever a user leaves the Room or not.
- </summary>
-
- <remarks>
- The default value is <c>false</c>.
- </remarks>
-
- <seealso cref="F:Sfs2X.Core.SFSEvent.USER_ENTER_ROOM"/>
- </member>
- <member name="P:Sfs2X.Requests.RoomEvents.AllowUserCountChange">
- <summary>
- Indicates whether or not the <see cref="F:Sfs2X.Core.SFSEvent.USER_COUNT_CHANGE"/> event should be dispatched whenever the users (or players+spectators) count changes in the Room.
- </summary>
-
- <remarks>
- The default value is <c>false</c>.
- </remarks>
-
- <seealso cref="F:Sfs2X.Core.SFSEvent.USER_COUNT_CHANGE"/>
- </member>
- <member name="P:Sfs2X.Requests.RoomEvents.AllowUserVariablesUpdate">
- <summary>
- Indicates whether or not the <see cref="F:Sfs2X.Core.SFSEvent.USER_VARIABLES_UPDATE"/> event should be dispatched whenever a user in the Room updates his User Variables.
- </summary>
-
- <remarks>
- The default value is <c>false</c>.
- </remarks>
-
- <seealso cref="F:Sfs2X.Core.SFSEvent.USER_VARIABLES_UPDATE"/>
- </member>
- <member name="T:Sfs2X.Requests.RoomExtension">
- <summary>
- The RoomExtension class contains a specific subset of the RoomSettings required to create a Room.
- </summary>
-
- <remarks>
- This class defines which server-side Extension should be attached to the Room upon creation.
- <para/>
- The client can communicate with the Room Extension by means of the <see cref="T:Sfs2X.Requests.ExtensionRequest"/> request.
- </remarks>
-
- <seealso cref="P:Sfs2X.Requests.RoomSettings.Extension"/>
- <seealso cref="T:Sfs2X.Requests.CreateRoomRequest"/>
- </member>
- <member name="M:Sfs2X.Requests.RoomExtension.#ctor(System.String,System.String)">
- <summary>
- Creates a new RoomExtension instance.
- </summary>
-
- <remarks>
- The <see cref="P:Sfs2X.Requests.RoomSettings.Extension">RoomSettings.Extension</see> property must be set to this instance during Room creation.
- </remarks>
-
- <param name="id">The name of the Extension as deployed on the server; it's the name of the folder containing the Extension classes inside the main <em>[sfs2x-install-folder]/SFS2X/extensions</em> folder.</param>
- <param name="className">The fully qualified name of the main class of the Extension.</param>
-
- <seealso cref="P:Sfs2X.Requests.RoomSettings.Extension"/>
- </member>
- <member name="P:Sfs2X.Requests.RoomExtension.Id">
- <summary>
- Returns the name of the Extension to be attached to the Room.
- </summary>
-
- <remarks>
- This is the name of the server-side folder containing the Extension classes inside the main <em>[sfs2x-install-folder]/SFS2X/extensions</em> folder.
- </remarks>
- </member>
- <member name="P:Sfs2X.Requests.RoomExtension.ClassName">
- <summary>
- Returns the fully qualified name of the main class of the Extension.
- </summary>
- </member>
- <member name="P:Sfs2X.Requests.RoomExtension.PropertiesFile">
- <summary>
- Defines the name of an optional properties file that should be loaded on the server-side during the Extension initialization.
- </summary>
-
- <remarks>
- The file must be located in the server-side folder containing the Extension classes.
- </remarks>
- </member>
- <member name="T:Sfs2X.Requests.RoomPermissions">
- <summary>
- The RoomPermissions class contains a specific subset of the RoomSettings required to create a Room.
- </summary>
-
- <remarks>
- This class defines which operations users will be able to execute on the Room after its creation.
- </remarks>
-
- <seealso cref="P:Sfs2X.Requests.RoomSettings.Permissions"/>
- <seealso cref="T:Sfs2X.Requests.CreateRoomRequest"/>
- </member>
- <member name="M:Sfs2X.Requests.RoomPermissions.#ctor">
- <summary>
- Creates a new RoomPermissions instance.
- </summary>
-
- <remarks>
- The <see cref="P:Sfs2X.Requests.RoomSettings.Permissions">RoomSettings.Permissions</see> property must be set to this instance during Room creation.
- </remarks>
- </member>
- <member name="P:Sfs2X.Requests.RoomPermissions.AllowNameChange">
- <summary>
- Indicates whether changing the Room name after its creation is allowed or not.
- </summary>
-
- <remarks>
- The Room name can be changed by means of the <see cref="T:Sfs2X.Requests.ChangeRoomNameRequest"/> request.
- <para/>
- The default value is <c>false</c>.
- </remarks>
-
- <seealso cref="T:Sfs2X.Requests.ChangeRoomNameRequest"/>
- </member>
- <member name="P:Sfs2X.Requests.RoomPermissions.AllowPasswordStateChange">
- <summary>
- Indicates whether changing (or removing) the Room password after its creation is allowed or not.
- </summary>
-
- <remarks>
- The Room password can be changed by means of the <see cref="T:Sfs2X.Requests.ChangeRoomPasswordStateRequest"/> request.
- <para/>
- The default value is <c>false</c>.
- </remarks>
-
- <seealso cref="T:Sfs2X.Requests.ChangeRoomPasswordStateRequest"/>
- </member>
- <member name="P:Sfs2X.Requests.RoomPermissions.AllowPublicMessages">
- <summary>
- Indicates whether users inside the Room are allowed to send public messages or not.
- </summary>
-
- <remarks>
- Public messages can be sent by means of the <see cref="T:Sfs2X.Requests.PublicMessageRequest"/> request.
- <para/>
- The default value is <c>false</c>.
- </remarks>
-
- <seealso cref="T:Sfs2X.Requests.PublicMessageRequest"/>
- </member>
- <member name="P:Sfs2X.Requests.RoomPermissions.AllowResizing">
- <summary>
- Indicates whether the Room capacity can be changed after its creation or not.
- </summary>
-
- <remarks>
- The capacity is the maximum number of users and spectators (in Game Rooms) allowed to enter the Room. It can be changed by means of the <see cref="T:Sfs2X.Requests.ChangeRoomCapacityRequest"/> request.
- <para/>
- The default value is <c>false</c>.
- </remarks>
-
- <seealso cref="T:Sfs2X.Requests.ChangeRoomCapacityRequest"/>
- </member>
- <member name="T:Sfs2X.Requests.RoomSettings">
- <summary>
- The RoomSettings class is a container for the settings required to create a Room.
- </summary>
-
- <seealso cref="T:Sfs2X.Requests.CreateRoomRequest"/>
- </member>
- <member name="M:Sfs2X.Requests.RoomSettings.#ctor(System.String)">
- <summary>
- Creates a new RoomSettings instance.
- </summary>
-
- <remarks>
- The instance must be passed to the <see cref="T:Sfs2X.Requests.CreateRoomRequest"/> class constructor.
- </remarks>
-
- <param name="name">The name of the Room to be created.</param>
-
- <seealso cref="T:Sfs2X.Requests.CreateRoomRequest"/>
- </member>
- <member name="P:Sfs2X.Requests.RoomSettings.Name">
- <summary>
- Defines the name of the Room.
- </summary>
- </member>
- <member name="P:Sfs2X.Requests.RoomSettings.Password">
- <summary>
- Defines the password of the Room.
- </summary>
-
- <remarks>
- If the password is set to an empty string, the Room won't be password protected.
- <para/>
- The default value is an empty string.
- </remarks>
- </member>
- <member name="P:Sfs2X.Requests.RoomSettings.IsGame">
- <summary>
- Indicates whether the Room is a Game Room or not.
- </summary>
-
- <remarks>
- The default value is <em>false</em>.
- </remarks>
- </member>
- <member name="P:Sfs2X.Requests.RoomSettings.MaxUsers">
- <summary>
- Defines the maximum number of users allowed in the Room.
- </summary>
-
- <remarks>
- In case of Game Rooms, this is the maximum number of players.
- <para/>
- The default value is <em>10</em>.
- </remarks>
-
- <seealso cref="P:Sfs2X.Requests.RoomSettings.MaxSpectators"/>
- </member>
- <member name="P:Sfs2X.Requests.RoomSettings.MaxVariables">
- <summary>
- Defines the maximum number of Room Variables allowed for the Room.
- </summary>
-
- <remarks>
- The default value is <em>5</em>.
- </remarks>
- </member>
- <member name="P:Sfs2X.Requests.RoomSettings.MaxSpectators">
- <summary>
- Defines the maximum number of spectators allowed in the Room (only for Game Rooms).
- </summary>
-
- <remarks>
- The default value is <em>0</em>.
- </remarks>
-
- <seealso cref="P:Sfs2X.Requests.RoomSettings.MaxUsers"/>
- </member>
- <member name="P:Sfs2X.Requests.RoomSettings.Variables">
- <summary>
- Defines a list of RooomVariable objects to be attached to the Room.
- </summary>
-
- <remarks>
- The default value is <c>null</c>.
- </remarks>
-
- <seealso cref="T:Sfs2X.Entities.Variables.RoomVariable"/>
- </member>
- <member name="P:Sfs2X.Requests.RoomSettings.Permissions">
- <summary>
- Defines the flags indicating which operations are permitted on the Room.
- </summary>
-
- <remarks>
- Permissions include: name and password change, maximum users change and public messaging. If set to <c>null</c>,
- the permissions configured on the server-side are used (see the SmartFoxServer 2X Administration Tool documentation).
- <para/>
- The default value is <c>null</c>.
- </remarks>
- </member>
- <member name="P:Sfs2X.Requests.RoomSettings.Events">
- <summary>
- Defines the flags indicating which events related to the Room are dispatched by the <em>SmartFox</em> client.
- </summary>
-
- <remarks>
- Room events include: users entering or leaving the room, user count change and user variables update. If set to <c>null</c>,
- the events configured on the server-side are used (see the SmartFoxServer 2X Administration Tool documentation).
- <para/>
- The default value is <c>null</c>.
- </remarks>
- </member>
- <member name="P:Sfs2X.Requests.RoomSettings.Extension">
- <summary>
- Defines the Extension that must be attached to the Room on the server-side, and its settings.
- </summary>
- </member>
- <member name="P:Sfs2X.Requests.RoomSettings.GroupId">
- <summary>
- Defines the id of the Group to which the Room should belong.
- </summary>
-
- <remarks>
- If the Group doesn't exist yet, a new one is created before assigning the Room to it.
- <para/>
- The default value is <em>default</em>.
- </remarks>
-
- <seealso cref="P:Sfs2X.Entities.Room.GroupId"/>
- </member>
- <member name="P:Sfs2X.Requests.RoomSettings.AllowOwnerOnlyInvitation">
- <summary>
- Specifies if the Room allows "Join Room" invitations to be sent by any user or just by its owner.
- </summary>
-
- <remarks>
- The default value is <em>true</em>.
- </remarks>
-
- <seealso cref="T:Sfs2X.Requests.Game.JoinRoomInvitationRequest"/>
- </member>
- <member name="T:Sfs2X.Requests.SetRoomVariablesRequest">
- <summary>
- Sets one or more custom Room Variables in a Room.
- </summary>
-
- <remarks>
- When a Room Variable is set, the <see cref="F:Sfs2X.Core.SFSEvent.ROOM_VARIABLES_UPDATE"/> event is dispatched to all the users in the target Room, including the user who updated it.
- Also, if the Room Variable is global (see the <see cref="T:Sfs2X.Entities.Variables.SFSRoomVariable"/> class description), the event is dispatched to all users who subscribed the Group to which the target Room is associated.
- </remarks>
-
- <example>
- The following example sets a number of Room Variables and handles the respective update event:
- <code>
- void SomeMethod() {
- sfs.AddEventListener(SFSEvent.ROOM_VARIABLES_UPDATE, OnRoomVarsUpdate);
-
- // Create some Room Variables
- List<RoomVariable> roomVars = new List<RoomVariable>();
- roomVars.Add( new SFSRoomVariable("gameStarted", false) );
- roomVars.Add( new SFSRoomVariable("gameType", "Snooker") );
- roomVars.Add( new SFSRoomVariable("minRank", 10) );
-
- sfs.Send( new SetRoomVariablesRequest(roomVars) );
- }
-
- void OnRoomVarsUpdate(BaseEvent evt) {
- List<String> changedVars = (List<String>)evt.Params["changedVars"];
- Room room = (Room)evt.Params["room"];
-
- // Check if the gameStarted variable was changed
- if (changedVars.Contains ("gameStarted")) {
- if (room.GetVariable("gameStarted").GetBoolValue()) {
- Console.WriteLine("Game started"); // .Net / Unity
- System.Diagnostics.Debug.WriteLine("Game started"); // Windows Universal
- } else {
- Console.WriteLine("Game stopped"); // .Net / Unity
- System.Diagnostics.Debug.WriteLine("Game stopped"); // Windows Universal
- }
- }
- }
- </code>
- </example>
-
- <seealso cref="F:Sfs2X.Core.SFSEvent.ROOM_VARIABLES_UPDATE"/>
- <seealso cref="T:Sfs2X.Entities.Variables.SFSRoomVariable"/>
- </member>
- <member name="F:Sfs2X.Requests.SetRoomVariablesRequest.KEY_VAR_ROOM">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.SetRoomVariablesRequest.KEY_VAR_LIST">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Requests.SetRoomVariablesRequest.#ctor(System.Collections.Generic.ICollection{Sfs2X.Entities.Variables.RoomVariable},Sfs2X.Entities.Room)">
- <summary>
- Creates a new SetRoomVariablesRequest instance.
- </summary>
-
- <remarks>
- The instance must be passed to the <see cref="M:Sfs2X.SmartFox.Send(Sfs2X.Requests.IRequest)">SmartFox.Send</see> method for the request to be performed.
- </remarks>
-
- <param name="roomVariables">A collection of objects representing the Room Variables to be set.</param>
- <param name="room">An object representing the Room where to set the Room Variables; if <c>null</c>, the last Room joined by the current user is used (default = <c>null</c>).</param>
- </member>
- <member name="M:Sfs2X.Requests.SetRoomVariablesRequest.#ctor(System.Collections.Generic.ICollection{Sfs2X.Entities.Variables.RoomVariable})">
- <summary>
- See <em>SetRoomVariablesRequest(ICollection<RoomVariable>, Room)</em> constructor.
- </summary>
- </member>
- <member name="M:Sfs2X.Requests.SetRoomVariablesRequest.Validate(Sfs2X.SmartFox)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Requests.SetRoomVariablesRequest.Execute(Sfs2X.SmartFox)">
- <exclude/>
- </member>
- <member name="T:Sfs2X.Requests.SetUserVariablesRequest">
- <summary>
- Sets one or more custom User Variables for the current user.
- </summary>
-
- <remarks>
- When a User Variable is set, the <see cref="F:Sfs2X.Core.SFSEvent.USER_VARIABLES_UPDATE"/> event is dispatched to all the users in all the Rooms joined by the current user, including himself.
- <para/>
- <b>NOTE</b>: the <see cref="F:Sfs2X.Core.SFSEvent.USER_VARIABLES_UPDATE"/> event is dispatched to users in a specific Room
- only if it is configured to allow this event (see the <see cref="P:Sfs2X.Requests.RoomSettings.Permissions">RoomSettings.Permissions</see> parameter).
- </remarks>
-
- <example>
- The following example sets a number of User Variables and handles the respective update event:
- <code>
- void SomeMethod() {
- sfs.AddEventListener(SFSEvent.USER_VARIABLES_UPDATE, OnUserVarsUpdate);
-
- // Create some User Variables
- List<UserVariable> userVars = new List<UserVariable>();
- userVars.Add( new SFSUserVariable("avatarType", "SwedishCook") );
- userVars.Add( new SFSUserVariable("country", "Sweden") );
- userVars.Add( new SFSUserVariable("x", 10) );
- userVars.Add( new SFSUserVariable("y", 5) );
-
- sfs.Send( new SetUserVariablesRequest(userVars) );
- }
-
- void OnUserVarsUpdate(BaseEvent evt) {
- List<String> changedVars = (List<String>)evt.Params["changedVars"];
- User user = (User)evt.Params["user"];
-
- // Check if the user changed his x and y User Variables
- if (changedVars.Contains("x") || changedVars.Contains("y"))
- {
- // Move the character to a new position...
- UpdateClientPosition(user);
- }
- }
- </code>
- </example>
-
- <seealso cref="F:Sfs2X.Core.SFSEvent.USER_VARIABLES_UPDATE"/>
- <seealso cref="T:Sfs2X.Entities.Variables.SFSUserVariable"/>
- </member>
- <member name="F:Sfs2X.Requests.SetUserVariablesRequest.KEY_USER">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.SetUserVariablesRequest.KEY_VAR_LIST">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Requests.SetUserVariablesRequest.#ctor(System.Collections.Generic.ICollection{Sfs2X.Entities.Variables.UserVariable})">
- <summary>
- Creates a new SetUserVariablesRequest instance.
- </summary>
-
- <remarks>
- The instance must be passed to the <see cref="M:Sfs2X.SmartFox.Send(Sfs2X.Requests.IRequest)">SmartFox.Send</see> method for the request to be performed.
- </remarks>
-
- <param name="userVariables">A collection of objects representing the User Variables to be set.</param>
- </member>
- <member name="M:Sfs2X.Requests.SetUserVariablesRequest.Validate(Sfs2X.SmartFox)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Requests.SetUserVariablesRequest.Execute(Sfs2X.SmartFox)">
- <exclude/>
- </member>
- <member name="T:Sfs2X.Requests.SpectatorToPlayerRequest">
- <summary>
- Turns the current user from spectator to player in a Game Room.
- </summary>
-
- <remarks>
- If the operation is successful, all the users in the target Room are notified with the <see cref="F:Sfs2X.Core.SFSEvent.SPECTATOR_TO_PLAYER"/> event.
- The operation could fail if no player slots are available in the Game Room at the time of the request;
- in this case the <see cref="F:Sfs2X.Core.SFSEvent.SPECTATOR_TO_PLAYER_ERROR"/> event is dispatched to the requester's client.
- </remarks>
-
- <example>
- The following example turns the current user from spectator to player in the last joined Game Room:
- <code>
- void SomeMethod() {
- sfs.AddEventListener(SFSEvent.SPECTATOR_TO_PLAYER, OnSpectatorToPlayerSwitch);
- sfs.AddEventListener(SFSEvent.SPECTATOR_TO_PLAYER_ERROR, OnSpectatorToPlayerSwitchError);
-
- // Switch spectator to player
- sfs.Send( new PlayerToSpectatorRequest() );
- }
-
- void OnSpectatorToPlayerSwitch(BaseEvent evt) {
- User user = (User)evt.Params["user"];
- Console.WriteLine("Spectator " + user.Name + " is now a player"); // .Net / Unity
- System.Diagnostics.Debug.WriteLine("Spectator " + user.Name + " is now a player"); // Windows Universal
- }
-
- void OnSpectatorToPlayerSwitchError(BaseEvent evt) {
- Console.WriteLine("Unable to become a player due to the following error: " + (string)evt.Params["errorMessage"]); // .Net / Unity
- System.Diagnostics.Debug.WriteLine("Unable to become a player due to the following error: " + (string)evt.Params["errorMessage"]); // Windows Universal
- }
- </code>
- </example>
-
- <seealso cref="F:Sfs2X.Core.SFSEvent.SPECTATOR_TO_PLAYER"/>
- <seealso cref="F:Sfs2X.Core.SFSEvent.SPECTATOR_TO_PLAYER_ERROR"/>
- <seealso cref="T:Sfs2X.Requests.PlayerToSpectatorRequest"/>
- </member>
- <member name="F:Sfs2X.Requests.SpectatorToPlayerRequest.KEY_ROOM_ID">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.SpectatorToPlayerRequest.KEY_USER_ID">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.SpectatorToPlayerRequest.KEY_PLAYER_ID">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Requests.SpectatorToPlayerRequest.#ctor(Sfs2X.Entities.Room)">
- <summary>
- Creates a new SpectatorToPlayerRequest instance.
- </summary>
-
- <remarks>
- The instance must be passed to the <see cref="M:Sfs2X.SmartFox.Send(Sfs2X.Requests.IRequest)">SmartFox.Send</see> method for the request to be performed.
- </remarks>
-
- <param name="targetRoom">The object corresponding to the Room in which the spectator should be turned to player. If <c>null</c>, the last Room joined by the user is used (default = <c>null</c>).</param>
- </member>
- <member name="M:Sfs2X.Requests.SpectatorToPlayerRequest.#ctor">
- <summary>
- See <em>SpectatorToPlayerRequest(Room)</em> constructor.
- </summary>
- </member>
- <member name="M:Sfs2X.Requests.SpectatorToPlayerRequest.Validate(Sfs2X.SmartFox)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Requests.SpectatorToPlayerRequest.Execute(Sfs2X.SmartFox)">
- <exclude/>
- </member>
- <member name="T:Sfs2X.Requests.SubscribeRoomGroupRequest">
- <summary>
- Subscribes the current user to Room-related events occurring in the specified Group.
- </summary>
-
- <remarks>
- This allows the user to be notified of specific Room events even if he didn't join the Room from which the events originated, provided the Room belongs to the subscribed Group.
- <para/>
- If the subscription operation is successful, the current user receives a <see cref="F:Sfs2X.Core.SFSEvent.ROOM_GROUP_SUBSCRIBE"/> event; otherwise the <see cref="F:Sfs2X.Core.SFSEvent.ROOM_GROUP_SUBSCRIBE_ERROR"/> event is fired.
- </remarks>
-
- <example>
- The following example makes the current user subscribe a Group:
- <code>
- void SomeMethod() {
- sfs.AddEventListener(SFSEvent.ROOM_GROUP_SUBSCRIBE, OnSubscribeRoomGroup);
- sfs.AddEventListener(SFSEvent.ROOM_GROUP_SUBSCRIBE_ERROR, OnSubscribeRoomGroupError);
-
- // Subscribe the "card_games" group
- sfs.Send( new SubscribeRoomGroupRequest("card_games") );
- }
-
- void OnSubscribeRoomGroup(BaseEvent evt) {
- Console.WriteLine("Group subscribed. The following rooms are now accessible: " + (List<Room>)evt.Params["newRooms"]); // .Net / Unity
- System.Diagnostics.Debug.WriteLine("Group subscribed. The following rooms are now accessible: " + (List<Room>)evt.Params["newRooms"]); // Windows Universal
- }
-
- void OnSubscribeRoomGroupError(BaseEvent evt) {
- Console.WriteLine("Group subscription failed: " + (string)evt.Params["errorMessage"]); // .Net / Unity
- System.Diagnostics.Debug.WriteLine("Group subscription failed: " + (string)evt.Params["errorMessage"]); // Windows Universal
- }
- </code>
- </example>
-
- <seealso cref="F:Sfs2X.Core.SFSEvent.ROOM_GROUP_SUBSCRIBE"/>
- <seealso cref="F:Sfs2X.Core.SFSEvent.ROOM_GROUP_SUBSCRIBE_ERROR"/>
- <seealso cref="T:Sfs2X.Requests.UnsubscribeRoomGroupRequest"/>
- </member>
- <member name="F:Sfs2X.Requests.SubscribeRoomGroupRequest.KEY_GROUP_ID">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.SubscribeRoomGroupRequest.KEY_ROOM_LIST">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Requests.SubscribeRoomGroupRequest.#ctor(System.String)">
- <summary>
- Creates a new SubscribeRoomGroupRequest instance.
- </summary>
-
- <remarks>
- The instance must be passed to the <see cref="M:Sfs2X.SmartFox.Send(Sfs2X.Requests.IRequest)">SmartFox.Send</see> method for the request to be performed.
- </remarks>
-
- <param name="groupId">The name of the Room Group to subscribe.</param>
- </member>
- <member name="M:Sfs2X.Requests.SubscribeRoomGroupRequest.Validate(Sfs2X.SmartFox)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Requests.SubscribeRoomGroupRequest.Execute(Sfs2X.SmartFox)">
- <exclude/>
- </member>
- <member name="T:Sfs2X.Requests.UnsubscribeRoomGroupRequest">
- <summary>
- Unsubscribes the current user to Room-related events occurring in the specified Group.
- </summary>
-
- <remarks>
- This allows the user to stop being notified of specific Room events occurring in Rooms belonging to the unsubscribed Group.
- <para/>
- If the operation is successful, the current user receives a <see cref="F:Sfs2X.Core.SFSEvent.ROOM_GROUP_UNSUBSCRIBE"/> event; otherwise the <see cref="F:Sfs2X.Core.SFSEvent.ROOM_GROUP_UNSUBSCRIBE_ERROR"/> event is fired.
- </remarks>
-
- <example>
- The following example makes the current user unsubscribe a Group:
- <code>
- void SomeMethod() {
- sfs.AddEventListener(SFSEvent.ROOM_GROUP_UNSUBSCRIBE, OnUnsubscribeRoomGroup);
- sfs.AddEventListener(SFSEvent.ROOM_GROUP_UNSUBSCRIBE_ERROR, OnUnsubscribeRoomGroupError);
-
- // Unsubscribe the "card_games" group
- sfs.Send( new UnsubscribeRoomGroupRequest("card_games") );
- }
-
- void OnUnsubscribeRoomGroup(BaseEvent evt) {
- Console.WriteLine("Group unsubscribed: " + (string)evt.Params["groupId"]); // .Net / Unity
- System.Diagnostics.Debug.WriteLine("Group unsubscribed: " + (string)evt.Params["groupId"]); // Windows Universal
- }
-
- void OnUnsubscribeRoomGroupError(BaseEvent evt) {
- Console.WriteLine("Group unsubscribing failed: " + (string)evt.Params["errorMessage"]); // .Net / Unity
- System.Diagnostics.Debug.WriteLine("Group unsubscribing failed: " + (string)evt.Params["errorMessage"]); // Windows Universal
- }
- </code>
- </example>
-
- <seealso cref="F:Sfs2X.Core.SFSEvent.ROOM_GROUP_UNSUBSCRIBE"/>
- <seealso cref="F:Sfs2X.Core.SFSEvent.ROOM_GROUP_UNSUBSCRIBE_ERROR"/>
- <seealso cref="T:Sfs2X.Requests.SubscribeRoomGroupRequest"/>
- </member>
- <member name="F:Sfs2X.Requests.UnsubscribeRoomGroupRequest.KEY_GROUP_ID">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Requests.UnsubscribeRoomGroupRequest.#ctor(System.String)">
- <summary>
- Creates a new UnsubscribeRoomGroupRequest instance.
- </summary>
-
- <remarks>
- The instance must be passed to the <see cref="M:Sfs2X.SmartFox.Send(Sfs2X.Requests.IRequest)">SmartFox.Send</see> method for the request to be performed.
- </remarks>
-
- <param name="groupId">The name of the Room Group to unsubscribe.</param>
- </member>
- <member name="M:Sfs2X.Requests.UnsubscribeRoomGroupRequest.Validate(Sfs2X.SmartFox)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Requests.UnsubscribeRoomGroupRequest.Execute(Sfs2X.SmartFox)">
- <exclude/>
- </member>
- <member name="T:Sfs2X.Requests.Buddylist.AddBuddyRequest">
- <summary>
- Adds a new buddy to the current user's buddies list.
- </summary>
-
- <remarks>
- In order to add a buddy, the current user must be online in the Buddy List system.
- If the buddy is added successfully, the operation is confirmed by a <see cref="F:Sfs2X.Core.SFSBuddyEvent.BUDDY_ADD"/> event;
- otherwise the <see cref="F:Sfs2X.Core.SFSBuddyEvent.BUDDY_ERROR"/> event is fired.
- <para/>
- This request can be sent if the Buddy List system was previously initialized only (see the <see cref="T:Sfs2X.Requests.Buddylist.InitBuddyListRequest"/> request description).
- </remarks>
-
- <example>
- The following example sends a request to add a buddy:
- <code>
- void SomeMethod() {
- sfs.AddEventListener(SFSBuddyEvent.BUDDY_ADD, OnBuddyAdded);
- sfs.AddEventListener(SFSBuddyEvent.BUDDY_ERROR, OnBuddyError);
-
- // Add Jack as a new buddy to my buddies list
- sfs.Send(new AddBuddyRequest("Jack"));
- }
-
- void OnBuddyAdded(BaseEvent evt) {
- Console.WriteLine("Buddy was added: " + (Buddy)evt.Params["buddy"]); // .Net / Unity
- System.Diagnostics.Debug.WriteLine("Buddy was added: " + (Buddy)evt.Params["buddy"]); // Windows Universal
- }
-
- void OnBuddyError(BaseEvent evt) {
- Console.WriteLine("The following error occurred while executing a buddy-related request: " + (string)evt.Params["errorMessage"]); // .Net / Unity
- System.Diagnostics.Debug.WriteLine("The following error occurred while executing a buddy-related request: " + (string)evt.Params["errorMessage"]); // Windows Universal
- }
- </code>
- </example>
-
- <seealso cref="F:Sfs2X.Core.SFSBuddyEvent.BUDDY_ADD"/>
- <seealso cref="F:Sfs2X.Core.SFSBuddyEvent.BUDDY_ERROR"/>
- <seealso cref="T:Sfs2X.Requests.Buddylist.RemoveBuddyRequest"/>
- </member>
- <member name="F:Sfs2X.Requests.Buddylist.AddBuddyRequest.KEY_BUDDY_NAME">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Requests.Buddylist.AddBuddyRequest.#ctor(System.String)">
- <summary>
- Creates a new AddBuddyRequest instance.
- </summary>
-
- <remarks>
- The instance must be passed to the <see cref="M:Sfs2X.SmartFox.Send(Sfs2X.Requests.IRequest)">SmartFox.Send</see> method for the request to be performed.
- </remarks>
-
- <param name="buddyName">The name of the user to be added as a buddy.</param>
- </member>
- <member name="M:Sfs2X.Requests.Buddylist.AddBuddyRequest.Validate(Sfs2X.SmartFox)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Requests.Buddylist.AddBuddyRequest.Execute(Sfs2X.SmartFox)">
- <exclude/>
- </member>
- <member name="T:Sfs2X.Requests.Buddylist.BlockBuddyRequest">
- <summary>
- Blocks or unblocks a buddy in the current user's buddies list. Blocked buddies won't be able to send messages or requests to that user.
- </summary>
-
- <remarks>
- In order to block a buddy, the current user must be online in the Buddy List system.
- If the operation is successful, a <see cref="F:Sfs2X.Core.SFSBuddyEvent.BUDDY_BLOCK"/> confirmation event is dispatched; otherwise the <see cref="F:Sfs2X.Core.SFSBuddyEvent.BUDDY_ERROR"/> event is fired.
- <para/>
- This request can be sent if the Buddy List system was previously initialized only (see the <see cref="T:Sfs2X.Requests.Buddylist.InitBuddyListRequest"/> request description).
- </remarks>
-
- <example>
- The following example sends a request to block a buddy:
- <code>
- void SomeMethod() {
- sfs.AddEventListener(SFSBuddyEvent.BUDDY_BLOCK, onBuddyBlock);
- sfs.AddEventListener(SFSBuddyEvent.BUDDY_ERROR, OnBuddyError);
-
- // Block Jack in my buddies list
- sfs.Send(new BlockBuddyRequest("Jack", true));
- }
-
- void onBuddyBlock(BaseEvent evt) {
- Buddy buddy = (Buddy)evt.Params["buddy"];
- Console.WriteLine("Buddy " + buddy.Name + " is now " + (buddy.IsBlocked ? "blocked" : "unblocked")); // .Net / Unity
- System.Diagnostics.Debug.WriteLine("Buddy " + buddy.Name + " is now " + (buddy.IsBlocked ? "blocked" : "unblocked")); // Windows Universal
- }
-
- void OnBuddyError(BaseEvent evt) {
- Console.WriteLine("The following error occurred while executing a buddy-related request: " + (string)evt.Params["errorMessage"]); // .Net / Unity
- System.Diagnostics.Debug.WriteLine("The following error occurred while executing a buddy-related request: " + (string)evt.Params["errorMessage"]); // Windows Universal
- }
- </code>
- </example>
-
- <seealso cref="F:Sfs2X.Core.SFSBuddyEvent.BUDDY_BLOCK"/>
- <seealso cref="F:Sfs2X.Core.SFSBuddyEvent.BUDDY_ERROR"/>
- </member>
- <member name="F:Sfs2X.Requests.Buddylist.BlockBuddyRequest.KEY_BUDDY_NAME">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.Buddylist.BlockBuddyRequest.KEY_BUDDY_BLOCK_STATE">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.Buddylist.BlockBuddyRequest.KEY_BUDDY">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Requests.Buddylist.BlockBuddyRequest.#ctor(System.String,System.Boolean)">
- <summary>
- Creates a new BlockBuddyRequest instance.
- </summary>
-
- <remarks>
- The instance must be passed to the <see cref="M:Sfs2X.SmartFox.Send(Sfs2X.Requests.IRequest)">SmartFox.Send</see> method for the request to be performed.
- </remarks>
-
- <param name="buddyName">The name of the buddy to be blocked or unblocked.</param>
- <param name="blocked"><c>true</c> if the buddy must be blocked; <c>false</c> if he must be unblocked.</param>
- </member>
- <member name="M:Sfs2X.Requests.Buddylist.BlockBuddyRequest.Validate(Sfs2X.SmartFox)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Requests.Buddylist.BlockBuddyRequest.Execute(Sfs2X.SmartFox)">
- <exclude/>
- </member>
- <member name="T:Sfs2X.Requests.Buddylist.BuddyMessageRequest">
- <summary>
- Sends a message to a buddy in the current user's buddies list.
- </summary>
-
- <remarks>
- Messages sent to buddies using the <see cref="T:Sfs2X.Requests.Buddylist.BuddyMessageRequest"/> request are similar to the standard private messages (see the <see cref="T:Sfs2X.Requests.PrivateMessageRequest"/> request)
- but are specifically designed for the Buddy List system: they don't require any Room parameter, nor they require that users joined a Room.
- Additionally, buddy messages are subject to specific validation, such as making sure that the recipient is in the sender's buddies list and the sender is not blocked by the recipient.
- <para/>
- If the operation is successful, a <see cref="F:Sfs2X.Core.SFSBuddyEvent.BUDDY_MESSAGE"/> event is dispatched in both the sender and recipient clients.
- <para/>
- This request can be sent if the Buddy List system was previously initialized only (see the <see cref="T:Sfs2X.Requests.Buddylist.InitBuddyListRequest"/> request description).
- </remarks>
-
- <example>
- The following example sends a message to a buddy and handles the related event:
- <code>
- void SomeMethod() {
- sfs.AddEventListener(SFSBuddyEvent.BUDDY_MESSAGE, OnBuddyMessage);
-
- // Obtain the recipient of the message
- Buddy kermitTheFrog = sfs.BuddyListManager.GetBuddyByName("KermitTheFrog");
-
- // Block a buddy in the current buddy list
- sfs.Send(new BuddyMessageRequest("Hello Kermit!", kermitTheFrog));
- }
-
- void OnBuddyMessage(BaseEvent evt) {
- bool isItMe = (bool)evt.Params["isItMe"];
- Buddy buddy = (Buddy)evt.Params["buddy"];
-
- if (isItMe)
- {
- Console.WriteLine("I said: " + (string)evt.Params["message"]); // .Net / Unity
- System.Diagnostics.Debug.WriteLine("I said: " + (string)evt.Params["message"]); // Windows Universal
- }
- else
- {
- Console.WriteLine(buddy.Name + " said: " + (string)evt.Params["message"]); // .Net / Unity
- System.Diagnostics.Debug.WriteLine(buddy.Name + " said: " + (string)evt.Params["message"]); // Windows Universal
- }
- }
- </code>
- </example>
-
- <seealso cref="F:Sfs2X.Core.SFSBuddyEvent.BUDDY_MESSAGE"/>
- </member>
- <member name="M:Sfs2X.Requests.Buddylist.BuddyMessageRequest.#ctor(System.String,Sfs2X.Entities.Buddy,Sfs2X.Entities.Data.ISFSObject)">
- <summary>
- Creates a new BuddyMessageRequest instance.
- </summary>
-
- <remarks>
- The instance must be passed to the <see cref="M:Sfs2X.SmartFox.Send(Sfs2X.Requests.IRequest)">SmartFox.Send</see> method for the request to be performed.
- </remarks>
-
- <param name="message">The message to be sent to a buddy.</param>
- <param name="targetBuddy">The Buddy object corresponding to the message recipient.</param>
- <param name="parameters">An instance of <see cref="T:Sfs2X.Entities.Data.SFSObject"/> containing additional custom parameters (e.g. the message color, an emoticon id, etc). Default is <c>null</c>.</param>
- </member>
- <member name="M:Sfs2X.Requests.Buddylist.BuddyMessageRequest.#ctor(System.String,Sfs2X.Entities.Buddy)">
- <summary>
- See <em>BuddyMessageRequest(String, Buddy, ISFSObject)</em> constructor.
- </summary>
- </member>
- <member name="T:Sfs2X.Requests.Buddylist.GoOnlineRequest">
- <summary>
- Toggles the current user's online/offline state as buddy in other users' buddies lists.
- </summary>
-
- <remarks>
- All clients who have the current user as buddy in their buddies list will receive the <see cref="F:Sfs2X.Core.SFSBuddyEvent.BUDDY_ONLINE_STATE_UPDATE"/> event and see the <see cref="P:Sfs2X.Entities.Buddy.IsOnline"/> property change accordingly.
- The same event is also dispatched to the current user, who sent the request, so that the application interface can be updated accordingly. Going online/offline as buddy doesn't affect the user connection, the currently joined Zone and Rooms, etc.
- <para/>
- The online state of a user in a buddy list is handled by means of a reserved and persistent Buddy Variable.
- <para/>
- This request can be sent if the Buddy List system was previously initialized only (see the <see cref="T:Sfs2X.Requests.Buddylist.InitBuddyListRequest"/> request description).
- </remarks>
-
- <example>
- The following example changes the user online state in the Buddy List system:
- <code>
- void SomeMethod() {
- sfs.AddEventListener(SFSBuddyEvent.BUDDY_ONLINE_STATE_UPDATE, OnBuddyOnlineStateUpdate);
-
- // Put myself offline in the Buddy List system
- sfs.Send(new GoOnlineRequest(false));
- }
-
- void OnBuddyOnlineStateUpdate(BaseEvent evt) {
-
- // As the state change event is dispatched to me too,
- // I have to check if I am the one who changed his state
- bool isItMe = (bool)evt.Params["isItMe"];
- Buddy buddy = (Buddy)evt.Params["buddy"];
-
- if (isItMe)
- {
- Console.WriteLine("I'm now " + (sfs.BuddyManager.MyOnlineState ? "online" : "offline")); // .Net / Unity
- System.Diagnostics.Debug.WriteLine("I'm now " + (sfs.BuddyManager.MyOnlineState ? "online" : "offline")); // Windows Universal
- }
- else
- {
- Console.WriteLine("My buddy " + buddy.Name + " is now", (buddy.IsOnline ? "online" : "offline")); // .Net / Unity
- System.Diagnostics.Debug.WriteLine("My buddy " + buddy.Name + " is now", (buddy.IsOnline ? "online" : "offline")); // Windows Universal
- }
- }
- </code>
- </example>
-
- <seealso cref="F:Sfs2X.Core.SFSBuddyEvent.BUDDY_ONLINE_STATE_UPDATE"/>
- <seealso cref="P:Sfs2X.Entities.Buddy.IsOnline"/>
- <seealso cref="P:Sfs2X.Entities.Managers.IBuddyManager.MyOnlineState"/>
- <seealso cref="T:Sfs2X.Entities.Variables.ReservedBuddyVariables"/>
- </member>
- <member name="F:Sfs2X.Requests.Buddylist.GoOnlineRequest.KEY_ONLINE">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.Buddylist.GoOnlineRequest.KEY_BUDDY_NAME">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.Buddylist.GoOnlineRequest.KEY_BUDDY_ID">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Requests.Buddylist.GoOnlineRequest.#ctor(System.Boolean)">
- <summary>
- Creates a new GoOnlineRequest instance.
- </summary>
-
- <remarks>
- The instance must be passed to the <see cref="M:Sfs2X.SmartFox.Send(Sfs2X.Requests.IRequest)">SmartFox.Send</see> method for the request to be performed.
- </remarks>
-
- <param name="online"><c>true</c> to make the current user available (online) in the Buddy List system; <c>false</c> to make him not available (offline).</param>
- </member>
- <member name="M:Sfs2X.Requests.Buddylist.GoOnlineRequest.Validate(Sfs2X.SmartFox)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Requests.Buddylist.GoOnlineRequest.Execute(Sfs2X.SmartFox)">
- <exclude/>
- </member>
- <member name="T:Sfs2X.Requests.Buddylist.InitBuddyListRequest">
- <summary>
- Initializes the Buddy List system on the current client.
- </summary>
-
- <remarks>
- Buddy List system initialization involves loading any previously stored buddy-specific data from the server, such as the current user's buddies list,
- his previous state and the persistent Buddy Variables. The initialization request is <b>the first operation to be executed</b> in order to be able
- to use the Buddy List system features. Once the initialization is completed, the <see cref="F:Sfs2X.Core.SFSBuddyEvent.BUDDY_LIST_INIT"/> event id fired
- and the user has access to all his previously set data and can start to interact with his buddies; if the initialization failed, a <see cref="F:Sfs2X.Core.SFSBuddyEvent.BUDDY_ERROR"/> event id fired.
- </remarks>
-
- <example>
- The following example initializes the Buddy List system:
- <code>
- void SomeMethod() {
- sfs.AddEventListener(SFSBuddyEvent.BUDDY_LIST_INIT, OnBuddyInited);
- sfs.AddEventListener(SFSBuddyEvent.BUDDY_ERROR, OnBuddyError);
-
- // Initialize the Buddy List system
- sfs.Send(new InitBuddyListRequest());
- }
-
- void OnBuddyInited(BaseEvent evt) {
- Console.WriteLine("Buddy List system initialized successfully"); // .Net / Unity
- System.Diagnostics.Debug.WriteLine("Buddy List system initialized successfully"); // Windows Universal
-
- // Retrieve my buddies list
- List<Buddy> buddies = sfs.BuddyManager.BuddyList;
-
- // Display the online buddies in a list component in the application interface
- ...
- }
-
- void OnBuddyError(BaseEvent evt) {
- Console.WriteLine("The following error occurred while executing a buddy-related request: " + (string)evt.Params["errorMessage"]); // .Net / Unity
- System.Diagnostics.Debug.WriteLine("The following error occurred while executing a buddy-related request: " + (string)evt.Params["errorMessage"]); // Windows Universal
- }
- </code>
- </example>
-
- <seealso cref="F:Sfs2X.Core.SFSBuddyEvent.BUDDY_LIST_INIT"/>
- <seealso cref="F:Sfs2X.Core.SFSBuddyEvent.BUDDY_ERROR"/>
- </member>
- <member name="F:Sfs2X.Requests.Buddylist.InitBuddyListRequest.KEY_BLIST">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.Buddylist.InitBuddyListRequest.KEY_BUDDY_STATES">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.Buddylist.InitBuddyListRequest.KEY_MY_VARS">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Requests.Buddylist.InitBuddyListRequest.#ctor">
- <summary>
- Creates a new InitBuddyListRequest instance.
- </summary>
-
- <remarks>
- The instance must be passed to the <see cref="M:Sfs2X.SmartFox.Send(Sfs2X.Requests.IRequest)">SmartFox.Send</see> method for the request to be performed.
- </remarks>
- </member>
- <member name="M:Sfs2X.Requests.Buddylist.InitBuddyListRequest.Validate(Sfs2X.SmartFox)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Requests.Buddylist.InitBuddyListRequest.Execute(Sfs2X.SmartFox)">
- <exclude/>
- </member>
- <member name="T:Sfs2X.Requests.Buddylist.RemoveBuddyRequest">
- <summary>
- Removes a buddy from the current user's buddies list.
- </summary>
-
- <remarks>
- In order to remove a buddy, the current user must be online in the Buddy List system. If the buddy is removed successfully,
- the operation is confirmed by a <see cref="F:Sfs2X.Core.SFSBuddyEvent.BUDDY_REMOVE"/> event; otherwise the <see cref="F:Sfs2X.Core.SFSBuddyEvent.BUDDY_ERROR"/> event is fired.
- <para/>
- This request can be sent if the Buddy List system was previously initialized only (see the <see cref="T:Sfs2X.Requests.Buddylist.InitBuddyListRequest"/> request description).
- </remarks>
-
- <example>
- The following example sends a request to remove a buddy:
- <code>
- void SomeMethod() {
- sfs.AddEventListener(SFSBuddyEvent.BUDDY_REMOVE, OnBuddyRemoved);
- sfs.AddEventListener(SFSBuddyEvent.BUDDY_ERROR, OnBuddyError);
-
- // Remove Jack from my buddies list
- sfs.Send(new RemoveBuddyRequest("Jack"));
- }
-
- void OnBuddyRemoved(BaseEvent evt) {
- Console.WriteLine("This buddy was removed: " + (Buddy)evt.Params["buddy"]); // .Net / Unity
- System.Diagnostics.Debug.WriteLine("This buddy was removed: " + (Buddy)evt.Params["buddy"]); // Windows Universal
- }
-
- void OnBuddyError(BaseEvent evt) {
- Console.WriteLine("The following error occurred while executing a buddy-related request: " + (string)evt.Params["errorMessage"]); // .Net / Unity
- System.Diagnostics.Debug.WriteLine("The following error occurred while executing a buddy-related request: " + (string)evt.Params["errorMessage"]); // Windows Universal
- }
- </code>
- </example>
-
- <seealso cref="F:Sfs2X.Core.SFSBuddyEvent.BUDDY_REMOVE"/>
- <seealso cref="F:Sfs2X.Core.SFSBuddyEvent.BUDDY_ERROR"/>
- <seealso cref="T:Sfs2X.Requests.Buddylist.AddBuddyRequest"/>
- </member>
- <member name="F:Sfs2X.Requests.Buddylist.RemoveBuddyRequest.KEY_BUDDY_NAME">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Requests.Buddylist.RemoveBuddyRequest.#ctor(System.String)">
- <summary>
- Creates a new RemoveBuddyRequest instance.
- </summary>
-
- <remarks>
- The instance must be passed to the <see cref="M:Sfs2X.SmartFox.Send(Sfs2X.Requests.IRequest)">SmartFox.Send</see> method for the request to be performed.
- </remarks>
-
- <param name="buddyName">The name of the buddy to be removed from the user's buddies list.</param>
- </member>
- <member name="M:Sfs2X.Requests.Buddylist.RemoveBuddyRequest.Validate(Sfs2X.SmartFox)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Requests.Buddylist.RemoveBuddyRequest.Execute(Sfs2X.SmartFox)">
- <exclude/>
- </member>
- <member name="T:Sfs2X.Requests.Buddylist.SetBuddyVariablesRequest">
- <summary>
- Sets one or more Buddy Variables for the current user.
- </summary>
-
- <remarks>
- This operation updates the Buddy object representing the user in all the buddies lists in which the user was added as a buddy.
- If the operation is successful, a <see cref="F:Sfs2X.Core.SFSBuddyEvent.BUDDY_VARIABLES_UPDATE"/> event is dispatched to all the
- owners of those buddies lists and to the user who updated his variables too.
- <para/>
- The Buddy Variables can be persisted, which means that their value will be saved even it the user disconnects and it will be restored when he connects again.
- In order to make a variable persistent, put the constant <see cref="F:Sfs2X.Entities.Variables.SFSBuddyVariable.OFFLINE_PREFIX">SFSBuddyVariable.OFFLINE_PREFIX</see> before its name.
- Read the SmartFoxServer 2X documentaion about the Buddy List API for more informations.
- <para/>
- This request can be sent if the Buddy List system was previously initialized only (see the <see cref="T:Sfs2X.Requests.Buddylist.InitBuddyListRequest"/> request description) and the current user state in the system is "online".
- </remarks>
-
- <example>
- The following example sets some Buddy Variables for the current user, one of which is persistent; the example also handles changes made by the user or by his buddies:
- <code>
- void SomeMethod() {
- // Add event listener for BuddyVariables
- sfs.AddEventListener(SFSBuddyEvent.BUDDY_VARIABLES_UPDATE, OnBuddyVarsUpdate);
-
- // Create two Buddy Variables containing the title and artist of the song I'm listening to
- BuddyVariable songTitle = new SFSBuddyVariable("songTitle", "Ascension");
- BuddyVariable songAuthor = new SFSBuddyVariable("songAuthor", "Mike Oldfield");
-
- // Create a persistent Buddy Variable containing my mood message
- BuddyVariable mood = new SFSBuddyVariable(SFSBuddyVariable.OFFLINE_PREFIX + "mood", "I Need SmartFoxServer 2X desperately!");
-
- // Set my Buddy Variables
- List<BuddyVariable> myVars = new List<BuddyVariable>();
- myVars.Add(songTitle);
- myVars.Add(songAuthor);
- myVars.Add(mood);
- sfs.send(new SetBuddyVariablesRequest(myVars));
- }
-
- void OnBuddyVarsUpdate(BaseEvent evt) {
- // As the update event is dispatched to me too,
- // I have to check if I am the one who changed his Buddy Variables
-
- Buddy buddy = (Buddy)evt.Params["buddy"]);
- bool isItMe = (bool)evt.Params["isItMe"];
- List<string> changedVars = (List<string>)evt.Params["changedVars"];
-
- if (isItMe)
- {
- Console.WriteLine("I've updated the following Buddy Variables:"); // .Net / Unity
- System.Diagnostics.Debug.WriteLine("I've updated the following Buddy Variables:"); // Windows Universal
-
- for (int i = 0; i < changedVars.Count; i++)
- {
- string bVarName = changedVars[i];
- Console.WriteLine(bVarName + ": " + sfs.BuddyManager.GetMyVariable(bVarName).Value()); // .Net / Unity
- System.Diagnostics.Debug.WriteLine(bVarName + ": " + sfs.BuddyManager.GetMyVariable(bVarName).Value()); // Windows Universal
- }
- }
- else
- {
- string buddyName = buddy.Name;
-
- Console.WriteLine("My buddy " + buddyName + " updated the following Buddy Variables:"); // .Net / Unity
- System.Diagnostics.Debug.WriteLine("My buddy " + buddyName + " updated the following Buddy Variables:"); // Windows Universal
-
- for (int i = 0; i < changedVars.Count; i++)
- {
- var bVarName:String = changedVars[i];
- Console.WriteLine(bVarName + ": " + sfs.BuddyManager.GetBuddyByName(buddyName).GetVariable(bVarName).Value()); // .Net / Unity
- System.Diagnostics.Debug.WriteLine(bVarName + ": " + sfs.BuddyManager.GetBuddyByName(buddyName).GetVariable(bVarName).Value()); // Windows Universal
- }
- }
- }
- </code>
- </example>
-
- <seealso cref="F:Sfs2X.Core.SFSBuddyEvent.BUDDY_VARIABLES_UPDATE"/>
- <seealso cref="T:Sfs2X.Entities.Variables.SFSBuddyVariable"/>
- </member>
- <member name="F:Sfs2X.Requests.Buddylist.SetBuddyVariablesRequest.KEY_BUDDY_NAME">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.Buddylist.SetBuddyVariablesRequest.KEY_BUDDY_VARS">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Requests.Buddylist.SetBuddyVariablesRequest.#ctor(System.Collections.Generic.List{Sfs2X.Entities.Variables.BuddyVariable})">
- <summary>
- Creates a new SetBuddyVariablesRequest instance.
- </summary>
-
- <remarks>
- The instance must be passed to the <see cref="M:Sfs2X.SmartFox.Send(Sfs2X.Requests.IRequest)">SmartFox.Send</see> method for the request to be performed.
- </remarks>
-
- <param name="buddyVariables">A list of objects representing the Buddy Variables to be set.</param>
- </member>
- <member name="M:Sfs2X.Requests.Buddylist.SetBuddyVariablesRequest.Validate(Sfs2X.SmartFox)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Requests.Buddylist.SetBuddyVariablesRequest.Execute(Sfs2X.SmartFox)">
- <exclude/>
- </member>
- <member name="T:Sfs2X.Requests.Game.CreateSFSGameRequest">
- <summary>
- Creates a new public or private game, including player matching criteria, invitations settings and more.
- </summary>
-
- <remarks>
- A game is created through the istantiation of a <em>SFSGame</em> on the server-side, a specialized Room type that provides advanced features during the creation phase of a game.
- Specific game-configuration settings are passed by means of the <see cref="T:Sfs2X.Requests.Game.SFSGameSettings"/> class.
- <para/>
- If the creation is successful, a <see cref="F:Sfs2X.Core.SFSEvent.ROOM_ADD"/> event is dispatched to all the users who subscribed the Group to which the Room is associated,
- including the game creator. Otherwise, a <see cref="F:Sfs2X.Core.SFSEvent.ROOM_CREATION_ERROR"/> event is returned to the creator's client.
- <para/>
- Also, if the settings passed in the <see cref="T:Sfs2X.Requests.Game.SFSGameSettings"/> object cause invitations to join the game to be sent, an invitation event is dispatched to all the recipient clients.
- <para/>
- Check the SmartFoxServer 2X documentation for a more in-depth overview of the GAME API.
- </remarks>
-
- <example>
- The following example creates a new game:
- <code>
- void SomeMethod() {
- sfs.AddEventListener(SFSEvent.ROOM_ADD, OnRoomCreated);
- sfs.AddEventListener(SFSEvent.ROOM_CREATION_ERROR, OnRoomError);
-
- // Prepare the settings for a public game
- SFSGameSettings settings = new SFSGameSettings("DartsGame");
- settings.MaxUsers = 2;
- settings.MaxSpectators = 8;
- settings.IsPublic = true;
- settings.MinPlayersToStartGame = 2;
- settings.NotifyGameStarted = true;
-
- // Set the matching expression to filter users joining the Room
- settings.PlayerMatchExpression = new MatchExpression("bestScore", NumberMatch.GREATER_THAN, 100);
-
- // Set a Room Variable containing the description of the game
- List<RoomVariable> roomVars = new List<RoomVariable>();
- roomVars.Add(new SFSRoomVariable("desc", "Darts game, public, bestScore > 100"));
- settings.variables = roomVars;
-
- // Create the game
- smartFox.Send( new CreateSFSGameRequest(settings) );
- }
-
- void OnRoomCreated(BaseEvent evt) {
- Console.WriteLine("Room created: " + (Room)evt.Params["room"]); // .Net / Unity
- System.Diagnostics.Debug.WriteLine("Room created: " + (Room)evt.Params["room"]); // Windows Universal
- }
-
- void OnRoomError(BaseEvent evt) {
- Console.WriteLine("Room creation failed: " + (string)evt.Params["errorMessage"]); // .Net / Unity
- System.Diagnostics.Debug.WriteLine("Room creation failed: " + (string)evt.Params["errorMessage"]); // Windows Universal
- }
- </code>
- </example>
-
- <seealso cref="F:Sfs2X.Core.SFSEvent.ROOM_ADD"/>
- <seealso cref="F:Sfs2X.Core.SFSEvent.ROOM_CREATION_ERROR"/>
- <seealso cref="F:Sfs2X.Core.SFSEvent.INVITATION"/>
- <seealso cref="T:Sfs2X.Requests.Game.SFSGameSettings"/>
- </member>
- <member name="F:Sfs2X.Requests.Game.CreateSFSGameRequest.KEY_IS_PUBLIC">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.Game.CreateSFSGameRequest.KEY_MIN_PLAYERS">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.Game.CreateSFSGameRequest.KEY_INVITED_PLAYERS">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.Game.CreateSFSGameRequest.KEY_SEARCHABLE_ROOMS">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.Game.CreateSFSGameRequest.KEY_PLAYER_MATCH_EXP">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.Game.CreateSFSGameRequest.KEY_SPECTATOR_MATCH_EXP">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.Game.CreateSFSGameRequest.KEY_INVITATION_EXPIRY">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.Game.CreateSFSGameRequest.KEY_LEAVE_ROOM">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.Game.CreateSFSGameRequest.KEY_NOTIFY_GAME_STARTED">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.Game.CreateSFSGameRequest.KEY_INVITATION_PARAMS">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Requests.Game.CreateSFSGameRequest.#ctor(Sfs2X.Requests.Game.SFSGameSettings)">
- <summary>
- Creates a new CreateSFSGameRequest instance.
- </summary>
-
- <remarks>
- The instance must be passed to the <see cref="M:Sfs2X.SmartFox.Send(Sfs2X.Requests.IRequest)">SmartFox.Send</see> method for the request to be performed.
- </remarks>
-
- <param name="settings">An object containing the SFSGame configuration settings.</param>
- </member>
- <member name="M:Sfs2X.Requests.Game.CreateSFSGameRequest.Validate(Sfs2X.SmartFox)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Requests.Game.CreateSFSGameRequest.Execute(Sfs2X.SmartFox)">
- <exclude/>
- </member>
- <member name="T:Sfs2X.Requests.Game.InvitationReplyRequest">
- <summary>
- Replies to an invitation received by the current user.
- </summary>
-
- <remarks>
- Users who receive an invitation sent by means of the <see cref="T:Sfs2X.Requests.Game.InviteUsersRequest"/> request can either accept or refuse it using this request.
- The reply causes an <see cref="F:Sfs2X.Core.SFSEvent.INVITATION_REPLY"/> event to be dispatched to the inviter; if a reply is not sent, or it is sent after the invitation expiration,
- the system will react as if the invitation was refused.
- <para/>
- If an error occurs while the reply is delivered to the inviter user (for example the invitation is already expired), an <see cref="F:Sfs2X.Core.SFSEvent.INVITATION_REPLY_ERROR"/> event is returned to the current user.
- </remarks>
-
- <example>
- The following example receives an invitation and accepts it automatically; in a real case scenario, the application interface usually allows the user choosing to accept or refuse the invitation, or even ignore it:
- <code>
- void SomeMethod() {
- sfs.AddEventListener(SFSEvent.INVITATION, OnInvitationReceived);
- sfs.AddEventListener(SFSEvent.INVITATION_REPLY_ERROR, OnInvitationReplyError);
- }
-
- void OnInvitationReceived(BaseEvent evt) {
- // Let's accept this invitation
- sfs.Send( new InvitationReplyRequest((Invitation)evt.Params["invitation"], InvitationReply.ACCEPT) );
- }
-
- void OnInvitationReplyError(BaseEvent evt) {
- Console.WriteLine("Failed to reply to invitation due to the following problem: " + (string)evt.Params["errorMessage"]); // .Net / Unity
- System.Diagnostics.Debug.WriteLine("Failed to reply to invitation due to the following problem: " + (string)evt.Params["errorMessage"]); // Windows Universal
- }
- </code>
- </example>
-
- <seealso cref="F:Sfs2X.Core.SFSEvent.INVITATION_REPLY"/>
- <seealso cref="F:Sfs2X.Core.SFSEvent.INVITATION_REPLY_ERROR"/>
- <seealso cref="T:Sfs2X.Requests.Game.InviteUsersRequest"/>
- </member>
- <member name="F:Sfs2X.Requests.Game.InvitationReplyRequest.KEY_INVITATION_ID">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.Game.InvitationReplyRequest.KEY_INVITATION_REPLY">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.Game.InvitationReplyRequest.KEY_INVITATION_PARAMS">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Requests.Game.InvitationReplyRequest.#ctor(Sfs2X.Entities.Invitation.Invitation,Sfs2X.Entities.Invitation.InvitationReply,Sfs2X.Entities.Data.ISFSObject)">
- <summary>
- Creates a new InvitationReplyRequest instance.
- </summary>
-
- <remarks>
- The instance must be passed to the <see cref="M:Sfs2X.SmartFox.Send(Sfs2X.Requests.IRequest)">SmartFox.Send</see> method for the request to be performed.
- </remarks>
-
- <param name="invitation">An instance of the Invitation class containing the invitation details (inviter, custom parameters, etc).</param>
- <param name="reply">The answer to be sent to the inviter, among those available as constants in the <see cref="T:Sfs2X.Entities.Invitation.InvitationReply"/> class.</param>
- <param name="parameters">An instance of <see cref="T:Sfs2X.Entities.Data.SFSObject"/> containing custom parameters to be returned to the inviter together with the reply (for example a message describing the reason of refusal). Default is <c>null</c>.</param>
-
- <seealso cref="T:Sfs2X.Entities.Invitation.InvitationReply"/>
- </member>
- <member name="M:Sfs2X.Requests.Game.InvitationReplyRequest.#ctor(Sfs2X.Entities.Invitation.Invitation,Sfs2X.Entities.Invitation.InvitationReply)">
- <summary>
- See <em>InvitationReplyRequest(Invitation, InvitationReply, ISFSObject)</em> constructor.
- </summary>
- </member>
- <member name="M:Sfs2X.Requests.Game.InvitationReplyRequest.Validate(Sfs2X.SmartFox)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Requests.Game.InvitationReplyRequest.Execute(Sfs2X.SmartFox)">
- <exclude/>
- </member>
- <member name="T:Sfs2X.Requests.Game.InviteUsersRequest">
- <summary>
- Sends a generic invitation to a list of users.
- </summary>
-
- <remarks>
- Invitations can be used for different purposes, such as requesting users to join a game or visit a specific Room, asking the permission to add them as buddies, etc.
- Invited users receive the invitation as an <see cref="F:Sfs2X.Core.SFSEvent.INVITATION"/> event dispatched to their clients: they can accept or refuse it
- by means of the InvitationReplyRequest request, which must be sent within the specified amount of time.
- </remarks>
-
- <example>
- The following example sends an invitation to join the current user in his private Room; the invitation contains a custom message and the Room name and password, so that the recipient clients can join the Room if the users accept the invitation:
- <code>
- void SomeMethod() {
- // Add a listener to the invitation reply
- sfs.AddEventListener(SFSEvent.INVITATION_REPLY, OnInvitationReply);
-
- // Choose the invitation recipients
- User friend1 = sfs.UserManager.GetUserByName("Piggy");
- User friend2 = sfs.UserManager.GetUserByName("Gonzo");
-
- List<object> invitedUsers = new List<object>();
- invitedUsers.Add(user1);
- invitedUsers.Add(user2);
-
- // Set the custom invitation details
- ISFSObject parameters = new SFSObject();
- parameters.PutUtfString("msg", "Would you like to join me in my private room?");
- parameters.PutUtfString("roomName", "Kermit's room");
- parameters.PutUtfString("roomPwd", "drowssap");
-
- // Send the invitation; recipients have 20 seconds to reply before the invitation expires
- sfs.Send( new InviteUsersRequest(invitedUsers, 20, parameters) );
- }
-
- void OnInvitationReply(BaseEvent evt) {
- // If at least one recipient accepted the invitation, make me join my private Room to meet him there
- if ((InvitationReply)evt.Params["reply"] == InvitationReply.ACCEPT) {
- Room currentRoom = sfs.LastJoinedRoom;
- if (currentRoom.name != "Kermit's room")
- sfs.Send(new JoinRoomRequest("Kermit's room"));
- }
- else ((InvitationReply)evt.Params["reply"] == InvitationReply.REFUSE) {
- Console.WriteLine((User)evt.Params["invitee"] + " refused the invitation"); // .Net / Unity
- System.Diagnostics.Debug.WriteLine((User)evt.Params["invitee"] + " refused the invitation"); // Windows Universal
- }
- }
- </code>
- </example>
-
- <seealso cref="F:Sfs2X.Core.SFSEvent.INVITATION"/>
- <seealso cref="T:Sfs2X.Requests.Game.InvitationReplyRequest"/>
- </member>
- <member name="F:Sfs2X.Requests.Game.InviteUsersRequest.KEY_USER">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.Game.InviteUsersRequest.KEY_USER_ID">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.Game.InviteUsersRequest.KEY_INVITATION_ID">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.Game.InviteUsersRequest.KEY_TIME">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.Game.InviteUsersRequest.KEY_PARAMS">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.Game.InviteUsersRequest.KEY_INVITEE_ID">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.Game.InviteUsersRequest.KEY_INVITED_USERS">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.Game.InviteUsersRequest.KEY_REPLY_ID">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.Game.InviteUsersRequest.MAX_INVITATIONS_FROM_CLIENT_SIDE">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.Game.InviteUsersRequest.MIN_EXPIRY_TIME">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.Game.InviteUsersRequest.MAX_EXPIRY_TIME">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Requests.Game.InviteUsersRequest.#ctor(System.Collections.Generic.List{System.Object},System.Int32,Sfs2X.Entities.Data.ISFSObject)">
- <summary>
- Creates a new InviteUsersRequest instance.
- </summary>
-
- <remarks>
- The instance must be passed to the <see cref="M:Sfs2X.SmartFox.Send(Sfs2X.Requests.IRequest)">SmartFox.Send</see> method for the request to be performed.
- </remarks>
-
- <param name="invitedUsers">A list of objects representing the users to send the invitation to.</param>
- <param name="secondsForReply">The number of seconds available to each invited user to reply to the invitation (recommended range: 15 to 40 seconds).</param>
- <param name="parameters">An instance of <see cref="T:Sfs2X.Entities.Data.SFSObject"/> containing custom parameters which specify the invitation details.</param>
- </member>
- <member name="M:Sfs2X.Requests.Game.InviteUsersRequest.Validate(Sfs2X.SmartFox)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Requests.Game.InviteUsersRequest.Execute(Sfs2X.SmartFox)">
- <exclude/>
- </member>
- <member name="T:Sfs2X.Requests.Game.QuickJoinGameRequest">
- <summary>
- Quickly joins the current user in a public game.
- </summary>
-
- <remarks>
- By providing a matching expression and a list of Rooms or Groups, SmartFoxServer can search for a matching public Game Room and immediately join the user into that Room as a player.
- <para/>
- If a game could be found and joined, the <see cref="F:Sfs2X.Core.SFSEvent.ROOM_JOIN"/> event is dispatched to the requester's client.
- </remarks>
-
- <example>
- The following example makes the user quickly join a public game:
- <code>
- void SomeMethod() {
- sfs.AddEventListener(SFSEvent.ROOM_JOIN, onRoomJoin);
-
- // Create a matching expression to find a Darts game with a "maxBet" variable less than 100
- MatchExpression exp = new MatchExpression("type", StringMatch.EQUALS, "Darts").And("maxBet", NumberMatch.LESS_THAN, 100);
-
- // Search and join a public game within the "games" Group, leaving the last joined Room
- sfs.Send( new QuickJoinGameRequest(exp, new List<string>(){"games"}, sfs.LastJoinedRoom) );
- }
-
- void OnRoomJoin(BaseEvent evt) {
- Console.WriteLine("Successfully joined Room: " + (Room)evt.Params["room"]); // .Net / Unity
- System.Diagnostics.Debug.WriteLine("Successfully joined Room: " + (Room)evt.Params["room"]); // Windows Universal
- }
- </code>
- </example>
-
- <seealso cref="F:Sfs2X.Core.SFSEvent.ROOM_JOIN"/>
- <seealso cref="T:Sfs2X.Entities.Match.MatchExpression"/>
- </member>
- <member name="F:Sfs2X.Requests.Game.QuickJoinGameRequest.KEY_ROOM_LIST">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.Game.QuickJoinGameRequest.KEY_GROUP_LIST">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.Game.QuickJoinGameRequest.KEY_ROOM_TO_LEAVE">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.Game.QuickJoinGameRequest.KEY_MATCH_EXPRESSION">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Requests.Game.QuickJoinGameRequest.#ctor(Sfs2X.Entities.Match.MatchExpression,System.Collections.Generic.List{System.String},Sfs2X.Entities.Room)">
- <summary>
- Creates a new QuickJoinGameRequest instance.
- </summary>
-
- <remarks>
- The instance must be passed to the <see cref="M:Sfs2X.SmartFox.Send(Sfs2X.Requests.IRequest)">SmartFox.Send</see> method for the request to be performed.
- </remarks>
-
- <param name="matchExpression">A matching expression that the system will use to search a Game Room where to join the current user.</param>
- <param name="whereToSearch">A list of Group names to which the matching expression should be applied. The maximum number of elements in this list is 32.</param>
- <param name="roomToLeave">An object representing the Room that the user should leave when joining the game. Default is <c>null</c>.</param>
- </member>
- <member name="M:Sfs2X.Requests.Game.QuickJoinGameRequest.#ctor(Sfs2X.Entities.Match.MatchExpression,System.Collections.Generic.List{System.String})">
- <summary>
- See <em>QuickJoinGameRequest(MatchExpression, List<string>, Room)</em> constructor.
- </summary>
- </member>
- <member name="M:Sfs2X.Requests.Game.QuickJoinGameRequest.#ctor(Sfs2X.Entities.Match.MatchExpression,System.Collections.Generic.List{Sfs2X.Entities.Room},Sfs2X.Entities.Room)">
- <summary>
- Creates a new QuickJoinGameRequest instance.
- </summary>
-
- <remarks>
- The instance must be passed to the <see cref="M:Sfs2X.SmartFox.Send(Sfs2X.Requests.IRequest)">SmartFox.Send</see> method for the request to be performed.
- </remarks>
-
- <param name="matchExpression">A matching expression that the system will use to search a Game Room where to join the current user.</param>
- <param name="whereToSearch">A list of Room objects to which the matching expression should be applied. The maximum number of elements in this list is 32.</param>
- <param name="roomToLeave">An object representing the Room that the user should leave when joining the game. Default is <c>null</c>.</param>
- </member>
- <member name="M:Sfs2X.Requests.Game.QuickJoinGameRequest.#ctor(Sfs2X.Entities.Match.MatchExpression,System.Collections.Generic.List{Sfs2X.Entities.Room})">
- <summary>
- See <em>QuickJoinGameRequest(MatchExpression, List<Room>, Room)</em> constructor.
- </summary>
- </member>
- <member name="M:Sfs2X.Requests.Game.QuickJoinGameRequest.Validate(Sfs2X.SmartFox)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Requests.Game.QuickJoinGameRequest.Execute(Sfs2X.SmartFox)">
- <exclude/>
- </member>
- <member name="T:Sfs2X.Requests.Game.SFSGameSettings">
- <summary>
- The SFSGameSettings class is a container for the settings required to create a Game Room using the CreateSFSGameRequest request.
- </summary>
-
- <remarks>
- On the server-side, a Game Room is represented by the <em>SFSGame</em> Java class which extends the <see cref="T:Sfs2X.Entities.Room"/> class providing new advanced features such as player matching,
- game invitations, public and private games, quick game joining, etc. On the client side Game Rooms are regular Rooms with their <see cref="P:Sfs2X.Entities.Room.IsGame">Room.IsGame</see> property set to true.
- </remarks>
-
- <seealso cref="T:Sfs2X.Requests.Game.CreateSFSGameRequest"/>
- </member>
- <member name="M:Sfs2X.Requests.Game.SFSGameSettings.#ctor(System.String)">
- <summary>
- Creates a new SFSGameSettings instance.
- </summary>
-
- <remarks>
- The instance must be passed to the <see cref="T:Sfs2X.Requests.Game.CreateSFSGameRequest"/> class constructor.
- </remarks>
-
- <param name="name">The name of the Game Room to be created.</param>
-
- <seealso cref="T:Sfs2X.Requests.Game.CreateSFSGameRequest"/>
- </member>
- <member name="P:Sfs2X.Requests.Game.SFSGameSettings.IsPublic">
- <summary>
- Indicates whether the game is public or private.
- </summary>
-
- <remarks>
- A public game can be joined by any player whose User Variables match the <see cref="P:Sfs2X.Requests.Game.SFSGameSettings.PlayerMatchExpression"/> assigned to the Game Room.
- A private game can be joined by users invited by the game creator by means of <see cref="P:Sfs2X.Requests.Game.SFSGameSettings.InvitedPlayers"/> list.
- <para/>
- The default value is <c>true</c>.
- </remarks>
- </member>
- <member name="P:Sfs2X.Requests.Game.SFSGameSettings.MinPlayersToStartGame">
- <summary>
- Defines the minimum number of players required to start the game.
- </summary>
-
- <remarks>
- If the <see cref="P:Sfs2X.Requests.Game.SFSGameSettings.NotifyGameStarted"/> property is set to <c>true</c>, when this number is reached, the game start is notified.
- <para/>
- The default value is <c>2</c>.
- </remarks>
- </member>
- <member name="P:Sfs2X.Requests.Game.SFSGameSettings.InvitedPlayers">
- <summary>
- In private games, defines a list of User objects representing players to be invited to join the game.
- </summary>
-
- <remarks>
- If the invitations are less than the minimum number of players required to start the game (see the <see cref="P:Sfs2X.Requests.Game.SFSGameSettings.MinPlayersToStartGame"/> property),
- the server will send additional invitations automatically, searching users in the Room Groups specified in the <see cref="P:Sfs2X.Requests.Game.SFSGameSettings.SearchableRooms"/> list
- and filtering them by means of the object passed to the <see cref="P:Sfs2X.Requests.Game.SFSGameSettings.PlayerMatchExpression"/> property.
- <para/>
- The game matching criteria contained in the <see cref="P:Sfs2X.Requests.Game.SFSGameSettings.PlayerMatchExpression"/> property do not apply to the users specified in this list.
- <para/>
- The default value is <c>null</c>.
- </remarks>
- </member>
- <member name="P:Sfs2X.Requests.Game.SFSGameSettings.SearchableRooms">
- <summary>
- In private games, defines a list of Groups names where to search players to invite.
- </summary>
-
- <remarks>
- If the users invited to join the game (specified through the <see cref="P:Sfs2X.Requests.Game.SFSGameSettings.InvitedPlayers"/> property) are less than the minimum number of players
- required to start the game (see the <see cref="P:Sfs2X.Requests.Game.SFSGameSettings.MinPlayersToStartGame"/> property), the server will invite others automatically,
- searching them in Rooms belonging to the Groups specified in this list and filtering them by means of the object passed to the <see cref="P:Sfs2X.Requests.Game.SFSGameSettings.PlayerMatchExpression"/> property.
- <para/>
- The default value is <c>null</c>.
- </remarks>
- </member>
- <member name="P:Sfs2X.Requests.Game.SFSGameSettings.InvitationExpiryTime">
- <summary>
- In private games, defines the number of seconds that the users invited to join the game have to reply to the invitation.
- </summary>
-
- <remarks>
- The suggested range is 10 to 40 seconds. Default value is <c>15</c>.
- </remarks>
- </member>
- <member name="P:Sfs2X.Requests.Game.SFSGameSettings.LeaveLastJoinedRoom">
- <summary>
- In private games, indicates whether the players must leave the previous Room when joining the game or not.
- </summary>
-
- <remarks>
- This setting applies to private games only because users join the Game Room automatically when they accept the invitation to play,
- while public games require a <see cref="T:Sfs2X.Requests.JoinRoomRequest"/> request to be sent, where this behavior can be determined manually.
- <para/>
- The default value is <c>true</c>.
- </remarks>
- </member>
- <member name="P:Sfs2X.Requests.Game.SFSGameSettings.NotifyGameStarted">
- <summary>
- Indicates if a game state change must be notified when the minimum number of players is reached.
- </summary>
-
- <remarks>
- If this setting is true, the game state (started or stopped) is handled by means of the reserved Room Variable represented by the <see cref="F:Sfs2X.Entities.Variables.ReservedRoomVariables.RV_GAME_STARTED">ReservedRoomVariables.RV_GAME_STARTED</see> constant.
- Listening to the <see cref="F:Sfs2X.Core.SFSEvent.ROOM_VARIABLES_UPDATE"/> event for this variable allows clients to be notified when the game can start due to minimum number of players being reached.
- <para/>
- As the used Room Variable is created as <em>global</em> (see the <see cref="T:Sfs2X.Entities.Variables.SFSRoomVariable"/> class description), its update is broadcast outside the Room too:
- this can be used on the client-side, for example, to show the game state in a list of available games.
- <para/>
- The default value is <c>false</c>.
- </remarks>
- </member>
- <member name="P:Sfs2X.Requests.Game.SFSGameSettings.PlayerMatchExpression">
- <summary>
- Defines the game matching expression to be used to filters players.
- </summary>
-
- <remarks>
- Filtering is applied when:
- <ol>
- <li>users try to join a public Game Room as players (their User Variables must match the matching criteria);</li>
- <li>the server selects additional users to be invited to join a private game (see the <see cref="P:Sfs2X.Requests.Game.SFSGameSettings.SearchableRooms"/> property).</li>
- </ol>
- Filtering is not applied to users invited by the creator to join a private game (see the <see cref="P:Sfs2X.Requests.Game.SFSGameSettings.InvitedPlayers"/> property).
- <para/>
- The default value is <c>null</c>.
- </remarks>
- <seealso cref="P:Sfs2X.Requests.Game.SFSGameSettings.SpectatorMatchExpression"/>
- </member>
- <member name="P:Sfs2X.Requests.Game.SFSGameSettings.SpectatorMatchExpression">
- <summary>
- Defines the game matching expression to be used to filters spectators.
- </summary>
-
- <remarks>
- Filtering is applied when users try to join a public Game Room as spectators (their User Variables must match the matching criteria).
- <para/>
- The default value is <c>null</c>.
- </remarks>
-
- <seealso cref="P:Sfs2X.Requests.Game.SFSGameSettings.PlayerMatchExpression"/>
- </member>
- <member name="P:Sfs2X.Requests.Game.SFSGameSettings.InvitationParams">
- <summary>
- In private games, defines an optional object containing additional custom parameters to be sent together with the invitation.
- </summary>
-
- <remarks>
- This object must be an instance of <see cref="T:Sfs2X.Entities.Data.SFSObject"/>. Possible custom parameters to be transferred to the invitees are a message
- for the recipient, the game details (title, type...), the inviter details, etc.
- <para/>
- The default value is <c>null</c>.
- </remarks>
- </member>
- <member name="T:Sfs2X.Requests.Game.JoinRoomInvitationRequest">
- <summary>
- Sends an invitation to other users/players to join a specific Room.
- </summary>
-
- <remarks>
- Invited users receive the invitation as an <see cref="F:Sfs2X.Core.SFSEvent.INVITATION"/> event dispatched to their clients: they can accept or refuse it
- by means of the InvitationReplyRequest request, which must be sent within the specified amount of time.
- <para/>
- Depending on the Room's settings this invitation can be sent by the Room's owner only or by any other user.
- This behavior can be set via the RoomSettings.AllowOwnerOnlyInvitation parameter.
- <para/>
- <b>NOTE:</b> spectators in a Game Room are not allowed to invite other users; only players are.
- <para/>
- An invitation can also specify the amount of time given to each invitee to reply. Default is 30 seconds.
- A positive answer will attempt to join the user in the designated Room. For Game Rooms the <em>asSpectator</em> flag can be toggled to join the invitee as player or spectator (default = player).
- <para/>
- There aren't any specific notifications sent back to the inviter after the invitee's response. Users that have accepted the invitation will join the Room while those who didn't reply or turned down the invitation won't generate any event.
- In order to send specific messages (e.g. chat), just send a private message back to the inviter.
- </remarks>
-
- <example>
- The following example invites two more users in the current game:
- <code>
- void SomeMethod() {
- sfs.AddEventListener(SFSEvent.USER_ENTER_ROOM, onUserJoin);
-
- List<string> invitedUsers = new List<string>(){"Fozzie", "Piggy"};
- Room room = sfs.GetRoomByName("The Garden");
-
- // Add message to be shown to the invited users
- ISFSObject params = SFSObject.NewInstance();
- params.PutUtfString("msg", "You are invited in this Room: " + room.Name);
-
- // Send the request
- sfs.Send( new JoinRoomInvitationRequest(room, invitedUsers, params) );
- }
-
- void onUserJoin(BaseEvent evt) {
- User user = (User)evt.Params["user"];
-
- Console.WriteLine("Room joined by: " + user.Name); // .Net / Unity
- System.Diagnostics.Debug.WriteLine("Room joined by: " + user.Name); // Windows Universal
- }
- </code>
- </example>
-
- <seealso cref="T:Sfs2X.Requests.RoomSettings"/>
- </member>
- <member name="F:Sfs2X.Requests.Game.JoinRoomInvitationRequest.KEY_ROOM_ID">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.Game.JoinRoomInvitationRequest.KEY_EXPIRY_SECONDS">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.Game.JoinRoomInvitationRequest.KEY_INVITED_NAMES">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.Game.JoinRoomInvitationRequest.KEY_AS_SPECT">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.Game.JoinRoomInvitationRequest.KEY_OPTIONAL_PARAMS">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Requests.Game.JoinRoomInvitationRequest.#ctor(Sfs2X.Entities.Room,System.Collections.Generic.List{System.String},Sfs2X.Entities.Data.ISFSObject,System.Int32,System.Boolean)">
- <summary>
- Creates a new JoinRoomInvitationRequest instance.
- </summary>
-
- <remarks>
- The instance must be passed to the <see cref="M:Sfs2X.SmartFox.Send(Sfs2X.Requests.IRequest)">SmartFox.Send</see> method for the request to be performed.
- </remarks>
-
- <param name="targetRoom">The Room to join (must have free user/player slots).</param>
- <param name="invitedUserNames">A list of user names to invite.</param>
- <param name="parameters">An instance of <see cref="T:Sfs2X.Entities.Data.SFSObject"/> containing any relevant parameter or message to be sent to the invited users (for example an invitation message). Default is <c>null</c>.</param>
- <param name="expirySeconds">The time given to the invitee to reply to the invitation. Default is 30.</param>
- <param name="asSpectator">In Game Rooms only, indicates if the invited user(s) should join as spectator(s) instead of player(s). Default is <c>false</c>.</param>
- </member>
- <member name="M:Sfs2X.Requests.Game.JoinRoomInvitationRequest.#ctor(Sfs2X.Entities.Room,System.Collections.Generic.List{System.String},Sfs2X.Entities.Data.ISFSObject,System.Int32)">
- <summary>
- See <em>JoinRoomInvitationRequest(Room, List<string>, ISFSObject, int, bool)</em> constructor.
- </summary>
- </member>
- <member name="M:Sfs2X.Requests.Game.JoinRoomInvitationRequest.#ctor(Sfs2X.Entities.Room,System.Collections.Generic.List{System.String},Sfs2X.Entities.Data.ISFSObject)">
- <summary>
- See <em>JoinRoomInvitationRequest(Room, List<string>, ISFSObject, int, bool)</em> constructor.
- </summary>
- </member>
- <member name="M:Sfs2X.Requests.Game.JoinRoomInvitationRequest.#ctor(Sfs2X.Entities.Room,System.Collections.Generic.List{System.String})">
- <summary>
- See <em>JoinRoomInvitationRequest(Room, List<string>, ISFSObject, int, bool)</em> constructor.
- </summary>
- </member>
- <member name="M:Sfs2X.Requests.Game.JoinRoomInvitationRequest.Validate(Sfs2X.SmartFox)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Requests.Game.JoinRoomInvitationRequest.Execute(Sfs2X.SmartFox)">
- <exclude/>
- </member>
- <member name="T:Sfs2X.Requests.MMO.MMORoomSettings">
- <summary>
- The MMORoomSettings class is a container for the settings required to create an MMORoom using the CreateRoomRequest request.
- </summary>
-
- <seealso cref="T:Sfs2X.Requests.CreateRoomRequest"/>
- <seealso cref="T:Sfs2X.Entities.MMORoom"/>
- </member>
- <member name="M:Sfs2X.Requests.MMO.MMORoomSettings.#ctor(System.String)">
- <summary>
- Creates a new MMORoomSettings instance.
- </summary>
-
- <remarks>
- The instance must be passed to the <see cref="T:Sfs2X.Requests.CreateRoomRequest"/> class constructor.
- </remarks>
-
- <param name="name">The name of the MMORoom to be created.</param>
-
- <seealso cref="T:Sfs2X.Requests.CreateRoomRequest"/>
- </member>
- <member name="P:Sfs2X.Requests.MMO.MMORoomSettings.DefaultAOI">
- <summary>
- Defines the Area of Interest (AoI) for the MMORoom.
- </summary>
-
- <remarks>
- This value represents the area/range around the user that will be affected by server events and other users events.
- It is represented by a <em>Vec3D</em> object providing 2D or 3D coordinates.
- <para/>
- Setting this value is mandatory.
- </remarks>
-
- <example>
- A <c>Vec3D(50,50)</c> describes a range of 50 units (e.g. pixels) in all four directions (top, bottom, left, right) with respect to the user position in a 2D coordinates system.
-
- A <c>Vec3D(120,120,60)</c> describes a range of 120 units in all four directions (top, bottom, left, right) and 60 units along the two Z-axis directions (backward, forward) with respect to the user position in a 3D coordinates system.
- </example>
- </member>
- <member name="P:Sfs2X.Requests.MMO.MMORoomSettings.MapLimits">
- <summary>
- Defines the limits of the virtual environment represented by the MMORoom.
- </summary>
-
- <remarks>
- When specified, this property must contain two non-null <em>Vec3D</em> objects representing the minimum and maximum limits of the 2D/3D coordinates systems.
- Any positional value that falls outside the provided limit will be refused by the server.
- <para/>
- This setting is optional but its usage is highly recommended.
- </remarks>
- </member>
- <member name="P:Sfs2X.Requests.MMO.MMORoomSettings.UserMaxLimboSeconds">
- <summary>
- Defines the time limit before a user without a physical position set inside the MMORoom is kicked from the Room.
- </summary>
-
- <remarks>
- As soon as the MMORoom is joined, the user still doesn't have a physical position set in the coordinates system, therefore it is
- considered in a "limbo" state. At this point the user is expected to set his position (via the <see cref="T:Sfs2X.Requests.MMO.SetUserPositionRequest"/> request) within the amount of seconds expressed by this value.
- <para/>
- The default value is <c>50</c> seconds.
- </remarks>
- </member>
- <member name="P:Sfs2X.Requests.MMO.MMORoomSettings.ProximityListUpdateMillis">
- <summary>
- Configures the speed at which the PROXIMITY_LIST_UPDATE event is sent by the server.
- </summary>
-
- <remarks>
- In an MMORoom, the regular users list is replaced by a proximity list, which keeps an updated view of the users currently within the Area of Interest
- of the current user. The speed at which these updates are fired by the server is regulated by this parameter, which sets the minimum time between two subsequent updates.
- <para/>
- The default value is <c>250</c> milliseconds.
- <para/>
- <b>NOTE:</b> values below the default might be unnecessary for most applications unless they are in realtime.
- </remarks>
-
- <seealso cref="F:Sfs2X.Core.SFSEvent.PROXIMITY_LIST_UPDATE"/>
- </member>
- <member name="P:Sfs2X.Requests.MMO.MMORoomSettings.SendAOIEntryPoint">
- <summary>
- Sets if the users entry points in the current user's Area of Interest should be transmitted in the PROXIMITY_LIST_UPDATE event.
- </summary>
-
- <remarks>
- If this setting is set to <c>true</c>, when a user enters the AoI of another user, the server will also send the coordinates
- at which the former "appeared" within the AoI. This option should be turned off in case these coordinates are not needed, in order to save bandwidth.
- <para/>
- The default value is <c>true</c>.
- </remarks>
-
- <seealso cref="P:Sfs2X.Entities.User.AOIEntryPoint"/>
- <seealso cref="P:Sfs2X.Entities.MMOItem.AOIEntryPoint"/>
- <seealso cref="F:Sfs2X.Core.SFSEvent.PROXIMITY_LIST_UPDATE"/>
- </member>
- <member name="T:Sfs2X.Requests.MMO.MapLimits">
- <summary>
- The MapLimits class is used to set the limits of the virtual environment represented by an MMORoom when creating it.
- </summary>
-
- <remarks>
- The limits represent the minimum and maximum coordinate values (2D or 3D) that the MMORoom should expect.
- </remarks>
-
- <seealso cref="T:Sfs2X.Requests.MMO.MMORoomSettings"/>
- <seealso cref="T:Sfs2X.Entities.MMORoom"/>
- <seealso cref="T:Sfs2X.Entities.Data.Vec3D"/>
- </member>
- <member name="M:Sfs2X.Requests.MMO.MapLimits.#ctor(Sfs2X.Entities.Data.Vec3D,Sfs2X.Entities.Data.Vec3D)">
- <summary>
- Creates a new MapLimits instance.
- </summary>
-
- <remarks>
- The <see cref="P:Sfs2X.Requests.MMO.MMORoomSettings.MapLimits"/> property must be set to this instance during the MMORoom creation.
- </remarks>
-
- <param name="lowerLimit">The lower coordinates limit of the virtual environment along the X,Y,Z axes.</param>
- <param name="higherLimit">The higher coordinates limit of the virtual environment along the X,Y,Z axes.</param>
- </member>
- <member name="P:Sfs2X.Requests.MMO.MapLimits.LowerLimit">
- <summary>
- Returns the lower coordinates limit of the virtual environment along the X,Y,Z axes.
- </summary>
- </member>
- <member name="P:Sfs2X.Requests.MMO.MapLimits.HigherLimit">
- <summary>
- Returns the higher coordinates limit of the virtual environment along the X,Y,Z axes.
- </summary>
- </member>
- <member name="T:Sfs2X.Requests.MMO.SetMMOItemVariables">
- <exclude/>
- </member>
- <member name="T:Sfs2X.Requests.MMO.SetUserPositionRequest">
- <summary>
- Updates the User position inside an MMORoom.
- </summary>
-
- <remarks>
- MMORooms represent virtual environments and can host any number of users. Based on their position, the system allows users within a certain range
- from each other (Area of Interest, or AoI) to interact.
- <para/>
- This request allows the current user to update his position inside the MMORoom, which in turn will trigger a
- <see cref="F:Sfs2X.Core.SFSEvent.PROXIMITY_LIST_UPDATE">PROXIMITY_LIST_UPDATE</see> event for all users that fall within his AoI.
- </remarks>
-
- <example>
- The following example changes the position of the user in a 2D coordinates space and handles the related event:
- <code>
- private void UpdatePlayerPosition(int px, int py)
- {
- var newPos = new Vec3D(px, py);
- sfs.send(new SetUserPositionRequest(newPos));
- }
-
- private void OnProximityListUpdate(BaseEvent evt)
- {
- var added = (List<User>) evt.params["addedUsers"];
- var removed = (List<User>) evt.params["removedUsers"];
-
- // Add users that entered the proximity list
- foreach (User user in added)
- {
- // Obtain the coordinates at which the user "appeared" in our range
- Vec3D entryPoint = user.AoiEntryPoint;
-
- // Add new avatar in the scene
- var avatarSprite = new AvatarSprite();
- avatarSprite.x = entryPoint.px;
- avatarSprite.y = entryPoint.py;
- ...
- }
-
- // Remove users that left the proximity list
- foreach (User user in removed)
- {
- // Remove the avatar from the scene
- ...
- }
- }
- </code>
- </example>
-
- <seealso cref="F:Sfs2X.Core.SFSEvent.PROXIMITY_LIST_UPDATE"/>
- <seealso cref="T:Sfs2X.Entities.MMORoom"/>
- </member>
- <member name="F:Sfs2X.Requests.MMO.SetUserPositionRequest.KEY_ROOM">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.MMO.SetUserPositionRequest.KEY_VEC3D">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.MMO.SetUserPositionRequest.KEY_PLUS_USER_LIST">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.MMO.SetUserPositionRequest.KEY_MINUS_USER_LIST">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.MMO.SetUserPositionRequest.KEY_PLUS_ITEM_LIST">
- <exclude/>
- </member>
- <member name="F:Sfs2X.Requests.MMO.SetUserPositionRequest.KEY_MINUS_ITEM_LIST">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Requests.MMO.SetUserPositionRequest.#ctor(Sfs2X.Entities.Data.Vec3D,Sfs2X.Entities.Room)">
- <summary>
- Creates a new SetUserPositionRequest instance.
- </summary>
-
- <remarks>
- The instance must be passed to the <see cref="M:Sfs2X.SmartFox.Send(Sfs2X.Requests.IRequest)">SmartFox.Send</see> method for the request to be performed.
- </remarks>
-
- <param name="position">The user position.</param>
- <param name="room">The <em>MMORoom</em> object corresponding to the Room where the position should be set; if <c>null</c>, the last Room joined by the user is used.</param>
- </member>
- <member name="M:Sfs2X.Requests.MMO.SetUserPositionRequest.#ctor(Sfs2X.Entities.Data.Vec3D)">
- <summary>
- See <em>SetUserPositionRequest(Vec3D, Room)</em> constructor.
- </summary>
- </member>
- <member name="M:Sfs2X.Requests.MMO.SetUserPositionRequest.Validate(Sfs2X.SmartFox)">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Requests.MMO.SetUserPositionRequest.Execute(Sfs2X.SmartFox)">
- <exclude/>
- </member>
- <member name="T:Sfs2X.Util.BuddyOnlineState">
- <summary>
- Provide information on the Online Status of the Buddy.
- </summary>
-
- <exclude/>
- </member>
- <member name="F:Sfs2X.Util.BuddyOnlineState.ONLINE">
- <summary>
- The Buddy is online.
- </summary>
- </member>
- <member name="F:Sfs2X.Util.BuddyOnlineState.OFFLINE">
- <summary>
- The Buddy is offline in the Buddy List system.
- </summary>
- </member>
- <member name="F:Sfs2X.Util.BuddyOnlineState.LEFT_THE_SERVER">
- <summary>
- The Buddy left the server.
- </summary>
- </member>
- <member name="T:Sfs2X.Util.ClientDisconnectionReason">
- <summary>
- The ClientDisconnectionReason class contains the costants describing the possible reasons why a disconnection from the server occurred.
- </summary>
- </member>
- <member name="F:Sfs2X.Util.ClientDisconnectionReason.IDLE">
- <summary>
- Client was disconnected because it was idle for too long.
- </summary>
-
- <remarks>
- The connection timeout depends on the server settings.
- </remarks>
- </member>
- <member name="F:Sfs2X.Util.ClientDisconnectionReason.KICK">
- <summary>
- Client was kicked out of the server.
- </summary>
-
- <remarks>
- Kicking can occur automatically (i.e. for swearing, if the words filter is active) or due to the intervention of a user with enough privileges (i.e. an administrator or a moderator).
- </remarks>
- </member>
- <member name="F:Sfs2X.Util.ClientDisconnectionReason.BAN">
- <summary>
- Client was banned from the server.
- </summary>
-
- <remarks>
- Banning can occur automatically (i.e. for flooding, if the flood filter is active) or due to the intervention of a user with enough privileges (i.e. an administrator or a moderator).
- </remarks>
- </member>
- <member name="F:Sfs2X.Util.ClientDisconnectionReason.MANUAL">
- <summary>
- The client manually disconnected from the server.
- </summary>
-
- <remarks>
- The <see cref="M:Sfs2X.SmartFox.Disconnect"/> method on the <em>SmartFox</em> class was called.
- </remarks>
- </member>
- <member name="F:Sfs2X.Util.ClientDisconnectionReason.UNKNOWN">
- <summary>
- A generic network error occurred, and the client is unable to determine the cause of the disconnection.
- </summary>
-
- <remarks>
- The server-side log should be checked for possible error messages or warnings.
- </remarks>
- </member>
- <member name="M:Sfs2X.Util.ClientDisconnectionReason.GetReason(System.Int32)">
- <exclude/>
- </member>
- <member name="T:Sfs2X.Util.ConfigData">
- <summary>
- The ConfigData class stores the client configuration data loaded from an external XML file or passed directly to the deputy connect method.
- </summary>
-
- <remarks>
- The external configuration file is loaded by the <em>SmartFox</em> class when its <see cref="M:Sfs2X.SmartFox.LoadConfig">SmartFox.LoadConfig()</see> method is called.
- Otherwise it can be passed directly to one of the <see cref="M:Sfs2X.SmartFox.Connect(Sfs2X.Util.ConfigData)">SmartFox.Connect(ConfigData)</see> method overloads of the <em>SmartFox</em> class.
- </remarks>
-
- <seealso cref="P:Sfs2X.SmartFox.Config"/>
- </member>
- <member name="M:Sfs2X.Util.ConfigData.#ctor">
- <summary>
- Creates a new ConfigData instance.
- </summary>
- </member>
- <member name="P:Sfs2X.Util.ConfigData.Host">
- <summary>
- Specifies the IP address or host name of the SmartFoxServer 2X instance to connect to (TCP connection).
- </summary>
-
- <remarks>
- The default value is <c>127.0.0.1</c>.
- <para/>
- When using a websocket connection to an IPv6 address, always wrap the address in square brackets.
- </remarks>
- </member>
- <member name="P:Sfs2X.Util.ConfigData.Port">
- <summary>
- Specifies the TCP port of the SmartFoxServer 2X instance to connect to (TCP connection).
- </summary>
-
- <remarks>
- The default value is <c>9933</c>.
- </remarks>
- </member>
- <member name="P:Sfs2X.Util.ConfigData.UdpHost">
- <summary>
- Specifies the IP address of the SmartFoxServer 2X instance to connect to (UDP connection).
- </summary>
-
- <remarks>
- The default value is <c>127.0.0.1</c>.
- </remarks>
- </member>
- <member name="P:Sfs2X.Util.ConfigData.UdpPort">
- <summary>
- Specifies the UDP port of the SmartFoxServer 2X instance to connect to (UDP connection).
- </summary>
-
- <remarks>
- The default value is <c>9933</c>.
- </remarks>
- </member>
- <member name="P:Sfs2X.Util.ConfigData.Zone">
- <summary>
- Specifies the Zone of the SmartFoxServer 2X instance to join.
- </summary>
-
- <remarks>
- The default value is <c>null</c>.
- </remarks>
- </member>
- <member name="P:Sfs2X.Util.ConfigData.Debug">
- <summary>
- Indicates whether the client-server messages debug should be enabled or not.
- </summary>
-
- <remarks>
- The default value is <c>false</c>.
- </remarks>
- </member>
- <member name="P:Sfs2X.Util.ConfigData.HttpPort">
- <summary>
- Specifies the port for generic HTTP communication.
- </summary>
-
- <remarks>
- The default value is <c>8080</c>.
- </remarks>
- </member>
- <member name="P:Sfs2X.Util.ConfigData.HttpsPort">
- <summary>
- Specifies the port for HTTPS communication.
- </summary>
-
- <remarks>
- For example this parameter is required during the initialization of an encrypted connection.
- The default value is <c>8443</c>.
- </remarks>
- </member>
- <member name="P:Sfs2X.Util.ConfigData.UseBlueBox">
- <summary>
- Indicates whether the SmartFoxServer's BlueBox should be enabled or not.
- </summary>
-
- <remarks>
- The default value is <c>true</c>.
- </remarks>
- </member>
- <member name="P:Sfs2X.Util.ConfigData.BlueBoxPollingRate">
- <summary>
- Specifies the BlueBox polling speed.
- </summary>
-
- <remarks>
- The default value is <c>750</c>.
- </remarks>
- </member>
- <member name="P:Sfs2X.Util.ConfigData.TcpNoDelay">
- <summary>
- Indicates whether SmartFoxServer's TCP socket is using the Nagle algorithm or not.
- </summary>
-
- <remarks>
- This setting must be <c>false</c> to use the Nagle algorithm; otherwise, <c>true</c>.
- The default value is <c>false</c>.
- </remarks>
- </member>
- <member name="T:Sfs2X.Util.ConfigLoader">
- <exclude/>
- </member>
- <member name="M:Sfs2X.Util.ConfigLoader.LoadConfig(System.String)">
- <summary>
- By default load a file called sfs-config.xml located in the same folder of the application
- </summary>
- <param name="filePath">
- Path to config file
- </param>
- </member>
- <member name="T:Sfs2X.Util.PasswordUtil">
- <summary>
- Helper class for logging in with a pre-hashed password.
- </summary>
-
- <remarks>
- This is needed if your server-side database stores User passwords hashed with MD5.
- <para/>
- For more information see the <see href="http://docs2x.smartfoxserver.com/DevelopmentBasics/signup-assistant-basics" target="_blank">Sign Up Assistant component tutorial</see> (<b>Password Mode</b> section).
- </remarks>
- </member>
- <member name="M:Sfs2X.Util.PasswordUtil.MD5Password(System.String)">
- <summary>
- Generates the MD5 hash of the user password.
- </summary>
-
- <param name="pass">The plain text password.</param>
-
- <returns>The hashed password.</returns>
-
- <example>
- <code>
- string userName = "testName";
- string userPass = "testPass";
-
- string md5Pass = PasswordUtil.MD5Password(userPass);
- sfs.Send(new LoginRequest(userName, md5Pass, sfs.Config.Zone));
- </code>
- </example>
- </member>
- <member name="T:Sfs2X.Util.SFSErrorCodes">
- <summary>
- The SFSErrorCodes class provides a mean of translation between server error codes and their relative error messages.
- </summary>
-
- <remarks>
- Error messages are provided by default in the English language but they can be localized and substituted in any other language.
- The error messages contain special placeholders that are processed at runtime and substituted with runtime data.
- They are in the form of a number enclosed in curly brackets such as: {0}, {1}, etc. Please make sure you maintain these placeholders while translating the messages.
- <para/>
- For more informations please visit this link: <see href="http://docs2x.smartfoxserver.com/AdvancedTopics/client-error-messages" target="_blank">http://docs2x.smartfoxserver.com/AdvancedTopics/client-error-messages</see>.
- </remarks>
- </member>
- <member name="M:Sfs2X.Util.SFSErrorCodes.SetErrorMessage(System.Int32,System.String)">
- <summary>
- Sets the text of the error message corresponding to the passed error code.
- </summary>
-
- <remarks>
- Make sure to maintain all the placeholders while modifying the messages.
- </remarks>
-
- <param name="code">The code of the error message to be modified.</param>
- <param name="message">The new error message, including the placeholders for runtime informations.</param>
-
- <example>
- The following example shows how to translate error 13 to French language retaining the required placeholders:
- <code>
- SFSErrorCodes.SetErrorMessage(13, "Le Groupe demandé n'est pas disponible - Salle: {0}; Groupe: {1}");
- </code>
- </example>
- </member>
- <member name="M:Sfs2X.Util.SFSErrorCodes.GetErrorMessage(System.Int32,Sfs2X.Logging.Logger,System.Object[])">
- <exclude/>
- </member>
- <member name="T:Sfs2X.Util.LagMonitor.DefaultLagMonitor">
- <exclude/>
- </member>
- <member name="T:Sfs2X.Util.LagMonitor.ILagMonitor">
- <exclude/>
- </member>
- <member name="T:Sfs2X.Util.XMLNode">
- <exclude/>
- </member>
- <member name="T:Sfs2X.Util.XMLNodeList">
- <exclude/>
- </member>
- <member name="T:Sfs2X.Util.XMLParser">
- <exclude/>
- </member>
- <member name="T:Sfs2X.Util.UseWebSocket">
- <summary>
- The available websocket connection modes to be passed to the SmartFox class constructor.
- </summary>
-
- <seealso cref="M:Sfs2X.SmartFox.#ctor(Sfs2X.Util.UseWebSocket)"/>
- </member>
- <member name="F:Sfs2X.Util.UseWebSocket.WS">
- <summary>
- Unsecure, text-type websocket communication should be established when connecting to a SmartFoxServer 2X instance.
- </summary>
- </member>
- <member name="F:Sfs2X.Util.UseWebSocket.WSS">
- <summary>
- Secure, text-type websocket communication should be established when connecting to a SmartFoxServer 2X instance.
- </summary>
- </member>
- <member name="F:Sfs2X.Util.UseWebSocket.WS_BIN">
- <summary>
- Unsecure, binary-type websocket communication should be established when connecting to a SmartFoxServer 2X instance.
- </summary>
- </member>
- <member name="F:Sfs2X.Util.UseWebSocket.WSS_BIN">
- <summary>
- Secure, binary-type websocket communication should be established when connecting to a SmartFoxServer 2X instance.
- </summary>
- </member>
- <member name="M:ComponentAce.Compression.Libs.zlib.SupportClass.Identity(System.Int64)">
- <summary>
- This method returns the literal value received
- </summary>
- <param name="literal">The literal to return</param>
- <returns>The received value</returns>
- </member>
- <member name="M:ComponentAce.Compression.Libs.zlib.SupportClass.Identity(System.UInt64)">
- <summary>
- This method returns the literal value received
- </summary>
- <param name="literal">The literal to return</param>
- <returns>The received value</returns>
- </member>
- <member name="M:ComponentAce.Compression.Libs.zlib.SupportClass.Identity(System.Single)">
- <summary>
- This method returns the literal value received
- </summary>
- <param name="literal">The literal to return</param>
- <returns>The received value</returns>
- </member>
- <member name="M:ComponentAce.Compression.Libs.zlib.SupportClass.Identity(System.Double)">
- <summary>
- This method returns the literal value received
- </summary>
- <param name="literal">The literal to return</param>
- <returns>The received value</returns>
- </member>
- <member name="M:ComponentAce.Compression.Libs.zlib.SupportClass.URShift(System.Int32,System.Int32)">
- <summary>
- Performs an unsigned bitwise right shift with the specified number
- </summary>
- <param name="number">Number to operate on</param>
- <param name="bits">Ammount of bits to shift</param>
- <returns>The resulting number from the shift operation</returns>
- </member>
- <member name="M:ComponentAce.Compression.Libs.zlib.SupportClass.URShift(System.Int32,System.Int64)">
- <summary>
- Performs an unsigned bitwise right shift with the specified number
- </summary>
- <param name="number">Number to operate on</param>
- <param name="bits">Ammount of bits to shift</param>
- <returns>The resulting number from the shift operation</returns>
- </member>
- <member name="M:ComponentAce.Compression.Libs.zlib.SupportClass.URShift(System.Int64,System.Int32)">
- <summary>
- Performs an unsigned bitwise right shift with the specified number
- </summary>
- <param name="number">Number to operate on</param>
- <param name="bits">Ammount of bits to shift</param>
- <returns>The resulting number from the shift operation</returns>
- </member>
- <member name="M:ComponentAce.Compression.Libs.zlib.SupportClass.URShift(System.Int64,System.Int64)">
- <summary>
- Performs an unsigned bitwise right shift with the specified number
- </summary>
- <param name="number">Number to operate on</param>
- <param name="bits">Ammount of bits to shift</param>
- <returns>The resulting number from the shift operation</returns>
- </member>
- <member name="M:ComponentAce.Compression.Libs.zlib.SupportClass.ReadInput(System.IO.Stream,System.Byte[],System.Int32,System.Int32)">
- <summary>Reads a number of characters from the current source Stream and writes the data to the target array at the specified index.</summary>
- <param name="sourceStream">The source Stream to read from.</param>
- <param name="target">Contains the array of characteres read from the source Stream.</param>
- <param name="start">The starting index of the target array.</param>
- <param name="count">The maximum number of characters to read from the source Stream.</param>
- <returns>The number of characters read. The number will be less than or equal to count depending on the data available in the source Stream. Returns -1 if the end of the stream is reached.</returns>
- </member>
- <member name="M:ComponentAce.Compression.Libs.zlib.SupportClass.ReadInput(System.IO.TextReader,System.Byte[],System.Int32,System.Int32)">
- <summary>Reads a number of characters from the current source TextReader and writes the data to the target array at the specified index.</summary>
- <param name="sourceTextReader">The source TextReader to read from</param>
- <param name="target">Contains the array of characteres read from the source TextReader.</param>
- <param name="start">The starting index of the target array.</param>
- <param name="count">The maximum number of characters to read from the source TextReader.</param>
- <returns>The number of characters read. The number will be less than or equal to count depending on the data available in the source TextReader. Returns -1 if the end of the stream is reached.</returns>
- </member>
- <member name="M:ComponentAce.Compression.Libs.zlib.SupportClass.ToByteArray(System.String)">
- <summary>
- Converts a string to an array of bytes
- </summary>
- <param name="sourceString">The string to be converted</param>
- <returns>The new array of bytes</returns>
- </member>
- <member name="M:ComponentAce.Compression.Libs.zlib.SupportClass.ToCharArray(System.Byte[])">
- <summary>
- Converts an array of bytes to an array of chars
- </summary>
- <param name="byteArray">The array of bytes to convert</param>
- <returns>The new array of chars</returns>
- </member>
- <member name="P:ComponentAce.Compression.Libs.zlib.ZInputStream.TotalIn">
- <summary> Returns the total number of bytes input so far.</summary>
- </member>
- <member name="P:ComponentAce.Compression.Libs.zlib.ZInputStream.TotalOut">
- <summary> Returns the total number of bytes output so far.</summary>
- </member>
- <member name="P:ComponentAce.Compression.Libs.zlib.ZOutputStream.TotalIn">
- <summary> Returns the total number of bytes input so far.</summary>
- </member>
- <member name="P:ComponentAce.Compression.Libs.zlib.ZOutputStream.TotalOut">
- <summary> Returns the total number of bytes output so far.</summary>
- </member>
- <member name="T:WebSocketSharp.ByteOrder">
- <summary>
- Contains the values that indicate whether the byte order is a Little-endian or Big-endian.
- </summary>
- </member>
- <member name="F:WebSocketSharp.ByteOrder.Little">
- <summary>
- Indicates a Little-endian.
- </summary>
- </member>
- <member name="F:WebSocketSharp.ByteOrder.Big">
- <summary>
- Indicates a Big-endian.
- </summary>
- </member>
- <member name="T:WebSocketSharp.CloseEventArgs">
- <summary>
- Contains the event data associated with a <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 WebSocket connection has been closed cleanly.
- </summary>
- <value>
- <c>true</c> if the WebSocket connection has been closed cleanly; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="T:WebSocketSharp.CloseStatusCode">
- <summary>
- Contains the values of the status code for the WebSocket connection close.
- </summary>
- <remarks>
- <para>
- The values of the status code 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 close control 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 a 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.IncorrectData">
- <summary>
- Equivalent to close status 1003.
- Indicates that an endpoint is terminating the connection because it has received
- an unacceptable type message.
- </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.NoStatusCode">
- <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.InconsistentData">
- <summary>
- Equivalent to close status 1007.
- Indicates that an endpoint is terminating the connection because it has received
- a message that contains a 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.IgnoreExtension">
- <summary>
- Equivalent to close status 1010.
- Indicates that the 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 the 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.CompressionMethod">
- <summary>
- Contains the values of the compression method used to compress the message on the WebSocket
- connection.
- </summary>
- <remarks>
- The values of the compression method are defined in
- <see href="http://tools.ietf.org/html/draft-ietf-hybi-permessage-compression-09">Compression
- Extensions for WebSocket</see>.
- </remarks>
- </member>
- <member name="F:WebSocketSharp.CompressionMethod.None">
- <summary>
- Indicates non compression.
- </summary>
- </member>
- <member name="F:WebSocketSharp.CompressionMethod.Deflate">
- <summary>
- Indicates using DEFLATE.
- </summary>
- </member>
- <member name="T:WebSocketSharp.ErrorEventArgs">
- <summary>
- Contains the event data associated with a <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 <see cref="T:System.Exception"/>
- instance by accessing the <see cref="P:WebSocketSharp.ErrorEventArgs.Exception"/> property.
- </para>
- </remarks>
- </member>
- <member name="P:WebSocketSharp.ErrorEventArgs.Exception">
- <summary>
- Gets the <see cref="T:System.Exception"/> instance 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.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 the WebSocket URL to try.
- </param>
- <param name="result">
- When this method returns, a <see cref="T:System.Uri"/> that represents the WebSocket URL
- if <paramref name="uriString"/> is valid; otherwise, <see langword="null"/>.
- </param>
- <param name="message">
- When this method returns, a <see cref="T:System.String"/> that represents the error message
- if <paramref name="uriString"/> is invalid; otherwise, <see cref="F:System.String.Empty"/>.
- </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
- the local IP address.
- </summary>
- <returns>
- <c>true</c> if <paramref name="address"/> represents the local IP address;
- otherwise, <c>false</c>.
- </returns>
- <param name="address">
- A <see cref="T:System.Net.IPAddress"/> to test.
- </param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="address"/> is <see langword="null"/>.
- </exception>
- </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, indicates 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, indicates 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, indicates 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 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 write the content data.
- </param>
- <param name="content">
- An array of <see cref="T:System.Byte"/> that represents the content data to write.
- </param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="response"/> is <see langword="null"/>.
- </exception>
- </member>
- <member name="T:WebSocketSharp.LogData">
- <summary>
- Represents a log data used by the <see cref="T:WebSocketSharp.Logger"/> class.
- </summary>
- </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="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="T:WebSocketSharp.LogLevel">
- <summary>
- Contains the values of the logging level.
- </summary>
- </member>
- <member name="F:WebSocketSharp.LogLevel.Trace">
- <summary>
- Indicates the bottom logging level.
- </summary>
- </member>
- <member name="F:WebSocketSharp.LogLevel.Debug">
- <summary>
- Indicates the 2nd logging level from the bottom.
- </summary>
- </member>
- <member name="F:WebSocketSharp.LogLevel.Info">
- <summary>
- Indicates the 3rd logging level from the bottom.
- </summary>
- </member>
- <member name="F:WebSocketSharp.LogLevel.Warn">
- <summary>
- Indicates the 3rd logging level from the top.
- </summary>
- </member>
- <member name="F:WebSocketSharp.LogLevel.Error">
- <summary>
- Indicates the 2nd logging level from the top.
- </summary>
- </member>
- <member name="F:WebSocketSharp.LogLevel.Fatal">
- <summary>
- Indicates 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 <see cref="P:WebSocketSharp.Logger.Level"/>,
- it cannot be outputted.
- </para>
- <para>
- The default output action writes a log to the standard output stream and
- the <see cref="P:WebSocketSharp.Logger.File"/> if it has a valid path.
- </para>
- <para>
- If you would like to use the custom output action, you should set the
- <see cref="P:WebSocketSharp.Logger.Output"/> 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="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, indicates 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"/>.
- </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="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="T:WebSocketSharp.MessageEventArgs">
- <summary>
- Contains the event data associated with a <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.
- </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>
- <remarks>
- <para>
- If the message data is empty, this property returns <see cref="F:System.String.Empty"/>.
- </para>
- <para>
- Or if the message is a binary message, this property returns <c>"Binary"</c>.
- </para>
- </remarks>
- <value>
- A <see cref="T:System.String"/> that represents the message data.
- </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 type of the message.
- </summary>
- <value>
- <see cref="F:WebSocketSharp.Opcode.Text"/> or <see cref="F:WebSocketSharp.Opcode.Binary"/>.
- </value>
- </member>
- <member name="T:WebSocketSharp.Opcode">
- <summary>
- Contains the values of the opcode that indicates the type of a WebSocket frame.
- </summary>
- <remarks>
- The values of the opcode 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 a continuation frame.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Opcode.Text">
- <summary>
- Equivalent to numeric value 1.
- Indicates a text frame.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Opcode.Binary">
- <summary>
- Equivalent to numeric value 2.
- Indicates a binary frame.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Opcode.Close">
- <summary>
- Equivalent to numeric value 8.
- Indicates a connection close frame.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Opcode.Ping">
- <summary>
- Equivalent to numeric value 9.
- Indicates a ping frame.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Opcode.Pong">
- <summary>
- Equivalent to numeric value 10.
- Indicates a pong frame.
- </summary>
- </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="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.ArgumentException">
- <para>
- <paramref name="url"/> is invalid.
- </para>
- <para>
- -or-
- </para>
- <para>
- <paramref name="protocols"/> is invalid.
- </para>
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="url"/> is <see langword="null"/>.
- </exception>
- </member>
- <member name="P:WebSocketSharp.WebSocket.Compression">
- <summary>
- Gets or sets the compression method used to compress the message on the WebSocket
- connection.
- </summary>
- <value>
- One of the <see cref="T:WebSocketSharp.CompressionMethod"/> enum values, indicates the compression method
- used to compress the 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 connection 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.EnableRedirection">
- <summary>
- Gets or sets a value indicating whether the <see cref="T:WebSocketSharp.WebSocket"/> redirects to
- the new URL located in the handshake response.
- </summary>
- <value>
- <c>true</c> if the <see cref="T:WebSocketSharp.WebSocket"/> redirects 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 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.WebSocket.Origin">
- <summary>
- Gets or sets the value of the HTTP Origin header to send with the WebSocket connection
- 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 WebSocket
- 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 as server.
- </value>
- </member>
- <member name="P:WebSocketSharp.WebSocket.Url">
- <summary>
- Gets the WebSocket URL to connect.
- </summary>
- <value>
- A <see cref="T:System.Uri"/> that represents the WebSocket URL to connect.
- </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 by
- 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="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>
- </member>
- <member name="M:WebSocketSharp.WebSocket.ConnectAsync">
- <summary>
- Establishes a WebSocket connection asynchronously.
- </summary>
- <remarks>
- This method doesn't wait for the connect to be complete.
- </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 a 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 a 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 a 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 a 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 a 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 a 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 a 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 connection 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 connection 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="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.WebSocketState">
- <summary>
- Contains the values of the state of the WebSocket connection.
- </summary>
- <remarks>
- The values of the state 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 is 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 opened.
- </summary>
- </member>
- <member name="T:WebSocketSharp.Net.AuthenticationSchemes">
- <summary>
- Contains the values of the schemes for authentication.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.AuthenticationSchemes.None">
- <summary>
- Indicates that no authentication is allowed.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.AuthenticationSchemes.Digest">
- <summary>
- Indicates digest authentication.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.AuthenticationSchemes.Basic">
- <summary>
- Indicates basic authentication.
- </summary>
- </member>
- <member name="F:WebSocketSharp.Net.AuthenticationSchemes.Anonymous">
- <summary>
- Indicates anonymous authentication.
- </summary>
- </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="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.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="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="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="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="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="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="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.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.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="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>
- <value>
- A <see cref="T:System.String"/> that represents the name of the realm. The default value is
- <c>"SECRET AREA"</c>.
- </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 a function
- that only returns <see langword="null"/>.
- </value>
- <exception cref="T:System.ObjectDisposedException">
- This listener has been closed.
- </exception>
- </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="T:WebSocketSharp.Net.HttpListenerContext">
- <summary>
- Provides the access to the HTTP request and response information
- used by the <see cref="T:WebSocketSharp.Net.HttpListener"/>.
- </summary>
- <remarks>
- The HttpListenerContext class cannot be inherited.
- </remarks>
- </member>
- <member name="P:WebSocketSharp.Net.HttpListenerContext.Request">
- <summary>
- Gets the HTTP request information from a client.
- </summary>
- <value>
- A <see cref="T:WebSocketSharp.Net.HttpListenerRequest"/> that represents the HTTP request.
- </value>
- </member>
- <member name="P:WebSocketSharp.Net.HttpListenerContext.Response">
- <summary>
- Gets the HTTP response information used to send to the client.
- </summary>
- <value>
- A <see cref="T:WebSocketSharp.Net.HttpListenerResponse"/> that represents the HTTP response to send.
- </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="M:WebSocketSharp.Net.HttpListenerContext.AcceptWebSocket(System.String)">
- <summary>
- Accepts a WebSocket connection request.
- </summary>
- <returns>
- A <see cref="T:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext"/> that represents the WebSocket connection
- request.
- </returns>
- <param name="protocol">
- A <see cref="T:System.String"/> that represents the subprotocol used in the 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>
- </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="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="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="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="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 an 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 size of 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. The
- value is a number of bytes in the entity body data. <c>-1</c> if the size 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="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="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="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.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.ContentLength64">
- <summary>
- Gets or sets the size of 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.
- The value is a number of bytes in the entity body data.
- </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 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.ArgumentNullException">
- The value specified for a set operation is <see langword="null"/>.
- </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.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>
- <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.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.ArgumentNullException">
- The value specified for a set operation is <see langword="null"/>.
- </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.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.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.ArgumentNullException">
- The value specified for a set operation is <see langword="null"/>.
- </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.
- </value>
- <exception cref="T:System.ArgumentException">
- The value specified for a set operation is empty.
- </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.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>.
- </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 <see cref="F:WebSocketSharp.Net.HttpStatusCode.OK"/>.
- </value>
- <exception cref="T:System.InvalidOperationException">
- The response has already been sent.
- </exception>
- <exception cref="T:System.Net.ProtocolViolationException">
- The value specified for a set operation is invalid. Valid values are between 100 and 999.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- This object is closed.
- </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.
- </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="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.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.ArgumentNullException">
- <paramref name="name"/> is <see langword="null"/> or empty.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- The length of <paramref name="value"/> is greater than 65,535 characters.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- <para>
- The response has already been sent.
- </para>
- <para>
- -or-
- </para>
- <para>
- The header cannot be allowed to add to the current headers.
- </para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- This object is closed.
- </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>
- <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.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.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.ArgumentNullException">
- <paramref name="name"/> is <see langword="null"/> or empty.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- The length of <paramref name="value"/> is greater than 65,535 characters.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- <para>
- The response has already been sent.
- </para>
- <para>
- -or-
- </para>
- <para>
- The current headers cannot allow the header to append a value.
- </para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- This object is closed.
- </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.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.CopyFrom(WebSocketSharp.Net.HttpListenerResponse)">
- <summary>
- Copies 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.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.Redirect(System.String)">
- <summary>
- Configures the response to redirect the client's request to the specified
- <paramref name="url"/>.
- </summary>
- <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.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.ArgumentException">
- <paramref name="cookie"/> already exists in the cookies and couldn't be replaced.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="cookie"/> is <see langword="null"/>.
- </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.System#IDisposable#Dispose">
- <summary>
- Releases all resources used by the <see cref="T:WebSocketSharp.Net.HttpListenerResponse"/>.
- </summary>
- </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>
- <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="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.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.NetworkCredential">
- <summary>
- Provides the credentials for 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.ArgumentException">
- <paramref name="username"/> is <see langword="null"/> or 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.ArgumentException">
- <paramref name="username"/> is <see langword="null"/> or 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.
- </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.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.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="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="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="M:WebSocketSharp.Net.WebHeaderCollection.AddWithoutValidate(System.String,System.String)">
- <summary>
- Adds a header to the collection without checking whether 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="T:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext">
- <summary>
- Provides the properties used to access the information in a WebSocket connection request
- received by the <see cref="T:WebSocketSharp.Net.HttpListener"/>.
- </summary>
- </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 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.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 connection 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="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="T:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext">
- <summary>
- Provides the properties used to access the information in a WebSocket connection request
- received by the <see cref="T:System.Net.Sockets.TcpListener"/>.
- </summary>
- </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 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.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 connection 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="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="T:WebSocketSharp.Net.WebSockets.WebSocketContext">
- <summary>
- Exposes the properties used to access the information in a WebSocket connection request.
- </summary>
- <remarks>
- The WebSocketContext 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 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.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 connection 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="T:WebSocketSharp.Server.HttpRequestEventArgs">
- <summary>
- Contains the event data associated with an 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, you should access
- the <see cref="P:WebSocketSharp.Server.HttpRequestEventArgs.Request"/> property.
- </para>
- <para>
- And if you would like to get the 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 <see cref="T:WebSocketSharp.Net.HttpListenerRequest"/> that represents the HTTP request sent from
- a client.
- </summary>
- <value>
- A <see cref="T:WebSocketSharp.Net.HttpListenerRequest"/> that represents the request.
- </value>
- </member>
- <member name="P:WebSocketSharp.Server.HttpRequestEventArgs.Response">
- <summary>
- Gets the <see cref="T:WebSocketSharp.Net.HttpListenerResponse"/> used to return an HTTP response to the client.
- </summary>
- <value>
- A <see cref="T:WebSocketSharp.Net.HttpListenerResponse"/> used to return a response.
- </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.
- </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.ArgumentException">
- Pair of <paramref name="port"/> and <paramref name="secure"/> is invalid.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> isn't between 1 and 65535.
- </exception>
- </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>
- <value>
- A <see cref="T:System.String"/> that represents the name of the realm.
- The default value is <c>"SECRET AREA"</c>.
- </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 Func<<see cref="T:System.Security.Principal.IIdentity"/>, <see cref="T:WebSocketSharp.Net.NetworkCredential"/>> delegate that
- references the method(s) used to find the credentials. The default value is a function
- that only returns <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="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.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 Func<T> 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.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="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.WebSocketBehavior">
- <summary>
- Exposes the methods and properties used to define the behavior of a WebSocket service
- provided by the <see cref="T:WebSocketSharp.Server.HttpServer"/> or <see cref="T:WebSocketSharp.Server.WebSocketServer"/>.
- </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="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 connection request to the WebSocket service.
- </summary>
- <value>
- A <see cref="T:WebSocketSharp.Net.WebSockets.WebSocketContext"/> that provides the access to the connection 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 connection request to the WebSocket service.
- </summary>
- <remarks>
- The delegate is called when the <see cref="T:WebSocketSharp.WebSocket"/> used in the session validates
- the connection request.
- </remarks>
- <value>
- <para>
- A <c>Func<CookieCollection, CookieCollection, bool></c> delegate that references
- the method(s) used to validate the cookies. 1st <see cref="T:WebSocketSharp.Net.CookieCollection"/> passed to
- this delegate contains the cookies to validate if any. 2nd <see cref="T:WebSocketSharp.Net.CookieCollection"/>
- 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.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 connection request.
- </summary>
- <value>
- <c>true</c> if the WebSocket service ignores the extensions; 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 connection request to the WebSocket service.
- </summary>
- <remarks>
- The delegate is called when the <see cref="T:WebSocketSharp.WebSocket"/> used in the session validates
- the connection request.
- </remarks>
- <value>
- <para>
- A <c>Func<string, bool></c> delegate that references the method(s) used to validate
- the origin header. A <see cref="T:System.String"/> 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"/> used in the session.
- </value>
- </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 a 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 a 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 a 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 a 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 a 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 a 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 a 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="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.
- </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 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.ArgumentException">
- <paramref name="url"/> is invalid.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="url"/> is <see langword="null"/>.
- </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.ArgumentException">
- Pair of <paramref name="port"/> and <paramref name="secure"/> is invalid.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> isn't between 1 and 65535.
- </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="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.ArgumentException">
- <paramref name="address"/> isn't a local IP address.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="address"/> is <see langword="null"/>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> isn't between 1 and 65535.
- </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="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.ArgumentException">
- <para>
- <paramref name="address"/> isn't a local IP address.
- </para>
- <para>
- -or-
- </para>
- <para>
- Pair of <paramref name="port"/> and <paramref name="secure"/> is invalid.
- </para>
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="address"/> is <see langword="null"/>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> isn't between 1 and 65535.
- </exception>
- </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>
- <value>
- A <see cref="T:System.String"/> that represents the name of the realm.
- The default value is <c>"SECRET AREA"</c>.
- </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 Func<<see cref="T:System.Security.Principal.IIdentity"/>, <see cref="T:WebSocketSharp.Net.NetworkCredential"/>> delegate that
- references the method(s) used to find the credentials. The default value is a function
- that only returns <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="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.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 Func<T> 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.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="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.HttpServer"/> or <see cref="T:WebSocketSharp.Server.WebSocketServer"/>.
- </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="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="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="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="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="M:WebSocketSharp.Server.WebSocketServiceManager.Broadcast(System.Byte[])">
- <summary>
- Broadcasts a 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 broadcast.
- </param>
- </member>
- <member name="M:WebSocketSharp.Server.WebSocketServiceManager.Broadcast(System.String)">
- <summary>
- Broadcasts a 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 broadcast.
- </param>
- </member>
- <member name="M:WebSocketSharp.Server.WebSocketServiceManager.BroadcastAsync(System.Byte[],System.Action)">
- <summary>
- Broadcasts a binary <paramref name="data"/> asynchronously to every client
- in the WebSocket services.
- </summary>
- <remarks>
- This method doesn't wait for the broadcast to be complete.
- </remarks>
- <param name="data">
- An array of <see cref="T:System.Byte"/> that represents the binary data to broadcast.
- </param>
- <param name="completed">
- An <see cref="T:System.Action"/> delegate that references the method(s) called when
- the broadcast is complete.
- </param>
- </member>
- <member name="M:WebSocketSharp.Server.WebSocketServiceManager.BroadcastAsync(System.String,System.Action)">
- <summary>
- Broadcasts a text <paramref name="data"/> asynchronously to every client
- in the WebSocket services.
- </summary>
- <remarks>
- This method doesn't wait for the broadcast to be complete.
- </remarks>
- <param name="data">
- A <see cref="T:System.String"/> that represents the text data to broadcast.
- </param>
- <param name="completed">
- An <see cref="T:System.Action"/> delegate that references the method(s) called when
- the broadcast is complete.
- </param>
- </member>
- <member name="M:WebSocketSharp.Server.WebSocketServiceManager.BroadcastAsync(System.IO.Stream,System.Int32,System.Action)">
- <summary>
- Broadcasts a 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 broadcast to be complete.
- </remarks>
- <param name="stream">
- A <see cref="T:System.IO.Stream"/> from which contains the binary data to broadcast.
- </param>
- <param name="length">
- An <see cref="T:System.Int32"/> that represents the number of bytes to broadcast.
- </param>
- <param name="completed">
- An <see cref="T:System.Action"/> delegate that references the method(s) called when
- the broadcast 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="T:WebSocketSharp.Server.WebSocketSessionManager">
- <summary>
- Manages the sessions in a Websocket service.
- </summary>
- </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="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>
- </members>
- </doc>
|