1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453745474557456745774587459746074617462746374647465746674677468746974707471747274737474747574767477747874797480748174827483748474857486748774887489749074917492749374947495749674977498749975007501750275037504750575067507750875097510751175127513751475157516751775187519752075217522752375247525752675277528752975307531753275337534753575367537753875397540754175427543754475457546754775487549755075517552755375547555755675577558755975607561756275637564756575667567756875697570757175727573757475757576757775787579758075817582758375847585758675877588758975907591759275937594759575967597759875997600760176027603760476057606760776087609761076117612761376147615761676177618761976207621762276237624762576267627762876297630763176327633763476357636763776387639764076417642764376447645764676477648764976507651765276537654765576567657765876597660766176627663766476657666766776687669767076717672767376747675767676777678767976807681768276837684768576867687768876897690769176927693769476957696769776987699770077017702770377047705770677077708770977107711771277137714771577167717771877197720772177227723772477257726772777287729773077317732773377347735773677377738773977407741774277437744774577467747774877497750775177527753775477557756775777587759776077617762776377647765776677677768776977707771777277737774777577767777777877797780778177827783778477857786778777887789779077917792779377947795779677977798779978007801780278037804780578067807780878097810781178127813781478157816781778187819782078217822782378247825782678277828782978307831783278337834783578367837783878397840784178427843784478457846784778487849785078517852785378547855785678577858785978607861786278637864786578667867786878697870787178727873787478757876787778787879788078817882788378847885788678877888788978907891789278937894789578967897789878997900790179027903790479057906790779087909791079117912791379147915791679177918791979207921792279237924792579267927792879297930793179327933793479357936793779387939794079417942794379447945794679477948794979507951795279537954795579567957795879597960796179627963796479657966796779687969797079717972797379747975797679777978797979807981798279837984798579867987798879897990799179927993799479957996799779987999800080018002800380048005800680078008800980108011801280138014801580168017801880198020802180228023802480258026802780288029803080318032803380348035803680378038803980408041804280438044804580468047804880498050805180528053805480558056805780588059806080618062806380648065806680678068806980708071807280738074807580768077807880798080808180828083808480858086808780888089809080918092809380948095809680978098809981008101810281038104810581068107810881098110811181128113811481158116811781188119812081218122812381248125812681278128812981308131813281338134813581368137813881398140814181428143814481458146814781488149815081518152815381548155815681578158815981608161816281638164816581668167816881698170817181728173817481758176817781788179818081818182818381848185818681878188818981908191819281938194819581968197819881998200820182028203820482058206820782088209821082118212821382148215821682178218821982208221822282238224822582268227822882298230823182328233823482358236823782388239824082418242824382448245824682478248824982508251825282538254825582568257825882598260826182628263826482658266826782688269827082718272827382748275827682778278827982808281828282838284828582868287828882898290829182928293829482958296829782988299830083018302830383048305830683078308830983108311831283138314831583168317831883198320832183228323832483258326832783288329833083318332833383348335833683378338833983408341834283438344834583468347834883498350835183528353835483558356835783588359836083618362836383648365836683678368836983708371837283738374837583768377837883798380838183828383838483858386838783888389839083918392839383948395839683978398839984008401840284038404840584068407840884098410841184128413841484158416841784188419842084218422842384248425842684278428842984308431843284338434843584368437843884398440844184428443844484458446844784488449845084518452845384548455845684578458845984608461846284638464846584668467846884698470847184728473847484758476847784788479848084818482848384848485848684878488848984908491849284938494849584968497849884998500850185028503850485058506850785088509851085118512851385148515851685178518851985208521852285238524852585268527852885298530853185328533853485358536853785388539854085418542854385448545854685478548854985508551855285538554855585568557855885598560856185628563856485658566856785688569857085718572857385748575857685778578857985808581858285838584858585868587858885898590859185928593859485958596859785988599860086018602860386048605860686078608860986108611861286138614861586168617861886198620862186228623862486258626862786288629863086318632863386348635863686378638863986408641864286438644864586468647864886498650865186528653865486558656865786588659866086618662866386648665866686678668866986708671867286738674867586768677867886798680868186828683868486858686868786888689869086918692869386948695869686978698869987008701870287038704870587068707870887098710871187128713871487158716871787188719872087218722872387248725872687278728872987308731873287338734873587368737873887398740874187428743874487458746874787488749875087518752875387548755875687578758875987608761876287638764876587668767876887698770877187728773877487758776877787788779878087818782878387848785878687878788878987908791879287938794879587968797879887998800 |
- <?xml version="1.0"?>
- <doc>
- <assembly>
- <name>Ice</name>
- </assembly>
- <members>
- <member name="T:Ice.AMDCallback">
- <summary>
- AMDCallback is the interface from which all AMD callbacks are derived.
- </summary>
- </member>
- <member name="M:Ice.AMDCallback.ice_exception(System.Exception)">
- <summary>
- Indicates to the Ice run time that an operation completed
- with a run-time exception.
- </summary>
- <param name="ex">The encoded Ice run-time exception. Note that, if ex
- is a user exception, the caller receives UnknownUserException.
- Use ice_response to raise user exceptions.</param>
- </member>
- <member name="T:Ice.SignalPolicy">
- <summary>
- The signal policy for Ice.Application signal handling.
- </summary>
- </member>
- <member name="F:Ice.SignalPolicy.HandleSignals">
- <summary>
- If a signal is received, Ice.Application reacts to the signal
- by calling Communicator.destroy or Communicator.shutdown,
- or by calling a custom shutdown hook installed by the application.
- </summary>
- </member>
- <member name="F:Ice.SignalPolicy.NoSignalHandling">
- <summary>
- Any signal that is received is not intercepted and takes the default action.
- </summary>
- </member>
- <member name="T:Ice.Application">
- <summary>
- Utility base class that makes it easy to correctly initialize and finalize
- the Ice run time, as well as handle signals. Unless the application specifies
- a logger, Application installs a per-process logger that logs to the standard
- error output.
- Applications must create a derived class that implements the run method.
- A program can contain only one instance of this class.
- </summary>
- </member>
- <member name="M:Ice.Application.run(System.String[])">
- <summary>
- Called once the communicator has been initialized. The derived class must
- implement run, which is the application's starting method.
- </summary>
- <param name="args">The argument vector for the application. Application
- scans the argument vector passed to main for options that are
- specific to the Ice run time and removes them; therefore, the vector passed
- to run is free from Ice-related options and contains only options
- and arguments that are application-specific.</param>
- <returns>The run method should return zero for successful termination, and
- non-zero otherwise. Application.main returns the value returned by run.</returns>
- </member>
- <member name="M:Ice.Application.interruptCallback(System.Int32)">
- <summary>
- Override this method to provide a custom application interrupt
- hook. You must call callbackOnInterrupt for this method
- to be called. Note that the interruptCallback can be called
- concurrently with any other thread (including main) in your
- application--take appropriate concurrency precautions.
- </summary>
- <param name="sig">The cause of the interrupt.</param>
- </member>
- <member name="M:Ice.Application.#ctor">
- <summary>
- Initializes an instance that calls Communicator.shutdown if a signal is received.
- </summary>
- </member>
- <member name="M:Ice.Application.#ctor(Ice.SignalPolicy)">
- <summary>
- Initializes an instance that handles signals according to the signal policy.
- </summary>
- <param name="signalPolicy">Determines how to respond to signals.</param>
- </member>
- <member name="M:Ice.Application.main(System.String[])">
- <summary>
- The application must call main after it has
- instantiated the derived class. main creates
- a communicator, establishes the specified signal policy, and,
- once run returns, destroys the communicator.
- The method prints an error message for any exception that propagates
- out of run and ensures that the communicator is
- destroyed correctly even if run completes abnormally.
- </summary>
- <param name="args">The arguments for the application (as passed to Main(string[])
- by the operating system.</param>
- <returns>The value returned by run. If run terminates with an exception,
- the return value is non-zero.</returns>
- </member>
- <member name="M:Ice.Application.main(System.String[],System.String)">
- <summary>
- The application must call main after it has
- instantiated the derived class. main creates
- a communicator, establishes the specified signal policy, and,
- once run returns, destroys the communicator.
- The method prints an error message for any exception that propagates
- out of run and ensures that the communicator is
- destroyed correctly even if run completes abnormally.
- </summary>
- <param name="args">The arguments for the application (as passed to Main(string[])
- by the operating system.</param>
- <param name="configFile">The configuration file with which to initialize
- Ice properties.</param>
- <returns>The value returned by run. If run terminates with an exception,
- the return value is non-zero.</returns>
- </member>
- <member name="M:Ice.Application.main(System.String[],Ice.InitializationData)">
- <summary>
- The application must call main after it has
- instantiated the derived class. main creates
- a communicator, establishes the specified signal policy, and,
- once run returns, destroys the communicator.
- The method prints an error message for any exception that propagates
- out of run and ensures that the communicator is
- destroyed correctly even if run completes abnormally.
- </summary>
- <param name="args">The arguments for the application (as passed to Main(string[])
- by the operating system.</param>
- <param name="initializationData">Additional data used to initialize the communicator.</param>
- <returns>The value returned by run. If run terminates with an exception,
- the return value is non-zero.</returns>
- </member>
- <member name="M:Ice.Application.appName">
- <summary>
- Returns the application name (which is also the value of Ice.ProgramName.
- This method is useful mainly for error messages that
- include the application name. Because appName is a static method, it is available from anywhere
- in the program.
- </summary>
- <returns>The name of the application.</returns>
- </member>
- <member name="M:Ice.Application.communicator">
- <summary>
- Returns the communicator for the application. Because communicator is a static method,
- it permits access to the communicator from anywhere in the program. Note that, as a consequence,
- you cannot have more than one instance of Application in a program.
- </summary>
- <returns>The communicator for the application.</returns>
- </member>
- <member name="M:Ice.Application.destroyOnInterrupt">
- <summary>
- Instructs Application to call Communicator.destroy on receipt of a signal.
- This is default signal handling policy established by the default constructor.
- </summary>
- </member>
- <member name="M:Ice.Application.shutdownOnInterrupt">
- <summary>
- Instructs Application to call Communicator.shutdown on receipt of a signal.
- </summary>
- </member>
- <member name="M:Ice.Application.ignoreInterrupt">
- <summary>
- Instructs Application to ignore signals.
- </summary>
- </member>
- <member name="M:Ice.Application.callbackOnInterrupt">
- <summary>
- Instructs Application to call interruptCallback on receipt of a signal.
- The derived class can intercept signals by overriding interruptCallback.
- </summary>
- </member>
- <member name="M:Ice.Application.holdInterrupt">
- <summary>
- Instructs Application to call to hold signals.
- </summary>
- </member>
- <member name="M:Ice.Application.releaseInterrupt">
- <summary>
- Instructs Application respond to signals. If a signal arrived since the last call
- to holdInterrupt, it is delivered once you call releaseInterrupt.
- </summary>
- </member>
- <member name="M:Ice.Application.interrupted">
- <summary>
- Determines whether the application shut down intentionally or was forced to shut down due to a signal.
- This is useful for logging purposes.
- </summary>
- <returns>True if a signal caused the communicator to shut down; false otherwise.</returns>
- </member>
- <member name="T:Ice.AsyncCallback">
-
- <summary>
- Callback that requires the application to down-cast the proxy.
- </summary>
-
- </member>
- <member name="T:Ice.OnewayCallback">
-
- <summary>
- Callback for the successful completion of an operation
- that returns no data.
- </summary>
-
- </member>
- <member name="T:Ice.SentCallback">
-
- <summary>
- Callback for the successful completion of an operation
- that returns no data.
- </summary>
-
- </member>
- <member name="T:Ice.ExceptionCallback">
-
- <summary>
- Called when an invocation raises an exception.
- </summary>
-
- </member>
- <member name="T:Ice.AsyncResult">
-
- <summary>
- <!-- TODO -->
- </summary>
- </member>
- <member name="M:Ice.BatchRequest.enqueue">
- <summary>
- Confirms the queuing of the batch request.
- </summary>
- </member>
- <member name="M:Ice.BatchRequest.getSize">
- <summary>
- Get the marshalled size of the request.
- </summary>
- <returns>The request size.</returns>
- </member>
- <member name="M:Ice.BatchRequest.getOperation">
- <summary>
- Get the name of the operation
- </summary>
- <returns>The request operation.</returns>
- </member>
- <member name="M:Ice.BatchRequest.getProxy">
- <summary>
- The proxy used to invoke the batch request.
- </summary>
- <returns>The request proxy.</returns>
- </member>
- <member name="T:Ice.BatchRequestInterceptor">
- <summary>
- Base interface for listening to batch request queues.
- </summary>
- </member>
- <member name="M:Ice.BatchRequestInterceptor.enqueue(Ice.BatchRequest,System.Int32,System.Int32)">
- <summary>
- Called by the Ice runtime when a batch request is about to be
- added to the batch request queue of a proxy or connection.
-
- The implementation of this method must call enqueue() on the
- request to confirm its addition to the queue, if not called
- the request isn't added to the queue. The implementation can
- raise an Ice local exception to notify the caller of a failure.
- </summary>
- <param name="request">The batch request.</param>
- <param name="queueBatchRequestCount">The number of batch request queued.</param>
- <param name="queueBatchRequestSize">The size of the queued batch requests.</param>
- </member>
- <member name="M:Ice.Communicator.destroy">
- <summary>
- Destroy the communicator.
- This operation calls shutdown
- implicitly. Calling destroy cleans up memory, and shuts down
- this communicator's client functionality and destroys all object
- adapters. Subsequent calls to destroy are ignored.
-
- </summary>
- </member>
- <member name="M:Ice.Communicator.shutdown">
- <summary>
- Shuts down this communicator's server functionality, which
- includes the deactivation of all object adapters.
- (Attempts to use
- a deactivated object adapter raise ObjectAdapterDeactivatedException.)
- Subsequent calls to shutdown are ignored.
-
- After shutdown returns, no new requests are
- processed. However, requests that have been started before
- shutdown was called might still be active. You can use
- waitForShutdown to wait for the completion of all
- requests.
-
- </summary>
- </member>
- <member name="M:Ice.Communicator.waitForShutdown">
- <summary>
- Wait until the application has called shutdown (or destroy).
- On the server side, this operation blocks the calling thread
- until all currently-executing operations have completed.
- On the client side, the operation simply block until another
- thread has called shutdown or destroy.
-
- A typical use of this operation is to call it
- from the main thread, which then waits until some other thread
- calls shutdown. After shut-down is complete, the main thread
- returns and can do some cleanup work before it finally calls
- destroy to shut down the client functionality, and then
- exits the application.
-
- </summary>
- </member>
- <member name="M:Ice.Communicator.isShutdown">
- <summary>
- Check whether communicator has been shut down.
- </summary>
- <returns>True if the communicator has been shut down; false otherwise.
-
- </returns>
- </member>
- <member name="M:Ice.Communicator.stringToProxy(System.String)">
- <summary>
- Convert a stringified proxy into a proxy.
- For example,
- MyCategory/MyObject:tcp -h some_host -p
- 10000 creates a proxy that refers to the Ice object
- having an identity with a name "MyObject" and a category
- "MyCategory", with the server running on host "some_host", port
- 10000. If the stringified proxy does not parse correctly, the
- operation throws one of ProxyParseException,
- EndpointParseException, or IdentityParseException.
- An appendix in the Ice manual provides a detailed description
- of the syntax supported by stringified proxies.
-
- </summary>
- <param name="str">The stringified proxy to convert into a proxy.
-
- </param>
- <returns>The proxy, or nil if str is an empty string.
-
- </returns>
- </member>
- <member name="M:Ice.Communicator.proxyToString(Ice.ObjectPrx)">
- <summary>
- Convert a proxy into a string.
- </summary>
- <param name="obj">The proxy to convert into a stringified proxy.
-
- </param>
- <returns>The stringified proxy, or an empty string if
- obj is nil.
-
- </returns>
- </member>
- <member name="M:Ice.Communicator.propertyToProxy(System.String)">
- <summary>
- Convert a set of proxy properties into a proxy.
- The "base"
- name supplied in the property argument refers to a
- property containing a stringified proxy, such as
- MyProxy=id:tcp -h localhost -p 10000. Additional
- properties configure local settings for the proxy, such as
- MyProxy.PreferSecure=1. The "Properties"
- appendix in the Ice manual describes each of the supported
- proxy properties.
-
- </summary>
- <param name="property">The base property name.
-
- </param>
- <returns>The proxy.</returns>
- </member>
- <member name="M:Ice.Communicator.proxyToProperty(Ice.ObjectPrx,System.String)">
- <summary>
- Convert a proxy to a set of proxy properties.
- </summary>
- <param name="proxy">The proxy.
-
- </param>
- <param name="property">The base property name.
-
- </param>
- <returns>The property set.</returns>
- </member>
- <member name="M:Ice.Communicator.stringToIdentity(System.String)">
- <summary>
- Convert a string into an identity.
- If the string does not parse
- correctly, the operation throws IdentityParseException.
-
- </summary>
- <param name="str">The string to convert into an identity.
-
- </param>
- <returns>The identity.
-
- </returns>
- </member>
- <member name="M:Ice.Communicator.identityToString(Ice.Identity)">
- <summary>
- Convert an identity into a string.
- </summary>
- <param name="ident">The identity to convert into a string.
-
- </param>
- <returns>The "stringified" identity.
-
- </returns>
- </member>
- <member name="M:Ice.Communicator.createObjectAdapter(System.String)">
- <summary>
- Create a new object adapter.
- The endpoints for the object
- adapter are taken from the property name.Endpoints.
-
- It is legal to create an object adapter with the empty string as
- its name. Such an object adapter is accessible via bidirectional
- connections or by collocated invocations that originate from the
- same communicator as is used by the adapter.
-
- Attempts to create a named object adapter for which no configuration
- can be found raise InitializationException.
-
- </summary>
- <param name="name">The object adapter name.
-
- </param>
- <returns>The new object adapter.
-
- </returns>
- </member>
- <member name="M:Ice.Communicator.createObjectAdapterWithEndpoints(System.String,System.String)">
- <summary>
- Create a new object adapter with endpoints.
- This operation sets
- the property name.Endpoints,
- and then calls createObjectAdapter. It is provided as a
- convenience function.
-
- Calling this operation with an empty name will result in a
- UUID being generated for the name.
-
- </summary>
- <param name="name">The object adapter name.
-
- </param>
- <param name="endpoints">The endpoints for the object adapter.
-
- </param>
- <returns>The new object adapter.
-
- </returns>
- </member>
- <member name="M:Ice.Communicator.createObjectAdapterWithRouter(System.String,Ice.RouterPrx)">
- <summary>
- Create a new object adapter with a router.
- This operation
- creates a routed object adapter.
-
- Calling this operation with an empty name will result in a
- UUID being generated for the name.
-
- </summary>
- <param name="name">The object adapter name.
-
- </param>
- <param name="rtr">The router.
-
- </param>
- <returns>The new object adapter.
-
- </returns>
- </member>
- <member name="M:Ice.Communicator.addObjectFactory(Ice.ObjectFactory,System.String)">
- <summary>
- Add an object factory to this communicator.
- Installing a
- factory with an id for which a factory is already registered
- throws AlreadyRegisteredException.
-
- When unmarshaling an Ice object, the Ice run time reads the
- most-derived type id off the wire and attempts to create an
- instance of the type using a factory. If no instance is created,
- either because no factory was found, or because all factories
- returned nil, the behavior of the Ice run time depends on the
- format with which the object was marshaled:
-
- If the object uses the "sliced" format, Ice ascends the class
- hierarchy until it finds a type that is recognized by a factory,
- or it reaches the least-derived type. If no factory is found that
- can create an instance, the run time throws
- NoObjectFactoryException.
-
- If the object uses the "compact" format, Ice immediately raises
- NoObjectFactoryException.
-
- The following order is used to locate a factory for a type:
-
-
-
- The Ice run-time looks for a factory registered
- specifically for the type.
-
- If no instance has been created, the Ice run-time looks
- for the default factory, which is registered with an empty type id.
-
-
- If no instance has been created by any of the preceding
- steps, the Ice run-time looks for a factory that may have been
- statically generated by the language mapping for non-abstract classes.
-
-
-
-
- </summary>
- <param name="factory">The factory to add.
-
- </param>
- <param name="id">The type id for which the factory can create instances, or
- an empty string for the default factory.
-
- </param>
- </member>
- <member name="M:Ice.Communicator.findObjectFactory(System.String)">
- <summary>
- Find an object factory registered with this communicator.
- </summary>
- <param name="id">The type id for which the factory can create instances,
- or an empty string for the default factory.
-
- </param>
- <returns>The object factory, or null if no object factory was
- found for the given id.
-
- </returns>
- </member>
- <member name="M:Ice.Communicator.getImplicitContext">
- <summary>
- Get the implicit context associated with this communicator.
- </summary>
- <returns>The implicit context associated with this communicator;
- returns null when the property Ice.ImplicitContext is not set
- or is set to None.</returns>
- </member>
- <member name="M:Ice.Communicator.getProperties">
- <summary>
- Get the properties for this communicator.
- </summary>
- <returns>This communicator's properties.
-
- </returns>
- </member>
- <member name="M:Ice.Communicator.getLogger">
- <summary>
- Get the logger for this communicator.
- </summary>
- <returns>This communicator's logger.
-
- </returns>
- </member>
- <member name="M:Ice.Communicator.getObserver">
- <summary>
- Get the observer resolver object for this communicator.
- </summary>
- <returns>This communicator's observer resolver object.</returns>
- </member>
- <member name="M:Ice.Communicator.getDefaultRouter">
- <summary>
- Get the default router this communicator.
- </summary>
- <returns>The default router for this communicator.
-
- </returns>
- </member>
- <member name="M:Ice.Communicator.setDefaultRouter(Ice.RouterPrx)">
- <summary>
- Set a default router for this communicator.
- All newly
- created proxies will use this default router. To disable the
- default router, null can be used. Note that this
- operation has no effect on existing proxies.
-
- You can also set a router for an individual proxy
- by calling the operation ice_router on the proxy.
-
- </summary>
- <param name="rtr">The default router to use for this communicator.
-
- </param>
- </member>
- <member name="M:Ice.Communicator.getDefaultLocator">
- <summary>
- Get the default locator this communicator.
- </summary>
- <returns>The default locator for this communicator.
-
- </returns>
- </member>
- <member name="M:Ice.Communicator.setDefaultLocator(Ice.LocatorPrx)">
- <summary>
- Set a default Ice locator for this communicator.
- All newly
- created proxy and object adapters will use this default
- locator. To disable the default locator, null can be used.
- Note that this operation has no effect on existing proxies or
- object adapters.
-
- You can also set a locator for an individual proxy
- by calling the operation ice_locator on the proxy, or for an
- object adapter by calling the operation ObjectAdapter.setLocator
- on the object adapter.
-
- </summary>
- <param name="loc">The default locator to use for this communicator.
-
- </param>
- </member>
- <member name="M:Ice.Communicator.getPluginManager">
- <summary>
- Get the plug-in manager for this communicator.
- </summary>
- <returns>This communicator's plug-in manager.
-
- </returns>
- </member>
- <member name="M:Ice.Communicator.flushBatchRequests">
- <summary>
- Flush any pending batch requests for this communicator.
- This means all batch requests invoked on fixed proxies
- for all connections associated with the communicator.
- Any errors that occur while flushing a connection are ignored.
- </summary>
- </member>
- <member name="M:Ice.Communicator.createAdmin(Ice.ObjectAdapter,Ice.Identity)">
- <summary>
- Add the Admin object with all its facets to the provided object adapter.
- If Ice.Admin.ServerId is set and the provided object adapter has a Locator,
- createAdmin registers the Admin's Process facet with the Locator's LocatorRegistry.
-
- createAdmin call only be called once; subsequent calls raise InitializationException.
-
- </summary>
- <param name="adminAdapter">The object adapter used to host the Admin object; if null and
- Ice.Admin.Endpoints is set, create, activate and use the Ice.Admin object adapter.
-
- </param>
- <param name="adminId">The identity of the Admin object.
-
- </param>
- <returns>A proxy to the main ("") facet of the Admin object. Never returns a null proxy.
-
- </returns>
- </member>
- <member name="M:Ice.Communicator.getAdmin">
- <summary>
- Get a proxy to the main facet of the Admin object.
- getAdmin also creates the Admin object and creates and activates the Ice.Admin object
- adapter to host this Admin object if Ice.Admin.Enpoints is set. The identity of the Admin
- object created by getAdmin is /admin, or /admin
- when Ice.Admin.InstanceName is not set.
-
- If Ice.Admin.DelayCreation is 0 or not set, getAdmin is called by the communicator
- initialization, after initialization of all plugins.
-
- </summary>
- <returns>A proxy to the main ("") facet of the Admin object, or a null proxy if no
- Admin object is configured.
-
- </returns>
- </member>
- <member name="M:Ice.Communicator.addAdminFacet(Ice.Object,System.String)">
- <summary>
- Add a new facet to the Admin object.
- Adding a servant with a facet that is already registered
- throws AlreadyRegisteredException.
-
- </summary>
- <param name="servant">The servant that implements the new Admin facet.
- </param>
- <param name="facet">The name of the new Admin facet.</param>
- </member>
- <member name="M:Ice.Communicator.removeAdminFacet(System.String)">
- <summary>
- Remove the following facet to the Admin object.
- Removing a facet that was not previously registered throws
- NotRegisteredException.
-
- </summary>
- <param name="facet">The name of the Admin facet.
- </param>
- <returns>The servant associated with this Admin facet.</returns>
- </member>
- <member name="M:Ice.Communicator.findAdminFacet(System.String)">
- <summary>
- Returns a facet of the Admin object.
- </summary>
- <param name="facet">The name of the Admin facet.
- </param>
- <returns>The servant associated with this Admin facet, or
- null if no facet is registered with the given name.</returns>
- </member>
- <member name="M:Ice.Communicator.findAllAdminFacets">
- <summary>
- Returns a map of all facets of the Admin object.
- </summary>
- <returns>A collection containing all the facet names and
- servants of the Admin object.
-
- </returns>
- </member>
- <member name="M:Ice.Connection.close(System.Boolean)">
- <summary>
- Close a connection, either gracefully or forcefully.
- If a
- connection is closed forcefully, it closes immediately, without
- sending the relevant close connection protocol messages to the
- peer and waiting for the peer to acknowledge these protocol
- messages.
-
- </summary>
- <param name="force">If true, close forcefully. Otherwise the
- connection is closed gracefully.</param>
- </member>
- <member name="M:Ice.Connection.createProxy(Ice.Identity)">
- <summary>
- Create a special proxy that always uses this connection.
- This
- can be used for callbacks from a server to a client if the
- server cannot directly establish a connection to the client,
- for example because of firewalls. In this case, the server
- would create a proxy using an already established connection
- from the client.
-
- </summary>
- <param name="id">The identity for which a proxy is to be created.
-
- </param>
- <returns>A proxy that matches the given identity and uses this
- connection.
-
- </returns>
- </member>
- <member name="M:Ice.Connection.setAdapter(Ice.ObjectAdapter)">
- <summary>
- Explicitly set an object adapter that dispatches requests that
- are received over this connection.
- A client can invoke an
- operation on a server using a proxy, and then set an object
- adapter for the outgoing connection that is used by the proxy
- in order to receive callbacks. This is useful if the server
- cannot establish a connection back to the client, for example
- because of firewalls.
-
- </summary>
- <param name="adapter">The object adapter that should be used by this
- connection to dispatch requests. The object adapter must be
- activated. When the object adapter is deactivated, it is
- automatically removed from the connection.
-
- </param>
- </member>
- <member name="M:Ice.Connection.getAdapter">
- <summary>
- Get the object adapter that dispatches requests for this
- connection.
- </summary>
- <returns>The object adapter that dispatches requests for the
- connection, or null if no adapter is set.
-
- </returns>
- </member>
- <member name="M:Ice.Connection.getEndpoint">
- <summary>
- Get the endpoint from which the connection was created.
- </summary>
- <returns>The endpoint from which the connection was created.</returns>
- </member>
- <member name="M:Ice.Connection.flushBatchRequests">
- <summary>
- Flush any pending batch requests for this connection.
- This means all batch requests invoked on fixed proxies
- associated with the connection.
- </summary>
- </member>
- <member name="M:Ice.Connection.setCallback(Ice.ConnectionCallback)">
- <summary>
- Set callback on the connection.
- The callback is called by the
- connection when it's closed. The callback is called from the
- Ice thread pool associated with the connection.
-
- </summary>
- <param name="callback">The connection callback object.</param>
- </member>
- <member name="M:Ice.Connection.setACM(Ice.Optional{System.Int32},Ice.Optional{Ice.ACMClose},Ice.Optional{Ice.ACMHeartbeat})">
- <summary>
- Set the active connection management parameters.
- </summary>
- <param name="timeout">The timeout value in milliseconds.
-
- </param>
- <param name="close">The close condition
-
- </param>
- <param name="heartbeat">The hertbeat condition</param>
- </member>
- <member name="M:Ice.Connection.getACM">
- <summary>
- Get the ACM parameters.
- </summary>
- <returns>The ACM parameters.</returns>
- </member>
- <member name="M:Ice.Connection.type">
- <summary>
- Return the connection type.
- This corresponds to the endpoint
- type, i.e., "tcp", "udp", etc.
-
- </summary>
- <returns>The type of the connection.</returns>
- </member>
- <member name="M:Ice.Connection.timeout">
- <summary>
- Get the timeout for the connection.
- </summary>
- <returns>The connection's timeout.</returns>
- </member>
- <member name="M:Ice.Connection.ice_toString_">
- <summary>
- Return a description of the connection as human readable text,
- suitable for logging or error messages.
- </summary>
- <returns>The description of the connection as human readable
- text.</returns>
- </member>
- <member name="M:Ice.Connection.getInfo">
- <summary>
- Returns the connection information.
- </summary>
- <returns>The connection information.</returns>
- </member>
- <member name="M:Ice.Connection.setBufferSize(System.Int32,System.Int32)">
- <summary>
- Set the connectiion buffer receive/send size.
- </summary>
- <param name="rcvSize">The connection receive buffer size.
- </param>
- <param name="sndSize">The connection send buffer size.</param>
- </member>
- <member name="T:Ice.DispatchInterceptor">
- <summary>
- Base class that allows a server intercept incoming requests.
- The application must derive a concrete class from DispatchInterceptor
- that implements the DispatchInterceptor.dispatch operation. An instance of this derived
- class can be registered with an object adapter like any other servant.
- A dispatch interceptor is useful particularly to automatically retry requests
- that have failed due to a recoverable error condition.
- </summary>
- </member>
- <member name="T:Ice.ObjectImpl">
- <summary>
- Base class for all Slice classes.
- </summary>
- </member>
- <member name="T:Ice.Object">
- <summary>
- the base interface for servants.
- </summary>
- </member>
- <member name="M:Ice.Object.ice_isA(System.String)">
- <summary>
- Tests whether this object supports a specific Slice interface.
- </summary>
-
- <param name="s">The type ID of the Slice interface to test against.</param>
- <returns>True if this object has the interface
- specified by s or derives from the interface specified by s.</returns>
- </member>
- <member name="M:Ice.Object.ice_isA(System.String,Ice.Current)">
- <summary>
- Tests whether this object supports a specific Slice interface.
- </summary>
-
- <param name="s">The type ID of the Slice interface to test against.</param>
- <param name="current">The Current object for the invocation.</param>
- <returns>True if this object has the interface
- specified by s or derives from the interface specified by s.</returns>
- </member>
- <member name="M:Ice.Object.ice_ping">
- <summary>
- Tests whether this object can be reached.
- </summary>
- </member>
- <member name="M:Ice.Object.ice_ping(Ice.Current)">
- <summary>
- Tests whether this object can be reached.
- </summary>
- <param name="current">The Current object for the invocation.</param>
- </member>
- <member name="M:Ice.Object.ice_ids">
- <summary>
- Returns the Slice type IDs of the interfaces supported by this object.
- </summary>
- <returns>The Slice type IDs of the interfaces supported by this object, in base-to-derived
- order. The first element of the returned array is always ::Ice::Object.</returns>
- </member>
- <member name="M:Ice.Object.ice_ids(Ice.Current)">
- <summary>
- Returns the Slice type IDs of the interfaces supported by this object.
- </summary>
- <param name="current">The Current object for the invocation.</param>
- <returns>The Slice type IDs of the interfaces supported by this object, in base-to-derived
- order. The first element of the returned array is always ::Ice::Object.</returns>
- </member>
- <member name="M:Ice.Object.ice_id">
- <summary>
- Returns the Slice type ID of the most-derived interface supported by this object.
- </summary>
- <returns>The Slice type ID of the most-derived interface.</returns>
- </member>
- <member name="M:Ice.Object.ice_id(Ice.Current)">
- <summary>
- Returns the Slice type ID of the most-derived interface supported by this object.
- </summary>
- <param name="current">The Current object for the invocation.</param>
- <returns>The Slice type ID of the most-derived interface.</returns>
- </member>
- <member name="M:Ice.Object.ice_preMarshal">
- <summary>
- The Ice run time invokes this method prior to marshaling an object's data members. This allows a subclass
- to override this method in order to validate its data members.
- </summary>
- </member>
- <member name="M:Ice.Object.ice_postUnmarshal">
- <summary>
- This Ice run time invokes this method vafter unmarshaling an object's data members. This allows a
- subclass to override this method in order to perform additional initialization.
- </summary>
- </member>
- <member name="M:Ice.Object.ice_dispatch(Ice.Request,Ice.DispatchInterceptorAsyncCallback)">
- <summary>
- Dispatches an invocation to a servant. This method is used by dispatch interceptors to forward an invocation
- to a servant (or to another interceptor).
- </summary>
- <param name="request">The details of the invocation.</param>
- <param name="cb">The callback object for asynchchronous dispatch. For synchronous dispatch,
- the callback object must be null.</param>
- <returns>The dispatch status for the operation.</returns>
- </member>
- <member name="M:Ice.Object.ice_dispatch(Ice.Request)">
- <summary>
- Dispatches an invocation to a servant. This method is used by dispatch interceptors to forward an invocation
- to a servant (or to another interceptor).
- </summary>
- <param name="request">The details of the invocation.</param>
- <returns>The dispatch status for the operation.</returns>
- </member>
- <member name="M:Ice.ObjectImpl.#ctor">
- <summary>
- Instantiates an Ice object.
- </summary>
- </member>
- <member name="M:Ice.ObjectImpl.Clone">
- <summary>
- Returns a copy of the object. The cloned object contains field-for-field copies
- of the state.
- </summary>
- <returns>The cloned object.</returns>
- </member>
- <member name="M:Ice.ObjectImpl.ice_isA(System.String)">
- <summary>
- Tests whether this object supports a specific Slice interface.
- </summary>
- <param name="s">The type ID of the Slice interface to test against.</param>
- <returns>The return value is true if s is ::Ice::Object.</returns>
- </member>
- <member name="M:Ice.ObjectImpl.ice_isA(System.String,Ice.Current)">
- <summary>
- Tests whether this object supports a specific Slice interface.
- </summary>
- <param name="s">The type ID of the Slice interface to test against.</param>
- <param name="current">The Current object for the invocation.</param>
- <returns>The return value is true if s is ::Ice::Object.</returns>
- </member>
- <member name="M:Ice.ObjectImpl.ice_ping">
- <summary>
- Tests whether this object can be reached.
- </summary>
- </member>
- <member name="M:Ice.ObjectImpl.ice_ping(Ice.Current)">
- <summary>
- Tests whether this object can be reached.
- <param name="current">The Current object for the invocation.</param>
- </summary>
- </member>
- <member name="M:Ice.ObjectImpl.ice_ids">
- <summary>
- Returns the Slice type IDs of the interfaces supported by this object.
- </summary>
- <returns>An array whose only element is ::Ice::Object.</returns>
- </member>
- <member name="M:Ice.ObjectImpl.ice_ids(Ice.Current)">
- <summary>
- Returns the Slice type IDs of the interfaces supported by this object.
- </summary>
- <param name="current">The Current object for the invocation.</param>
- <returns>An array whose only element is ::Ice::Object.</returns>
- </member>
- <member name="M:Ice.ObjectImpl.ice_id">
- <summary>
- Returns the Slice type ID of the most-derived interface supported by this object.
- </summary>
- <returns>The return value is always ::Ice::Object.</returns>
- </member>
- <member name="M:Ice.ObjectImpl.ice_id(Ice.Current)">
- <summary>
- Returns the Slice type ID of the most-derived interface supported by this object.
- </summary>
- <param name="current">The Current object for the invocation.</param>
- <returns>The return value is always ::Ice::Object.</returns>
- </member>
- <member name="M:Ice.ObjectImpl.ice_staticId">
- <summary>
- Returns the Slice type ID of the interface supported by this object.
- </summary>
- <returns>The return value is always ::Ice::Object.</returns>
- </member>
- <member name="M:Ice.ObjectImpl.ice_preMarshal">
- <summary>
- The Ice run time invokes this method prior to marshaling an object's data members. This allows a subclass
- to override this method in order to validate its data members.
- </summary>
- </member>
- <member name="M:Ice.ObjectImpl.ice_postUnmarshal">
- <summary>
- This Ice run time invokes this method vafter unmarshaling an object's data members. This allows a
- subclass to override this method in order to perform additional initialization.
- </summary>
- </member>
- <member name="M:Ice.ObjectImpl.ice_dispatch(Ice.Request,Ice.DispatchInterceptorAsyncCallback)">
- <summary>
- Dispatches an invocation to a servant. This method is used by dispatch interceptors to forward an invocation
- to a servant (or to another interceptor).
- </summary>
- <param name="request">The details of the invocation.</param>
- <param name="cb">The callback object for asynchchronous dispatch. For synchronous dispatch, the
- callback object must be null.</param>
- <returns>The dispatch status for the operation.</returns>
- </member>
- <member name="M:Ice.ObjectImpl.ice_dispatch(Ice.Request)">
- <summary>
- Dispatches an invocation to a servant. This method is used by dispatch interceptors to forward an invocation
- to a servant (or to another interceptor).
- </summary>
- <param name="request">The details of the invocation.</param>
- <returns>The dispatch status for the operation.</returns>
- </member>
- <member name="M:Ice.DispatchInterceptor.dispatch(Ice.Request)">
- <summary>
- Called by the Ice run time to dispatch an incoming request. The implementation
- of <code>dispatch</code> must dispatch the request to the actual servant.
- </summary>
- <param name="request">The details of the incoming request.</param>
- <returns>For synchronous dispatch, the return value must be whatever is
- returned ice_dispatch. For asynchronous dispatch, the return
- value must be DispatchAsync.</returns>
- </member>
- <member name="M:Ice.Endpoint.ice_toString_">
- <summary>
- Return a string representation of the endpoint.
- </summary>
- <returns>The string representation of the endpoint.</returns>
- </member>
- <member name="M:Ice.Endpoint.getInfo">
- <summary>
- Returns the endpoint information.
- </summary>
- <returns>The endpoint information class.</returns>
- </member>
- <member name="T:Ice.Exception">
- <summary>
- Base class for Ice exceptions.
- </summary>
- </member>
- <member name="M:Ice.Exception.Clone">
- <summary>
- Creates and returns a copy of this exception.
- </summary>
- <returns>A copy of this exception.</returns>
- </member>
- <member name="M:Ice.Exception.#ctor">
- <summary>
- Creates a default-initialized exception.
- </summary>
- </member>
- <member name="M:Ice.Exception.#ctor(System.Exception)">
- <summary>
- Creates a default-initialized exception and sets the InnerException
- property to the passed exception.
- </summary>
- <param name="ex">The inner exception.</param>
- </member>
- <member name="M:Ice.Exception.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Initializes a new instance of the exception with serialized data.
- </summary>
- <param name="info">Holds the serialized object data about the exception being thrown.</param>
- <param name="context">Contains contextual information about the source or destination.</param>
- </member>
- <member name="M:Ice.Exception.ice_name">
- <summary>
- Returns the name of this exception.
- </summary>
- <returns>The name of this exception.</returns>
- </member>
- <member name="M:Ice.Exception.ToString">
- <summary>
- Returns a string representation of this exception, including
- any inner exceptions.
- </summary>
- <returns>The string representation of this exception.</returns>
- </member>
- <member name="T:Ice.LocalException">
- <summary>
- Base class for local exceptions.
- </summary>
- </member>
- <member name="M:Ice.LocalException.#ctor">
- <summary>
- Creates a default-initialized local exception.
- </summary>
- </member>
- <member name="M:Ice.LocalException.#ctor(System.Exception)">
- <summary>
- Creates a default-initialized local exception and sets the InnerException
- property to the passed exception.
- </summary>
- <param name="ex">The inner exception.</param>
- </member>
- <member name="M:Ice.LocalException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Initializes a new instance of the exception with serialized data.
- </summary>
- <param name="info">Holds the serialized object data about the exception being thrown.</param>
- <param name="context">Contains contextual information about the source or destination.</param>
- </member>
- <member name="T:Ice.SystemException">
- <summary>
- Base class for Ice run-time exceptions.
- </summary>
- </member>
- <member name="M:Ice.SystemException.#ctor">
- <summary>
- Creates a default-initialized run-time exception.
- </summary>
- </member>
- <member name="M:Ice.SystemException.#ctor(System.Exception)">
- <summary>
- Creates a default-initialized run-time exception and sets the InnerException
- property to the passed exception.
- </summary>
- <param name="ex">The inner exception.</param>
- </member>
- <member name="M:Ice.SystemException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Initializes a new instance of the exception with serialized data.
- </summary>
- <param name="info">Holds the serialized object data about the exception being thrown.</param>
- <param name="context">Contains contextual information about the source or destination.</param>
- </member>
- <member name="T:Ice.UserException">
- <summary>
- Base class for Slice user exceptions.
- </summary>
- </member>
- <member name="M:Ice.UserException.#ctor">
- <summary>
- Creates a default-initialized user exception.
- </summary>
- </member>
- <member name="M:Ice.UserException.#ctor(System.Exception)">
- <summary>
- Creates a default-initialized user exception and sets the InnerException
- property to the passed exception.
- </summary>
- <param name="ex">The inner exception.</param>
- </member>
- <member name="M:Ice.UserException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Initializes a new instance of the exception with serialized data.
- </summary>
- <param name="info">Holds the serialized object data about the exception being thrown.</param>
- <param name="context">Contains contextual information about the source or destination.</param>
- </member>
- <member name="T:Ice.FormatType">
- <summary>
- This enumeration describes the possible formats for classes and exceptions.
- </summary>
- </member>
- <member name="M:Ice.ImplicitContext.getContext">
- <summary>
- Get a copy of the underlying context.
- </summary>
- <returns>A copy of the underlying context.</returns>
- </member>
- <member name="M:Ice.ImplicitContext.setContext(System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- Set the underlying context.
- </summary>
- <param name="newContext">The new context.</param>
- </member>
- <member name="M:Ice.ImplicitContext.containsKey(System.String)">
- <summary>
- Check if this key has an associated value in the underlying context.
- </summary>
- <param name="key">The key.
-
- </param>
- <returns>True if the key has an associated value, False otherwise.</returns>
- </member>
- <member name="M:Ice.ImplicitContext.get(System.String)">
- <summary>
- Get the value associated with the given key in the underlying context.
- Returns an empty string if no value is associated with the key.
- containsKey allows you to distinguish between an empty-string value and
- no value at all.
-
- </summary>
- <param name="key">The key.
-
- </param>
- <returns>The value associated with the key.</returns>
- </member>
- <member name="M:Ice.ImplicitContext.put(System.String,System.String)">
- <summary>
- Create or update a key/value entry in the underlying context.
- </summary>
- <param name="key">The key.
-
- </param>
- <param name="value">The value.
-
- </param>
- <returns>The previous value associated with the key, if any.</returns>
- </member>
- <member name="M:Ice.ImplicitContext.remove(System.String)">
- <summary>
- Remove the entry for the given key in the underlying context.
- </summary>
- <param name="key">The key.
-
- </param>
- <returns>The value associated with the key, if any.</returns>
- </member>
- <member name="T:Ice.Request">
- <summary>
- Interface for incoming requests.
- </summary>
- </member>
- <member name="M:Ice.Request.getCurrent">
- <summary>
- Returns the {@link Current} object for this the request.
- </summary>
- <returns>The Current object for this request.</returns>
- </member>
- <member name="T:Ice.AMD_Object_ice_invoke">
- <summary>
- Callback interface for Blobject AMD servants.
- </summary>
- </member>
- <member name="M:Ice.AMD_Object_ice_invoke.ice_response(System.Boolean,System.Byte[])">
- <summary>
- Indicates to the Ice run time that an operation
- completed.
- </summary>
- <param name="ok">True indicates that the operation
- completed successfully; false indicates that the
- operation raised a user exception.</param>
- <param name="outEncaps">The encoded out-parameters for the operation or,
- if ok is false, the encoded user exception.</param>
- </member>
- <member name="M:Ice.Instrumentation.ObserverUpdater.updateConnectionObservers">
- <summary>
- Update connection observers associated with each of the Ice
- connection from the communicator and its object adapters.
- When called, this method goes through all the connections and
- for each connection CommunicatorObserver.getConnectionObserver
- is called. The implementation of getConnectionObserver has the
- possibility to return an updated observer if necessary.
- </summary>
- </member>
- <member name="M:Ice.Instrumentation.ObserverUpdater.updateThreadObservers">
- <summary>
- Update thread observers associated with each of the Ice thread
- from the communicator and its object adapters.
- When called, this method goes through all the threads and for
- each thread CommunicatorObserver.getThreadObserver is
- called. The implementation of getThreadObserver has the
- possibility to return an updated observer if necessary.
- </summary>
- </member>
- <member name="M:Ice.Instrumentation.Observer.attach">
- <summary>
- This method is called when the instrumented object is created
- or when the observer is attached to an existing object.
- </summary>
- </member>
- <member name="M:Ice.Instrumentation.Observer.detach">
- <summary>
- This method is called when the instrumented object is destroyed
- and as a result the observer detached from the object.
- </summary>
- </member>
- <member name="M:Ice.Instrumentation.Observer.failed(System.String)">
- <summary>
- Notification of a failure.
- </summary>
- <param name="exceptionName">The name of the exception.</param>
- </member>
- <member name="M:Ice.Instrumentation.ConnectionObserver.sentBytes(System.Int32)">
- <summary>
- Notification of sent bytes over the connection.
- </summary>
- <param name="num">The number of bytes sent.</param>
- </member>
- <member name="M:Ice.Instrumentation.ConnectionObserver.receivedBytes(System.Int32)">
- <summary>
- Notification of received bytes over the connection.
- </summary>
- <param name="num">The number of bytes received.</param>
- </member>
- <member name="M:Ice.Instrumentation.DispatchObserver.userException">
- <summary>
- Notification of a user exception.
- </summary>
- </member>
- <member name="M:Ice.Instrumentation.DispatchObserver.reply(System.Int32)">
- <summary>
- Reply notification.
- </summary>
- <param name="size">The size of the reply.</param>
- </member>
- <member name="M:Ice.Instrumentation.ChildInvocationObserver.reply(System.Int32)">
- <summary>
- Reply notification.
- </summary>
- <param name="size">The size of the reply.</param>
- </member>
- <member name="M:Ice.Instrumentation.InvocationObserver.retried">
- <summary>
- Notification of the invocation being retried.
- </summary>
- </member>
- <member name="M:Ice.Instrumentation.InvocationObserver.userException">
- <summary>
- Notification of a user exception.
- </summary>
- </member>
- <member name="M:Ice.Instrumentation.InvocationObserver.getRemoteObserver(Ice.ConnectionInfo,Ice.Endpoint,System.Int32,System.Int32)">
- <summary>
- Get a remote observer for this invocation.
- </summary>
- <param name="con">The connection information.
-
- </param>
- <param name="endpt">The connection endpoint.
-
- </param>
- <param name="requestId">The ID of the invocation.
-
- </param>
- <param name="size">The size of the invocation.
-
- </param>
- <returns>The observer to instrument the remote invocation.</returns>
- </member>
- <member name="M:Ice.Instrumentation.InvocationObserver.getCollocatedObserver(Ice.ObjectAdapter,System.Int32,System.Int32)">
- <summary>
- Get a collocated observer for this invocation.
- </summary>
- <param name="adapter">The object adapter hosting the collocated Ice object.
-
- </param>
- <param name="requestId">The ID of the invocation.
-
- </param>
- <param name="size">The size of the invocation.
-
- </param>
- <returns>The observer to instrument the collocated invocation.</returns>
- </member>
- <member name="M:Ice.Instrumentation.ThreadObserver.stateChanged(Ice.Instrumentation.ThreadState,Ice.Instrumentation.ThreadState)">
- <summary>
- Notification of thread state change.
- </summary>
- <param name="oldState">The previous thread state.
-
- </param>
- <param name="newState">The new thread state.</param>
- </member>
- <member name="M:Ice.Instrumentation.CommunicatorObserver.getConnectionEstablishmentObserver(Ice.Endpoint,System.String)">
- <summary>
- This method should return an observer for the given endpoint
- information and connector.
- The Ice run-time calls this method
- for each connection establishment attempt.
-
- </summary>
- <param name="endpt">The endpoint.
-
- </param>
- <param name="connector">The description of the connector. For IP
- transports, this is typically the IP address to connect to.
-
- </param>
- <returns>The observer to instrument the connection establishment.</returns>
- </member>
- <member name="M:Ice.Instrumentation.CommunicatorObserver.getEndpointLookupObserver(Ice.Endpoint)">
- <summary>
- This method should return an observer for the given endpoint
- information.
- The Ice run-time calls this method to resolve an
- endpoint and obtain the list of connectors.
-
- For IP endpoints, this typically involves doing a DNS lookup to
- obtain the IP addresses associated with the DNS name.
-
- </summary>
- <param name="endpt">The endpoint.
-
- </param>
- <returns>The observer to instrument the endpoint lookup.</returns>
- </member>
- <member name="M:Ice.Instrumentation.CommunicatorObserver.getConnectionObserver(Ice.ConnectionInfo,Ice.Endpoint,Ice.Instrumentation.ConnectionState,Ice.Instrumentation.ConnectionObserver)">
- <summary>
- This method should return a connection observer for the given
- connection.
- The Ice run-time calls this method for each new
- connection and for all the Ice communicator connections when
- ObserverUpdater.updateConnectionObservers is called.
-
- </summary>
- <param name="c">The connection information.
-
- </param>
- <param name="e">The connection endpoint.
-
- </param>
- <param name="s">The state of the connection.
-
- </param>
- <param name="o">The old connection observer if one is already set or a
- null reference otherwise.
-
- </param>
- <returns>The connection observer to instrument the connection.</returns>
- </member>
- <member name="M:Ice.Instrumentation.CommunicatorObserver.getThreadObserver(System.String,System.String,Ice.Instrumentation.ThreadState,Ice.Instrumentation.ThreadObserver)">
- <summary>
- This method should return a thread observer for the given
- thread.
- The Ice run-time calls this method for each new thread
- and for all the Ice communicator threads when
- ObserverUpdater.updateThreadObservers is called.
-
- </summary>
- <param name="parent">The parent of the thread.
-
- </param>
- <param name="id">The ID of the thread to observe.
-
- </param>
- <param name="s">The state of the thread.
-
- </param>
- <param name="o">The old thread observer if one is already set or a
- null reference otherwise.
-
- </param>
- <returns>The thread observer to instrument the thread.</returns>
- </member>
- <member name="M:Ice.Instrumentation.CommunicatorObserver.getInvocationObserver(Ice.ObjectPrx,System.String,System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- This method should return an invocation observer for the given
- invocation.
- The Ice run-time calls this method for each new
- invocation on a proxy.
-
- </summary>
- <param name="prx">The proxy used for the invocation.
-
- </param>
- <param name="operation">The name of the invocation.
-
- </param>
- <param name="ctx">The context specified by the user.
-
- </param>
- <returns>The invocation observer to instrument the invocation.</returns>
- </member>
- <member name="M:Ice.Instrumentation.CommunicatorObserver.getDispatchObserver(Ice.Current,System.Int32)">
- <summary>
- This method should return a dispatch observer for the given
- dispatch.
- The Ice run-time calls this method each time it
- receives an incoming invocation to be dispatched for an Ice
- object.
-
- </summary>
- <param name="c">The current object as provided to the Ice servant
- dispatching the invocation.
-
- </param>
- <param name="size">The size of the dispatch.
-
- </param>
- <returns>The dispatch observer to instrument the dispatch.</returns>
- </member>
- <member name="M:Ice.Instrumentation.CommunicatorObserver.setObserverUpdater(Ice.Instrumentation.ObserverUpdater)">
- <summary>
- The Ice run-time calls this method when the communicator is
- initialized.
- The add-in implementing this interface can use
- this object to get the Ice run-time to re-obtain observers for
- observed objects.
-
- </summary>
- <param name="updater">The observer updater object.</param>
- </member>
- <member name="M:Ice.EndpointInfo.type">
- <summary>
- Returns the type of the endpoint.
- </summary>
- </member>
- <member name="M:Ice.EndpointInfo.datagram">
- <summary>
- Returns true if this endpoint is a datagram endpoint.
- </summary>
- </member>
- <member name="M:Ice.EndpointInfo.secure">
- <summary>
- Returns true if this endpoint is a secure endpoint.
- </summary>
- </member>
- <member name="T:Ice.LoggerAdminOperations_">
- <summary>
- The interface of the admin object that allows an Ice application the attach its
- RemoteLogger to the Logger of this admin object's Ice communicator.
- </summary>
- </member>
- <member name="M:Ice.LoggerAdminOperations_.attachRemoteLogger(Ice.RemoteLoggerPrx,Ice.LogMessageType[],System.String[],System.Int32,Ice.Current)">
- <summary>
- attachRemoteLogger is called to attach a RemoteLogger object to
- the local Logger.
- attachRemoteLogger calls init on the provided RemoteLogger proxy.
-
- </summary>
- <param name="prx">A proxy to the remote logger.
-
- </param>
- <param name="messageTypes">The list of message types that the remote logger wishes to receive.
- An empty list means no filtering (send all message types).
-
- </param>
- <param name="traceCategories">The categories of traces that the remote logger wishes to receive.
- This parameter is ignored if messageTypes is not empty and does not include trace.
- An empty list means no filtering (send all trace categories).
-
- </param>
- <param name="messageMax">The maximum number of log messages (of all types) to be provided
- to RemoteLogger.init. A negative value requests all messages available.
-
- </param>
- <exception name="RemoteLoggerAlreadyAttachedException">Raised if this remote logger is already
- attached to this admin object.</exception>
- <param name="current__">The Current object for the invocation.</param>
- </member>
- <member name="M:Ice.LoggerAdminOperations_.detachRemoteLogger(Ice.RemoteLoggerPrx,Ice.Current)">
- <summary>
- detachRemoteLogger is called to detach a RemoteLogger object from
- the local Logger.
- </summary>
- <param name="prx">A proxy to the remote logger.
-
- </param>
- <returns>True if the provided remote logger proxy was detached, and false otherwise.</returns>
- <param name="current__">The Current object for the invocation.</param>
- </member>
- <member name="M:Ice.LoggerAdminOperations_.getLog(Ice.LogMessageType[],System.String[],System.Int32,System.String@,Ice.Current)">
- <summary>
- getLog retrieves log messages recently logged.
- </summary>
- <param name="messageTypes">The list of message types that the caller wishes to receive.
- An empty list means no filtering (send all message types).
-
- </param>
- <param name="traceCategories">The categories of traces that caller wish to receive.
- This parameter is ignored if messageTypes is not empty and does not include trace.
- An empty list means no filtering (send all trace categories).
-
- </param>
- <param name="messageMax">The maximum number of log messages (of all types) to be returned.
- A negative value requests all messages available.
-
- </param>
- <param name="prefix">The prefix of the associated local Logger.
-
- </param>
- <returns>The Log messages.</returns>
- <param name="current__">The Current object for the invocation.</param>
- </member>
- <member name="T:Ice.LoggerAdminOperationsNC_">
- <summary>
- The interface of the admin object that allows an Ice application the attach its
- RemoteLogger to the Logger of this admin object's Ice communicator.
- </summary>
- </member>
- <member name="M:Ice.LoggerAdminOperationsNC_.attachRemoteLogger(Ice.RemoteLoggerPrx,Ice.LogMessageType[],System.String[],System.Int32)">
- <summary>
- attachRemoteLogger is called to attach a RemoteLogger object to
- the local Logger.
- attachRemoteLogger calls init on the provided RemoteLogger proxy.
-
- </summary>
- <param name="prx">A proxy to the remote logger.
-
- </param>
- <param name="messageTypes">The list of message types that the remote logger wishes to receive.
- An empty list means no filtering (send all message types).
-
- </param>
- <param name="traceCategories">The categories of traces that the remote logger wishes to receive.
- This parameter is ignored if messageTypes is not empty and does not include trace.
- An empty list means no filtering (send all trace categories).
-
- </param>
- <param name="messageMax">The maximum number of log messages (of all types) to be provided
- to RemoteLogger.init. A negative value requests all messages available.
-
- </param>
- <exception name="RemoteLoggerAlreadyAttachedException">Raised if this remote logger is already
- attached to this admin object.</exception>
- </member>
- <member name="M:Ice.LoggerAdminOperationsNC_.detachRemoteLogger(Ice.RemoteLoggerPrx)">
- <summary>
- detachRemoteLogger is called to detach a RemoteLogger object from
- the local Logger.
- </summary>
- <param name="prx">A proxy to the remote logger.
-
- </param>
- <returns>True if the provided remote logger proxy was detached, and false otherwise.</returns>
- </member>
- <member name="M:Ice.LoggerAdminOperationsNC_.getLog(Ice.LogMessageType[],System.String[],System.Int32,System.String@)">
- <summary>
- getLog retrieves log messages recently logged.
- </summary>
- <param name="messageTypes">The list of message types that the caller wishes to receive.
- An empty list means no filtering (send all message types).
-
- </param>
- <param name="traceCategories">The categories of traces that caller wish to receive.
- This parameter is ignored if messageTypes is not empty and does not include trace.
- An empty list means no filtering (send all trace categories).
-
- </param>
- <param name="messageMax">The maximum number of log messages (of all types) to be returned.
- A negative value requests all messages available.
-
- </param>
- <param name="prefix">The prefix of the associated local Logger.
-
- </param>
- <returns>The Log messages.</returns>
- </member>
- <member name="M:Ice.Logger.print(System.String)">
- <summary>
- Print a message.
- The message is printed literally, without
- any decorations such as executable name or time stamp.
- </summary>
- </member>
- <member name="M:Ice.Logger.trace(System.String,System.String)">
- <summary>
- Log a trace message.
- </summary>
- <param name="category">The trace category.
-
- </param>
- <param name="message">The trace message to log.</param>
- </member>
- <member name="M:Ice.Logger.warning(System.String)">
- <summary>
- Log a warning message.
- </summary>
- <param name="message">The warning message to log.
-
- </param>
- </member>
- <member name="M:Ice.Logger.error(System.String)">
- <summary>
- Log an error message.
- </summary>
- <param name="message">The error message to log.
-
- </param>
- </member>
- <member name="M:Ice.Logger.getPrefix">
- <summary>
- Returns this logger's prefix.
- </summary>
- <returns>The prefix.</returns>
- </member>
- <member name="M:Ice.Logger.cloneWithPrefix(System.String)">
- <summary>
- Returns a clone of the logger with a new prefix.
- </summary>
- <param name="prefix">The new prefix for the logger.</param>
- </member>
- <member name="T:Ice.LoggerPlugin">
- <summary>
- Class to support custom loggers. Applications using a custom logger
- instantiate a LoggerPlugin with a custom logger and
- return the instance from their PluginFactory implementation.
- </summary>
- </member>
- <member name="M:Ice.Plugin.initialize">
- <summary>
- Perform any necessary initialization steps.
- </summary>
- </member>
- <member name="M:Ice.Plugin.destroy">
- <summary>
- Called when the communicator is being destroyed.
- </summary>
- </member>
- <member name="M:Ice.LoggerPlugin.#ctor(Ice.Communicator,Ice.Logger)">
- <summary>
- Installs a custom logger for a communicator.
- </summary>
- <param name="communicator">The communicator using the custom logger.</param>
- <param name="logger">The custom logger for the communicator.</param>
- </member>
- <member name="M:Ice.LoggerPlugin.initialize">
- <summary>
- Called by the Ice run time during communicator initialization. The derived class
- can override this method to perform any initialization that might be required
- by a custom logger.
- </summary>
- </member>
- <member name="M:Ice.LoggerPlugin.destroy">
- <summary>
- Called by the Ice run time when the communicator is destroyed. The derived class
- can override this method to perform any finalization that might be required
- by a custom logger.
- </summary>
- </member>
- <member name="T:IceMX.MetricsAdminOperations_">
- <summary>
- The metrics administrative facet interface.
- This interface allows
- remote administrative clients to access metrics of an application
- that enabled the Ice administrative facility and configured some
- metrics views.
- </summary>
- </member>
- <member name="M:IceMX.MetricsAdminOperations_.getMetricsViewNames(System.String[]@,Ice.Current)">
- <summary>
- Get the names of enabled and disabled metrics.
- </summary>
- <param name="disabledViews">The names of the disabled views.
-
- </param>
- <returns>The name of the enabled views.</returns>
- <param name="current__">The Current object for the invocation.</param>
- </member>
- <member name="M:IceMX.MetricsAdminOperations_.enableMetricsView(System.String,Ice.Current)">
- <summary>
- Enables a metrics view.
- </summary>
- <param name="name">The metrics view name.
-
- </param>
- <exception name="UnknownMetricsView">Raised if the metrics view cannot be
- found.</exception>
- <param name="current__">The Current object for the invocation.</param>
- </member>
- <member name="M:IceMX.MetricsAdminOperations_.disableMetricsView(System.String,Ice.Current)">
- <summary>
- Disable a metrics view.
- </summary>
- <param name="name">The metrics view name.
-
- </param>
- <exception name="UnknownMetricsView">Raised if the metrics view cannot be
- found.</exception>
- <param name="current__">The Current object for the invocation.</param>
- </member>
- <member name="M:IceMX.MetricsAdminOperations_.getMetricsView(System.String,System.Int64@,Ice.Current)">
- <summary>
- Get the metrics objects for the given metrics view.
- This
- returns a dictionnary of metric maps for each metrics class
- configured with the view. The timestamp allows the client to
- compute averages which are not dependent of the invocation
- latency for this operation.
-
- </summary>
- <param name="view">The name of the metrics view.
-
- </param>
- <param name="timestamp">The local time of the process when the metrics
- object were retrieved.
-
- </param>
- <returns>The metrics view data.
-
- </returns>
- <exception name="UnknownMetricsView">Raised if the metrics view cannot be
- found.</exception>
- <param name="current__">The Current object for the invocation.</param>
- </member>
- <member name="M:IceMX.MetricsAdminOperations_.getMapMetricsFailures(System.String,System.String,Ice.Current)">
- <summary>
- Get the metrics failures associated with the given view and map.
- </summary>
- <param name="view">The name of the metrics view.
-
- </param>
- <param name="map">The name of the metrics map.
-
- </param>
- <returns>The metrics failures associated with the map.
-
- </returns>
- <exception name="UnknownMetricsView">Raised if the metrics view cannot be
- found.</exception>
- <param name="current__">The Current object for the invocation.</param>
- </member>
- <member name="M:IceMX.MetricsAdminOperations_.getMetricsFailures(System.String,System.String,System.String,Ice.Current)">
- <summary>
- Get the metrics failure associated for the given metrics.
- </summary>
- <param name="view">The name of the metrics view.
-
- </param>
- <param name="map">The name of the metrics map.
-
- </param>
- <param name="id">The ID of the metrics.
-
- </param>
- <returns>The metrics failures associated with the metrics.
-
- </returns>
- <exception name="UnknownMetricsView">Raised if the metrics view cannot be
- found.</exception>
- <param name="current__">The Current object for the invocation.</param>
- </member>
- <member name="T:IceMX.MetricsAdminOperationsNC_">
- <summary>
- The metrics administrative facet interface.
- This interface allows
- remote administrative clients to access metrics of an application
- that enabled the Ice administrative facility and configured some
- metrics views.
- </summary>
- </member>
- <member name="M:IceMX.MetricsAdminOperationsNC_.getMetricsViewNames(System.String[]@)">
- <summary>
- Get the names of enabled and disabled metrics.
- </summary>
- <param name="disabledViews">The names of the disabled views.
-
- </param>
- <returns>The name of the enabled views.</returns>
- </member>
- <member name="M:IceMX.MetricsAdminOperationsNC_.enableMetricsView(System.String)">
- <summary>
- Enables a metrics view.
- </summary>
- <param name="name">The metrics view name.
-
- </param>
- <exception name="UnknownMetricsView">Raised if the metrics view cannot be
- found.</exception>
- </member>
- <member name="M:IceMX.MetricsAdminOperationsNC_.disableMetricsView(System.String)">
- <summary>
- Disable a metrics view.
- </summary>
- <param name="name">The metrics view name.
-
- </param>
- <exception name="UnknownMetricsView">Raised if the metrics view cannot be
- found.</exception>
- </member>
- <member name="M:IceMX.MetricsAdminOperationsNC_.getMetricsView(System.String,System.Int64@)">
- <summary>
- Get the metrics objects for the given metrics view.
- This
- returns a dictionnary of metric maps for each metrics class
- configured with the view. The timestamp allows the client to
- compute averages which are not dependent of the invocation
- latency for this operation.
-
- </summary>
- <param name="view">The name of the metrics view.
-
- </param>
- <param name="timestamp">The local time of the process when the metrics
- object were retrieved.
-
- </param>
- <returns>The metrics view data.
-
- </returns>
- <exception name="UnknownMetricsView">Raised if the metrics view cannot be
- found.</exception>
- </member>
- <member name="M:IceMX.MetricsAdminOperationsNC_.getMapMetricsFailures(System.String,System.String)">
- <summary>
- Get the metrics failures associated with the given view and map.
- </summary>
- <param name="view">The name of the metrics view.
-
- </param>
- <param name="map">The name of the metrics map.
-
- </param>
- <returns>The metrics failures associated with the map.
-
- </returns>
- <exception name="UnknownMetricsView">Raised if the metrics view cannot be
- found.</exception>
- </member>
- <member name="M:IceMX.MetricsAdminOperationsNC_.getMetricsFailures(System.String,System.String,System.String)">
- <summary>
- Get the metrics failure associated for the given metrics.
- </summary>
- <param name="view">The name of the metrics view.
-
- </param>
- <param name="map">The name of the metrics map.
-
- </param>
- <param name="id">The ID of the metrics.
-
- </param>
- <returns>The metrics failures associated with the metrics.
-
- </returns>
- <exception name="UnknownMetricsView">Raised if the metrics view cannot be
- found.</exception>
- </member>
- <member name="T:Ice.DispatchStatus">
- <summary>
- Indicates the status of operation dispatch.
- </summary>
- </member>
- <member name="F:Ice.DispatchStatus.DispatchOK">
- <summary>
- Indicates that an operation was dispatched synchronously and successfully.
- </summary>
- </member>
- <member name="F:Ice.DispatchStatus.DispatchUserException">
- <summary>
- Indicates that an operation was dispatched synchronously and raised a user exception.
- </summary>
- </member>
- <member name="F:Ice.DispatchStatus.DispatchAsync">
- <summary>
- Indicates that an operation was dispatched asynchronously.
- </summary>
- </member>
- <member name="T:Ice.Blobject">
- <summary>
- Base class for dynamic dispatch servants. A server application
- derives a concrete servant class from Blobject that
- implements the Blobject.ice_invoke method.
- </summary>
- </member>
- <member name="M:Ice.Blobject.ice_invoke(System.Byte[],System.Byte[]@,Ice.Current)">
- <summary>
- Dispatch an incoming request.
- </summary>
- <param name="inParams">The encoded in-parameters for the operation.</param>
- <param name="outParams">The encoded out-paramaters and return value
- for the operation. The return value follows any out-parameters.</param>
- <param name="current">The Current object to pass to the operation.</param>
- <returns>If the operation completed successfully, the return value
- is true. If the operation raises a user exception,
- the return value is false; in this case, outParams
- must contain the encoded user exception. If the operation raises an
- Ice run-time exception, it must throw it directly.</returns>
- </member>
- <member name="M:Ice.ObjectAdapter.getName">
- <summary>
- Get the name of this object adapter.
- </summary>
- <returns>This object adapter's name.</returns>
- </member>
- <member name="M:Ice.ObjectAdapter.getCommunicator">
- <summary>
- Get the communicator this object adapter belongs to.
- </summary>
- <returns>This object adapter's communicator.
-
- </returns>
- </member>
- <member name="M:Ice.ObjectAdapter.activate">
- <summary>
- Activate all endpoints that belong to this object adapter.
- After activation, the object adapter can dispatch requests
- received through its endpoints.
-
- </summary>
- </member>
- <member name="M:Ice.ObjectAdapter.hold">
- <summary>
- Temporarily hold receiving and dispatching requests.
- The object
- adapter can be reactivated with the activate operation.
-
- Holding is not immediate, i.e., after hold
- returns, the object adapter might still be active for some
- time. You can use waitForHold to wait until holding is
- complete.
-
- </summary>
- </member>
- <member name="M:Ice.ObjectAdapter.waitForHold">
- <summary>
- Wait until the object adapter holds requests.
- Calling hold
- initiates holding of requests, and waitForHold only returns
- when holding of requests has been completed.
-
- </summary>
- </member>
- <member name="M:Ice.ObjectAdapter.deactivate">
- <summary>
- Deactivate all endpoints that belong to this object adapter.
- After deactivation, the object adapter stops receiving
- requests through its endpoints. Object adapters that have been
- deactivated must not be reactivated again, and cannot be used
- otherwise. Attempts to use a deactivated object adapter raise
- ObjectAdapterDeactivatedException; however, attempts to
- deactivate an already deactivated object adapter are
- ignored and do nothing. Once deactivated, it is possible to
- destroy the adapter to clean up resources and then create and
- activate a new adapter with the same name.
-
- After deactivate returns, no new requests
- are processed by the object adapter. However, requests that
- have been started before deactivate was called might
- still be active. You can use waitForDeactivate to wait
- for the completion of all requests for this object adapter.
-
- </summary>
- </member>
- <member name="M:Ice.ObjectAdapter.waitForDeactivate">
- <summary>
- Wait until the object adapter has deactivated.
- Calling
- deactivate initiates object adapter deactivation, and
- waitForDeactivate only returns when deactivation has
- been completed.
-
- </summary>
- </member>
- <member name="M:Ice.ObjectAdapter.isDeactivated">
- <summary>
- Check whether object adapter has been deactivated.
- </summary>
- <returns>Whether adapter has been deactivated.
-
- </returns>
- </member>
- <member name="M:Ice.ObjectAdapter.destroy">
- <summary>
- Destroys the object adapter and cleans up all resources held by
- the object adapter.
- If the object adapter has not yet been
- deactivated, destroy implicitly initiates the deactivation
- and waits for it to finish. Subsequent calls to destroy are
- ignored. Once destroy has returned, it is possible to create
- another object adapter with the same name.
-
- </summary>
- </member>
- <member name="M:Ice.ObjectAdapter.add(Ice.Object,Ice.Identity)">
- <summary>
- Add a servant to this object adapter's Active Servant Map.
- Note
- that one servant can implement several Ice objects by registering
- the servant with multiple identities. Adding a servant with an
- identity that is in the map already throws AlreadyRegisteredException.
-
- </summary>
- <param name="servant">The servant to add.
-
- </param>
- <param name="id">The identity of the Ice object that is implemented by
- the servant.
-
- </param>
- <returns>A proxy that matches the given identity and this object
- adapter.
-
- </returns>
- </member>
- <member name="M:Ice.ObjectAdapter.addFacet(Ice.Object,Ice.Identity,System.String)">
- <summary>
- Like add, but with a facet.
- Calling add(servant, id)
- is equivalent to calling addFacet with an empty facet.
-
- </summary>
- <param name="servant">The servant to add.
-
- </param>
- <param name="id">The identity of the Ice object that is implemented by
- the servant.
-
- </param>
- <param name="facet">The facet. An empty facet means the default facet.
-
- </param>
- <returns>A proxy that matches the given identity, facet, and
- this object adapter.
-
- </returns>
- </member>
- <member name="M:Ice.ObjectAdapter.addWithUUID(Ice.Object)">
- <summary>
- Add a servant to this object adapter's Active Servant Map,
- using an automatically generated UUID as its identity.
- Note that
- the generated UUID identity can be accessed using the proxy's
- ice_getIdentity operation.
-
- </summary>
- <param name="servant">The servant to add.
-
- </param>
- <returns>A proxy that matches the generated UUID identity and
- this object adapter.
-
- </returns>
- </member>
- <member name="M:Ice.ObjectAdapter.addFacetWithUUID(Ice.Object,System.String)">
- <summary>
- Like addWithUUID, but with a facet.
- Calling
- addWithUUID(servant) is equivalent to calling
- addFacetWithUUID with an empty facet.
-
- </summary>
- <param name="servant">The servant to add.
-
- </param>
- <param name="facet">The facet. An empty facet means the default
- facet.
-
- </param>
- <returns>A proxy that matches the generated UUID identity,
- facet, and this object adapter.
-
- </returns>
- </member>
- <member name="M:Ice.ObjectAdapter.addDefaultServant(Ice.Object,System.String)">
- <summary>
- Add a default servant to handle requests for a specific
- category.
- Adding a default servant for a category for
- which a default servant is already registered throws
- AlreadyRegisteredException. To dispatch operation
- calls on servants, the object adapter tries to find a servant
- for a given Ice object identity and facet in the following
- order:
-
-
-
- The object adapter tries to find a servant for the identity
- and facet in the Active Servant Map.
-
- If no servant has been found in the Active Servant Map, the
- object adapter tries to find a default servant for the category
- component of the identity.
-
- If no servant has been found by any of the preceding steps,
- the object adapter tries to find a default servant for an empty
- category, regardless of the category contained in the identity.
-
- If no servant has been found by any of the preceding steps,
- the object adapter gives up and the caller receives
- ObjectNotExistException or FacetNotExistException.
-
-
-
- </summary>
- <param name="servant">The default servant.
-
- </param>
- <param name="category">The category for which the default servant is
- registered. An empty category means it will handle all categories.
-
- </param>
- </member>
- <member name="M:Ice.ObjectAdapter.remove(Ice.Identity)">
- <summary>
- Remove a servant (that is, the default facet) from the object
- adapter's Active Servant Map.
- </summary>
- <param name="id">The identity of the Ice object that is implemented by
- the servant. If the servant implements multiple Ice objects,
- remove has to be called for all those Ice objects.
- Removing an identity that is not in the map throws
- NotRegisteredException.
-
- </param>
- <returns>The removed servant.
-
- </returns>
- </member>
- <member name="M:Ice.ObjectAdapter.removeFacet(Ice.Identity,System.String)">
- <summary>
- Like remove, but with a facet.
- Calling remove(id)
- is equivalent to calling removeFacet with an empty facet.
-
- </summary>
- <param name="id">The identity of the Ice object that is implemented by
- the servant.
-
- </param>
- <param name="facet">The facet. An empty facet means the default facet.
-
- </param>
- <returns>The removed servant.
-
- </returns>
- </member>
- <member name="M:Ice.ObjectAdapter.removeAllFacets(Ice.Identity)">
- <summary>
- Remove all facets with the given identity from the Active
- Servant Map.
- The operation completely removes the Ice object,
- including its default facet. Removing an identity that
- is not in the map throws NotRegisteredException.
-
- </summary>
- <param name="id">The identity of the Ice object to be removed.
-
- </param>
- <returns>A collection containing all the facet names and
- servants of the removed Ice object.
-
- </returns>
- </member>
- <member name="M:Ice.ObjectAdapter.removeDefaultServant(System.String)">
- <summary>
- Remove the default servant for a specific category.
- Attempting
- to remove a default servant for a category that is not
- registered throws NotRegisteredException.
-
- </summary>
- <param name="category">The category of the default servant to remove.
-
- </param>
- <returns>The default servant.
-
- </returns>
- </member>
- <member name="M:Ice.ObjectAdapter.find(Ice.Identity)">
- <summary>
- Look up a servant in this object adapter's Active Servant Map
- by the identity of the Ice object it implements.
- This operation only tries to look up a servant in
- the Active Servant Map. It does not attempt to find a servant
- by using any installed ServantLocator.
-
- </summary>
- <param name="id">The identity of the Ice object for which the servant
- should be returned.
-
- </param>
- <returns>The servant that implements the Ice object with the
- given identity, or null if no such servant has been found.
-
- </returns>
- </member>
- <member name="M:Ice.ObjectAdapter.findFacet(Ice.Identity,System.String)">
- <summary>
- Like find, but with a facet.
- Calling find(id)
- is equivalent to calling findFacet with an empty
- facet.
-
- </summary>
- <param name="id">The identity of the Ice object for which the
- servant should be returned.
-
- </param>
- <param name="facet">The facet. An empty facet means the default
- facet.
-
- </param>
- <returns>The servant that implements the Ice object with the
- given identity and facet, or null if no such servant has been
- found.
-
- </returns>
- </member>
- <member name="M:Ice.ObjectAdapter.findAllFacets(Ice.Identity)">
- <summary>
- Find all facets with the given identity in the Active Servant
- Map.
- </summary>
- <param name="id">The identity of the Ice object for which the facets
- should be returned.
-
- </param>
- <returns>A collection containing all the facet names and
- servants that have been found, or an empty map if there is no
- facet for the given identity.
-
- </returns>
- </member>
- <member name="M:Ice.ObjectAdapter.findByProxy(Ice.ObjectPrx)">
- <summary>
- Look up a servant in this object adapter's Active Servant Map,
- given a proxy.
- This operation only tries to lookup a servant in
- the Active Servant Map. It does not attempt to find a servant
- by using any installed ServantLocator.
-
- </summary>
- <param name="proxy">The proxy for which the servant should be returned.
-
- </param>
- <returns>The servant that matches the proxy, or null if no such
- servant has been found.
-
- </returns>
- </member>
- <member name="M:Ice.ObjectAdapter.addServantLocator(Ice.ServantLocator,System.String)">
- <summary>
- Add a Servant Locator to this object adapter.
- Adding a servant
- locator for a category for which a servant locator is already
- registered throws AlreadyRegisteredException. To dispatch
- operation calls on servants, the object adapter tries to find a
- servant for a given Ice object identity and facet in the
- following order:
-
-
-
- The object adapter tries to find a servant for the identity
- and facet in the Active Servant Map.
-
- If no servant has been found in the Active Servant Map,
- the object adapter tries to find a servant locator for the
- category component of the identity. If a locator is found, the
- object adapter tries to find a servant using this locator.
-
- If no servant has been found by any of the preceding steps,
- the object adapter tries to find a locator for an empty category,
- regardless of the category contained in the identity. If a
- locator is found, the object adapter tries to find a servant
- using this locator.
-
- If no servant has been found by any of the preceding steps,
- the object adapter gives up and the caller receives
- ObjectNotExistException or FacetNotExistException.
-
-
-
- Only one locator for the empty category can be
- installed.
-
- </summary>
- <param name="locator">The locator to add.
-
- </param>
- <param name="category">The category for which the Servant Locator can
- locate servants, or an empty string if the Servant Locator does
- not belong to any specific category.
-
- </param>
- </member>
- <member name="M:Ice.ObjectAdapter.removeServantLocator(System.String)">
- <summary>
- Remove a Servant Locator from this object adapter.
- </summary>
- <param name="category">The category for which the Servant Locator can
- locate servants, or an empty string if the Servant Locator does
- not belong to any specific category.
-
- </param>
- <returns>The Servant Locator, or throws NotRegisteredException
- if no Servant Locator was found for the given category.
-
- </returns>
- </member>
- <member name="M:Ice.ObjectAdapter.findServantLocator(System.String)">
- <summary>
- Find a Servant Locator installed with this object adapter.
- </summary>
- <param name="category">The category for which the Servant Locator can
- locate servants, or an empty string if the Servant Locator does
- not belong to any specific category.
-
- </param>
- <returns>The Servant Locator, or null if no Servant Locator was
- found for the given category.
-
- </returns>
- </member>
- <member name="M:Ice.ObjectAdapter.findDefaultServant(System.String)">
- <summary>
- Find the default servant for a specific category.
- </summary>
- <param name="category">The category of the default servant to find.
-
- </param>
- <returns>The default servant or null if no default servant was
- registered for the category.
-
- </returns>
- </member>
- <member name="M:Ice.ObjectAdapter.createProxy(Ice.Identity)">
- <summary>
- Create a proxy for the object with the given identity.
- If this
- object adapter is configured with an adapter id, the return
- value is an indirect proxy that refers to the adapter id. If
- a replica group id is also defined, the return value is an
- indirect proxy that refers to the replica group id. Otherwise,
- if no adapter id is defined, the return value is a direct
- proxy containing this object adapter's published endpoints.
-
- </summary>
- <param name="id">The object's identity.
-
- </param>
- <returns>A proxy for the object with the given identity.
-
- </returns>
- </member>
- <member name="M:Ice.ObjectAdapter.createDirectProxy(Ice.Identity)">
- <summary>
- Create a direct proxy for the object with the given identity.
- The returned proxy contains this object adapter's published
- endpoints.
-
- </summary>
- <param name="id">The object's identity.
-
- </param>
- <returns>A proxy for the object with the given identity.
-
- </returns>
- </member>
- <member name="M:Ice.ObjectAdapter.createIndirectProxy(Ice.Identity)">
- <summary>
- Create an indirect proxy for the object with the given identity.
- If this object adapter is configured with an adapter id, the
- return value refers to the adapter id. Otherwise, the return
- value contains only the object identity.
-
- </summary>
- <param name="id">The object's identity.
-
- </param>
- <returns>A proxy for the object with the given identity.
-
- </returns>
- </member>
- <member name="M:Ice.ObjectAdapter.setLocator(Ice.LocatorPrx)">
- <summary>
- Set an Ice locator for this object adapter.
- By doing so, the
- object adapter will register itself with the locator registry
- when it is activated for the first time. Furthermore, the proxies
- created by this object adapter will contain the adapter identifier
- instead of its endpoints. The adapter identifier must be configured
- using the AdapterId property.
-
- </summary>
- <param name="loc">The locator used by this object adapter.
-
- </param>
- </member>
- <member name="M:Ice.ObjectAdapter.getLocator">
- <summary>
- Get the Ice locator used by this object adapter.
- </summary>
- <returns> The locator used by this object adapter, or null if no locator is
- used by this object adapter.
-
- </returns>
- </member>
- <member name="M:Ice.ObjectAdapter.refreshPublishedEndpoints">
- <summary>
- Refresh the set of published endpoints.
- The run time re-reads
- the PublishedEndpoints property if it is set and re-reads the
- list of local interfaces if the adapter is configured to listen
- on all endpoints. This operation is useful to refresh the endpoint
- information that is published in the proxies that are created by
- an object adapter if the network interfaces used by a host changes.
- </summary>
- </member>
- <member name="M:Ice.ObjectAdapter.getEndpoints">
- <summary>
- Get the set of endpoints configured with this object adapter.
- </summary>
- <returns>The set of endpoints.
-
- </returns>
- </member>
- <member name="M:Ice.ObjectAdapter.getPublishedEndpoints">
- <summary>
- Get the set of endpoints that proxies created by this object
- adapter will contain.
- </summary>
- <returns>The set of published endpoints.
-
- </returns>
- </member>
- <member name="T:Ice.Optional`1">
- <summary>
- Encapsulates an optional value. Instances of this type are immutable.
- </summary>
- </member>
- <member name="M:Ice.Optional`1.#ctor(Ice.NoneType)">
- <summary>
- Creates an optional value whose state is unset.
- </summary>
- </member>
- <member name="M:Ice.Optional`1.#ctor(`0)">
- <summary>
- Creates an optional value and sets its value to the given argument.
- </summary>
- </member>
- <member name="M:Ice.Optional`1.#ctor(Ice.Optional{`0})">
- <summary>
- Creates an optional value whose state is copied from the given argument.
- </summary>
- </member>
- <member name="M:Ice.Optional`1.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Initializes a new instance of the exception with serialized data.
- </summary>
- <param name="info">Holds the serialized object data about the exception being thrown.</param>
- <param name="context">Contains contextual information about the source or destination.</param>
- </member>
- <member name="M:Ice.Optional`1.op_Explicit(Ice.Optional{`0})~`0">
- <summary>
- Conversion operator to the underlying type; a cast is required. An exception
- is raised if no value is set.
- </summary>
- <returns>The encapsulated value.</returns>
- <exception cref="T:System.InvalidOperationException">Thrown if no value is set.</exception>
- </member>
- <member name="M:Ice.Optional`1.op_Implicit(`0)~Ice.Optional{`0}">
- <summary>
- Conversion operator from a value of the underlying type; no cast is required.
- </summary>
- </member>
- <member name="M:Ice.Optional`1.op_Implicit(Ice.NoneType)~Ice.Optional{`0}">
- <summary>
- Conversion operator from a None value; no cast is required.
- </summary>
- </member>
- <member name="M:Ice.Optional`1.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Serializes an optional value.
- </summary>
- <param name="info">Holds the serialized object data about the exception being thrown.</param>
- <param name="context">Contains contextual information about the source or destination.</param>
- </member>
- <member name="P:Ice.Optional`1.Value">
- <summary>
- Reads and writes the encapsulated value.
- </summary>
- <exception cref="T:System.InvalidOperationException">Thrown if the property is read and no value is
- set.</exception>
- </member>
- <member name="P:Ice.Optional`1.HasValue">
- <summary>
- Determines whether a value is set.
- </summary>
- <returns>True if a value is set, false otherwise.</returns>
- </member>
- <member name="T:Ice.OptionalPatcher`1">
- <summary>
- Handles callbacks for an optional object parameter.
- </summary>
- </member>
- <member name="T:Ice.ReadObjectCallback">
- <summary>
- Callback class to inform an application when a Slice class has been unmarshaled
- from an input stream.
- </summary>
- </member>
- <member name="M:Ice.ReadObjectCallback.invoke(Ice.Object)">
- <summary>
- The Ice run time calls this method when it has fully unmarshaled the state
- of a Slice class.
- </summary>
- <param name="obj">The unmarshaled Slice class.</param>
- </member>
- <member name="M:Ice.OptionalPatcher`1.#ctor(System.String)">
- <summary>
- Instantiates the class with the given optional.
- </summary>
- <param name="type">The Slice type ID corresponding to the formal type.</param>
- </member>
- <member name="M:Ice.OptionalPatcher`1.patch(Ice.Object)">
- <summary>
- Sets the Ice object of the optional to the passed instance.
- </summary>
- <param name="v">The new object for the optional.</param>
- </member>
- <member name="F:Ice.OptionalPatcher`1.value">
- <summary>
- The target optional.
- </summary>
- </member>
- <member name="T:Ice.OptionalFormat">
- <summary>
- The optional format.
-
- An optional value is encoded with a specific optional format. This optional
- format describes how the data is encoded and how it can be skipped by the
- unmarshaling code if the optional is not known to the receiver.
- </summary>
- </member>
- <member name="T:Ice.PluginFactory">
- <summary>
- Applications implement this interface to provide a plug-in factory
- to the Ice run time.
- </summary>
- </member>
- <member name="M:Ice.PluginFactory.create(Ice.Communicator,System.String,System.String[])">
- <summary>
- Called by the Ice run time to create a new plug-in.
- </summary>
-
- <param name="communicator">The communicator that is in the process of being initialized.</param>
- <param name="name">The name of the plug-in.</param>
- <param name="args">The arguments that are specified in the plug-ins configuration.</param>
- <returns>The plug-in that was created by this method.</returns>
- </member>
- <member name="M:Ice.PluginManager.initializePlugins">
- <summary>
- Initialize the configured plug-ins.
- The communicator automatically initializes
- the plug-ins by default, but an application may need to interact directly with
- a plug-in prior to initialization. In this case, the application must set
- Ice.InitPlugins=0 and then invoke initializePlugins
- manually. The plug-ins are initialized in the order in which they are loaded.
- If a plug-in raises an exception during initialization, the communicator
- invokes destroy on the plug-ins that have already been initialized.
-
- </summary>
- <exception name="InitializationException">Raised if the plug-ins have already been initialized.</exception>
- </member>
- <member name="M:Ice.PluginManager.getPlugins">
- <summary>
- Get a list of plugins installed.
- </summary>
- <returns>The names of the plugins installed.
-
- </returns>
- </member>
- <member name="M:Ice.PluginManager.getPlugin(System.String)">
- <summary>
- Obtain a plug-in by name.
- </summary>
- <param name="name">The plug-in's name.
-
- </param>
- <returns>The plug-in.
-
- </returns>
- <exception name="NotRegisteredException">Raised if no plug-in is found with the given name.</exception>
- </member>
- <member name="M:Ice.PluginManager.addPlugin(System.String,Ice.Plugin)">
- <summary>
- Install a new plug-in.
- </summary>
- <param name="name">The plug-in's name.
-
- </param>
- <param name="pi">The plug-in.
-
- </param>
- <exception name="AlreadyRegisteredException">Raised if a plug-in already exists with the given name.</exception>
- </member>
- <member name="M:Ice.PluginManager.destroy">
- <summary>
- Called when the communicator is being destroyed.
- </summary>
- </member>
- <member name="T:Ice.ProcessOperations_">
- <summary>
- An administrative interface for process management.
- Managed servers must
- implement this interface.
-
- A servant implementing this interface is a potential target
- for denial-of-service attacks, therefore proper security precautions
- should be taken. For example, the servant can use a UUID to make its
- identity harder to guess, and be registered in an object adapter with
- a secured endpoint.
- </summary>
- </member>
- <member name="M:Ice.ProcessOperations_.shutdown(Ice.Current)">
- <summary>
- Initiate a graceful shut-down.
- </summary>
- <param name="current__">The Current object for the invocation.</param>
- </member>
- <member name="M:Ice.ProcessOperations_.writeMessage(System.String,System.Int32,Ice.Current)">
- <summary>
- Write a message on the process' stdout or stderr.
- </summary>
- <param name="message">The message.
-
- </param>
- <param name="fd">1 for stdout, 2 for stderr.</param>
- <param name="current__">The Current object for the invocation.</param>
- </member>
- <member name="T:Ice.ProcessOperationsNC_">
- <summary>
- An administrative interface for process management.
- Managed servers must
- implement this interface.
-
- A servant implementing this interface is a potential target
- for denial-of-service attacks, therefore proper security precautions
- should be taken. For example, the servant can use a UUID to make its
- identity harder to guess, and be registered in an object adapter with
- a secured endpoint.
- </summary>
- </member>
- <member name="M:Ice.ProcessOperationsNC_.shutdown">
- <summary>
- Initiate a graceful shut-down.
- </summary>
- </member>
- <member name="M:Ice.ProcessOperationsNC_.writeMessage(System.String,System.Int32)">
- <summary>
- Write a message on the process' stdout or stderr.
- </summary>
- <param name="message">The message.
-
- </param>
- <param name="fd">1 for stdout, 2 for stderr.</param>
- </member>
- <member name="T:Ice.PropertiesAdminOperations_">
- <summary>
- The PropertiesAdmin interface provides remote access to the properties
- of a communicator.
- </summary>
- </member>
- <member name="M:Ice.PropertiesAdminOperations_.getProperty(System.String,Ice.Current)">
- <summary>
- Get a property by key.
- If the property is not set, an empty
- string is returned.
-
- </summary>
- <param name="key">The property key.
-
- </param>
- <returns>The property value.</returns>
- <param name="current__">The Current object for the invocation.</param>
- </member>
- <member name="M:Ice.PropertiesAdminOperations_.getPropertiesForPrefix(System.String,Ice.Current)">
- <summary>
- Get all properties whose keys begin with prefix.
- If
- prefix is an empty string then all properties are returned.
-
- </summary>
- <param name="prefix">The prefix to search for (empty string if none).
- </param>
- <returns>The matching property set.</returns>
- <param name="current__">The Current object for the invocation.</param>
- </member>
- <member name="M:Ice.PropertiesAdminOperations_.setProperties_async(Ice.AMD_PropertiesAdmin_setProperties,System.Collections.Generic.Dictionary{System.String,System.String},Ice.Current)">
- <summary>
- Update the communicator's properties with the given property set.
- </summary>
- <param name="cb__">The callback object for the operation.</param>
- <param name="newProperties">Properties to be added, changed, or removed.
- If an entry in newProperties matches the name of an existing property,
- that property's value is replaced with the new value. If the new value
- is an empty string, the property is removed. Any existing properties
- that are not modified or removed by the entries in newProperties are
- retained with their original values.</param>
- <param name="current__">The Current object for the invocation.</param>
- </member>
- <member name="T:Ice.PropertiesAdminOperationsNC_">
- <summary>
- The PropertiesAdmin interface provides remote access to the properties
- of a communicator.
- </summary>
- </member>
- <member name="M:Ice.PropertiesAdminOperationsNC_.getProperty(System.String)">
- <summary>
- Get a property by key.
- If the property is not set, an empty
- string is returned.
-
- </summary>
- <param name="key">The property key.
-
- </param>
- <returns>The property value.</returns>
- </member>
- <member name="M:Ice.PropertiesAdminOperationsNC_.getPropertiesForPrefix(System.String)">
- <summary>
- Get all properties whose keys begin with prefix.
- If
- prefix is an empty string then all properties are returned.
-
- </summary>
- <param name="prefix">The prefix to search for (empty string if none).
- </param>
- <returns>The matching property set.</returns>
- </member>
- <member name="M:Ice.PropertiesAdminOperationsNC_.setProperties_async(Ice.AMD_PropertiesAdmin_setProperties,System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- Update the communicator's properties with the given property set.
- </summary>
- <param name="cb__">The callback object for the operation.</param>
- <param name="newProperties">Properties to be added, changed, or removed.
- If an entry in newProperties matches the name of an existing property,
- that property's value is replaced with the new value. If the new value
- is an empty string, the property is removed. Any existing properties
- that are not modified or removed by the entries in newProperties are
- retained with their original values.</param>
- </member>
- <member name="M:Ice.Properties.getProperty(System.String)">
- <summary>
- Get a property by key.
- If the property is not set, an empty
- string is returned.
-
- </summary>
- <param name="key">The property key.
-
- </param>
- <returns>The property value.
-
- </returns>
- </member>
- <member name="M:Ice.Properties.getPropertyWithDefault(System.String,System.String)">
- <summary>
- Get a property by key.
- If the property is not set, the
- given default value is returned.
-
- </summary>
- <param name="key">The property key.
-
- </param>
- <param name="value">The default value to use if the property does not
- exist.
-
- </param>
- <returns>The property value or the default value.
-
- </returns>
- </member>
- <member name="M:Ice.Properties.getPropertyAsInt(System.String)">
- <summary>
- Get a property as an integer.
- If the property is not set, 0
- is returned.
-
- </summary>
- <param name="key">The property key.
-
- </param>
- <returns>The property value interpreted as an integer.
-
- </returns>
- </member>
- <member name="M:Ice.Properties.getPropertyAsIntWithDefault(System.String,System.Int32)">
- <summary>
- Get a property as an integer.
- If the property is not set, the
- given default value is returned.
-
- </summary>
- <param name="key">The property key.
-
- </param>
- <param name="value">The default value to use if the property does not
- exist.
-
- </param>
- <returns>The property value interpreted as an integer, or the
- default value.
-
- </returns>
- </member>
- <member name="M:Ice.Properties.getPropertyAsList(System.String)">
- <summary>
- Get a property as a list of strings.
- The strings must be
- separated by whitespace or comma. If the property is not set,
- an empty list is returned. The strings in the list can contain
- whitespace and commas if they are enclosed in single or double
- quotes. If quotes are mismatched, an empty list is returned.
- Within single quotes or double quotes, you can escape the
- quote in question with \, e.g. O'Reilly can be written as
- O'Reilly, "O'Reilly" or 'O\'Reilly'.
-
- </summary>
- <param name="key">The property key.
-
- </param>
- <returns>The property value interpreted as a list of strings.
-
- </returns>
- </member>
- <member name="M:Ice.Properties.getPropertyAsListWithDefault(System.String,System.String[])">
- <summary>
- Get a property as a list of strings.
- The strings must be
- separated by whitespace or comma. If the property is not set,
- the default list is returned. The strings in the list can contain
- whitespace and commas if they are enclosed in single or double
- quotes. If quotes are mismatched, the default list is returned.
- Within single quotes or double quotes, you can escape the
- quote in question with \, e.g. O'Reilly can be written as
- O'Reilly, "O'Reilly" or 'O\'Reilly'.
-
- </summary>
- <param name="key">The property key.
-
- </param>
- <param name="value">The default value to use if the property is not set.
-
- </param>
- <returns>The property value interpreted as list of strings, or the
- default value.
-
- </returns>
- </member>
- <member name="M:Ice.Properties.getPropertiesForPrefix(System.String)">
- <summary>
- Get all properties whose keys begins with
- prefix.
- If
- prefix is an empty string,
- then all properties are returned.
-
- </summary>
- <param name="prefix">The prefix to search for (empty string if none).
- </param>
- <returns>The matching property set.</returns>
- </member>
- <member name="M:Ice.Properties.setProperty(System.String,System.String)">
- <summary>
- Set a property.
- To unset a property, set it to
- the empty string.
-
- </summary>
- <param name="key">The property key.
- </param>
- <param name="value">The property value.
-
- </param>
- </member>
- <member name="M:Ice.Properties.getCommandLineOptions">
- <summary>
- Get a sequence of command-line options that is equivalent to
- this property set.
- Each element of the returned sequence is
- a command-line option of the form
- --key=value.
-
- </summary>
- <returns>The command line options for this property set.</returns>
- </member>
- <member name="M:Ice.Properties.parseCommandLineOptions(System.String,System.String[])">
- <summary>
- Convert a sequence of command-line options into properties.
- All options that begin with
- --prefix. are
- converted into properties. If the prefix is empty, all options
- that begin with -- are converted to properties.
-
- </summary>
- <param name="prefix">The property prefix, or an empty string to
- convert all options starting with --.
-
- </param>
- <param name="options">The command-line options.
-
- </param>
- <returns>The command-line options that do not start with the specified
- prefix, in their original order.</returns>
- </member>
- <member name="M:Ice.Properties.parseIceCommandLineOptions(System.String[])">
- <summary>
- Convert a sequence of command-line options into properties.
- All options that begin with one of the following prefixes
- are converted into properties: --Ice, --IceBox, --IceGrid,
- --IcePatch2, --IceSSL, --IceStorm, --Freeze, and --Glacier2.
-
- </summary>
- <param name="options">The command-line options.
-
- </param>
- <returns>The command-line options that do not start with one of
- the listed prefixes, in their original order.</returns>
- </member>
- <member name="M:Ice.Properties.load(System.String)">
- <summary>
- Load properties from a file.
- </summary>
- <param name="file">The property file.</param>
- </member>
- <member name="M:Ice.Properties.ice_clone_">
- <summary>
- Create a copy of this property set.
- </summary>
- <returns>A copy of this property set.</returns>
- </member>
- <member name="T:Ice.Callback_Object_ice_isA">
- <summary>
- Delegate for a successful <code>ice_isA</code> invocation.
- <param name="ret__">True if the remote object supports the type, false otherwise.</param>
- </summary>
- </member>
- <member name="T:Ice.Callback_Object_ice_ids">
- <summary>
- Delegate for a successful <code>ice_ids</code> invocation.
- <param name="ret__">The array of Slice type ids supported by the remote object.</param>
- </summary>
- </member>
- <member name="T:Ice.Callback_Object_ice_id">
- <summary>
- Delegate for a successful <code>ice_id</code> invocation.
- <param name="ret__">The Slice type id of the most-derived interface supported by the remote object.</param>
- </summary>
- </member>
- <member name="T:Ice.Callback_Object_ice_ping">
- <summary>
- Delegate for a successful <code>ice_ping</code> invocation.
- </summary>
- </member>
- <member name="T:Ice.Callback_Object_ice_invoke">
- <summary>
- Delegate for a successful <code>ice_invoke</code> invocation.
- <param name="ret__">True if the invocation succeeded, or false if the invocation
- raised a user exception.</param>
- <param name="outEncaps">The encoded out-parameters or user exception.</param>
- </summary>
- </member>
- <member name="T:Ice.Callback_Object_ice_getConnection">
- <summary>
- Delegate for a successful <code>ice_getConnection</code> invocation.
- <param name="ret__">The connection used by the proxy.</param>
- </summary>
- </member>
- <member name="T:Ice.ObjectPrx">
- <summary>
- Base interface of all object proxies.
- </summary>
- </member>
- <member name="M:Ice.ObjectPrx.ice_getCommunicator">
- <summary>
- Returns the communicator that created this proxy.
- </summary>
- <returns>The communicator that created this proxy.</returns>
- </member>
- <member name="M:Ice.ObjectPrx.ice_isA(System.String)">
- <summary>
- Tests whether this object supports a specific Slice interface.
- </summary>
- <param name="id__">The type ID of the Slice interface to test against.</param>
- <returns>True if the target object has the interface specified by id__ or derives
- from the interface specified by id__.</returns>
- </member>
- <member name="M:Ice.ObjectPrx.ice_isA(System.String,System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- Tests whether this object supports a specific Slice interface.
- </summary>
- <param name="id__">The type ID of the Slice interface to test against.</param>
- <param name="context__">The context dictionary for the invocation.</param>
- <returns>True if the target object has the interface specified by id__ or derives
- from the interface specified by id__.</returns>
- </member>
- <member name="M:Ice.ObjectPrx.begin_ice_isA(System.String)">
- <summary>
- Tests whether this object supports a specific Slice interface.
- </summary>
- <param name="id">The type ID of the Slice interface to test against.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.ObjectPrx.begin_ice_isA(System.String,System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- Tests whether this object supports a specific Slice interface.
- </summary>
- <param name="id">The type ID of the Slice interface to test against.</param>
- <param name="context__">The context dictionary for the invocation.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.ObjectPrx.begin_ice_isA(System.String,Ice.AsyncCallback,System.Object)">
- <summary>
- Tests whether this object supports a specific Slice interface.
- </summary>
- <param name="id">The type ID of the Slice interface to test against.</param>
- <param name="cb__">A callback to be invoked when the invocation completes.</param>
- <param name="cookie__">Application-specific data to be stored in the result.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.ObjectPrx.begin_ice_isA(System.String,System.Collections.Generic.Dictionary{System.String,System.String},Ice.AsyncCallback,System.Object)">
- <summary>
- Tests whether this object supports a specific Slice interface.
- </summary>
- <param name="id">The type ID of the Slice interface to test against.</param>
- <param name="context__">The context dictionary for the invocation.</param>
- <param name="cb__">A callback to be invoked when the invocation completes.</param>
- <param name="cookie__">Application-specific data to be stored in the result.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.ObjectPrx.end_ice_isA(Ice.AsyncResult)">
- <summary>
- Tests whether this object supports a specific Slice interface.
- </summary>
- <param name="r__">The asynchronous result object returned by <code>begin_ice_isA</code>.</param>
- <returns>True if the object supports the Slice interface, false otherwise.</returns>
- </member>
- <member name="M:Ice.ObjectPrx.ice_ping">
- <summary>
- Tests whether the target object of this proxy can be reached.
- </summary>
- </member>
- <member name="M:Ice.ObjectPrx.ice_ping(System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- Tests whether the target object of this proxy can be reached.
- </summary>
- <param name="context__">The context dictionary for the invocation.</param>
- </member>
- <member name="M:Ice.ObjectPrx.begin_ice_ping">
- <summary>
- Tests whether the target object of this proxy can be reached.
- </summary>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.ObjectPrx.begin_ice_ping(System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- Tests whether the target object of this proxy can be reached.
- </summary>
- <param name="context__">The context dictionary for the invocation.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.ObjectPrx.begin_ice_ping(Ice.AsyncCallback,System.Object)">
- <summary>
- Tests whether the target object of this proxy can be reached.
- </summary>
- <param name="cb__">A callback to be invoked when the invocation completes.</param>
- <param name="cookie__">Application-specific data to be stored in the result.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.ObjectPrx.begin_ice_ping(System.Collections.Generic.Dictionary{System.String,System.String},Ice.AsyncCallback,System.Object)">
- <summary>
- Tests whether the target object of this proxy can be reached.
- </summary>
- <param name="context__">The context dictionary for the invocation.</param>
- <param name="cb__">A callback to be invoked when the invocation completes.</param>
- <param name="cookie__">Application-specific data to be stored in the result.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.ObjectPrx.end_ice_ping(Ice.AsyncResult)">
- <summary>
- Tests whether the target object of this proxy can be reached.
- </summary>
- <param name="r__">The asynchronous result object returned by <code>begin_ice_ping</code>.</param>
- </member>
- <member name="M:Ice.ObjectPrx.ice_ids">
- <summary>
- Returns the Slice type IDs of the interfaces supported by the target object of this proxy.
- </summary>
- <returns>The Slice type IDs of the interfaces supported by the target object, in base-to-derived
- order. The first element of the returned array is always ::Ice::Object.</returns>
- </member>
- <member name="M:Ice.ObjectPrx.ice_ids(System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- Returns the Slice type IDs of the interfaces supported by the target object of this proxy.
- </summary>
- <param name="context__">The context dictionary for the invocation.</param>
- <returns>The Slice type IDs of the interfaces supported by the target object, in base-to-derived
- order. The first element of the returned array is always ::Ice::Object.</returns>
- </member>
- <member name="M:Ice.ObjectPrx.begin_ice_ids">
- <summary>
- Returns the Slice type IDs of the interfaces supported by the target object of this proxy.
- </summary>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.ObjectPrx.begin_ice_ids(System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- Returns the Slice type IDs of the interfaces supported by the target object of this proxy.
- </summary>
- <param name="context__">The context dictionary for the invocation.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.ObjectPrx.begin_ice_ids(Ice.AsyncCallback,System.Object)">
- <summary>
- Returns the Slice type IDs of the interfaces supported by the target object of this proxy.
- </summary>
- <param name="cb__">A callback to be invoked when the invocation completes.</param>
- <param name="cookie__">Application-specific data to be stored in the result.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.ObjectPrx.begin_ice_ids(System.Collections.Generic.Dictionary{System.String,System.String},Ice.AsyncCallback,System.Object)">
- <summary>
- Returns the Slice type IDs of the interfaces supported by the target object of this proxy.
- </summary>
- <param name="context__">The context dictionary for the invocation.</param>
- <param name="cb__">A callback to be invoked when the invocation completes.</param>
- <param name="cookie__">Application-specific data to be stored in the result.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.ObjectPrx.end_ice_ids(Ice.AsyncResult)">
- <summary>
- Returns the Slice type IDs of the interfaces supported by the target object of this proxy.
- </summary>
- <param name="r__">The asynchronous result object returned by <code>begin_ice_ids</code>.</param>
- <returns>The Slice type IDs of the interfaces supported by the target object, in base-to-derived
- order. The first element of the returned array is always ::Ice::Object.</returns>
- </member>
- <member name="M:Ice.ObjectPrx.ice_id">
- <summary>
- Returns the Slice type ID of the most-derived interface supported by the target object of this proxy.
- </summary>
- <returns>The Slice type ID of the most-derived interface.</returns>
- </member>
- <member name="M:Ice.ObjectPrx.ice_id(System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- Returns the Slice type ID of the most-derived interface supported by the target object of this proxy.
- </summary>
- <param name="context__">The context dictionary for the invocation.</param>
- <returns>The Slice type ID of the most-derived interface.</returns>
- </member>
- <member name="M:Ice.ObjectPrx.begin_ice_id">
- <summary>
- Returns the Slice type ID of the most-derived interface supported by the target object of this proxy.
- </summary>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.ObjectPrx.begin_ice_id(System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- Returns the Slice type ID of the most-derived interface supported by the target object of this proxy.
- </summary>
- <param name="context__">The context dictionary for the invocation.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.ObjectPrx.begin_ice_id(Ice.AsyncCallback,System.Object)">
- <summary>
- Returns the Slice type ID of the most-derived interface supported by the target object of this proxy.
- </summary>
- <param name="cb__">A callback to be invoked when the invocation completes.</param>
- <param name="cookie__">Application-specific data to be stored in the result.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.ObjectPrx.begin_ice_id(System.Collections.Generic.Dictionary{System.String,System.String},Ice.AsyncCallback,System.Object)">
- <summary>
- Returns the Slice type ID of the most-derived interface supported by the target object of this proxy.
- </summary>
- <param name="context__">The context dictionary for the invocation.</param>
- <param name="cb__">A callback to be invoked when the invocation completes.</param>
- <param name="cookie__">Application-specific data to be stored in the result.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.ObjectPrx.end_ice_id(Ice.AsyncResult)">
- <summary>
- Returns the Slice type ID of the most-derived interface supported by the target object of this proxy.
- </summary>
- <param name="r__">The asynchronous result object returned by <code>begin_ice_id</code>.</param>
- <returns>The Slice type ID of the most-derived interface.</returns>
- </member>
- <member name="M:Ice.ObjectPrx.ice_invoke(System.String,Ice.OperationMode,System.Byte[],System.Byte[]@)">
- <summary>
- Invokes an operation dynamically.
- </summary>
- <param name="operation">The name of the operation to invoke.</param>
- <param name="mode">The operation mode (normal or idempotent).</param>
- <param name="inEncaps">The encoded in-parameters for the operation.</param>
- <param name="outEncaps">The encoded out-paramaters and return value
- for the operation. The return value follows any out-parameters.</param>
- <returns>If the operation completed successfully, the return value
- is true. If the operation raises a user exception,
- the return value is false; in this case, outEncaps
- contains the encoded user exception. If the operation raises a run-time exception,
- it throws it directly.</returns>
- </member>
- <member name="M:Ice.ObjectPrx.ice_invoke(System.String,Ice.OperationMode,System.Byte[],System.Byte[]@,System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- Invokes an operation dynamically.
- </summary>
- <param name="operation">The name of the operation to invoke.</param>
- <param name="mode">The operation mode (normal or idempotent).</param>
- <param name="inEncaps">The encoded in-parameters for the operation.</param>
- <param name="outEncaps">The encoded out-paramaters and return value
- for the operation. The return value follows any out-parameters.</param>
- <param name="context__">The context dictionary for the invocation.</param>
- <returns>If the operation completed successfully, the return value
- is true. If the operation raises a user exception,
- the return value is false; in this case, outEncaps
- contains the encoded user exception. If the operation raises a run-time exception,
- it throws it directly.</returns>
- </member>
- <member name="M:Ice.ObjectPrx.begin_ice_invoke(System.String,Ice.OperationMode,System.Byte[])">
- <summary>
- Invokes an operation dynamically.
- </summary>
- <param name="operation">The name of the operation to invoke.</param>
- <param name="mode">The operation mode (normal or idempotent).</param>
- <param name="inEncaps">The encoded in-parameters for the operation.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.ObjectPrx.begin_ice_invoke(System.String,Ice.OperationMode,System.Byte[],System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- Invokes an operation dynamically.
- </summary>
- <param name="operation">The name of the operation to invoke.</param>
- <param name="mode">The operation mode (normal or idempotent).</param>
- <param name="inEncaps">The encoded in-parameters for the operation.</param>
- <param name="context__">The context dictionary for the invocation.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.ObjectPrx.begin_ice_invoke(System.String,Ice.OperationMode,System.Byte[],Ice.AsyncCallback,System.Object)">
- <summary>
- Invokes an operation dynamically.
- </summary>
- <param name="operation">The name of the operation to invoke.</param>
- <param name="mode">The operation mode (normal or idempotent).</param>
- <param name="inEncaps">The encoded in-parameters for the operation.</param>
- <param name="cb__">A callback to be invoked when the invocation completes.</param>
- <param name="cookie__">Application-specific data to be stored in the result.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.ObjectPrx.begin_ice_invoke(System.String,Ice.OperationMode,System.Byte[],System.Collections.Generic.Dictionary{System.String,System.String},Ice.AsyncCallback,System.Object)">
- <summary>
- Invokes an operation dynamically.
- </summary>
- <param name="operation">The name of the operation to invoke.</param>
- <param name="mode">The operation mode (normal or idempotent).</param>
- <param name="inEncaps">The encoded in-parameters for the operation.</param>
- <param name="context__">The context dictionary for the invocation.</param>
- <param name="cb__">A callback to be invoked when the invocation completes.</param>
- <param name="cookie__">Application-specific data to be stored in the result.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.ObjectPrx.end_ice_invoke(System.Byte[]@,Ice.AsyncResult)">
- <summary>
- Completes a dynamic invocation.
- </summary>
- <param name="outEncaps">The encoded out parameters or user exception.</param>
- <param name="r__">The asynchronous result object returned by <code>begin_ice_invoke</code>.</param>
- <returns>If the operation completed successfully, the return value
- is true. If the operation raises a user exception,
- the return value is false; in this case, outEncaps
- contains the encoded user exception. If the operation raises a run-time exception,
- it throws it directly.</returns>
- </member>
- <member name="M:Ice.ObjectPrx.ice_getIdentity">
- <summary>
- Returns the identity embedded in this proxy.
- <returns>The identity of the target object.</returns>
- </summary>
- </member>
- <member name="M:Ice.ObjectPrx.ice_identity(Ice.Identity)">
- <summary>
- Creates a new proxy that is identical to this proxy, except for the per-proxy context.
- <param name="newIdentity">The identity for the new proxy.</param>
- <returns>The proxy with the new identity.</returns>
- </summary>
- </member>
- <member name="M:Ice.ObjectPrx.ice_getContext">
- <summary>
- Returns the per-proxy context for this proxy.
- </summary>
- <returns>The per-proxy context. If the proxy does not have a per-proxy (implicit) context, the return value
- is null.</returns>
- </member>
- <member name="M:Ice.ObjectPrx.ice_context(System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- Creates a new proxy that is identical to this proxy, except for the per-proxy context.
- </summary>
- <param name="newContext">The context for the new proxy.</param>
- <returns>The proxy with the new per-proxy context.</returns>
- </member>
- <member name="M:Ice.ObjectPrx.ice_getFacet">
- <summary>
- Returns the facet for this proxy.
- </summary>
- <returns>The facet for this proxy. If the proxy uses the default facet, the return value is the
- empty string.</returns>
- </member>
- <member name="M:Ice.ObjectPrx.ice_facet(System.String)">
- <summary>
- Creates a new proxy that is identical to this proxy, except for the facet.
- </summary>
- <param name="newFacet">The facet for the new proxy.</param>
- <returns>The proxy with the new facet.</returns>
- </member>
- <member name="M:Ice.ObjectPrx.ice_getAdapterId">
- <summary>
- Returns the adapter ID for this proxy.
- </summary>
- <returns>The adapter ID. If the proxy does not have an adapter ID, the return value is the
- empty string.</returns>
- </member>
- <member name="M:Ice.ObjectPrx.ice_adapterId(System.String)">
- <summary>
- Creates a new proxy that is identical to this proxy, except for the adapter ID.
- </summary>
- <param name="newAdapterId">The adapter ID for the new proxy.</param>
- <returns>The proxy with the new adapter ID.</returns>
- </member>
- <member name="M:Ice.ObjectPrx.ice_getEndpoints">
- <summary>
- Returns the endpoints used by this proxy.
- </summary>
- <returns>The endpoints used by this proxy.</returns>
- </member>
- <member name="M:Ice.ObjectPrx.ice_endpoints(Ice.Endpoint[])">
- <summary>
- Creates a new proxy that is identical to this proxy, except for the endpoints.
- </summary>
- <param name="newEndpoints">The endpoints for the new proxy.</param>
- <returns>The proxy with the new endpoints.</returns>
- </member>
- <member name="M:Ice.ObjectPrx.ice_getLocatorCacheTimeout">
- <summary>
- Returns the locator cache timeout of this proxy.
- </summary>
- <returns>The locator cache timeout value (in seconds).</returns>
- </member>
- <member name="M:Ice.ObjectPrx.ice_locatorCacheTimeout(System.Int32)">
- <summary>
- Creates a new proxy that is identical to this proxy, except for the locator cache timeout.
- </summary>
- <param name="timeout">The new locator cache timeout (in seconds).</param>
- </member>
- <member name="M:Ice.ObjectPrx.ice_invocationTimeout(System.Int32)">
- <summary>
- Creates a new proxy that is identical to this proxy, except for the invocation timeout.
- </summary>
- <param name="timeout">The new invocation timeout (in seconds).</param>
- </member>
- <member name="M:Ice.ObjectPrx.ice_getInvocationTimeout">
- <summary>
- Returns the invocation timeout of this proxy.
- </summary>
- <returns>The invocation timeout value (in seconds).</returns>
- </member>
- <member name="M:Ice.ObjectPrx.ice_isConnectionCached">
- <summary>
- Returns whether this proxy caches connections.
- </summary>
- <returns>True if this proxy caches connections; false, otherwise.</returns>
- </member>
- <member name="M:Ice.ObjectPrx.ice_connectionCached(System.Boolean)">
- <summary>
- Creates a new proxy that is identical to this proxy, except for connection caching.
- </summary>
- <param name="newCache">True if the new proxy should cache connections; false, otherwise.</param>
- <returns>The new proxy with the specified caching policy.</returns>
- </member>
- <member name="M:Ice.ObjectPrx.ice_getEndpointSelection">
- <summary>
- Returns how this proxy selects endpoints (randomly or ordered).
- </summary>
- <returns>The endpoint selection policy.</returns>
- </member>
- <member name="M:Ice.ObjectPrx.ice_endpointSelection(Ice.EndpointSelectionType)">
- <summary>
- Creates a new proxy that is identical to this proxy, except for the endpoint selection policy.
- </summary>
- <param name="newType">The new endpoint selection policy.</param>
- <returns>The new proxy with the specified endpoint selection policy.</returns>
- </member>
- <member name="M:Ice.ObjectPrx.ice_isSecure">
- <summary>
- Returns whether this proxy communicates only via secure endpoints.
- </summary>
- <returns>True if this proxy communicates only vi secure endpoints; false, otherwise.</returns>
- </member>
- <member name="M:Ice.ObjectPrx.ice_secure(System.Boolean)">
- <summary>
- Creates a new proxy that is identical to this proxy, except for how it selects endpoints.
- </summary>
- <param name="b"> If b is true, only endpoints that use a secure transport are
- used by the new proxy. If b is false, the returned proxy uses both secure and insecure
- endpoints.</param>
- <returns>The new proxy with the specified selection policy.</returns>
- </member>
- <member name="M:Ice.ObjectPrx.ice_encodingVersion(Ice.EncodingVersion)">
- <summary>
- Creates a new proxy that is identical to this proxy, except for the encoding used to marshal
- parameters.
- </summary>
- <param name="e">The encoding version to use to marshal requests parameters.</param>
- <returns>The new proxy with the specified encoding version.</returns>
- </member>
- <member name="M:Ice.ObjectPrx.ice_getEncodingVersion">
- <summary>Returns the encoding version used to marshal requests parameters.</summary>
- <returns>The encoding version.</returns>
- </member>
- <member name="M:Ice.ObjectPrx.ice_isPreferSecure">
- <summary>
- Returns whether this proxy prefers secure endpoints.
- </summary>
- <returns>True if the proxy always attempts to invoke via secure endpoints before it
- attempts to use insecure endpoints; false, otherwise.</returns>
- </member>
- <member name="M:Ice.ObjectPrx.ice_preferSecure(System.Boolean)">
- <summary>
- Creates a new proxy that is identical to this proxy, except for its endpoint selection policy.
- </summary>
- <param name="b">If b is true, the new proxy will use secure endpoints for invocations
- and only use insecure endpoints if an invocation cannot be made via secure endpoints. If b is
- false, the proxy prefers insecure endpoints to secure ones.</param>
- <returns>The new proxy with the new endpoint selection policy.</returns>
- </member>
- <member name="M:Ice.ObjectPrx.ice_getRouter">
- <summary>
- Returns the router for this proxy.
- </summary>
- <returns>The router for the proxy. If no router is configured for the proxy, the return value
- is null.</returns>
- </member>
- <member name="M:Ice.ObjectPrx.ice_router(Ice.RouterPrx)">
- <summary>
- Creates a new proxy that is identical to this proxy, except for the router.
- </summary>
- <param name="router">The router for the new proxy.</param>
- <returns>The new proxy with the specified router.</returns>
- </member>
- <member name="M:Ice.ObjectPrx.ice_getLocator">
- <summary>
- Returns the locator for this proxy.
- </summary>
- <returns>The locator for this proxy. If no locator is configured, the return value is null.</returns>
- </member>
- <member name="M:Ice.ObjectPrx.ice_locator(Ice.LocatorPrx)">
- <summary>
- Creates a new proxy that is identical to this proxy, except for the locator.
- </summary>
- <param name="locator">The locator for the new proxy.</param>
- <returns>The new proxy with the specified locator.</returns>
- </member>
- <member name="M:Ice.ObjectPrx.ice_isCollocationOptimized">
- <summary>
- Returns whether this proxy uses collocation optimization.
- </summary>
- <returns>True if the proxy uses collocation optimization; false, otherwise.</returns>
- </member>
- <member name="M:Ice.ObjectPrx.ice_collocationOptimized(System.Boolean)">
- <summary>
- Creates a new proxy that is identical to this proxy, except for collocation optimization.
- </summary>
- <param name="b">True if the new proxy enables collocation optimization; false, otherwise.</param>
- <returns>The new proxy the specified collocation optimization.</returns>
- </member>
- <member name="M:Ice.ObjectPrx.ice_twoway">
- <summary>
- Creates a new proxy that is identical to this proxy, but uses twoway invocations.
- </summary>
- <returns>A new proxy that uses twoway invocations.</returns>
- </member>
- <member name="M:Ice.ObjectPrx.ice_isTwoway">
- <summary>
- Returns whether this proxy uses twoway invocations.
- </summary>
- <returns>True if this proxy uses twoway invocations; false, otherwise.</returns>
- </member>
- <member name="M:Ice.ObjectPrx.ice_oneway">
- <summary>
- Creates a new proxy that is identical to this proxy, but uses oneway invocations.
- </summary>
- <returns>A new proxy that uses oneway invocations.</returns>
- </member>
- <member name="M:Ice.ObjectPrx.ice_isOneway">
- <summary>
- Returns whether this proxy uses oneway invocations.
- </summary>
- <returns>True if this proxy uses oneway invocations; false, otherwise.</returns>
- </member>
- <member name="M:Ice.ObjectPrx.ice_batchOneway">
- <summary>
- Creates a new proxy that is identical to this proxy, but uses batch oneway invocations.
- </summary>
- <returns>A new proxy that uses batch oneway invocations.</returns>
- </member>
- <member name="M:Ice.ObjectPrx.ice_isBatchOneway">
- <summary>
- Returns whether this proxy uses batch oneway invocations.
- </summary>
- <returns>True if this proxy uses batch oneway invocations; false, otherwise.</returns>
- </member>
- <member name="M:Ice.ObjectPrx.ice_datagram">
- <summary>
- Creates a new proxy that is identical to this proxy, but uses datagram invocations.
- </summary>
- <returns>A new proxy that uses datagram invocations.</returns>
- </member>
- <member name="M:Ice.ObjectPrx.ice_isDatagram">
- <summary>
- Returns whether this proxy uses datagram invocations.
- </summary>
- <returns>True if this proxy uses datagram invocations; false, otherwise.</returns>
- </member>
- <member name="M:Ice.ObjectPrx.ice_batchDatagram">
- <summary>
- Creates a new proxy that is identical to this proxy, but uses batch datagram invocations.
- </summary>
- <returns>A new proxy that uses batch datagram invocations.</returns>
- </member>
- <member name="M:Ice.ObjectPrx.ice_isBatchDatagram">
- <summary>
- Returns whether this proxy uses batch datagram invocations.
- </summary>
- <returns>True if this proxy uses batch datagram invocations; false, otherwise.</returns>
- </member>
- <member name="M:Ice.ObjectPrx.ice_compress(System.Boolean)">
- <summary>
- Creates a new proxy that is identical to this proxy, except for compression.
- </summary>
- <param name="co">True enables compression for the new proxy; false disables compression.</param>
- <returns>A new proxy with the specified compression setting.</returns>
- </member>
- <member name="M:Ice.ObjectPrx.ice_timeout(System.Int32)">
- <summary>
- Creates a new proxy that is identical to this proxy, except for its timeout setting.
- </summary>
- <param name="t">The timeout for the new proxy in milliseconds.</param>
- <returns>A new proxy with the specified timeout.</returns>
- </member>
- <member name="M:Ice.ObjectPrx.ice_connectionId(System.String)">
- <summary>
- Creates a new proxy that is identical to this proxy, except for its connection ID.
- </summary>
- <param name="connectionId">The connection ID for the new proxy. An empty string removes the
- connection ID.</param>
- <returns>A new proxy with the specified connection ID.</returns>
- </member>
- <member name="M:Ice.ObjectPrx.ice_getConnectionId">
- <summary>
- Returns the connection id of this proxy.
- </summary>
- <returns>The connection id.</returns>
- </member>
- <member name="M:Ice.ObjectPrx.ice_getConnection">
- <summary>
- Returns the Connection for this proxy. If the proxy does not yet have an established connection,
- it first attempts to create a connection.
- </summary>
- <returns>The Connection for this proxy.</returns>
- <exception name="CollocationOptimizationException">If the proxy uses collocation optimization and denotes a
- collocated object.</exception>
- </member>
- <member name="M:Ice.ObjectPrx.begin_ice_getConnection">
- <summary>
- Asynchronously gets the connection for this proxy.
- </summary>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.ObjectPrx.begin_ice_getConnection(Ice.AsyncCallback,System.Object)">
- <summary>
- Asynchronously gets the connection for this proxy.
- </summary>
- <param name="cb__">A callback to be invoked when the invocation completes.</param>
- <param name="cookie__">Application-specific data to be stored in the result.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.ObjectPrx.end_ice_getConnection(Ice.AsyncResult)">
- <summary>
- Asynchronously gets the connection for this proxy.
- </summary>
- <param name="r__">The asynchronous result object returned by <code>begin_ice_getConnection</code>.</param>
- <returns>The connection.</returns>
- </member>
- <member name="M:Ice.ObjectPrx.ice_getCachedConnection">
- <summary>
- Returns the cached Connection for this proxy. If the proxy does not yet have an established
- connection, it does not attempt to create a connection.
- </summary>
- <returns>The cached Connection for this proxy (null if the proxy does not have
- an established connection).</returns>
- <exception name="CollocationOptimizationException">If the proxy uses collocation optimization and denotes a
- collocated object.</exception>
- </member>
- <member name="M:Ice.ObjectPrx.ice_flushBatchRequests">
- <summary>
- Flushes any pending batched requests for this communicator. The call blocks until the flush is complete.
- </summary>
- </member>
- <member name="T:Ice.ObjectPrxHelperBase">
- <summary>
- Base class of all object proxies.
- </summary>
- </member>
- <member name="M:Ice.ObjectPrxHelperBase.GetHashCode">
- <summary>
- Returns a hash code for this proxy.
- </summary>
- <returns>The hash code.</returns>
- </member>
- <member name="M:Ice.ObjectPrxHelperBase.ice_getCommunicator">
- <summary>
- Returns the communicator that created this proxy.
- </summary>
- <returns>The communicator that created this proxy.</returns>
- </member>
- <member name="M:Ice.ObjectPrxHelperBase.ToString">
- <summary>
- Returns the stringified form of this proxy.
- </summary>
- <returns>The stringified proxy.</returns>
- </member>
- <member name="M:Ice.ObjectPrxHelperBase.ice_isA(System.String)">
- <summary>
- Tests whether this object supports a specific Slice interface.
- </summary>
- <param name="id__">The type ID of the Slice interface to test against.</param>
- <returns>True if the target object has the interface specified by id__ or derives
- from the interface specified by id__.</returns>
- </member>
- <member name="M:Ice.ObjectPrxHelperBase.ice_isA(System.String,System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- Tests whether this object supports a specific Slice interface.
- </summary>
- <param name="id__">The type ID of the Slice interface to test against.</param>
- <param name="context__">The context dictionary for the invocation.</param>
- <returns>True if the target object has the interface specified by id__ or derives
- from the interface specified by id__.</returns>
- </member>
- <member name="M:Ice.ObjectPrxHelperBase.ice_ping">
- <summary>
- Tests whether the target object of this proxy can be reached.
- </summary>
- </member>
- <member name="M:Ice.ObjectPrxHelperBase.ice_ping(System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- Tests whether the target object of this proxy can be reached.
- </summary>
- <param name="context__">The context dictionary for the invocation.</param>
- </member>
- <member name="M:Ice.ObjectPrxHelperBase.ice_ids">
- <summary>
- Returns the Slice type IDs of the interfaces supported by the target object of this proxy.
- </summary>
- <returns>The Slice type IDs of the interfaces supported by the target object, in base-to-derived
- order. The first element of the returned array is always ::Ice::Object.</returns>
- </member>
- <member name="M:Ice.ObjectPrxHelperBase.ice_ids(System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- Returns the Slice type IDs of the interfaces supported by the target object of this proxy.
- </summary>
- <param name="context__">The context dictionary for the invocation.</param>
- <returns>The Slice type IDs of the interfaces supported by the target object, in base-to-derived
- order. The first element of the returned array is always ::Ice::Object.</returns>
- </member>
- <member name="M:Ice.ObjectPrxHelperBase.ice_id">
- <summary>
- Returns the Slice type ID of the most-derived interface supported by the target object of this proxy.
- </summary>
- <returns>The Slice type ID of the most-derived interface.</returns>
- </member>
- <member name="M:Ice.ObjectPrxHelperBase.ice_id(System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- Returns the Slice type ID of the most-derived interface supported by the target object of this proxy.
- </summary>
- <param name="context__">The context dictionary for the invocation.</param>
- <returns>The Slice type ID of the most-derived interface.</returns>
- </member>
- <member name="M:Ice.ObjectPrxHelperBase.ice_invoke(System.String,Ice.OperationMode,System.Byte[],System.Byte[]@)">
- <summary>
- Invokes an operation dynamically.
- </summary>
- <param name="operation">The name of the operation to invoke.</param>
- <param name="mode">The operation mode (normal or idempotent).</param>
- <param name="inEncaps">The encoded in-parameters for the operation.</param>
- <param name="outEncaps">The encoded out-paramaters and return value
- for the operation. The return value follows any out-parameters.</param>
- <returns>If the operation completed successfully, the return value
- is true. If the operation raises a user exception,
- the return value is false; in this case, outEncaps
- contains the encoded user exception. If the operation raises a run-time exception,
- it throws it directly.</returns>
- </member>
- <member name="M:Ice.ObjectPrxHelperBase.ice_invoke(System.String,Ice.OperationMode,System.Byte[],System.Byte[]@,System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- Invokes an operation dynamically.
- </summary>
- <param name="operation">The name of the operation to invoke.</param>
- <param name="mode">The operation mode (normal or idempotent).</param>
- <param name="inEncaps">The encoded in-parameters for the operation.</param>
- <param name="outEncaps">The encoded out-paramaters and return value
- for the operation. The return value follows any out-parameters.</param>
- <param name="context">The context dictionary for the invocation.</param>
- <returns>If the operation completed successfully, the return value
- is true. If the operation raises a user exception,
- the return value is false; in this case, outEncaps
- contains the encoded user exception. If the operation raises a run-time exception,
- it throws it directly.</returns>
- </member>
- <member name="M:Ice.ObjectPrxHelperBase.ice_getIdentity">
- <summary>
- Returns the identity embedded in this proxy.
- <returns>The identity of the target object.</returns>
- </summary>
- </member>
- <member name="M:Ice.ObjectPrxHelperBase.ice_identity(Ice.Identity)">
- <summary>
- Creates a new proxy that is identical to this proxy, except for the per-proxy context.
- <param name="newIdentity">The identity for the new proxy.</param>
- <returns>The proxy with the new identity.</returns>
- </summary>
- </member>
- <member name="M:Ice.ObjectPrxHelperBase.ice_getContext">
- <summary>
- Returns the per-proxy context for this proxy.
- </summary>
- <returns>The per-proxy context. If the proxy does not have a per-proxy (implicit) context, the return value
- is null.</returns>
- </member>
- <member name="M:Ice.ObjectPrxHelperBase.ice_context(System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- Creates a new proxy that is identical to this proxy, except for the per-proxy context.
- </summary>
- <param name="newContext">The context for the new proxy.</param>
- <returns>The proxy with the new per-proxy context.</returns>
- </member>
- <member name="M:Ice.ObjectPrxHelperBase.ice_getFacet">
- <summary>
- Returns the facet for this proxy.
- </summary>
- <returns>The facet for this proxy. If the proxy uses the default facet, the return value is the
- empty string.</returns>
- </member>
- <member name="M:Ice.ObjectPrxHelperBase.ice_facet(System.String)">
- <summary>
- Creates a new proxy that is identical to this proxy, except for the facet.
- </summary>
- <param name="newFacet">The facet for the new proxy.</param>
- <returns>The proxy with the new facet.</returns>
- </member>
- <member name="M:Ice.ObjectPrxHelperBase.ice_getAdapterId">
- <summary>
- Returns the adapter ID for this proxy.
- </summary>
- <returns>The adapter ID. If the proxy does not have an adapter ID, the return value is the
- empty string.</returns>
- </member>
- <member name="M:Ice.ObjectPrxHelperBase.ice_adapterId(System.String)">
- <summary>
- Creates a new proxy that is identical to this proxy, except for the adapter ID.
- </summary>
- <param name="newAdapterId">The adapter ID for the new proxy.</param>
- <returns>The proxy with the new adapter ID.</returns>
- </member>
- <member name="M:Ice.ObjectPrxHelperBase.ice_getEndpoints">
- <summary>
- Returns the endpoints used by this proxy.
- </summary>
- <returns>The endpoints used by this proxy.</returns>
- </member>
- <member name="M:Ice.ObjectPrxHelperBase.ice_endpoints(Ice.Endpoint[])">
- <summary>
- Creates a new proxy that is identical to this proxy, except for the endpoints.
- </summary>
- <param name="newEndpoints">The endpoints for the new proxy.</param>
- <returns>The proxy with the new endpoints.</returns>
- </member>
- <member name="M:Ice.ObjectPrxHelperBase.ice_getLocatorCacheTimeout">
- <summary>
- Returns the locator cache timeout of this proxy.
- </summary>
- <returns>The locator cache timeout value (in seconds).</returns>
- </member>
- <member name="M:Ice.ObjectPrxHelperBase.ice_locatorCacheTimeout(System.Int32)">
- <summary>
- Creates a new proxy that is identical to this proxy, except for the locator cache timeout.
- </summary>
- <param name="newTimeout">The new locator cache timeout (in seconds).</param>
- </member>
- <member name="M:Ice.ObjectPrxHelperBase.ice_getInvocationTimeout">
- <summary>
- Returns the invocation timeout of this proxy.
- </summary>
- <returns>The invocation timeout value (in seconds).</returns>
- </member>
- <member name="M:Ice.ObjectPrxHelperBase.ice_invocationTimeout(System.Int32)">
- <summary>
- Creates a new proxy that is identical to this proxy, except for the invocation timeout.
- </summary>
- <param name="newTimeout">The new invocation timeout (in seconds).</param>
- </member>
- <member name="M:Ice.ObjectPrxHelperBase.ice_isConnectionCached">
- <summary>
- Returns whether this proxy caches connections.
- </summary>
- <returns>True if this proxy caches connections; false, otherwise.</returns>
- </member>
- <member name="M:Ice.ObjectPrxHelperBase.ice_connectionCached(System.Boolean)">
- <summary>
- Creates a new proxy that is identical to this proxy, except for connection caching.
- </summary>
- <param name="newCache">True if the new proxy should cache connections; false, otherwise.</param>
- <returns>The new proxy with the specified caching policy.</returns>
- </member>
- <member name="M:Ice.ObjectPrxHelperBase.ice_getEndpointSelection">
- <summary>
- Returns how this proxy selects endpoints (randomly or ordered).
- </summary>
- <returns>The endpoint selection policy.</returns>
- </member>
- <member name="M:Ice.ObjectPrxHelperBase.ice_endpointSelection(Ice.EndpointSelectionType)">
- <summary>
- Creates a new proxy that is identical to this proxy, except for the endpoint selection policy.
- </summary>
- <param name="newType">The new endpoint selection policy.</param>
- <returns>The new proxy with the specified endpoint selection policy.</returns>
- </member>
- <member name="M:Ice.ObjectPrxHelperBase.ice_isSecure">
- <summary>
- Returns whether this proxy communicates only via secure endpoints.
- </summary>
- <returns>True if this proxy communicates only vi secure endpoints; false, otherwise.</returns>
- </member>
- <member name="M:Ice.ObjectPrxHelperBase.ice_secure(System.Boolean)">
- <summary>
- Creates a new proxy that is identical to this proxy, except for how it selects endpoints.
- </summary>
- <param name="b"> If b is true, only endpoints that use a secure transport are
- used by the new proxy. If b is false, the returned proxy uses both secure and insecure
- endpoints.</param>
- <returns>The new proxy with the specified selection policy.</returns>
- </member>
- <member name="M:Ice.ObjectPrxHelperBase.ice_encodingVersion(Ice.EncodingVersion)">
- <summary>
- Creates a new proxy that is identical to this proxy, except for the encoding used to marshal
- parameters.
- </summary>
- <param name="e">The encoding version to use to marshal requests parameters.</param>
- <returns>The new proxy with the specified encoding version.</returns>
- </member>
- <member name="M:Ice.ObjectPrxHelperBase.ice_getEncodingVersion">
- <summary>Returns the encoding version used to marshal requests parameters.</summary>
- <returns>The encoding version.</returns>
- </member>
- <member name="M:Ice.ObjectPrxHelperBase.ice_isPreferSecure">
- <summary>
- Returns whether this proxy prefers secure endpoints.
- </summary>
- <returns>True if the proxy always attempts to invoke via secure endpoints before it
- attempts to use insecure endpoints; false, otherwise.</returns>
- </member>
- <member name="M:Ice.ObjectPrxHelperBase.ice_preferSecure(System.Boolean)">
- <summary>
- Creates a new proxy that is identical to this proxy, except for its endpoint selection policy.
- </summary>
- <param name="b">If b is true, the new proxy will use secure endpoints for invocations
- and only use insecure endpoints if an invocation cannot be made via secure endpoints. If b is
- false, the proxy prefers insecure endpoints to secure ones.</param>
- <returns>The new proxy with the new endpoint selection policy.</returns>
- </member>
- <member name="M:Ice.ObjectPrxHelperBase.ice_getRouter">
- <summary>
- Returns the router for this proxy.
- </summary>
- <returns>The router for the proxy. If no router is configured for the proxy, the return value
- is null.</returns>
- </member>
- <member name="M:Ice.ObjectPrxHelperBase.ice_router(Ice.RouterPrx)">
- <summary>
- Creates a new proxy that is identical to this proxy, except for the router.
- </summary>
- <param name="router">The router for the new proxy.</param>
- <returns>The new proxy with the specified router.</returns>
- </member>
- <member name="M:Ice.ObjectPrxHelperBase.ice_getLocator">
- <summary>
- Returns the locator for this proxy.
- </summary>
- <returns>The locator for this proxy. If no locator is configured, the return value is null.</returns>
- </member>
- <member name="M:Ice.ObjectPrxHelperBase.ice_locator(Ice.LocatorPrx)">
- <summary>
- Creates a new proxy that is identical to this proxy, except for the locator.
- </summary>
- <param name="locator">The locator for the new proxy.</param>
- <returns>The new proxy with the specified locator.</returns>
- </member>
- <member name="M:Ice.ObjectPrxHelperBase.ice_isCollocationOptimized">
- <summary>
- Returns whether this proxy uses collocation optimization.
- </summary>
- <returns>True if the proxy uses collocation optimization; false, otherwise.</returns>
- </member>
- <member name="M:Ice.ObjectPrxHelperBase.ice_collocationOptimized(System.Boolean)">
- <summary>
- Creates a new proxy that is identical to this proxy, except for collocation optimization.
- </summary>
- <param name="b">True if the new proxy enables collocation optimization; false, otherwise.</param>
- <returns>The new proxy the specified collocation optimization.</returns>
- </member>
- <member name="M:Ice.ObjectPrxHelperBase.ice_twoway">
- <summary>
- Creates a new proxy that is identical to this proxy, but uses twoway invocations.
- </summary>
- <returns>A new proxy that uses twoway invocations.</returns>
- </member>
- <member name="M:Ice.ObjectPrxHelperBase.ice_isTwoway">
- <summary>
- Returns whether this proxy uses twoway invocations.
- </summary>
- <returns>True if this proxy uses twoway invocations; false, otherwise.</returns>
- </member>
- <member name="M:Ice.ObjectPrxHelperBase.ice_oneway">
- <summary>
- Creates a new proxy that is identical to this proxy, but uses oneway invocations.
- </summary>
- <returns>A new proxy that uses oneway invocations.</returns>
- </member>
- <member name="M:Ice.ObjectPrxHelperBase.ice_isOneway">
- <summary>
- Returns whether this proxy uses oneway invocations.
- </summary>
- <returns>True if this proxy uses oneway invocations; false, otherwise.</returns>
- </member>
- <member name="M:Ice.ObjectPrxHelperBase.ice_batchOneway">
- <summary>
- Creates a new proxy that is identical to this proxy, but uses batch oneway invocations.
- </summary>
- <returns>A new proxy that uses batch oneway invocations.</returns>
- </member>
- <member name="M:Ice.ObjectPrxHelperBase.ice_isBatchOneway">
- <summary>
- Returns whether this proxy uses batch oneway invocations.
- </summary>
- <returns>True if this proxy uses batch oneway invocations; false, otherwise.</returns>
- </member>
- <member name="M:Ice.ObjectPrxHelperBase.ice_datagram">
- <summary>
- Creates a new proxy that is identical to this proxy, but uses datagram invocations.
- </summary>
- <returns>A new proxy that uses datagram invocations.</returns>
- </member>
- <member name="M:Ice.ObjectPrxHelperBase.ice_isDatagram">
- <summary>
- Returns whether this proxy uses datagram invocations.
- </summary>
- <returns>True if this proxy uses datagram invocations; false, otherwise.</returns>
- </member>
- <member name="M:Ice.ObjectPrxHelperBase.ice_batchDatagram">
- <summary>
- Creates a new proxy that is identical to this proxy, but uses batch datagram invocations.
- </summary>
- <returns>A new proxy that uses batch datagram invocations.</returns>
- </member>
- <member name="M:Ice.ObjectPrxHelperBase.ice_isBatchDatagram">
- <summary>
- Returns whether this proxy uses batch datagram invocations.
- </summary>
- <returns>True if this proxy uses batch datagram invocations; false, otherwise.</returns>
- </member>
- <member name="M:Ice.ObjectPrxHelperBase.ice_compress(System.Boolean)">
- <summary>
- Creates a new proxy that is identical to this proxy, except for compression.
- </summary>
- <param name="co">True enables compression for the new proxy; false disables compression.</param>
- <returns>A new proxy with the specified compression setting.</returns>
- </member>
- <member name="M:Ice.ObjectPrxHelperBase.ice_timeout(System.Int32)">
- <summary>
- Creates a new proxy that is identical to this proxy, except for its timeout setting.
- </summary>
- <param name="t">The timeout for the new proxy in milliseconds.</param>
- <returns>A new proxy with the specified timeout.</returns>
- </member>
- <member name="M:Ice.ObjectPrxHelperBase.ice_connectionId(System.String)">
- <summary>
- Creates a new proxy that is identical to this proxy, except for its connection ID.
- </summary>
- <param name="connectionId">The connection ID for the new proxy. An empty string removes the
- connection ID.</param>
- <returns>A new proxy with the specified connection ID.</returns>
- </member>
- <member name="M:Ice.ObjectPrxHelperBase.ice_getConnectionId">
- <summary>
- Returns the connection id of this proxy.
- </summary>
- <returns>The connection id.</returns>
- </member>
- <member name="M:Ice.ObjectPrxHelperBase.ice_getConnection">
- <summary>
- Returns the Connection for this proxy. If the proxy does not yet have an established connection,
- it first attempts to create a connection.
- </summary>
- <returns>The Connection for this proxy.</returns>
- <exception name="CollocationOptimizationException">If the proxy uses collocation optimization and denotes a
- collocated object.</exception>
- </member>
- <member name="M:Ice.ObjectPrxHelperBase.ice_getCachedConnection">
- <summary>
- Returns the cached Connection for this proxy. If the proxy does not yet have an established
- connection, it does not attempt to create a connection.
- </summary>
- <returns>The cached Connection for this proxy (null if the proxy does not have
- an established connection).</returns>
- <exception name="CollocationOptimizationException">If the proxy uses collocation optimization and denotes a
- collocated object.</exception>
- </member>
- <member name="M:Ice.ObjectPrxHelperBase.ice_flushBatchRequests">
- <summary>
- Flushes any pending batched requests for this communicator. The call blocks until the flush is complete.
- </summary>
- </member>
- <member name="M:Ice.ObjectPrxHelperBase.Equals(System.Object)">
- <summary>
- Returns whether this proxy equals the passed object. Two proxies are equal if they are equal in all
- respects, that is, if their object identity, endpoints timeout settings, and so on are all equal.
- </summary>
- <param name="r">The object to compare this proxy with.</param>
- <returns>True if this proxy is equal to r; false, otherwise.</returns>
- </member>
- <member name="M:Ice.ObjectPrxHelperBase.Equals(Ice.ObjectPrxHelperBase,Ice.ObjectPrxHelperBase)">
- <summary>
- Returns whether two proxies are equal. Two proxies are equal if they are equal in all
- respects, that is, if their object identity, endpoints timeout settings, and so on are all equal.
- </summary>
- <param name="lhs">A proxy to compare with the proxy rhs.</param>
- <param name="rhs">A proxy to compare with the proxy lhs.</param>
- <returns>True if the proxies are equal; false, otherwise.</returns>
- </member>
- <member name="M:Ice.ObjectPrxHelperBase.op_Equality(Ice.ObjectPrxHelperBase,Ice.ObjectPrxHelperBase)">
- <summary>
- Returns whether two proxies are equal. Two proxies are equal if they are equal in all
- respects, that is, if their object identity, endpoints timeout settings, and so on are all equal.
- </summary>
- <param name="lhs">A proxy to compare with the proxy rhs.</param>
- <param name="rhs">A proxy to compare with the proxy lhs.</param>
- <returns>True if the proxies are equal; false, otherwise.</returns>
- </member>
- <member name="M:Ice.ObjectPrxHelperBase.op_Inequality(Ice.ObjectPrxHelperBase,Ice.ObjectPrxHelperBase)">
- <summary>
- Returns whether two proxies are not equal. Two proxies are equal if they are equal in all
- respects, that is, if their object identity, endpoints timeout settings, and so on are all equal.
- </summary>
- <param name="lhs">A proxy to compare with the proxy rhs.</param>
- <param name="rhs">A proxy to compare with the proxy lhs.</param>
- <returns>True if the proxies are not equal; false, otherwise.</returns>
- </member>
- <member name="T:Ice.ObjectPrxHelper">
- <summary>
- Base class for all proxy helpers.
- </summary>
- </member>
- <member name="M:Ice.ObjectPrxHelper.checkedCast(Ice.ObjectPrx)">
- <summary>
- Casts a proxy to {@link ObjectPrx}. This call contacts
- the server and will throw an Ice run-time exception if the target
- object does not exist or the server cannot be reached.
- </summary>
- <param name="b">The proxy to cast to ObjectPrx.</param>
- <returns>b.</returns>
- </member>
- <member name="M:Ice.ObjectPrxHelper.checkedCast(Ice.ObjectPrx,System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- Casts a proxy to {@link ObjectPrx}. This call contacts
- the server and throws an Ice run-time exception if the target
- object does not exist or the server cannot be reached.
- </summary>
- <param name="b">The proxy to cast to ObjectPrx.</param>
- <param name="ctx">The Context map for the invocation.</param>
- <returns>b.</returns>
- </member>
- <member name="M:Ice.ObjectPrxHelper.checkedCast(Ice.ObjectPrx,System.String)">
- <summary>
- Creates a new proxy that is identical to the passed proxy, except
- for its facet. This call contacts
- the server and throws an Ice run-time exception if the target
- object does not exist, the specified facet does not exist, or the server cannot be reached.
- </summary>
- <param name="b">The proxy to cast to ObjectPrx.</param>
- <param name="f">The facet for the new proxy.</param>
- <returns>The new proxy with the specified facet.</returns>
- </member>
- <member name="M:Ice.ObjectPrxHelper.checkedCast(Ice.ObjectPrx,System.String,System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- Creates a new proxy that is identical to the passed proxy, except
- for its facet. This call contacts
- the server and throws an Ice run-time exception if the target
- object does not exist, the specified facet does not exist, or the server cannot be reached.
- </summary>
- <param name="b">The proxy to cast to ObjectPrx.</param>
- <param name="f">The facet for the new proxy.</param>
- <param name="ctx">The Context map for the invocation.</param>
- <returns>The new proxy with the specified facet.</returns>
- </member>
- <member name="M:Ice.ObjectPrxHelper.uncheckedCast(Ice.ObjectPrx)">
- <summary>
- Casts a proxy to {@link ObjectPrx}. This call does
- not contact the server and always succeeds.
- </summary>
- <param name="b">The proxy to cast to ObjectPrx.</param>
- <returns>b.</returns>
- </member>
- <member name="M:Ice.ObjectPrxHelper.uncheckedCast(Ice.ObjectPrx,System.String)">
- <summary>
- Creates a new proxy that is identical to the passed proxy, except
- for its facet. This call does not contact the server and always succeeds.
- </summary>
- <param name="b">The proxy to cast to ObjectPrx.</param>
- <param name="f">The facet for the new proxy.</param>
- <returns>The new proxy with the specified facet.</returns>
- </member>
- <member name="M:Ice.ObjectPrxHelper.ice_staticId">
- <summary>
- Returns the Slice type id of the interface or class associated
- with this proxy class.
- </summary>
- <returns>The type id, "::Ice::Object".</returns>
- </member>
- <member name="T:Ice.ProxyIdentityKey">
- <summary>
- This class allows a proxy to be used as the key for a hashed collection.
- The GetHashCode, Equals, and Compare methods are based on the object identity
- of the proxy.
- </summary>
- </member>
- <member name="M:Ice.ProxyIdentityKey.GetHashCode(System.Object)">
- <summary>
- Computes a hash value based on the object identity of the proxy.
- </summary>
- <param name="obj">The proxy whose hash value to compute.</param>
- <returns>The hash value for the proxy based on the identity.</returns>
- </member>
- <member name="M:Ice.ProxyIdentityKey.Equals(System.Object,System.Object)">
- Compares two proxies for equality.
- <param name="obj1">A proxy to compare.</param>
- <param name="obj2">A proxy to compare.</param>
- <returns>True if the passed proxies have the same object
- identity; false, otherwise.</returns>
- </member>
- <member name="M:Ice.ProxyIdentityKey.Compare(System.Object,System.Object)">
- Compares two proxies using the object identity for comparison.
- <param name="obj1">A proxy to compare.</param>
- <param name="obj2">A proxy to compare.</param>
- <returns>< 0 if obj1 is less than obj2; > 0 if obj1 is greater than obj2;
- 0, otherwise.</returns>
- </member>
- <member name="T:Ice.ProxyIdentityFacetKey">
- <summary>
- This class allows a proxy to be used as the key for a hashed collection.
- The GetHashCode, Equals, and Compare methods are based on the object identity and
- the facet of the proxy.
- </summary>
- </member>
- <member name="M:Ice.ProxyIdentityFacetKey.GetHashCode(System.Object)">
- <summary>
- Computes a hash value based on the object identity and facet of the proxy.
- </summary>
- <param name="obj">The proxy whose hash value to compute.</param>
- <returns>The hash value for the proxy based on the identity and facet.</returns>
- </member>
- <member name="M:Ice.ProxyIdentityFacetKey.Equals(System.Object,System.Object)">
- Compares two proxies for equality.
- <param name="obj1">A proxy to compare.</param>
- <param name="obj2">A proxy to compare.</param>
- <returns>True if the passed proxies have the same object
- identity and facet; false, otherwise.</returns>
- </member>
- <member name="M:Ice.ProxyIdentityFacetKey.Compare(System.Object,System.Object)">
- Compares two proxies using the object identity and facet for comparison.
- <param name="obj1">A proxy to compare.</param>
- <param name="obj2">A proxy to compare.</param>
- <returns>< 0 if obj1 is less than obj2; > 0 if obj1 is greater than obj2;
- 0, otherwise.</returns>
- </member>
- <member name="T:Ice.SlicedData">
- <summary>
- SlicedData holds the slices of unknown class or exception types.
- </summary>
- </member>
- <member name="F:Ice.SlicedData.slices">
- The details of each slice, in order of most-derived to least-derived.
-
- </member>
- <member name="T:Ice.SliceInfo">
- <summary>
- SliceInfo encapsulates the details of a slice for an unknown class or exception type.
- </summary>
- </member>
- <member name="F:Ice.SliceInfo.typeId">
- <summary>
- The Slice type ID for this slice.
- </summary>
- </member>
- <member name="F:Ice.SliceInfo.compactId">
- <summary>
- The Slice compact type ID for this slice.
- </summary>
- </member>
- <member name="F:Ice.SliceInfo.bytes">
- <summary>
- The encoded bytes for this slice, including the leading size integer.
- </summary>
- </member>
- <member name="F:Ice.SliceInfo.objects">
- <summary>
- The Ice objects referenced by this slice.
- </summary>
- </member>
- <member name="F:Ice.SliceInfo.hasOptionalMembers">
- <summary>
- Whether or not the slice contains optional members.
- </summary>
- </member>
- <member name="F:Ice.SliceInfo.isLastSlice">
- <summary>
- Whether or not this is the last slice.
- </summary>
- </member>
- <member name="T:Ice.InputStream">
- <summary>
- Interface for input streams used to extract Slice types from a sequence of bytes.
- </summary>
- </member>
- <member name="M:Ice.InputStream.communicator">
- <summary>
- Returns the communicator for this input stream.
- </summary>
- <returns>The communicator.</returns>
- </member>
- <member name="M:Ice.InputStream.sliceObjects(System.Boolean)">
- <summary>
- Determines the behavior of the stream when extracting Slice objects.
- A Slice object is "sliced" when a factory cannot be found for a Slice type ID.
- </summary>
- <param name="slice">If true (the default), slicing is enabled; if false,
- slicing is disabled. If slicing is disabled and the stream encounters a Slice type ID
- during decoding for which no object factory is installed, it raises NoObjectFactoryException.</param>
- </member>
- <member name="M:Ice.InputStream.readBool">
- <summary>
- Extracts a boolean value from the stream.
- </summary>
- <returns>The extracted boolean.</returns>
- </member>
- <member name="M:Ice.InputStream.readBoolSeq">
- <summary>
- Extracts a sequence of boolean values from the stream.
- </summary>
- <returns>The extracted boolean sequence.</returns>
- </member>
- <member name="M:Ice.InputStream.readByte">
- <summary>
- Extracts a byte value from the stream.
- </summary>
- <returns>The extracted byte.</returns>
- </member>
- <member name="M:Ice.InputStream.readByteSeq">
- <summary>
- Extracts a sequence of byte values from the stream.
- </summary>
- <returns>The extracted byte sequence.</returns>
- </member>
- <member name="M:Ice.InputStream.readSerializable">
- <summary>
- Extracts a serializable .NET object from the stream.
- </summary>
- <returns>The deserialized .NET object.</returns>
- </member>
- <member name="M:Ice.InputStream.readShort">
- <summary>
- Extracts a short value from the stream.
- </summary>
- <returns>The extracted short value.</returns>
- </member>
- <member name="M:Ice.InputStream.readShortSeq">
- <summary>
- Extracts a sequence of short values from the stream.
- </summary>
- <returns>The extracted short sequence.</returns>
- </member>
- <member name="M:Ice.InputStream.readInt">
- <summary>
- Extracts an integer value from the stream.
- </summary>
- <returns>The extracted integer value.</returns>
- </member>
- <member name="M:Ice.InputStream.readIntSeq">
- <summary>
- Extracts a sequence of integer values from the stream.
- </summary>
- <returns>The extracted integer sequence.</returns>
- </member>
- <member name="M:Ice.InputStream.readLong">
- <summary>
- Extracts a long value from the stream.
- </summary>
- <returns>The extracted long value.</returns>
- </member>
- <member name="M:Ice.InputStream.readLongSeq">
- <summary>
- Extracts a sequence of long values from the stream.
- </summary>
- <returns>The extracted long sequence.</returns>
- </member>
- <member name="M:Ice.InputStream.readFloat">
- <summary>
- Extracts a float value from the stream.
- </summary>
- <returns>The extracted float value.</returns>
- </member>
- <member name="M:Ice.InputStream.readFloatSeq">
- <summary>
- Extracts a sequence of float values from the stream.
- </summary>
- <returns>The extracted float sequence.</returns>
- </member>
- <member name="M:Ice.InputStream.readDouble">
- <summary>
- Extracts a double value from the stream.
- </summary>
- <returns>The extracted double value.</returns>
- </member>
- <member name="M:Ice.InputStream.readDoubleSeq">
- <summary>
- Extracts a sequence of double values from the stream.
- </summary>
- <returns>The extracted double sequence.</returns>
- </member>
- <member name="M:Ice.InputStream.readString">
- <summary>
- Extracts a string from the stream.
- </summary>
- <returns>The extracted double value.</returns>
- </member>
- <member name="M:Ice.InputStream.readStringSeq">
- <summary>
- Extracts a sequence of strings from the stream.
- </summary>
- <returns>The extracted string sequence.</returns>
- </member>
- <member name="M:Ice.InputStream.readSize">
- <summary>
- Extracts a size from the stream.
- </summary>
- <returns>The extracted size.</returns>
- </member>
- <member name="M:Ice.InputStream.readAndCheckSeqSize(System.Int32)">
- <summary>
- Extracts and check a sequence size from the stream. The check ensures not too much memory will
- be pre-allocated for the sequence.
- </summary>
- <param name="minSize">The minimum size of an element of the sequence.</param>
- <returns>The extracted size.</returns>
- </member>
- <member name="M:Ice.InputStream.readProxy">
- <summary>
- Extracts a proxy from the stream.
- </summary>
- <returns>The extracted proxy.</returns>
- </member>
- <member name="M:Ice.InputStream.readObject(Ice.ReadObjectCallback)">
- <summary>
- Extracts the index of a Slice class from the stream.
- </summary>
- <param name="cb">The callback to notify the application when the extracted instance is available.
- The Ice run time extracts Slice classes in stages. The Ice run time calls ReadObjectCallback.invoke
- when the corresponding instance has been fully unmarshaled.</param>
- </member>
- <member name="M:Ice.InputStream.readEnum(System.Int32)">
- <summary>
- Read an enumerated value.
- </summary>
-
- <param name="maxValue">The maximum enumerator value in the definition.</param>
- <returns>The enumerator.</returns>
- </member>
- <member name="M:Ice.InputStream.throwException">
- <summary>
- Extracts a user exception from the stream and throws it.
- </summary>
- </member>
- <member name="M:Ice.InputStream.throwException(Ice.UserExceptionReaderFactory)">
- <summary>
- Extracts a user exception from the stream and throws it.
- Extracts a user exception from the stream and throws it, using the supplied
- factory to instantiate a UserExceptionReader.
- </summary>
- <param name="factory">A factory that creates UserExceptionReader instances.</param>
- </member>
- <member name="M:Ice.InputStream.startObject">
- <summary>
- Marks the start of an Ice object.
- </summary>
- </member>
- <member name="M:Ice.InputStream.endObject(System.Boolean)">
- <summary>
- Marks the end of an Ice object.
- </summary>
- <param name="preserve">True if unknown slices should be preserved, false otherwise.</param>
- <returns>A SlicedData object containing the preserved slices for unknown types.</returns>
- </member>
- <member name="M:Ice.InputStream.startException">
- <summary>
- Marks the start of a user exception.
- </summary>
- </member>
- <member name="M:Ice.InputStream.endException(System.Boolean)">
- <summary>
- Marks the end of a user exception.
- </summary>
- <param name="preserve">True if unknown slices should be preserved, false otherwise.</param>
- <returns>A SlicedData object containing the preserved slices for unknown types.</returns>
- </member>
- <member name="M:Ice.InputStream.startSlice">
- <summary>
- Reads the start of an object or exception slice.
- </summary>
- <returns>The Slice type ID for this slice.</returns>
- </member>
- <member name="M:Ice.InputStream.endSlice">
- <summary>
- Indicates that the end of an object or exception slice has been reached.
- </summary>
- </member>
- <member name="M:Ice.InputStream.skipSlice">
- <summary>
- Skips over an object or exception slice.
- </summary>
- </member>
- <member name="M:Ice.InputStream.startEncapsulation">
- <summary>
- Reads the start of an encapsulation.
- </summary>
- <returns>The encapsulation encoding version.</returns>
- </member>
- <member name="M:Ice.InputStream.endEncapsulation">
- <summary>
- Indicates that the end of an encapsulation has been reached.
- </summary>
- </member>
- <member name="M:Ice.InputStream.skipEncapsulation">
- <summary>
- Skips over an encapsulation.
- </summary>
- <returns>The encapsulation encoding version.</returns>
- </member>
- <member name="M:Ice.InputStream.getEncoding">
- <summary>
- Determines the current encoding version.
- </summary>
- <returns>The encoding version.</returns>
- </member>
- <member name="M:Ice.InputStream.readPendingObjects">
- <summary>
- Indicates that unmarshaling is complete, except for any Slice objects. The application must
- call this method only if the stream actually contains Slice objects. Calling readPendingObjects
- triggers the calls to ReadObjectCallback.invoke that inform the application that unmarshaling
- of a Slice object is complete.
- </summary>
- </member>
- <member name="M:Ice.InputStream.rewind">
- <summary>
- Resets the read position of the stream to the beginning.
- </summary>
- </member>
- <member name="M:Ice.InputStream.skip(System.Int32)">
- <summary>
- Skips ahead in the stream.
- </summary>
- <param name="sz">The number of bytes to skip.</param>
- </member>
- <member name="M:Ice.InputStream.skipSize">
- <summary>
- Skips over a size value.
- </summary>
- </member>
- <member name="M:Ice.InputStream.readOptional(System.Int32,Ice.OptionalFormat)">
- <summary>
- Determine if an optional value is available for reading.
- </summary>
- <param name="tag">The tag associated with the value.</param>
- <param name="format">The optional format for the value.</param>
- <returns>True if the value is present, false otherwise.</returns>
- </member>
- <member name="M:Ice.InputStream.pos">
- <summary>
- Determine the current position in the stream.
- </summary>
- <returns>The current position.</returns>
- </member>
- <member name="M:Ice.InputStream.destroy">
- <summary>
- Destroys the stream and its associated resources. The application must call destroy prior
- to releasing the last reference to a stream; failure to do so may result in resource leaks.
- </summary>
- </member>
- <member name="T:Ice.OutputStream">
- <summary>
- Interface for output streams used to write Slice types to a sequence
- of bytes.
- </summary>
- </member>
- <member name="M:Ice.OutputStream.communicator">
- <summary>
- Returns the communicator for this output stream.
- </summary>
- </member>
- <member name="M:Ice.OutputStream.writeBool(System.Boolean)">
- <summary>
- Writes a boolean to the stream.
- </summary>
- <param name="v">The boolean to write to the stream.</param>
- </member>
- <member name="M:Ice.OutputStream.writeBoolSeq(System.Boolean[])">
- <summary>
- Writes a sequence of booleans to the stream.
- </summary>
- <param name="v">The sequence of booleans to write.
- Passing null causes an empty sequence to be written to the stream.</param>
- </member>
- <member name="M:Ice.OutputStream.writeByte(System.Byte)">
- <summary>
- Writes a byte to the stream.
- </summary>
- <param name="v">The byte to write to the stream.</param>
- </member>
- <member name="M:Ice.OutputStream.writeByteSeq(System.Byte[])">
- <summary>
- Writes a sequence of bytes to the stream.
- </summary>
- <param name="v">The sequence of bytes to write.
- Passing null causes an empty sequence to be written to the stream.</param>
- </member>
- <member name="M:Ice.OutputStream.writeSerializable(System.Object)">
- <summary>
- Writes a serializable .NET object to the stream.
- </summary>
- <param name="v">The serializable object to write.</param>
- </member>
- <member name="M:Ice.OutputStream.writeShort(System.Int16)">
- <summary>
- Writes a short to the stream.
- </summary>
- <param name="v">The short to write to the stream.</param>
- </member>
- <member name="M:Ice.OutputStream.writeShortSeq(System.Int16[])">
- <summary>
- Writes a sequence of shorts to the stream.
- </summary>
- <param name="v">The sequence of shorts to write.
- Passing null causes an empty sequence to be written to the stream.</param>
- </member>
- <member name="M:Ice.OutputStream.writeInt(System.Int32)">
- <summary>
- Writes an integer to the stream.
- </summary>
- <param name="v">The integer to write to the stream.</param>
- </member>
- <member name="M:Ice.OutputStream.writeIntSeq(System.Int32[])">
- <summary>
- Writes a sequence of integers to the stream.
- </summary>
- <param name="v">The sequence of integers to write.
- Passing null causes an empty sequence to be written to the stream.</param>
- </member>
- <member name="M:Ice.OutputStream.writeLong(System.Int64)">
- <summary>
- Writes a long to the stream.
- </summary>
- <param name="v">The long to write to the stream.</param>
- </member>
- <member name="M:Ice.OutputStream.writeLongSeq(System.Int64[])">
- <summary>
- Writes a sequence of longs to the stream.
- </summary>
- <param name="v">The sequence of longs to write.
- Passing null causes an empty sequence to be written to the stream.</param>
- </member>
- <member name="M:Ice.OutputStream.writeFloat(System.Single)">
- <summary>
- Writes a float to the stream.
- </summary>
- <param name="v">The float to write to the stream.</param>
- </member>
- <member name="M:Ice.OutputStream.writeFloatSeq(System.Single[])">
- <summary>
- Writes a sequence of floats to the stream.
- </summary>
- <param name="v">The sequence of floats to write.
- Passing null causes an empty sequence to be written to the stream.</param>
- </member>
- <member name="M:Ice.OutputStream.writeDouble(System.Double)">
- <summary>
- Writes a double to the stream.
- </summary>
- <param name="v">The double to write to the stream.</param>
- </member>
- <member name="M:Ice.OutputStream.writeDoubleSeq(System.Double[])">
- <summary>
- Writes a sequence of doubles to the stream.
- </summary>
- <param name="v">The sequence of doubles to write.
- Passing null causes an empty sequence to be written to the stream.</param>
- </member>
- <member name="M:Ice.OutputStream.writeString(System.String)">
- <summary>
- Writes a string to the stream.
- </summary>
- <param name="v">The string to write to the stream.
- Passing null causes an empty string to be written to the stream.</param>
- </member>
- <member name="M:Ice.OutputStream.writeStringSeq(System.String[])">
- <summary>
- Writes a sequence of strings to the stream.
- </summary>
- <param name="v">The sequence of strings to write.
- Passing null causes an empty sequence to be written to the stream.</param>
- </member>
- <member name="M:Ice.OutputStream.writeSize(System.Int32)">
- <summary>
- Writes a size to the stream.
- </summary>
- <param name="sz">The size to write.</param>
- </member>
- <member name="M:Ice.OutputStream.writeProxy(Ice.ObjectPrx)">
- <summary>
- Writes a proxy to the stream.
- </summary>
- <param name="v">The proxy to write.</param>
- </member>
- <member name="M:Ice.OutputStream.writeObject(Ice.Object)">
- <summary>
- Writes a Slice class to the stream.
- </summary>
- <param name="v">The class to write. This method writes the index of a Slice class; the state of the
- class is written once writePendingObjects is called.</param>
- </member>
- <member name="M:Ice.OutputStream.writeEnum(System.Int32,System.Int32)">
- <summary>
- Write an enumerated value.
- </summary>
- <param name="v">The enumerator.</param>
- <param name="limit">The number of enumerators in the definition.</param>
- </member>
- <member name="M:Ice.OutputStream.writeException(Ice.UserException)">
- <summary>
- Writes a user exception to the stream.
- </summary>
- <param name="ex">The user exception to write.</param>
- </member>
- <member name="M:Ice.OutputStream.startObject(Ice.SlicedData)">
- <summary>
- Marks the start of an Ice object.
- </summary>
- <param name="slicedData">Preserved slices for this object, or null.</param>
- </member>
- <member name="M:Ice.OutputStream.endObject">
- <summary>
- Marks the end of an Ice object.
- </summary>
- </member>
- <member name="M:Ice.OutputStream.startException(Ice.SlicedData)">
- <summary>
- Marks the start of a user exception.
- </summary>
- <param name="slicedData">Preserved slices for this object, or null.</param>
- </member>
- <member name="M:Ice.OutputStream.endException">
- <summary>
- Marks the end of a user exception.
- </summary>
- </member>
- <member name="M:Ice.OutputStream.startSlice(System.String,System.Int32,System.Boolean)">
- <summary>
- Marks the start of a new slice for an Ice object or user exception.
- </summary>
- <param name="typeId">The Slice type ID corresponding to this slice.</param>
- <param name="compactId">The Slice compact type ID corresponding to this slice.</param>
- <param name="last">True if this is the last slice, false otherwise.</param>
- </member>
- <member name="M:Ice.OutputStream.endSlice">
- <summary>
- Marks the end of a slice for an Ice object or user exception.
- </summary>
- </member>
- <member name="M:Ice.OutputStream.startEncapsulation(Ice.EncodingVersion,Ice.FormatType)">
- <summary>
- Writes the start of an encapsulation to the stream.
- </summary>
- <param name="encoding">The encoding version of the encapsulation.</param>
- <param name="format">The format to use for encoding objects and user exceptions.</param>
- </member>
- <member name="M:Ice.OutputStream.startEncapsulation">
- <summary>
- Writes the start of an encapsulation to the stream.
- </summary>
- </member>
- <member name="M:Ice.OutputStream.endEncapsulation">
- <summary>
- Ends the previous encapsulation.
- </summary>
- </member>
- <member name="M:Ice.OutputStream.getEncoding">
- <summary>
- Determines the current encoding version.
- </summary>
- <returns>The encoding version.</returns>
- </member>
- <member name="M:Ice.OutputStream.writePendingObjects">
- <summary>
- Writes the state of Slice classes whose index was previously
- written with writeObject to the stream.
- </summary>
- </member>
- <member name="M:Ice.OutputStream.writeOptional(System.Int32,Ice.OptionalFormat)">
- <summary>
- Write the header information for an optional value.
- </summary>
- <param name="tag">The numeric tag associated with the value.</param>
- <param name="format">The optional format of the value.</param>
- <returns>True if the optional should be written, false otherwise.</returns>
- </member>
- <member name="M:Ice.OutputStream.pos">
- <summary>
- Determines the current position in the stream.
- </summary>
- <returns>The current position.</returns>
- </member>
- <member name="M:Ice.OutputStream.rewrite(System.Int32,System.Int32)">
- <summary>
- Inserts a fixed 32-bit size value into the stream at the given position.
- </summary>
- <param name="sz">The 32-bit size value.</param>
- <param name="pos">The position at which to write the value.</param>
- </member>
- <member name="M:Ice.OutputStream.startSize">
- <summary>
- Returns the current position and allocates four bytes for a fixed-length (32-bit)
- size value.
- </summary>
- <returns>The current position.</returns>
- </member>
- <member name="M:Ice.OutputStream.endSize(System.Int32)">
- <summary>
- Computes the amount of data written since the previous call to startSize and
- writes that value at the saved position.
- </summary>
- <param name="pos">The saved position at which to write the size.</param>
- </member>
- <member name="M:Ice.OutputStream.finished">
- <summary>
- Indicates that the marshaling of a request or reply is finished.
- </summary>
- <returns>The byte sequence containing the encoded request or reply.</returns>
- </member>
- <member name="M:Ice.OutputStream.reset(System.Boolean)">
- <summary>
- Resets this output stream. This method allows the stream to be reused, to avoid creating
- unnecessary garbage.
- </summary>
-
- <param name="clearBuffer">If true, the stream's internal buffer becomes eligible for
- garbage collection; if false, the stream's internal buffer is retained, to avoid
- creating unnecessary garbage. If retained, the internal buffer may be resized to a smaller
- capacity. Either way, reset resets the stream's writing position to zero.</param>
- </member>
- <member name="M:Ice.OutputStream.destroy">
- <summary>
- Destroys the stream and its associated resources. The application must call destroy prior
- to releasing the last reference to a stream; failure to do so may result in resource leaks.
- </summary>
- </member>
- <member name="T:Ice.ObjectReader">
- <summary>
- Base class for extracting objects from an input stream.
- </summary>
- </member>
- <member name="M:Ice.ObjectReader.read(Ice.InputStream)">
- <summary>
- Read the object's data members.
- </summary>
- <param name="inStream">The input stream to read from.</param>
- </member>
- <member name="T:Ice.ObjectWriter">
- <summary>
- Base class for writing objects to an output stream.
- </summary>
- </member>
- <member name="M:Ice.ObjectWriter.write(Ice.OutputStream)">
- <summary>
- Writes the state of this Slice class to an output stream.
- </summary>
- <param name="outStream">The stream to write to.</param>
- </member>
- <member name="T:Ice.ThreadHookPlugin">
- <summary>
- Class to support thread notification hooks. Applications using
- thread notification hooks instantiate a ThreadHookPlugin with a
- thread notification hook and return the instance from their
- PluginFactory implementation.
- </summary>
- </member>
- <member name="M:Ice.ThreadHookPlugin.#ctor(Ice.Communicator,Ice.ThreadNotification)">
- <summary>
- Installs a custom logger for a communicator.
- </summary>
- <param name="communicator">The communicator using the thread notification hook.</param>
- <param name="threadHook">The thread notification hook for the communicator.</param>
- </member>
- <member name="M:Ice.ThreadHookPlugin.initialize">
- <summary>
- Called by the Ice run time during communicator initialization. The derived class
- can override this method to perform any initialization that might be required
- by the thread notification hook.
- </summary>
- </member>
- <member name="M:Ice.ThreadHookPlugin.destroy">
- <summary>
- Called by the Ice run time when the communicator is destroyed. The derived class
- can override this method to perform any finalization that might be required
- by thread notification hook.
- </summary>
- </member>
- <member name="T:Ice.TieBase">
- <summary>
- Interface for servants using the tie mapping.
- </summary>
- </member>
- <member name="M:Ice.TieBase.ice_delegate">
- <summary>
- Returns the delegate for this tie.
- </summary>
- <returns>The delegate.</returns>
- </member>
- <member name="M:Ice.TieBase.ice_delegate(System.Object)">
- <summary>
- Returns the delegate for this tie.
- </summary>
- <param name="o">The delegate.</param>
- </member>
- <member name="T:Ice.UnknownSlicedObject">
- <summary>
- Unknown sliced object holds an instance of unknown type.
- </summary>
- </member>
- <member name="M:Ice.UnknownSlicedObject.#ctor(System.String)">
- <summary>
- Instantiates the class for an Ice object having the given Slice type.
- </summary>
- <param name="unknownTypeId">The Slice type ID of the unknown object.</param>
- </member>
- <member name="M:Ice.UnknownSlicedObject.getUnknownTypeId">
- <summary>
- Determine the Slice type ID associated with this object.
- </summary>
- <returns>The type ID.</returns>
- </member>
- <member name="T:Ice.ThreadNotification">
- <summary>
- Interface for thread notification hooks. Applications can derive
- a class tat implements the start and stop
- methods to intercept creation and destruction of threads created
- by the Ice run time.
- </summary>
- </member>
- <member name="M:Ice.ThreadNotification.start">
- <summary>
- The Ice run time calls start for each new
- thread it creates. The call is made by the newly-started thread.
- </summary>
- </member>
- <member name="M:Ice.ThreadNotification.stop">
- <summary>
- The Ice run time calls stop before it destroys
- a thread. The call is made by thread that is about to be
- destroyed.
- </summary>
- </member>
- <member name="T:Ice.Dispatcher">
- <summary>
- A delegate for the dispatcher. The dispatcher is called by the Ice
- runtime to dispatch servant calls and AMI callbacks.
- </summary>
- </member>
- <member name="T:Ice.CompactIdResolver">
- <summary>
- Applications that make use of compact type IDs to conserve space
- when marshaling class instances, and also use the streaming API to
- extract such classes, can intercept the translation between compact
- type IDs and their corresponding string type IDs by installing an
- instance of CompactIdResolver in InitializationData.
- </summary>
- </member>
- <member name="T:Ice.InitializationData">
- <summary>
- A class that encpasulates data to initialize a communicator.
- </summary>
- </member>
- <member name="M:Ice.InitializationData.Clone">
- <summary>
- Creates and returns a copy of this object.
- </summary>
- </member>
- <member name="F:Ice.InitializationData.properties">
- <summary>
- The properties for the communicator.
- </summary>
- </member>
- <member name="F:Ice.InitializationData.logger">
- <summary>
- The logger for the communicator.
- </summary>
- </member>
- <member name="F:Ice.InitializationData.observer">
- <summary>
- The communicator observer used by the Ice run-time.
- </summary>
- </member>
- <member name="F:Ice.InitializationData.threadHook">
- <summary>
- The thread hook for the communicator.
- </summary>
- </member>
- <member name="F:Ice.InitializationData.dispatcher">
- <summary>
- The dispatcher for the communicator.
- </summary>
- </member>
- <member name="F:Ice.InitializationData.compactIdResolver">
- <summary>
- The compact type ID resolver.
- </summary>
- </member>
- <member name="F:Ice.InitializationData.batchRequestInterceptor">
- <summary>
- The batch request interceptor.
- </summary>
- </member>
- <member name="T:Ice.Util">
- <summary>
- Utility methods for the Ice run time.
- </summary>
- </member>
- <member name="M:Ice.Util.createProperties">
- <summary>
- Creates a new empty property set.
- </summary>
- <returns>A new empty property set.</returns>
- </member>
- <member name="M:Ice.Util.createProperties(System.String[]@)">
- <summary>
- Creates a property set initialized from an argument vector.
- </summary>
- <param name="args">A command-line argument vector, possibly containing
- options to set properties. If the command-line options include
- a --Ice.Config option, the corresponding configuration
- files are parsed. If the same property is set in a configuration
- file and in the argument vector, the argument vector takes precedence.
- This method modifies the argument vector by removing any Ice-related options.</param>
- <returns>A property set initialized with the property settings
- that were removed from args.</returns>
- </member>
- <member name="M:Ice.Util.createProperties(System.String[]@,Ice.Properties)">
- <summary>
- Creates a property set initialized from an argument vector.
- </summary>
- <param name="args">A command-line argument vector, possibly containing
- options to set properties. If the command-line options include
- a --Ice.Config option, the corresponding configuration
- files are parsed. If the same property is set in a configuration
- file and in the argument vector, the argument vector takes precedence.
- This method modifies the argument vector by removing any Ice-related options.</param>
- <param name="defaults">Default values for the property set. Settings in configuration
- files and args override these defaults.</param>
- <returns>A property set initialized with the property settings
- that were removed from args.</returns>
- </member>
- <member name="M:Ice.Util.initialize(System.String[]@)">
- <summary>
- Creates a communicator.
- </summary>
- <param name="args">A command-line argument vector. Any Ice-related options
- in this vector are used to intialize the communicator.
- This method modifies the argument vector by removing any Ice-related options.</param>
- <returns>The initialized communicator.</returns>
- </member>
- <member name="M:Ice.Util.initialize(System.String[]@,Ice.InitializationData)">
- <summary>
- Creates a communicator.
- </summary>
- <param name="args">A command-line argument vector. Any Ice-related options
- in this vector are used to intialize the communicator.
- This method modifies the argument vector by removing any Ice-related options.</param>
- <param name="initData">Additional intialization data. Property settings in args
- override property settings in initData.</param>
- <returns>The initialized communicator.</returns>
- </member>
- <member name="M:Ice.Util.initialize(Ice.InitializationData)">
- <summary>
- Creates a communicator.
- </summary>
- <param name="initData">Additional intialization data.</param>
- <returns>The initialized communicator.</returns>
- </member>
- <member name="M:Ice.Util.initialize">
- <summary>
- Creates a communicator using a default configuration.
- </summary>
- </member>
- <member name="M:Ice.Util.stringToIdentity(System.String)">
- <summary>
- Converts a string to an object identity.
- </summary>
- <param name="s">The string to convert.</param>
- <returns>The converted object identity.</returns>
- </member>
- <member name="M:Ice.Util.identityToString(Ice.Identity)">
- <summary>
- Converts an object identity to a string.
- </summary>
- <param name="ident">The object identity to convert.</param>
- <returns>The string representation of the object identity.</returns>
- </member>
- <member name="M:Ice.Util.generateUUID">
- <summary>
- This method is deprecated. Use System.Guid instead.
- </summary>
- </member>
- <member name="M:Ice.Util.proxyIdentityCompare(Ice.ObjectPrx,Ice.ObjectPrx)">
- <summary>
- Compares the object identities of two proxies.
- </summary>
- <param name="lhs">A proxy.</param>
- <param name="rhs">A proxy.</param>
- <returns>-1 if the identity in lhs compares
- less than the identity in rhs; 0 if the identities
- compare equal; 1, otherwise.</returns>
- </member>
- <member name="M:Ice.Util.proxyIdentityAndFacetCompare(Ice.ObjectPrx,Ice.ObjectPrx)">
- <summary>
- Compares the object identities and facets of two proxies.
- </summary>
- <param name="lhs">A proxy.</param>
- <param name="rhs">A proxy.</param>
- <returns>-1 if the identity and facet in lhs compare
- less than the identity and facet in rhs; 0 if the identities
- and facets compare equal; 1, otherwise.</returns>
- </member>
- <member name="M:Ice.Util.createInputStream(Ice.Communicator,System.Byte[])">
- <summary>
- Creates an input stream for dynamic invocation and dispatch. The stream uses
- the communicator's default encoding version. The given data is copied.
- </summary>
- <param name="communicator">The communicator for the stream.</param>
- <param name="bytes">An encoded request or reply.</param>
- <returns>The input stream.</returns>
- </member>
- <member name="M:Ice.Util.createInputStream(Ice.Communicator,System.Byte[],Ice.EncodingVersion)">
- <summary>
- Creates an input stream for dynamic invocation and dispatch. The stream uses
- the given encoding version.
- </summary>
- <param name="communicator">The communicator for the stream.</param>
- <param name="bytes">An encoded request or reply.</param>
- <param name="v">The desired encoding version.</param>
- <returns>The input stream.</returns>
- </member>
- <member name="M:Ice.Util.wrapInputStream(Ice.Communicator,System.Byte[])">
- <summary>
- Wraps encoded data with an input stream for dynamic invocation and dispatch.
- The stream uses the communicator's default encoding version.
- </summary>
- <param name="communicator">The communicator for the stream.</param>
- <param name="bytes">An encoded request or reply.</param>
- <returns>The input stream.</returns>
- </member>
- <member name="M:Ice.Util.wrapInputStream(Ice.Communicator,System.Byte[],Ice.EncodingVersion)">
- <summary>
- Wraps encoded data with an input stream for dynamic invocation and dispatch.
- The stream uses the given encoding version.
- </summary>
- <param name="communicator">The communicator for the stream.</param>
- <param name="bytes">An encoded request or reply.</param>
- <param name="v">The desired encoding version.</param>
- <returns>The input stream.</returns>
- </member>
- <member name="M:Ice.Util.createOutputStream(Ice.Communicator)">
- <summary>
- Creates an output stream for dynamic invocation and dispatch. The stream uses
- the communicator's default encoding version.
- </summary>
- <param name="communicator">The communicator for the stream.</param>
- <returns>The output stream.</returns>
- </member>
- <member name="M:Ice.Util.createOutputStream(Ice.Communicator,Ice.EncodingVersion)">
- <summary>
- Creates an output stream for dynamic invocation and dispatch. The stream uses
- the given encoding version.
- </summary>
- <param name="communicator">The communicator for the stream.</param>
- <param name="v">The desired encoding version.</param>
- <returns>The output stream.</returns>
- </member>
- <member name="M:Ice.Util.getProcessLogger">
- <summary>
- Returns the process-wide logger.
- </summary>
- <returns>The process-wide logger.</returns>
- </member>
- <member name="M:Ice.Util.setProcessLogger(Ice.Logger)">
- <summary>
- Changes the process-wide logger.
- </summary>
- <param name="logger">The new process-wide logger.</param>
- </member>
- <member name="M:Ice.Util.stringVersion">
- <summary>
- Returns the Ice version in the form A.B.C, where A indicates the
- major version, B indicates the minor version, and C indicates the
- patch level.
- </summary>
- <returns>The Ice version.</returns>
- </member>
- <member name="M:Ice.Util.intVersion">
- <summary>
- Returns the Ice version as an integer in the form A.BB.CC, where A
- indicates the major version, BB indicates the minor version, and CC
- indicates the patch level. For example, for Ice 3.3.1, the returned value is 30301.
- </summary>
- <returns>The Ice version.</returns>
- </member>
- <member name="M:Ice.Util.stringToProtocolVersion(System.String)">
- <summary>
- Converts a string to a protocol version.
- </summary>
- <param name="version">The string to convert.</param>
- <returns>The converted protocol version.</returns>
- </member>
- <member name="M:Ice.Util.stringToEncodingVersion(System.String)">
- <summary>
- Converts a string to an encoding version.
- </summary>
- <param name="version">The string to convert.</param>
- <returns>The converted object identity.</returns>
- </member>
- <member name="M:Ice.Util.protocolVersionToString(Ice.ProtocolVersion)">
- <summary>
- Converts a protocol version to a string.
- </summary>
- <param name="v">The protocol version to convert.</param>
- <returns>The converted string.</returns>
- </member>
- <member name="M:Ice.Util.encodingVersionToString(Ice.EncodingVersion)">
- <summary>
- Converts an encoding version to a string.
- </summary>
- <param name="v">The encoding version to convert.</param>
- <returns>The converted string.</returns>
- </member>
- <member name="M:Ice.ConnectionCallback.heartbeat(Ice.Connection)">
- <summary>
- This method is called by the the connection when a heartbeat is
- received from the peer.
- </summary>
- </member>
- <member name="M:Ice.ConnectionCallback.closed(Ice.Connection)">
- <summary>
- This method is called by the the connection when the connection
- is closed.
- </summary>
- </member>
- <member name="T:Ice.InitializationException">
- <summary>
- This exception is raised when a failure occurs during initialization.
- </summary>
- </member>
- <member name="T:Ice.PluginInitializationException">
- <summary>
- This exception indicates that a failure occurred while initializing
- a plug-in.
- </summary>
- </member>
- <member name="T:Ice.CollocationOptimizationException">
- <summary>
- This exception is raised if a feature is requested that is not
- supported with collocation optimization.
-
- <para>this exception isn't used anymore by the Ice runtime</para>
-
- </summary>
- </member>
- <member name="T:Ice.AlreadyRegisteredException">
- <summary>
- An attempt was made to register something more than once with
- the Ice run time.
- This exception is raised if an attempt is made to register a
- servant, servant locator, facet, object factory, plug-in, object
- adapter, object, or user exception factory more than once for the
- same ID.
- </summary>
- </member>
- <member name="T:Ice.NotRegisteredException">
- <summary>
- An attempt was made to find or deregister something that is not
- registered with the Ice run time or Ice locator.
- This exception is raised if an attempt is made to remove a servant,
- servant locator, facet, object factory, plug-in, object adapter,
- object, or user exception factory that is not currently registered.
-
- It's also raised if the Ice locator can't find an object or object
- adapter when resolving an indirect proxy or when an object adapter
- is activated.
- </summary>
- </member>
- <member name="T:Ice.TwowayOnlyException">
- <summary>
- The operation can only be invoked with a twoway request.
- This exception is raised if an attempt is made to invoke an
- operation with ice_oneway, ice_batchOneway, ice_datagram,
- or ice_batchDatagram and the operation has a return value,
- out-parameters, or an exception specification.
- </summary>
- </member>
- <member name="T:Ice.CloneNotImplementedException">
- <summary>
- An attempt was made to clone a class that does not support
- cloning.
- This exception is raised if ice_clone is called on
- a class that is derived from an abstract Slice class (that is,
- a class containing operations), and the derived class does not
- provide an implementation of the ice_clone operation (C++ only).
- </summary>
- </member>
- <member name="T:Ice.UnknownException">
- <summary>
- This exception is raised if an operation call on a server raises an
- unknown exception.
- For example, for C++, this exception is raised
- if the server throws a C++ exception that is not directly or
- indirectly derived from Ice::LocalException or
- Ice::UserException.
- </summary>
- </member>
- <member name="T:Ice.UnknownLocalException">
- <summary>
- This exception is raised if an operation call on a server raises a
- local exception.
- Because local exceptions are not transmitted by
- the Ice protocol, the client receives all local exceptions raised
- by the server as UnknownLocalException. The only exception to this
- rule are all exceptions derived from RequestFailedException,
- which are transmitted by the Ice protocol even though they are
- declared local.
- </summary>
- </member>
- <member name="T:Ice.UnknownUserException">
- <summary>
- An operation raised an incorrect user exception.
- This exception is raised if an operation raises a
- user exception that is not declared in the exception's
- throws clause. Such undeclared exceptions are
- not transmitted from the server to the client by the Ice
- protocol, but instead the client just gets an
- UnknownUserException. This is necessary in order to not violate
- the contract established by an operation's signature: Only local
- exceptions and user exceptions declared in the
- throws clause can be raised.
- </summary>
- </member>
- <member name="T:Ice.VersionMismatchException">
- <summary>
- This exception is raised if the Ice library version does not match
- the version in the Ice header files.
- </summary>
- </member>
- <member name="T:Ice.CommunicatorDestroyedException">
- <summary>
- This exception is raised if the Communicator has been destroyed.
- </summary>
- </member>
- <member name="T:Ice.ObjectAdapterDeactivatedException">
- <summary>
- This exception is raised if an attempt is made to use a deactivated
- ObjectAdapter.
- </summary>
- </member>
- <member name="T:Ice.ObjectAdapterIdInUseException">
- <summary>
- This exception is raised if an ObjectAdapter cannot be activated.
- This happens if the Locator detects another active ObjectAdapter with
- the same adapter id.
- </summary>
- </member>
- <member name="T:Ice.NoEndpointException">
- <summary>
- This exception is raised if no suitable endpoint is available.
- </summary>
- </member>
- <member name="T:Ice.EndpointParseException">
- <summary>
- This exception is raised if there was an error while parsing an
- endpoint.
- </summary>
- </member>
- <member name="T:Ice.EndpointSelectionTypeParseException">
- <summary>
- This exception is raised if there was an error while parsing an
- endpoint selection type.
- </summary>
- </member>
- <member name="T:Ice.VersionParseException">
- <summary>
- This exception is raised if there was an error while parsing a
- version.
- </summary>
- </member>
- <member name="T:Ice.IdentityParseException">
- <summary>
- This exception is raised if there was an error while parsing a
- stringified identity.
- </summary>
- </member>
- <member name="T:Ice.ProxyParseException">
- <summary>
- This exception is raised if there was an error while parsing a
- stringified proxy.
- </summary>
- </member>
- <member name="T:Ice.IllegalIdentityException">
- <summary>
- This exception is raised if an illegal identity is encountered.
- </summary>
- </member>
- <member name="T:Ice.IllegalServantException">
- <summary>
- This exception is raised to reject an illegal servant (typically
- a null servant)
-
- </summary>
- </member>
- <member name="T:Ice.RequestFailedException">
- <summary>
- This exception is raised if a request failed.
- This exception, and
- all exceptions derived from RequestFailedException, are
- transmitted by the Ice protocol, even though they are declared
- local.
- </summary>
- </member>
- <member name="T:Ice.ObjectNotExistException">
- <summary>
- This exception is raised if an object does not exist on the server,
- that is, if no facets with the given identity exist.
- </summary>
- </member>
- <member name="T:Ice.FacetNotExistException">
- <summary>
- This exception is raised if no facet with the given name exists,
- but at least one facet with the given identity exists.
- </summary>
- </member>
- <member name="T:Ice.OperationNotExistException">
- <summary>
- This exception is raised if an operation for a given object does
- not exist on the server.
- Typically this is caused by either the
- client or the server using an outdated Slice specification.
- </summary>
- </member>
- <member name="T:Ice.SyscallException">
- <summary>
- This exception is raised if a system error occurred in the server
- or client process.
- There are many possible causes for such a system
- exception. For details on the cause, SyscallException.error
- should be inspected.
- </summary>
- </member>
- <member name="T:Ice.SocketException">
- <summary>
- This exception indicates socket errors.
- </summary>
- </member>
- <member name="T:Ice.FileException">
- <summary>
- This exception indicates file errors.
- </summary>
- </member>
- <member name="T:Ice.ConnectFailedException">
- <summary>
- This exception indicates connection failures.
- </summary>
- </member>
- <member name="T:Ice.ConnectionRefusedException">
- <summary>
- This exception indicates a connection failure for which
- the server host actively refuses a connection.
- </summary>
- </member>
- <member name="T:Ice.ConnectionLostException">
- <summary>
- This exception indicates a lost connection.
- </summary>
- </member>
- <member name="T:Ice.DNSException">
- <summary>
- This exception indicates a DNS problem.
- For details on the cause,
- DNSException.error should be inspected.
- </summary>
- </member>
- <member name="T:Ice.OperationInterruptedException">
- <summary>
- This exception indicates a request was interrupted.
- </summary>
- </member>
- <member name="T:Ice.TimeoutException">
- <summary>
- This exception indicates a timeout condition.
- </summary>
- </member>
- <member name="T:Ice.ConnectTimeoutException">
- <summary>
- This exception indicates a connection establishment timeout condition.
- </summary>
- </member>
- <member name="T:Ice.CloseTimeoutException">
- <summary>
- This exception indicates a connection closure timeout condition.
- </summary>
- </member>
- <member name="T:Ice.ConnectionTimeoutException">
- <summary>
- This exception indicates that a connection has been shut down because it has been
- idle for some time.
- </summary>
- </member>
- <member name="T:Ice.InvocationTimeoutException">
- <summary>
- This exception indicates that an invocation failed because it timed
- out.
- </summary>
- </member>
- <member name="T:Ice.InvocationCanceledException">
- <summary>
- This exception indicates that an asynchronous invocation failed
- because it was canceled explicitly by the user using the
- Ice::AsyncResult::cancel method.
- </summary>
- </member>
- <member name="T:Ice.ProtocolException">
- <summary>
- A generic exception base for all kinds of protocol error
- conditions.
- </summary>
- </member>
- <member name="T:Ice.BadMagicException">
- <summary>
- This exception indicates that a message did not start with the expected
- magic number ('I', 'c', 'e', 'P').
- </summary>
- </member>
- <member name="T:Ice.UnsupportedProtocolException">
- <summary>
- This exception indicates an unsupported protocol version.
- </summary>
- </member>
- <member name="T:Ice.UnsupportedEncodingException">
- <summary>
- This exception indicates an unsupported data encoding version.
- </summary>
- </member>
- <member name="T:Ice.UnknownMessageException">
- <summary>
- This exception indicates that an unknown protocol message has been received.
- </summary>
- </member>
- <member name="T:Ice.ConnectionNotValidatedException">
- <summary>
- This exception is raised if a message is received over a connection
- that is not yet validated.
- </summary>
- </member>
- <member name="T:Ice.UnknownRequestIdException">
- <summary>
- This exception indicates that a response for an unknown request ID has been
- received.
- </summary>
- </member>
- <member name="T:Ice.UnknownReplyStatusException">
- <summary>
- This exception indicates that an unknown reply status has been received.
- </summary>
- </member>
- <member name="T:Ice.CloseConnectionException">
- <summary>
- This exception indicates that the connection has been gracefully shut down by the
- server.
- The operation call that caused this exception has not been
- executed by the server. In most cases you will not get this
- exception, because the client will automatically retry the
- operation call in case the server shut down the connection. However,
- if upon retry the server shuts down the connection again, and the
- retry limit has been reached, then this exception is propagated to
- the application code.
- </summary>
- </member>
- <member name="T:Ice.ForcedCloseConnectionException">
- <summary>
- This exception is raised by an operation call if the application
- forcefully closes the connection Connection.close.
- </summary>
- </member>
- <member name="T:Ice.IllegalMessageSizeException">
- <summary>
- This exception indicates that a message size is less
- than the minimum required size.
- </summary>
- </member>
- <member name="T:Ice.CompressionException">
- <summary>
- This exception indicates a problem with compressing or uncompressing data.
- </summary>
- </member>
- <member name="T:Ice.DatagramLimitException">
- <summary>
- A datagram exceeds the configured size.
- This exception is raised if a datagram exceeds the configured send or receive buffer
- size, or exceeds the maximum payload size of a UDP packet (65507 bytes).
- </summary>
- </member>
- <member name="T:Ice.MarshalException">
- <summary>
- This exception is raised for errors during marshaling or unmarshaling data.
- </summary>
- </member>
- <member name="T:Ice.ProxyUnmarshalException">
- <summary>
- This exception is raised if inconsistent data is received while unmarshaling a proxy.
- </summary>
- </member>
- <member name="T:Ice.UnmarshalOutOfBoundsException">
- <summary>
- This exception is raised if an out-of-bounds condition occurs during unmarshaling.
- </summary>
- </member>
- <member name="T:Ice.NoObjectFactoryException">
- <summary>
- This exception is raised if no suitable object factory was found during
- unmarshaling of a Slice class instance.
- </summary>
- </member>
- <member name="T:Ice.UnexpectedObjectException">
- <summary>
- This exception is raised if the type of an unmarshaled Slice class instance does
- not match its expected type.
- This can happen if client and server are compiled with mismatched Slice
- definitions or if a class of the wrong type is passed as a parameter
- or return value using dynamic invocation. This exception can also be
- raised if IceStorm is used to send Slice class instances and
- an operation is subscribed to the wrong topic.
- </summary>
- </member>
- <member name="T:Ice.MemoryLimitException">
- <summary>
- This exception is raised when Ice receives a request or reply
- message whose size exceeds the limit specified by the
- Ice.MessageSizeMax property.
- </summary>
- </member>
- <member name="T:Ice.StringConversionException">
- <summary>
- This exception is raised when a string conversion to or from UTF-8
- fails during marshaling or unmarshaling.
- </summary>
- </member>
- <member name="T:Ice.EncapsulationException">
- <summary>
- This exception indicates a malformed data encapsulation.
- </summary>
- </member>
- <member name="T:Ice.FeatureNotSupportedException">
- <summary>
- This exception is raised if an unsupported feature is used.
- The
- unsupported feature string contains the name of the unsupported
- feature
- </summary>
- </member>
- <member name="T:Ice.SecurityException">
- <summary>
- This exception indicates a failure in a security subsystem,
- such as the IceSSL plug-in.
- </summary>
- </member>
- <member name="T:Ice.FixedProxyException">
- <summary>
- This exception indicates that an attempt has been made to
- change the connection properties of a fixed proxy.
- </summary>
- </member>
- <member name="T:Ice.ResponseSentException">
- <summary>
- Indicates that the response to a request has already been sent;
- re-dispatching such a request is not possible.
- </summary>
- </member>
- <member name="T:Ice.AdapterNotFoundException">
- <summary>
- This exception is raised if an adapter cannot be found.
- </summary>
- </member>
- <member name="T:Ice.InvalidReplicaGroupIdException">
- <summary>
- This exception is raised if the replica group provided by the
- server is invalid.
- </summary>
- </member>
- <member name="T:Ice.AdapterAlreadyActiveException">
- <summary>
- This exception is raised if a server tries to set endpoints for
- an adapter that is already active.
- </summary>
- </member>
- <member name="T:Ice.ObjectNotFoundException">
- <summary>
- This exception is raised if an object cannot be found.
- </summary>
- </member>
- <member name="T:Ice.ServerNotFoundException">
- <summary>
- This exception is raised if a server cannot be found.
- </summary>
- </member>
- <member name="T:Ice.LocatorOperations_">
- <summary>
- The Ice locator interface.
- This interface is used by clients to
- lookup adapters and objects. It is also used by servers to get the
- locator registry proxy.
-
- The Locator interface is intended to be used by
- Ice internals and by locator implementations. Regular user code
- should not attempt to use any functionality of this interface
- directly.
- </summary>
- </member>
- <member name="M:Ice.LocatorOperations_.findObjectById_async(Ice.AMD_Locator_findObjectById,Ice.Identity,Ice.Current)">
- <summary>
- Find an object by identity and return a proxy that contains
- the adapter ID or endpoints which can be used to access the
- object.
- </summary>
- <param name="cb__">The callback object for the operation.</param>
- <param name="id">The identity.
-
- </param>
- <param name="current__">The Current object for the invocation.</param>
- </member>
- <member name="M:Ice.LocatorOperations_.findAdapterById_async(Ice.AMD_Locator_findAdapterById,System.String,Ice.Current)">
- <summary>
- Find an adapter by id and return a proxy that contains
- its endpoints.
- </summary>
- <param name="cb__">The callback object for the operation.</param>
- <param name="id">The adapter id.
-
- </param>
- <param name="current__">The Current object for the invocation.</param>
- </member>
- <member name="M:Ice.LocatorOperations_.getRegistry(Ice.Current)">
- <summary>
- Get the locator registry.
- </summary>
- <returns>The locator registry.</returns>
- <param name="current__">The Current object for the invocation.</param>
- </member>
- <member name="T:Ice.LocatorOperationsNC_">
- <summary>
- The Ice locator interface.
- This interface is used by clients to
- lookup adapters and objects. It is also used by servers to get the
- locator registry proxy.
-
- The Locator interface is intended to be used by
- Ice internals and by locator implementations. Regular user code
- should not attempt to use any functionality of this interface
- directly.
- </summary>
- </member>
- <member name="M:Ice.LocatorOperationsNC_.findObjectById_async(Ice.AMD_Locator_findObjectById,Ice.Identity)">
- <summary>
- Find an object by identity and return a proxy that contains
- the adapter ID or endpoints which can be used to access the
- object.
- </summary>
- <param name="cb__">The callback object for the operation.</param>
- <param name="id">The identity.
-
- </param>
- </member>
- <member name="M:Ice.LocatorOperationsNC_.findAdapterById_async(Ice.AMD_Locator_findAdapterById,System.String)">
- <summary>
- Find an adapter by id and return a proxy that contains
- its endpoints.
- </summary>
- <param name="cb__">The callback object for the operation.</param>
- <param name="id">The adapter id.
-
- </param>
- </member>
- <member name="M:Ice.LocatorOperationsNC_.getRegistry">
- <summary>
- Get the locator registry.
- </summary>
- <returns>The locator registry.</returns>
- </member>
- <member name="T:Ice.LocatorRegistryOperations_">
- <summary>
- The Ice locator registry interface.
- This interface is used by
- servers to register adapter endpoints with the locator.
-
- The LocatorRegistry interface is intended to be used
- by Ice internals and by locator implementations. Regular user
- code should not attempt to use any functionality of this interface
- directly.
- </summary>
- </member>
- <member name="M:Ice.LocatorRegistryOperations_.setAdapterDirectProxy_async(Ice.AMD_LocatorRegistry_setAdapterDirectProxy,System.String,Ice.ObjectPrx,Ice.Current)">
- <summary>
- Set the adapter endpoints with the locator registry.
- </summary>
- <param name="cb__">The callback object for the operation.</param>
- <param name="id">The adapter id.
-
- </param>
- <param name="proxy">The adapter proxy (a dummy direct proxy created
- by the adapter). The direct proxy contains the adapter
- endpoints.
-
- </param>
- <param name="current__">The Current object for the invocation.</param>
- </member>
- <member name="M:Ice.LocatorRegistryOperations_.setReplicatedAdapterDirectProxy_async(Ice.AMD_LocatorRegistry_setReplicatedAdapterDirectProxy,System.String,System.String,Ice.ObjectPrx,Ice.Current)">
- <summary>
- Set the adapter endpoints with the locator registry.
- </summary>
- <param name="cb__">The callback object for the operation.</param>
- <param name="adapterId">The adapter id.
-
- </param>
- <param name="replicaGroupId">The replica group id.
-
- </param>
- <param name="p">The adapter proxy (a dummy direct proxy created
- by the adapter). The direct proxy contains the adapter
- endpoints.
-
- </param>
- <param name="current__">The Current object for the invocation.</param>
- </member>
- <member name="M:Ice.LocatorRegistryOperations_.setServerProcessProxy_async(Ice.AMD_LocatorRegistry_setServerProcessProxy,System.String,Ice.ProcessPrx,Ice.Current)">
- <summary>
- Set the process proxy for a server.
- </summary>
- <param name="cb__">The callback object for the operation.</param>
- <param name="id">The server id.
-
- </param>
- <param name="proxy">The process proxy.
-
- </param>
- <param name="current__">The Current object for the invocation.</param>
- </member>
- <member name="T:Ice.LocatorRegistryOperationsNC_">
- <summary>
- The Ice locator registry interface.
- This interface is used by
- servers to register adapter endpoints with the locator.
-
- The LocatorRegistry interface is intended to be used
- by Ice internals and by locator implementations. Regular user
- code should not attempt to use any functionality of this interface
- directly.
- </summary>
- </member>
- <member name="M:Ice.LocatorRegistryOperationsNC_.setAdapterDirectProxy_async(Ice.AMD_LocatorRegistry_setAdapterDirectProxy,System.String,Ice.ObjectPrx)">
- <summary>
- Set the adapter endpoints with the locator registry.
- </summary>
- <param name="cb__">The callback object for the operation.</param>
- <param name="id">The adapter id.
-
- </param>
- <param name="proxy">The adapter proxy (a dummy direct proxy created
- by the adapter). The direct proxy contains the adapter
- endpoints.
-
- </param>
- </member>
- <member name="M:Ice.LocatorRegistryOperationsNC_.setReplicatedAdapterDirectProxy_async(Ice.AMD_LocatorRegistry_setReplicatedAdapterDirectProxy,System.String,System.String,Ice.ObjectPrx)">
- <summary>
- Set the adapter endpoints with the locator registry.
- </summary>
- <param name="cb__">The callback object for the operation.</param>
- <param name="adapterId">The adapter id.
-
- </param>
- <param name="replicaGroupId">The replica group id.
-
- </param>
- <param name="p">The adapter proxy (a dummy direct proxy created
- by the adapter). The direct proxy contains the adapter
- endpoints.
-
- </param>
- </member>
- <member name="M:Ice.LocatorRegistryOperationsNC_.setServerProcessProxy_async(Ice.AMD_LocatorRegistry_setServerProcessProxy,System.String,Ice.ProcessPrx)">
- <summary>
- Set the process proxy for a server.
- </summary>
- <param name="cb__">The callback object for the operation.</param>
- <param name="id">The server id.
-
- </param>
- <param name="proxy">The process proxy.
-
- </param>
- </member>
- <member name="T:Ice.LocatorFinderOperations_">
- <summary>
- This inferface should be implemented by services implementing the
- Ice::Locator interface.
- It should be advertised through an Ice
- object with the identity `Ice/LocatorFinder'. This allows clients
- to retrieve the locator proxy with just the endpoint information of
- the service.
- </summary>
- </member>
- <member name="M:Ice.LocatorFinderOperations_.getLocator(Ice.Current)">
- <summary>
- Get the locator proxy implemented by the process hosting this
- finder object.
- The proxy might point to several replicas.
-
- </summary>
- <returns>The locator proxy.</returns>
- <param name="current__">The Current object for the invocation.</param>
- </member>
- <member name="T:Ice.LocatorFinderOperationsNC_">
- <summary>
- This inferface should be implemented by services implementing the
- Ice::Locator interface.
- It should be advertised through an Ice
- object with the identity `Ice/LocatorFinder'. This allows clients
- to retrieve the locator proxy with just the endpoint information of
- the service.
- </summary>
- </member>
- <member name="M:Ice.LocatorFinderOperationsNC_.getLocator">
- <summary>
- Get the locator proxy implemented by the process hosting this
- finder object.
- The proxy might point to several replicas.
-
- </summary>
- <returns>The locator proxy.</returns>
- </member>
- <member name="T:Ice.LocatorPrx">
- <summary>
- The Ice locator interface.
- This interface is used by clients to
- lookup adapters and objects. It is also used by servers to get the
- locator registry proxy.
-
- The Locator interface is intended to be used by
- Ice internals and by locator implementations. Regular user code
- should not attempt to use any functionality of this interface
- directly.
- </summary>
- </member>
- <member name="M:Ice.LocatorPrx.findObjectById(Ice.Identity)">
- <summary>
- Find an object by identity and return a proxy that contains
- the adapter ID or endpoints which can be used to access the
- object.
- </summary>
- <param name="id">The identity.
-
- </param>
- <returns>The proxy, or null if the object is not active.
-
- </returns>
- <exception name="ObjectNotFoundException">Raised if the object cannot
- be found.</exception>
- </member>
- <member name="M:Ice.LocatorPrx.findObjectById(Ice.Identity,System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- Find an object by identity and return a proxy that contains
- the adapter ID or endpoints which can be used to access the
- object.
- </summary>
- <param name="id">The identity.
-
- </param>
- <returns>The proxy, or null if the object is not active.
-
- </returns>
- <exception name="ObjectNotFoundException">Raised if the object cannot
- be found.</exception>
- <param name="ctx__">The Context map to send with the invocation.</param>
- </member>
- <member name="M:Ice.LocatorPrx.begin_findObjectById(Ice.Identity)">
- <summary>
- Find an object by identity and return a proxy that contains
- the adapter ID or endpoints which can be used to access the
- object.
- </summary>
- <param name="id">The identity.
-
- </param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.LocatorPrx.begin_findObjectById(Ice.Identity,System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- Find an object by identity and return a proxy that contains
- the adapter ID or endpoints which can be used to access the
- object.
- </summary>
- <param name="id">The identity.
-
- </param>
- <param name="ctx__">The Context map to send with the invocation.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.LocatorPrx.begin_findObjectById(Ice.Identity,Ice.AsyncCallback,System.Object)">
- <summary>
- Find an object by identity and return a proxy that contains
- the adapter ID or endpoints which can be used to access the
- object.
- </summary>
- <param name="id">The identity.
-
- </param>
- <param name="cb__">Asynchronous callback invoked when the operation completes.</param>
- <param name="cookie__">Application data to store in the asynchronous result object.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.LocatorPrx.begin_findObjectById(Ice.Identity,System.Collections.Generic.Dictionary{System.String,System.String},Ice.AsyncCallback,System.Object)">
- <summary>
- Find an object by identity and return a proxy that contains
- the adapter ID or endpoints which can be used to access the
- object.
- </summary>
- <param name="id">The identity.
-
- </param>
- <param name="ctx__">The Context map to send with the invocation.</param>
- <param name="cb__">Asynchronous callback invoked when the operation completes.</param>
- <param name="cookie__">Application data to store in the asynchronous result object.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.LocatorPrx.end_findObjectById(Ice.AsyncResult)">
- <summary>
- Find an object by identity and return a proxy that contains
- the adapter ID or endpoints which can be used to access the
- object.
- </summary>
- <param name="r__">The asynchronous result object for the invocation.</param>
- <returns>The proxy, or null if the object is not active.
-
- </returns>
- </member>
- <member name="M:Ice.LocatorPrx.findAdapterById(System.String)">
- <summary>
- Find an adapter by id and return a proxy that contains
- its endpoints.
- </summary>
- <param name="id">The adapter id.
-
- </param>
- <returns>The adapter proxy, or null if the adapter is not active.
-
- </returns>
- <exception name="AdapterNotFoundException">Raised if the adapter cannot be
- found.</exception>
- </member>
- <member name="M:Ice.LocatorPrx.findAdapterById(System.String,System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- Find an adapter by id and return a proxy that contains
- its endpoints.
- </summary>
- <param name="id">The adapter id.
-
- </param>
- <returns>The adapter proxy, or null if the adapter is not active.
-
- </returns>
- <exception name="AdapterNotFoundException">Raised if the adapter cannot be
- found.</exception>
- <param name="ctx__">The Context map to send with the invocation.</param>
- </member>
- <member name="M:Ice.LocatorPrx.begin_findAdapterById(System.String)">
- <summary>
- Find an adapter by id and return a proxy that contains
- its endpoints.
- </summary>
- <param name="id">The adapter id.
-
- </param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.LocatorPrx.begin_findAdapterById(System.String,System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- Find an adapter by id and return a proxy that contains
- its endpoints.
- </summary>
- <param name="id">The adapter id.
-
- </param>
- <param name="ctx__">The Context map to send with the invocation.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.LocatorPrx.begin_findAdapterById(System.String,Ice.AsyncCallback,System.Object)">
- <summary>
- Find an adapter by id and return a proxy that contains
- its endpoints.
- </summary>
- <param name="id">The adapter id.
-
- </param>
- <param name="cb__">Asynchronous callback invoked when the operation completes.</param>
- <param name="cookie__">Application data to store in the asynchronous result object.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.LocatorPrx.begin_findAdapterById(System.String,System.Collections.Generic.Dictionary{System.String,System.String},Ice.AsyncCallback,System.Object)">
- <summary>
- Find an adapter by id and return a proxy that contains
- its endpoints.
- </summary>
- <param name="id">The adapter id.
-
- </param>
- <param name="ctx__">The Context map to send with the invocation.</param>
- <param name="cb__">Asynchronous callback invoked when the operation completes.</param>
- <param name="cookie__">Application data to store in the asynchronous result object.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.LocatorPrx.end_findAdapterById(Ice.AsyncResult)">
- <summary>
- Find an adapter by id and return a proxy that contains
- its endpoints.
- </summary>
- <param name="r__">The asynchronous result object for the invocation.</param>
- <returns>The adapter proxy, or null if the adapter is not active.
-
- </returns>
- </member>
- <member name="M:Ice.LocatorPrx.getRegistry">
- <summary>
- Get the locator registry.
- </summary>
- <returns>The locator registry.</returns>
- </member>
- <member name="M:Ice.LocatorPrx.getRegistry(System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- Get the locator registry.
- </summary>
- <returns>The locator registry.</returns>
- <param name="ctx__">The Context map to send with the invocation.</param>
- </member>
- <member name="M:Ice.LocatorPrx.begin_getRegistry">
- <summary>
- Get the locator registry.
- </summary>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.LocatorPrx.begin_getRegistry(System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- Get the locator registry.
- </summary>
- <param name="ctx__">The Context map to send with the invocation.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.LocatorPrx.begin_getRegistry(Ice.AsyncCallback,System.Object)">
- <summary>
- Get the locator registry.
- </summary>
- <param name="cb__">Asynchronous callback invoked when the operation completes.</param>
- <param name="cookie__">Application data to store in the asynchronous result object.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.LocatorPrx.begin_getRegistry(System.Collections.Generic.Dictionary{System.String,System.String},Ice.AsyncCallback,System.Object)">
- <summary>
- Get the locator registry.
- </summary>
- <param name="ctx__">The Context map to send with the invocation.</param>
- <param name="cb__">Asynchronous callback invoked when the operation completes.</param>
- <param name="cookie__">Application data to store in the asynchronous result object.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.LocatorPrx.end_getRegistry(Ice.AsyncResult)">
- <summary>
- Get the locator registry.
- </summary>
- <param name="r__">The asynchronous result object for the invocation.</param>
- <returns>The locator registry.</returns>
- </member>
- <member name="T:Ice.LocatorRegistryPrx">
- <summary>
- The Ice locator registry interface.
- This interface is used by
- servers to register adapter endpoints with the locator.
-
- The LocatorRegistry interface is intended to be used
- by Ice internals and by locator implementations. Regular user
- code should not attempt to use any functionality of this interface
- directly.
- </summary>
- </member>
- <member name="M:Ice.LocatorRegistryPrx.setAdapterDirectProxy(System.String,Ice.ObjectPrx)">
- <summary>
- Set the adapter endpoints with the locator registry.
- </summary>
- <param name="id">The adapter id.
-
- </param>
- <param name="proxy">The adapter proxy (a dummy direct proxy created
- by the adapter). The direct proxy contains the adapter
- endpoints.
-
- </param>
- <exception name="AdapterNotFoundException">Raised if the adapter cannot
- be found, or if the locator only allows
- registered adapters to set their active proxy and the
- adapter is not registered with the locator.
-
- </exception>
- <exception name="AdapterAlreadyActiveException">Raised if an adapter with the same
- id is already active.</exception>
- </member>
- <member name="M:Ice.LocatorRegistryPrx.setAdapterDirectProxy(System.String,Ice.ObjectPrx,System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- Set the adapter endpoints with the locator registry.
- </summary>
- <param name="id">The adapter id.
-
- </param>
- <param name="proxy">The adapter proxy (a dummy direct proxy created
- by the adapter). The direct proxy contains the adapter
- endpoints.
-
- </param>
- <exception name="AdapterNotFoundException">Raised if the adapter cannot
- be found, or if the locator only allows
- registered adapters to set their active proxy and the
- adapter is not registered with the locator.
-
- </exception>
- <exception name="AdapterAlreadyActiveException">Raised if an adapter with the same
- id is already active.</exception>
- <param name="ctx__">The Context map to send with the invocation.</param>
- </member>
- <member name="M:Ice.LocatorRegistryPrx.begin_setAdapterDirectProxy(System.String,Ice.ObjectPrx)">
- <summary>
- Set the adapter endpoints with the locator registry.
- </summary>
- <param name="id">The adapter id.
-
- </param>
- <param name="proxy">The adapter proxy (a dummy direct proxy created
- by the adapter). The direct proxy contains the adapter
- endpoints.
-
- </param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.LocatorRegistryPrx.begin_setAdapterDirectProxy(System.String,Ice.ObjectPrx,System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- Set the adapter endpoints with the locator registry.
- </summary>
- <param name="id">The adapter id.
-
- </param>
- <param name="proxy">The adapter proxy (a dummy direct proxy created
- by the adapter). The direct proxy contains the adapter
- endpoints.
-
- </param>
- <param name="ctx__">The Context map to send with the invocation.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.LocatorRegistryPrx.begin_setAdapterDirectProxy(System.String,Ice.ObjectPrx,Ice.AsyncCallback,System.Object)">
- <summary>
- Set the adapter endpoints with the locator registry.
- </summary>
- <param name="id">The adapter id.
-
- </param>
- <param name="proxy">The adapter proxy (a dummy direct proxy created
- by the adapter). The direct proxy contains the adapter
- endpoints.
-
- </param>
- <param name="cb__">Asynchronous callback invoked when the operation completes.</param>
- <param name="cookie__">Application data to store in the asynchronous result object.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.LocatorRegistryPrx.begin_setAdapterDirectProxy(System.String,Ice.ObjectPrx,System.Collections.Generic.Dictionary{System.String,System.String},Ice.AsyncCallback,System.Object)">
- <summary>
- Set the adapter endpoints with the locator registry.
- </summary>
- <param name="id">The adapter id.
-
- </param>
- <param name="proxy">The adapter proxy (a dummy direct proxy created
- by the adapter). The direct proxy contains the adapter
- endpoints.
-
- </param>
- <param name="ctx__">The Context map to send with the invocation.</param>
- <param name="cb__">Asynchronous callback invoked when the operation completes.</param>
- <param name="cookie__">Application data to store in the asynchronous result object.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.LocatorRegistryPrx.end_setAdapterDirectProxy(Ice.AsyncResult)">
- <summary>
- Set the adapter endpoints with the locator registry.
- </summary>
- <param name="r__">The asynchronous result object for the invocation.</param>
- </member>
- <member name="M:Ice.LocatorRegistryPrx.setReplicatedAdapterDirectProxy(System.String,System.String,Ice.ObjectPrx)">
- <summary>
- Set the adapter endpoints with the locator registry.
- </summary>
- <param name="adapterId">The adapter id.
-
- </param>
- <param name="replicaGroupId">The replica group id.
-
- </param>
- <param name="p">The adapter proxy (a dummy direct proxy created
- by the adapter). The direct proxy contains the adapter
- endpoints.
-
- </param>
- <exception name="AdapterNotFoundException">Raised if the adapter cannot
- be found, or if the locator only allows registered adapters to
- set their active proxy and the adapter is not registered with
- the locator.
-
- </exception>
- <exception name="AdapterAlreadyActiveException">Raised if an adapter with the same
- id is already active.
-
- </exception>
- <exception name="InvalidReplicaGroupIdException">Raised if the given
- replica group doesn't match the one registered with the
- locator registry for this object adapter.</exception>
- </member>
- <member name="M:Ice.LocatorRegistryPrx.setReplicatedAdapterDirectProxy(System.String,System.String,Ice.ObjectPrx,System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- Set the adapter endpoints with the locator registry.
- </summary>
- <param name="adapterId">The adapter id.
-
- </param>
- <param name="replicaGroupId">The replica group id.
-
- </param>
- <param name="p">The adapter proxy (a dummy direct proxy created
- by the adapter). The direct proxy contains the adapter
- endpoints.
-
- </param>
- <exception name="AdapterNotFoundException">Raised if the adapter cannot
- be found, or if the locator only allows registered adapters to
- set their active proxy and the adapter is not registered with
- the locator.
-
- </exception>
- <exception name="AdapterAlreadyActiveException">Raised if an adapter with the same
- id is already active.
-
- </exception>
- <exception name="InvalidReplicaGroupIdException">Raised if the given
- replica group doesn't match the one registered with the
- locator registry for this object adapter.</exception>
- <param name="ctx__">The Context map to send with the invocation.</param>
- </member>
- <member name="M:Ice.LocatorRegistryPrx.begin_setReplicatedAdapterDirectProxy(System.String,System.String,Ice.ObjectPrx)">
- <summary>
- Set the adapter endpoints with the locator registry.
- </summary>
- <param name="adapterId">The adapter id.
-
- </param>
- <param name="replicaGroupId">The replica group id.
-
- </param>
- <param name="p">The adapter proxy (a dummy direct proxy created
- by the adapter). The direct proxy contains the adapter
- endpoints.
-
- </param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.LocatorRegistryPrx.begin_setReplicatedAdapterDirectProxy(System.String,System.String,Ice.ObjectPrx,System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- Set the adapter endpoints with the locator registry.
- </summary>
- <param name="adapterId">The adapter id.
-
- </param>
- <param name="replicaGroupId">The replica group id.
-
- </param>
- <param name="p">The adapter proxy (a dummy direct proxy created
- by the adapter). The direct proxy contains the adapter
- endpoints.
-
- </param>
- <param name="ctx__">The Context map to send with the invocation.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.LocatorRegistryPrx.begin_setReplicatedAdapterDirectProxy(System.String,System.String,Ice.ObjectPrx,Ice.AsyncCallback,System.Object)">
- <summary>
- Set the adapter endpoints with the locator registry.
- </summary>
- <param name="adapterId">The adapter id.
-
- </param>
- <param name="replicaGroupId">The replica group id.
-
- </param>
- <param name="p">The adapter proxy (a dummy direct proxy created
- by the adapter). The direct proxy contains the adapter
- endpoints.
-
- </param>
- <param name="cb__">Asynchronous callback invoked when the operation completes.</param>
- <param name="cookie__">Application data to store in the asynchronous result object.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.LocatorRegistryPrx.begin_setReplicatedAdapterDirectProxy(System.String,System.String,Ice.ObjectPrx,System.Collections.Generic.Dictionary{System.String,System.String},Ice.AsyncCallback,System.Object)">
- <summary>
- Set the adapter endpoints with the locator registry.
- </summary>
- <param name="adapterId">The adapter id.
-
- </param>
- <param name="replicaGroupId">The replica group id.
-
- </param>
- <param name="p">The adapter proxy (a dummy direct proxy created
- by the adapter). The direct proxy contains the adapter
- endpoints.
-
- </param>
- <param name="ctx__">The Context map to send with the invocation.</param>
- <param name="cb__">Asynchronous callback invoked when the operation completes.</param>
- <param name="cookie__">Application data to store in the asynchronous result object.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.LocatorRegistryPrx.end_setReplicatedAdapterDirectProxy(Ice.AsyncResult)">
- <summary>
- Set the adapter endpoints with the locator registry.
- </summary>
- <param name="r__">The asynchronous result object for the invocation.</param>
- </member>
- <member name="M:Ice.LocatorRegistryPrx.setServerProcessProxy(System.String,Ice.ProcessPrx)">
- <summary>
- Set the process proxy for a server.
- </summary>
- <param name="id">The server id.
-
- </param>
- <param name="proxy">The process proxy.
-
- </param>
- <exception name="ServerNotFoundException">Raised if the server cannot
- be found.</exception>
- </member>
- <member name="M:Ice.LocatorRegistryPrx.setServerProcessProxy(System.String,Ice.ProcessPrx,System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- Set the process proxy for a server.
- </summary>
- <param name="id">The server id.
-
- </param>
- <param name="proxy">The process proxy.
-
- </param>
- <exception name="ServerNotFoundException">Raised if the server cannot
- be found.</exception>
- <param name="ctx__">The Context map to send with the invocation.</param>
- </member>
- <member name="M:Ice.LocatorRegistryPrx.begin_setServerProcessProxy(System.String,Ice.ProcessPrx)">
- <summary>
- Set the process proxy for a server.
- </summary>
- <param name="id">The server id.
-
- </param>
- <param name="proxy">The process proxy.
-
- </param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.LocatorRegistryPrx.begin_setServerProcessProxy(System.String,Ice.ProcessPrx,System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- Set the process proxy for a server.
- </summary>
- <param name="id">The server id.
-
- </param>
- <param name="proxy">The process proxy.
-
- </param>
- <param name="ctx__">The Context map to send with the invocation.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.LocatorRegistryPrx.begin_setServerProcessProxy(System.String,Ice.ProcessPrx,Ice.AsyncCallback,System.Object)">
- <summary>
- Set the process proxy for a server.
- </summary>
- <param name="id">The server id.
-
- </param>
- <param name="proxy">The process proxy.
-
- </param>
- <param name="cb__">Asynchronous callback invoked when the operation completes.</param>
- <param name="cookie__">Application data to store in the asynchronous result object.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.LocatorRegistryPrx.begin_setServerProcessProxy(System.String,Ice.ProcessPrx,System.Collections.Generic.Dictionary{System.String,System.String},Ice.AsyncCallback,System.Object)">
- <summary>
- Set the process proxy for a server.
- </summary>
- <param name="id">The server id.
-
- </param>
- <param name="proxy">The process proxy.
-
- </param>
- <param name="ctx__">The Context map to send with the invocation.</param>
- <param name="cb__">Asynchronous callback invoked when the operation completes.</param>
- <param name="cookie__">Application data to store in the asynchronous result object.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.LocatorRegistryPrx.end_setServerProcessProxy(Ice.AsyncResult)">
- <summary>
- Set the process proxy for a server.
- </summary>
- <param name="r__">The asynchronous result object for the invocation.</param>
- </member>
- <member name="T:Ice.LocatorFinderPrx">
- <summary>
- This inferface should be implemented by services implementing the
- Ice::Locator interface.
- It should be advertised through an Ice
- object with the identity `Ice/LocatorFinder'. This allows clients
- to retrieve the locator proxy with just the endpoint information of
- the service.
- </summary>
- </member>
- <member name="M:Ice.LocatorFinderPrx.getLocator">
- <summary>
- Get the locator proxy implemented by the process hosting this
- finder object.
- The proxy might point to several replicas.
-
- </summary>
- <returns>The locator proxy.</returns>
- </member>
- <member name="M:Ice.LocatorFinderPrx.getLocator(System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- Get the locator proxy implemented by the process hosting this
- finder object.
- The proxy might point to several replicas.
-
- </summary>
- <returns>The locator proxy.</returns>
- <param name="ctx__">The Context map to send with the invocation.</param>
- </member>
- <member name="M:Ice.LocatorFinderPrx.begin_getLocator">
- <summary>
- Get the locator proxy implemented by the process hosting this
- finder object.
- The proxy might point to several replicas.
- </summary>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.LocatorFinderPrx.begin_getLocator(System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- Get the locator proxy implemented by the process hosting this
- finder object.
- The proxy might point to several replicas.
- </summary>
- <param name="ctx__">The Context map to send with the invocation.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.LocatorFinderPrx.begin_getLocator(Ice.AsyncCallback,System.Object)">
- <summary>
- Get the locator proxy implemented by the process hosting this
- finder object.
- The proxy might point to several replicas.
- </summary>
- <param name="cb__">Asynchronous callback invoked when the operation completes.</param>
- <param name="cookie__">Application data to store in the asynchronous result object.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.LocatorFinderPrx.begin_getLocator(System.Collections.Generic.Dictionary{System.String,System.String},Ice.AsyncCallback,System.Object)">
- <summary>
- Get the locator proxy implemented by the process hosting this
- finder object.
- The proxy might point to several replicas.
- </summary>
- <param name="ctx__">The Context map to send with the invocation.</param>
- <param name="cb__">Asynchronous callback invoked when the operation completes.</param>
- <param name="cookie__">Application data to store in the asynchronous result object.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.LocatorFinderPrx.end_getLocator(Ice.AsyncResult)">
- <summary>
- Get the locator proxy implemented by the process hosting this
- finder object.
- The proxy might point to several replicas.
- </summary>
- <param name="r__">The asynchronous result object for the invocation.</param>
- <returns>The locator proxy.</returns>
- </member>
- <member name="T:Ice.AMD_Locator_findObjectById">
- <summary>
- Find an object by identity and return a proxy that contains
- the adapter ID or endpoints which can be used to access the
- object.
- </summary>
- </member>
- <member name="M:Ice.AMD_Locator_findObjectById.ice_response(Ice.ObjectPrx)">
- <summary>
- ice_response indicates that
- the operation completed successfully.
- </summary>
- <param name="ret__">(return value) The proxy, or null if the object is not active.
-
- </param>
- </member>
- <member name="T:Ice.AMD_Locator_findAdapterById">
- <summary>
- Find an adapter by id and return a proxy that contains
- its endpoints.
- </summary>
- </member>
- <member name="M:Ice.AMD_Locator_findAdapterById.ice_response(Ice.ObjectPrx)">
- <summary>
- ice_response indicates that
- the operation completed successfully.
- </summary>
- <param name="ret__">(return value) The adapter proxy, or null if the adapter is not active.
-
- </param>
- </member>
- <member name="T:Ice.AMD_LocatorRegistry_setAdapterDirectProxy">
- <summary>
- Set the adapter endpoints with the locator registry.
- </summary>
- </member>
- <member name="M:Ice.AMD_LocatorRegistry_setAdapterDirectProxy.ice_response">
- <summary>
- ice_response indicates that
- the operation completed successfully.
- </summary>
- </member>
- <member name="T:Ice.AMD_LocatorRegistry_setReplicatedAdapterDirectProxy">
- <summary>
- Set the adapter endpoints with the locator registry.
- </summary>
- </member>
- <member name="M:Ice.AMD_LocatorRegistry_setReplicatedAdapterDirectProxy.ice_response">
- <summary>
- ice_response indicates that
- the operation completed successfully.
- </summary>
- </member>
- <member name="T:Ice.AMD_LocatorRegistry_setServerProcessProxy">
- <summary>
- Set the process proxy for a server.
- </summary>
- </member>
- <member name="M:Ice.AMD_LocatorRegistry_setServerProcessProxy.ice_response">
- <summary>
- ice_response indicates that
- the operation completed successfully.
- </summary>
- </member>
- <member name="T:IceMX.UnknownMetricsView">
- <summary>
- Raised if a metrics view cannot be found.
- </summary>
- </member>
- <member name="T:IceMX.MetricsPrx">
- <summary>
- The base class for metrics.
- A metrics object represents a
- collection of measurements associated to a given a system.
- </summary>
- </member>
- <member name="T:IceMX.MetricsAdminPrx">
- <summary>
- The metrics administrative facet interface.
- This interface allows
- remote administrative clients to access metrics of an application
- that enabled the Ice administrative facility and configured some
- metrics views.
- </summary>
- </member>
- <member name="M:IceMX.MetricsAdminPrx.getMetricsViewNames(System.String[]@)">
- <summary>
- Get the names of enabled and disabled metrics.
- </summary>
- <param name="disabledViews">The names of the disabled views.
-
- </param>
- <returns>The name of the enabled views.</returns>
- </member>
- <member name="M:IceMX.MetricsAdminPrx.getMetricsViewNames(System.String[]@,System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- Get the names of enabled and disabled metrics.
- </summary>
- <param name="disabledViews">The names of the disabled views.
-
- </param>
- <returns>The name of the enabled views.</returns>
- <param name="ctx__">The Context map to send with the invocation.</param>
- </member>
- <member name="M:IceMX.MetricsAdminPrx.begin_getMetricsViewNames">
- <summary>
- Get the names of enabled and disabled metrics.
- </summary>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:IceMX.MetricsAdminPrx.begin_getMetricsViewNames(System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- Get the names of enabled and disabled metrics.
- </summary>
- <param name="ctx__">The Context map to send with the invocation.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:IceMX.MetricsAdminPrx.begin_getMetricsViewNames(Ice.AsyncCallback,System.Object)">
- <summary>
- Get the names of enabled and disabled metrics.
- </summary>
- <param name="cb__">Asynchronous callback invoked when the operation completes.</param>
- <param name="cookie__">Application data to store in the asynchronous result object.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:IceMX.MetricsAdminPrx.begin_getMetricsViewNames(System.Collections.Generic.Dictionary{System.String,System.String},Ice.AsyncCallback,System.Object)">
- <summary>
- Get the names of enabled and disabled metrics.
- </summary>
- <param name="ctx__">The Context map to send with the invocation.</param>
- <param name="cb__">Asynchronous callback invoked when the operation completes.</param>
- <param name="cookie__">Application data to store in the asynchronous result object.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:IceMX.MetricsAdminPrx.end_getMetricsViewNames(System.String[]@,Ice.AsyncResult)">
- <summary>
- Get the names of enabled and disabled metrics.
- </summary>
- <param name="disabledViews">The names of the disabled views.
-
- </param>
- <param name="r__">The asynchronous result object for the invocation.</param>
- <returns>The name of the enabled views.</returns>
- </member>
- <member name="M:IceMX.MetricsAdminPrx.enableMetricsView(System.String)">
- <summary>
- Enables a metrics view.
- </summary>
- <param name="name">The metrics view name.
-
- </param>
- <exception name="UnknownMetricsView">Raised if the metrics view cannot be
- found.</exception>
- </member>
- <member name="M:IceMX.MetricsAdminPrx.enableMetricsView(System.String,System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- Enables a metrics view.
- </summary>
- <param name="name">The metrics view name.
-
- </param>
- <exception name="UnknownMetricsView">Raised if the metrics view cannot be
- found.</exception>
- <param name="ctx__">The Context map to send with the invocation.</param>
- </member>
- <member name="M:IceMX.MetricsAdminPrx.begin_enableMetricsView(System.String)">
- <summary>
- Enables a metrics view.
- </summary>
- <param name="name">The metrics view name.
-
- </param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:IceMX.MetricsAdminPrx.begin_enableMetricsView(System.String,System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- Enables a metrics view.
- </summary>
- <param name="name">The metrics view name.
-
- </param>
- <param name="ctx__">The Context map to send with the invocation.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:IceMX.MetricsAdminPrx.begin_enableMetricsView(System.String,Ice.AsyncCallback,System.Object)">
- <summary>
- Enables a metrics view.
- </summary>
- <param name="name">The metrics view name.
-
- </param>
- <param name="cb__">Asynchronous callback invoked when the operation completes.</param>
- <param name="cookie__">Application data to store in the asynchronous result object.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:IceMX.MetricsAdminPrx.begin_enableMetricsView(System.String,System.Collections.Generic.Dictionary{System.String,System.String},Ice.AsyncCallback,System.Object)">
- <summary>
- Enables a metrics view.
- </summary>
- <param name="name">The metrics view name.
-
- </param>
- <param name="ctx__">The Context map to send with the invocation.</param>
- <param name="cb__">Asynchronous callback invoked when the operation completes.</param>
- <param name="cookie__">Application data to store in the asynchronous result object.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:IceMX.MetricsAdminPrx.end_enableMetricsView(Ice.AsyncResult)">
- <summary>
- Enables a metrics view.
- </summary>
- <param name="r__">The asynchronous result object for the invocation.</param>
- </member>
- <member name="M:IceMX.MetricsAdminPrx.disableMetricsView(System.String)">
- <summary>
- Disable a metrics view.
- </summary>
- <param name="name">The metrics view name.
-
- </param>
- <exception name="UnknownMetricsView">Raised if the metrics view cannot be
- found.</exception>
- </member>
- <member name="M:IceMX.MetricsAdminPrx.disableMetricsView(System.String,System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- Disable a metrics view.
- </summary>
- <param name="name">The metrics view name.
-
- </param>
- <exception name="UnknownMetricsView">Raised if the metrics view cannot be
- found.</exception>
- <param name="ctx__">The Context map to send with the invocation.</param>
- </member>
- <member name="M:IceMX.MetricsAdminPrx.begin_disableMetricsView(System.String)">
- <summary>
- Disable a metrics view.
- </summary>
- <param name="name">The metrics view name.
-
- </param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:IceMX.MetricsAdminPrx.begin_disableMetricsView(System.String,System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- Disable a metrics view.
- </summary>
- <param name="name">The metrics view name.
-
- </param>
- <param name="ctx__">The Context map to send with the invocation.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:IceMX.MetricsAdminPrx.begin_disableMetricsView(System.String,Ice.AsyncCallback,System.Object)">
- <summary>
- Disable a metrics view.
- </summary>
- <param name="name">The metrics view name.
-
- </param>
- <param name="cb__">Asynchronous callback invoked when the operation completes.</param>
- <param name="cookie__">Application data to store in the asynchronous result object.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:IceMX.MetricsAdminPrx.begin_disableMetricsView(System.String,System.Collections.Generic.Dictionary{System.String,System.String},Ice.AsyncCallback,System.Object)">
- <summary>
- Disable a metrics view.
- </summary>
- <param name="name">The metrics view name.
-
- </param>
- <param name="ctx__">The Context map to send with the invocation.</param>
- <param name="cb__">Asynchronous callback invoked when the operation completes.</param>
- <param name="cookie__">Application data to store in the asynchronous result object.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:IceMX.MetricsAdminPrx.end_disableMetricsView(Ice.AsyncResult)">
- <summary>
- Disable a metrics view.
- </summary>
- <param name="r__">The asynchronous result object for the invocation.</param>
- </member>
- <member name="M:IceMX.MetricsAdminPrx.getMetricsView(System.String,System.Int64@)">
- <summary>
- Get the metrics objects for the given metrics view.
- This
- returns a dictionnary of metric maps for each metrics class
- configured with the view. The timestamp allows the client to
- compute averages which are not dependent of the invocation
- latency for this operation.
-
- </summary>
- <param name="view">The name of the metrics view.
-
- </param>
- <param name="timestamp">The local time of the process when the metrics
- object were retrieved.
-
- </param>
- <returns>The metrics view data.
-
- </returns>
- <exception name="UnknownMetricsView">Raised if the metrics view cannot be
- found.</exception>
- </member>
- <member name="M:IceMX.MetricsAdminPrx.getMetricsView(System.String,System.Int64@,System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- Get the metrics objects for the given metrics view.
- This
- returns a dictionnary of metric maps for each metrics class
- configured with the view. The timestamp allows the client to
- compute averages which are not dependent of the invocation
- latency for this operation.
-
- </summary>
- <param name="view">The name of the metrics view.
-
- </param>
- <param name="timestamp">The local time of the process when the metrics
- object were retrieved.
-
- </param>
- <returns>The metrics view data.
-
- </returns>
- <exception name="UnknownMetricsView">Raised if the metrics view cannot be
- found.</exception>
- <param name="ctx__">The Context map to send with the invocation.</param>
- </member>
- <member name="M:IceMX.MetricsAdminPrx.begin_getMetricsView(System.String)">
- <summary>
- Get the metrics objects for the given metrics view.
- This
- </summary>
- <param name="view">The name of the metrics view.
-
- </param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:IceMX.MetricsAdminPrx.begin_getMetricsView(System.String,System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- Get the metrics objects for the given metrics view.
- This
- </summary>
- <param name="view">The name of the metrics view.
-
- </param>
- <param name="ctx__">The Context map to send with the invocation.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:IceMX.MetricsAdminPrx.begin_getMetricsView(System.String,Ice.AsyncCallback,System.Object)">
- <summary>
- Get the metrics objects for the given metrics view.
- This
- </summary>
- <param name="view">The name of the metrics view.
-
- </param>
- <param name="cb__">Asynchronous callback invoked when the operation completes.</param>
- <param name="cookie__">Application data to store in the asynchronous result object.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:IceMX.MetricsAdminPrx.begin_getMetricsView(System.String,System.Collections.Generic.Dictionary{System.String,System.String},Ice.AsyncCallback,System.Object)">
- <summary>
- Get the metrics objects for the given metrics view.
- This
- </summary>
- <param name="view">The name of the metrics view.
-
- </param>
- <param name="ctx__">The Context map to send with the invocation.</param>
- <param name="cb__">Asynchronous callback invoked when the operation completes.</param>
- <param name="cookie__">Application data to store in the asynchronous result object.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:IceMX.MetricsAdminPrx.end_getMetricsView(System.Int64@,Ice.AsyncResult)">
- <summary>
- Get the metrics objects for the given metrics view.
- This
- </summary>
- <param name="timestamp">The local time of the process when the metrics
- object were retrieved.
-
- </param>
- <param name="r__">The asynchronous result object for the invocation.</param>
- <returns>The metrics view data.
-
- </returns>
- </member>
- <member name="M:IceMX.MetricsAdminPrx.getMapMetricsFailures(System.String,System.String)">
- <summary>
- Get the metrics failures associated with the given view and map.
- </summary>
- <param name="view">The name of the metrics view.
-
- </param>
- <param name="map">The name of the metrics map.
-
- </param>
- <returns>The metrics failures associated with the map.
-
- </returns>
- <exception name="UnknownMetricsView">Raised if the metrics view cannot be
- found.</exception>
- </member>
- <member name="M:IceMX.MetricsAdminPrx.getMapMetricsFailures(System.String,System.String,System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- Get the metrics failures associated with the given view and map.
- </summary>
- <param name="view">The name of the metrics view.
-
- </param>
- <param name="map">The name of the metrics map.
-
- </param>
- <returns>The metrics failures associated with the map.
-
- </returns>
- <exception name="UnknownMetricsView">Raised if the metrics view cannot be
- found.</exception>
- <param name="ctx__">The Context map to send with the invocation.</param>
- </member>
- <member name="M:IceMX.MetricsAdminPrx.begin_getMapMetricsFailures(System.String,System.String)">
- <summary>
- Get the metrics failures associated with the given view and map.
- </summary>
- <param name="view">The name of the metrics view.
-
- </param>
- <param name="map">The name of the metrics map.
-
- </param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:IceMX.MetricsAdminPrx.begin_getMapMetricsFailures(System.String,System.String,System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- Get the metrics failures associated with the given view and map.
- </summary>
- <param name="view">The name of the metrics view.
-
- </param>
- <param name="map">The name of the metrics map.
-
- </param>
- <param name="ctx__">The Context map to send with the invocation.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:IceMX.MetricsAdminPrx.begin_getMapMetricsFailures(System.String,System.String,Ice.AsyncCallback,System.Object)">
- <summary>
- Get the metrics failures associated with the given view and map.
- </summary>
- <param name="view">The name of the metrics view.
-
- </param>
- <param name="map">The name of the metrics map.
-
- </param>
- <param name="cb__">Asynchronous callback invoked when the operation completes.</param>
- <param name="cookie__">Application data to store in the asynchronous result object.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:IceMX.MetricsAdminPrx.begin_getMapMetricsFailures(System.String,System.String,System.Collections.Generic.Dictionary{System.String,System.String},Ice.AsyncCallback,System.Object)">
- <summary>
- Get the metrics failures associated with the given view and map.
- </summary>
- <param name="view">The name of the metrics view.
-
- </param>
- <param name="map">The name of the metrics map.
-
- </param>
- <param name="ctx__">The Context map to send with the invocation.</param>
- <param name="cb__">Asynchronous callback invoked when the operation completes.</param>
- <param name="cookie__">Application data to store in the asynchronous result object.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:IceMX.MetricsAdminPrx.end_getMapMetricsFailures(Ice.AsyncResult)">
- <summary>
- Get the metrics failures associated with the given view and map.
- </summary>
- <param name="r__">The asynchronous result object for the invocation.</param>
- <returns>The metrics failures associated with the map.
-
- </returns>
- </member>
- <member name="M:IceMX.MetricsAdminPrx.getMetricsFailures(System.String,System.String,System.String)">
- <summary>
- Get the metrics failure associated for the given metrics.
- </summary>
- <param name="view">The name of the metrics view.
-
- </param>
- <param name="map">The name of the metrics map.
-
- </param>
- <param name="id">The ID of the metrics.
-
- </param>
- <returns>The metrics failures associated with the metrics.
-
- </returns>
- <exception name="UnknownMetricsView">Raised if the metrics view cannot be
- found.</exception>
- </member>
- <member name="M:IceMX.MetricsAdminPrx.getMetricsFailures(System.String,System.String,System.String,System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- Get the metrics failure associated for the given metrics.
- </summary>
- <param name="view">The name of the metrics view.
-
- </param>
- <param name="map">The name of the metrics map.
-
- </param>
- <param name="id">The ID of the metrics.
-
- </param>
- <returns>The metrics failures associated with the metrics.
-
- </returns>
- <exception name="UnknownMetricsView">Raised if the metrics view cannot be
- found.</exception>
- <param name="ctx__">The Context map to send with the invocation.</param>
- </member>
- <member name="M:IceMX.MetricsAdminPrx.begin_getMetricsFailures(System.String,System.String,System.String)">
- <summary>
- Get the metrics failure associated for the given metrics.
- </summary>
- <param name="view">The name of the metrics view.
-
- </param>
- <param name="map">The name of the metrics map.
-
- </param>
- <param name="id">The ID of the metrics.
-
- </param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:IceMX.MetricsAdminPrx.begin_getMetricsFailures(System.String,System.String,System.String,System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- Get the metrics failure associated for the given metrics.
- </summary>
- <param name="view">The name of the metrics view.
-
- </param>
- <param name="map">The name of the metrics map.
-
- </param>
- <param name="id">The ID of the metrics.
-
- </param>
- <param name="ctx__">The Context map to send with the invocation.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:IceMX.MetricsAdminPrx.begin_getMetricsFailures(System.String,System.String,System.String,Ice.AsyncCallback,System.Object)">
- <summary>
- Get the metrics failure associated for the given metrics.
- </summary>
- <param name="view">The name of the metrics view.
-
- </param>
- <param name="map">The name of the metrics map.
-
- </param>
- <param name="id">The ID of the metrics.
-
- </param>
- <param name="cb__">Asynchronous callback invoked when the operation completes.</param>
- <param name="cookie__">Application data to store in the asynchronous result object.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:IceMX.MetricsAdminPrx.begin_getMetricsFailures(System.String,System.String,System.String,System.Collections.Generic.Dictionary{System.String,System.String},Ice.AsyncCallback,System.Object)">
- <summary>
- Get the metrics failure associated for the given metrics.
- </summary>
- <param name="view">The name of the metrics view.
-
- </param>
- <param name="map">The name of the metrics map.
-
- </param>
- <param name="id">The ID of the metrics.
-
- </param>
- <param name="ctx__">The Context map to send with the invocation.</param>
- <param name="cb__">Asynchronous callback invoked when the operation completes.</param>
- <param name="cookie__">Application data to store in the asynchronous result object.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:IceMX.MetricsAdminPrx.end_getMetricsFailures(Ice.AsyncResult)">
- <summary>
- Get the metrics failure associated for the given metrics.
- </summary>
- <param name="r__">The asynchronous result object for the invocation.</param>
- <returns>The metrics failures associated with the metrics.
-
- </returns>
- </member>
- <member name="T:IceMX.ThreadMetricsPrx">
- <summary>
- Provides information on the number of threads currently in use and
- their activity.
- </summary>
- </member>
- <member name="T:IceMX.DispatchMetricsPrx">
- <summary>
- Provides information on servant dispatch.
- </summary>
- </member>
- <member name="T:IceMX.ChildInvocationMetricsPrx">
- <summary>
- Provides information on child invocations.
- A child invocation is
- either remote (sent over an Ice connection) or collocated. An
- invocation can have multiple child invocation if it is
- retried. Child invocation metrics are embedded within InvocationMetrics.
- </summary>
- </member>
- <member name="T:IceMX.CollocatedMetricsPrx">
- <summary>
- Provides information on invocations that are collocated.
- Collocated
- metrics are embedded within InvocationMetrics.
- </summary>
- </member>
- <member name="T:IceMX.RemoteMetricsPrx">
- <summary>
- Provides information on invocations that are specifically sent over
- Ice connections.
- Remote metrics are embedded within InvocationMetrics.
- </summary>
- </member>
- <member name="T:IceMX.InvocationMetricsPrx">
- <summary>
- Provide measurements for proxy invocations.
- Proxy invocations can
- either be sent over the wire or be collocated.
- </summary>
- </member>
- <member name="T:IceMX.ConnectionMetricsPrx">
- <summary>
- Provides information on the data sent and received over Ice
- connections.
- </summary>
- </member>
- <member name="M:Ice.ObjectFactory.create(System.String)">
- <summary>
- Create a new object for a given object type.
- The type is the
- absolute Slice type id, i.e., the id relative to the
- unnamed top-level Slice module. For example, the absolute
- Slice type id for interfaces of type Bar in the module
- Foo is ::Foo::Bar.
-
- The leading "::" is required.
-
- </summary>
- <param name="type">The object type.
-
- </param>
- <returns>The object created for the given type, or nil if the
- factory is unable to create the object.</returns>
- </member>
- <member name="M:Ice.ObjectFactory.destroy">
- <summary>
- Called when the factory is removed from the communicator, or if
- the communicator is destroyed.
- </summary>
- </member>
- <member name="T:Ice.ProcessPrx">
- <summary>
- An administrative interface for process management.
- Managed servers must
- implement this interface.
-
- A servant implementing this interface is a potential target
- for denial-of-service attacks, therefore proper security precautions
- should be taken. For example, the servant can use a UUID to make its
- identity harder to guess, and be registered in an object adapter with
- a secured endpoint.
- </summary>
- </member>
- <member name="M:Ice.ProcessPrx.shutdown">
- <summary>
- Initiate a graceful shut-down.
- </summary>
- </member>
- <member name="M:Ice.ProcessPrx.shutdown(System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- Initiate a graceful shut-down.
- </summary>
- <param name="ctx__">The Context map to send with the invocation.</param>
- </member>
- <member name="M:Ice.ProcessPrx.begin_shutdown">
- <summary>
- Initiate a graceful shut-down.
- </summary>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.ProcessPrx.begin_shutdown(System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- Initiate a graceful shut-down.
- </summary>
- <param name="ctx__">The Context map to send with the invocation.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.ProcessPrx.begin_shutdown(Ice.AsyncCallback,System.Object)">
- <summary>
- Initiate a graceful shut-down.
- </summary>
- <param name="cb__">Asynchronous callback invoked when the operation completes.</param>
- <param name="cookie__">Application data to store in the asynchronous result object.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.ProcessPrx.begin_shutdown(System.Collections.Generic.Dictionary{System.String,System.String},Ice.AsyncCallback,System.Object)">
- <summary>
- Initiate a graceful shut-down.
- </summary>
- <param name="ctx__">The Context map to send with the invocation.</param>
- <param name="cb__">Asynchronous callback invoked when the operation completes.</param>
- <param name="cookie__">Application data to store in the asynchronous result object.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.ProcessPrx.end_shutdown(Ice.AsyncResult)">
- <summary>
- Initiate a graceful shut-down.
- </summary>
- <param name="r__">The asynchronous result object for the invocation.</param>
- </member>
- <member name="M:Ice.ProcessPrx.writeMessage(System.String,System.Int32)">
- <summary>
- Write a message on the process' stdout or stderr.
- </summary>
- <param name="message">The message.
-
- </param>
- <param name="fd">1 for stdout, 2 for stderr.</param>
- </member>
- <member name="M:Ice.ProcessPrx.writeMessage(System.String,System.Int32,System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- Write a message on the process' stdout or stderr.
- </summary>
- <param name="message">The message.
-
- </param>
- <param name="fd">1 for stdout, 2 for stderr.</param>
- <param name="ctx__">The Context map to send with the invocation.</param>
- </member>
- <member name="M:Ice.ProcessPrx.begin_writeMessage(System.String,System.Int32)">
- <summary>
- Write a message on the process' stdout or stderr.
- </summary>
- <param name="message">The message.
-
- </param>
- <param name="fd">1 for stdout, 2 for stderr.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.ProcessPrx.begin_writeMessage(System.String,System.Int32,System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- Write a message on the process' stdout or stderr.
- </summary>
- <param name="message">The message.
-
- </param>
- <param name="fd">1 for stdout, 2 for stderr.</param>
- <param name="ctx__">The Context map to send with the invocation.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.ProcessPrx.begin_writeMessage(System.String,System.Int32,Ice.AsyncCallback,System.Object)">
- <summary>
- Write a message on the process' stdout or stderr.
- </summary>
- <param name="message">The message.
-
- </param>
- <param name="fd">1 for stdout, 2 for stderr.</param>
- <param name="cb__">Asynchronous callback invoked when the operation completes.</param>
- <param name="cookie__">Application data to store in the asynchronous result object.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.ProcessPrx.begin_writeMessage(System.String,System.Int32,System.Collections.Generic.Dictionary{System.String,System.String},Ice.AsyncCallback,System.Object)">
- <summary>
- Write a message on the process' stdout or stderr.
- </summary>
- <param name="message">The message.
-
- </param>
- <param name="fd">1 for stdout, 2 for stderr.</param>
- <param name="ctx__">The Context map to send with the invocation.</param>
- <param name="cb__">Asynchronous callback invoked when the operation completes.</param>
- <param name="cookie__">Application data to store in the asynchronous result object.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.ProcessPrx.end_writeMessage(Ice.AsyncResult)">
- <summary>
- Write a message on the process' stdout or stderr.
- </summary>
- <param name="r__">The asynchronous result object for the invocation.</param>
- </member>
- <member name="T:Ice.PropertiesAdminPrx">
- <summary>
- The PropertiesAdmin interface provides remote access to the properties
- of a communicator.
- </summary>
- </member>
- <member name="M:Ice.PropertiesAdminPrx.getProperty(System.String)">
- <summary>
- Get a property by key.
- If the property is not set, an empty
- string is returned.
-
- </summary>
- <param name="key">The property key.
-
- </param>
- <returns>The property value.</returns>
- </member>
- <member name="M:Ice.PropertiesAdminPrx.getProperty(System.String,System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- Get a property by key.
- If the property is not set, an empty
- string is returned.
-
- </summary>
- <param name="key">The property key.
-
- </param>
- <returns>The property value.</returns>
- <param name="ctx__">The Context map to send with the invocation.</param>
- </member>
- <member name="M:Ice.PropertiesAdminPrx.begin_getProperty(System.String)">
- <summary>
- Get a property by key.
- If the property is not set, an empty
- </summary>
- <param name="key">The property key.
-
- </param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.PropertiesAdminPrx.begin_getProperty(System.String,System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- Get a property by key.
- If the property is not set, an empty
- </summary>
- <param name="key">The property key.
-
- </param>
- <param name="ctx__">The Context map to send with the invocation.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.PropertiesAdminPrx.begin_getProperty(System.String,Ice.AsyncCallback,System.Object)">
- <summary>
- Get a property by key.
- If the property is not set, an empty
- </summary>
- <param name="key">The property key.
-
- </param>
- <param name="cb__">Asynchronous callback invoked when the operation completes.</param>
- <param name="cookie__">Application data to store in the asynchronous result object.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.PropertiesAdminPrx.begin_getProperty(System.String,System.Collections.Generic.Dictionary{System.String,System.String},Ice.AsyncCallback,System.Object)">
- <summary>
- Get a property by key.
- If the property is not set, an empty
- </summary>
- <param name="key">The property key.
-
- </param>
- <param name="ctx__">The Context map to send with the invocation.</param>
- <param name="cb__">Asynchronous callback invoked when the operation completes.</param>
- <param name="cookie__">Application data to store in the asynchronous result object.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.PropertiesAdminPrx.end_getProperty(Ice.AsyncResult)">
- <summary>
- Get a property by key.
- If the property is not set, an empty
- </summary>
- <param name="r__">The asynchronous result object for the invocation.</param>
- <returns>The property value.</returns>
- </member>
- <member name="M:Ice.PropertiesAdminPrx.getPropertiesForPrefix(System.String)">
- <summary>
- Get all properties whose keys begin with prefix.
- If
- prefix is an empty string then all properties are returned.
-
- </summary>
- <param name="prefix">The prefix to search for (empty string if none).
- </param>
- <returns>The matching property set.</returns>
- </member>
- <member name="M:Ice.PropertiesAdminPrx.getPropertiesForPrefix(System.String,System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- Get all properties whose keys begin with prefix.
- If
- prefix is an empty string then all properties are returned.
-
- </summary>
- <param name="prefix">The prefix to search for (empty string if none).
- </param>
- <returns>The matching property set.</returns>
- <param name="ctx__">The Context map to send with the invocation.</param>
- </member>
- <member name="M:Ice.PropertiesAdminPrx.begin_getPropertiesForPrefix(System.String)">
- <summary>
- Get all properties whose keys begin with prefix.
- If
- </summary>
- <param name="prefix">The prefix to search for (empty string if none).
- </param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.PropertiesAdminPrx.begin_getPropertiesForPrefix(System.String,System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- Get all properties whose keys begin with prefix.
- If
- </summary>
- <param name="prefix">The prefix to search for (empty string if none).
- </param>
- <param name="ctx__">The Context map to send with the invocation.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.PropertiesAdminPrx.begin_getPropertiesForPrefix(System.String,Ice.AsyncCallback,System.Object)">
- <summary>
- Get all properties whose keys begin with prefix.
- If
- </summary>
- <param name="prefix">The prefix to search for (empty string if none).
- </param>
- <param name="cb__">Asynchronous callback invoked when the operation completes.</param>
- <param name="cookie__">Application data to store in the asynchronous result object.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.PropertiesAdminPrx.begin_getPropertiesForPrefix(System.String,System.Collections.Generic.Dictionary{System.String,System.String},Ice.AsyncCallback,System.Object)">
- <summary>
- Get all properties whose keys begin with prefix.
- If
- </summary>
- <param name="prefix">The prefix to search for (empty string if none).
- </param>
- <param name="ctx__">The Context map to send with the invocation.</param>
- <param name="cb__">Asynchronous callback invoked when the operation completes.</param>
- <param name="cookie__">Application data to store in the asynchronous result object.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.PropertiesAdminPrx.end_getPropertiesForPrefix(Ice.AsyncResult)">
- <summary>
- Get all properties whose keys begin with prefix.
- If
- </summary>
- <param name="r__">The asynchronous result object for the invocation.</param>
- <returns>The matching property set.</returns>
- </member>
- <member name="M:Ice.PropertiesAdminPrx.setProperties(System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- Update the communicator's properties with the given property set.
- </summary>
- <param name="newProperties">Properties to be added, changed, or removed.
- If an entry in newProperties matches the name of an existing property,
- that property's value is replaced with the new value. If the new value
- is an empty string, the property is removed. Any existing properties
- that are not modified or removed by the entries in newProperties are
- retained with their original values.</param>
- </member>
- <member name="M:Ice.PropertiesAdminPrx.setProperties(System.Collections.Generic.Dictionary{System.String,System.String},System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- Update the communicator's properties with the given property set.
- </summary>
- <param name="newProperties">Properties to be added, changed, or removed.
- If an entry in newProperties matches the name of an existing property,
- that property's value is replaced with the new value. If the new value
- is an empty string, the property is removed. Any existing properties
- that are not modified or removed by the entries in newProperties are
- retained with their original values.</param>
- <param name="ctx__">The Context map to send with the invocation.</param>
- </member>
- <member name="M:Ice.PropertiesAdminPrx.begin_setProperties(System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- Update the communicator's properties with the given property set.
- </summary>
- <param name="newProperties">Properties to be added, changed, or removed.
- If an entry in newProperties matches the name of an existing property,
- that property's value is replaced with the new value. If the new value
- is an empty string, the property is removed. Any existing properties
- that are not modified or removed by the entries in newProperties are
- retained with their original values.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.PropertiesAdminPrx.begin_setProperties(System.Collections.Generic.Dictionary{System.String,System.String},System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- Update the communicator's properties with the given property set.
- </summary>
- <param name="newProperties">Properties to be added, changed, or removed.
- If an entry in newProperties matches the name of an existing property,
- that property's value is replaced with the new value. If the new value
- is an empty string, the property is removed. Any existing properties
- that are not modified or removed by the entries in newProperties are
- retained with their original values.</param>
- <param name="ctx__">The Context map to send with the invocation.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.PropertiesAdminPrx.begin_setProperties(System.Collections.Generic.Dictionary{System.String,System.String},Ice.AsyncCallback,System.Object)">
- <summary>
- Update the communicator's properties with the given property set.
- </summary>
- <param name="newProperties">Properties to be added, changed, or removed.
- If an entry in newProperties matches the name of an existing property,
- that property's value is replaced with the new value. If the new value
- is an empty string, the property is removed. Any existing properties
- that are not modified or removed by the entries in newProperties are
- retained with their original values.</param>
- <param name="cb__">Asynchronous callback invoked when the operation completes.</param>
- <param name="cookie__">Application data to store in the asynchronous result object.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.PropertiesAdminPrx.begin_setProperties(System.Collections.Generic.Dictionary{System.String,System.String},System.Collections.Generic.Dictionary{System.String,System.String},Ice.AsyncCallback,System.Object)">
- <summary>
- Update the communicator's properties with the given property set.
- </summary>
- <param name="newProperties">Properties to be added, changed, or removed.
- If an entry in newProperties matches the name of an existing property,
- that property's value is replaced with the new value. If the new value
- is an empty string, the property is removed. Any existing properties
- that are not modified or removed by the entries in newProperties are
- retained with their original values.</param>
- <param name="ctx__">The Context map to send with the invocation.</param>
- <param name="cb__">Asynchronous callback invoked when the operation completes.</param>
- <param name="cookie__">Application data to store in the asynchronous result object.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.PropertiesAdminPrx.end_setProperties(Ice.AsyncResult)">
- <summary>
- Update the communicator's properties with the given property set.
- </summary>
- <param name="r__">The asynchronous result object for the invocation.</param>
- </member>
- <member name="T:Ice.AMD_PropertiesAdmin_setProperties">
- <summary>
- Update the communicator's properties with the given property set.
- </summary>
- </member>
- <member name="M:Ice.AMD_PropertiesAdmin_setProperties.ice_response">
- <summary>
- ice_response indicates that
- the operation completed successfully.
- </summary>
- </member>
- <member name="T:Ice.RemoteLoggerOperations_">
- <summary>
- The Ice remote logger interface.
- An application can implement a
- RemoteLogger to receive the log messages sent to the local Logger
- of another Ice application.
- </summary>
- </member>
- <member name="M:Ice.RemoteLoggerOperations_.init(System.String,Ice.LogMessage[],Ice.Current)">
- <summary>
- init is called by LoggerAdmin.attachRemoteLogger when a
- RemoteLogger proxy is attached.
- </summary>
- <param name="prefix">The prefix of the associated local Logger
-
- </param>
- <param name="logMessages">Old log messages generated before "now".
-
- </param>
- <param name="current__">The Current object for the invocation.</param>
- </member>
- <member name="M:Ice.RemoteLoggerOperations_.log(Ice.LogMessage,Ice.Current)">
- <summary>
- Log a LogMessage.
- Note that log may be called by LoggerAdmin
- before init.
-
- </summary>
- <param name="message">The message to log.
-
- </param>
- <param name="current__">The Current object for the invocation.</param>
- </member>
- <member name="T:Ice.RemoteLoggerOperationsNC_">
- <summary>
- The Ice remote logger interface.
- An application can implement a
- RemoteLogger to receive the log messages sent to the local Logger
- of another Ice application.
- </summary>
- </member>
- <member name="M:Ice.RemoteLoggerOperationsNC_.init(System.String,Ice.LogMessage[])">
- <summary>
- init is called by LoggerAdmin.attachRemoteLogger when a
- RemoteLogger proxy is attached.
- </summary>
- <param name="prefix">The prefix of the associated local Logger
-
- </param>
- <param name="logMessages">Old log messages generated before "now".
-
- </param>
- </member>
- <member name="M:Ice.RemoteLoggerOperationsNC_.log(Ice.LogMessage)">
- <summary>
- Log a LogMessage.
- Note that log may be called by LoggerAdmin
- before init.
-
- </summary>
- <param name="message">The message to log.
-
- </param>
- </member>
- <member name="T:Ice.RemoteLoggerAlreadyAttachedException">
- <summary>
- An exception thrown by LoggerAdmin.attachRemoteLogger to report
- that the provided RemoteLogger was previously attached to this
- LoggerAdmin.
- </summary>
- </member>
- <member name="T:Ice.RemoteLoggerPrx">
- <summary>
- The Ice remote logger interface.
- An application can implement a
- RemoteLogger to receive the log messages sent to the local Logger
- of another Ice application.
- </summary>
- </member>
- <member name="M:Ice.RemoteLoggerPrx.init(System.String,Ice.LogMessage[])">
- <summary>
- init is called by LoggerAdmin.attachRemoteLogger when a
- RemoteLogger proxy is attached.
- </summary>
- <param name="prefix">The prefix of the associated local Logger
-
- </param>
- <param name="logMessages">Old log messages generated before "now".
-
- </param>
- </member>
- <member name="M:Ice.RemoteLoggerPrx.init(System.String,Ice.LogMessage[],System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- init is called by LoggerAdmin.attachRemoteLogger when a
- RemoteLogger proxy is attached.
- </summary>
- <param name="prefix">The prefix of the associated local Logger
-
- </param>
- <param name="logMessages">Old log messages generated before "now".
-
- </param>
- <param name="ctx__">The Context map to send with the invocation.</param>
- </member>
- <member name="M:Ice.RemoteLoggerPrx.begin_init(System.String,Ice.LogMessage[])">
- <summary>
- init is called by LoggerAdmin.attachRemoteLogger when a
- RemoteLogger proxy is attached.
- </summary>
- <param name="prefix">The prefix of the associated local Logger
-
- </param>
- <param name="logMessages">Old log messages generated before "now".
-
- </param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.RemoteLoggerPrx.begin_init(System.String,Ice.LogMessage[],System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- init is called by LoggerAdmin.attachRemoteLogger when a
- RemoteLogger proxy is attached.
- </summary>
- <param name="prefix">The prefix of the associated local Logger
-
- </param>
- <param name="logMessages">Old log messages generated before "now".
-
- </param>
- <param name="ctx__">The Context map to send with the invocation.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.RemoteLoggerPrx.begin_init(System.String,Ice.LogMessage[],Ice.AsyncCallback,System.Object)">
- <summary>
- init is called by LoggerAdmin.attachRemoteLogger when a
- RemoteLogger proxy is attached.
- </summary>
- <param name="prefix">The prefix of the associated local Logger
-
- </param>
- <param name="logMessages">Old log messages generated before "now".
-
- </param>
- <param name="cb__">Asynchronous callback invoked when the operation completes.</param>
- <param name="cookie__">Application data to store in the asynchronous result object.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.RemoteLoggerPrx.begin_init(System.String,Ice.LogMessage[],System.Collections.Generic.Dictionary{System.String,System.String},Ice.AsyncCallback,System.Object)">
- <summary>
- init is called by LoggerAdmin.attachRemoteLogger when a
- RemoteLogger proxy is attached.
- </summary>
- <param name="prefix">The prefix of the associated local Logger
-
- </param>
- <param name="logMessages">Old log messages generated before "now".
-
- </param>
- <param name="ctx__">The Context map to send with the invocation.</param>
- <param name="cb__">Asynchronous callback invoked when the operation completes.</param>
- <param name="cookie__">Application data to store in the asynchronous result object.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.RemoteLoggerPrx.end_init(Ice.AsyncResult)">
- <summary>
- init is called by LoggerAdmin.attachRemoteLogger when a
- RemoteLogger proxy is attached.
- </summary>
- <param name="r__">The asynchronous result object for the invocation.</param>
- </member>
- <member name="M:Ice.RemoteLoggerPrx.log(Ice.LogMessage)">
- <summary>
- Log a LogMessage.
- Note that log may be called by LoggerAdmin
- before init.
-
- </summary>
- <param name="message">The message to log.
-
- </param>
- </member>
- <member name="M:Ice.RemoteLoggerPrx.log(Ice.LogMessage,System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- Log a LogMessage.
- Note that log may be called by LoggerAdmin
- before init.
-
- </summary>
- <param name="message">The message to log.
-
- </param>
- <param name="ctx__">The Context map to send with the invocation.</param>
- </member>
- <member name="M:Ice.RemoteLoggerPrx.begin_log(Ice.LogMessage)">
- <summary>
- Log a LogMessage.
- Note that log may be called by LoggerAdmin
- </summary>
- <param name="message">The message to log.
-
- </param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.RemoteLoggerPrx.begin_log(Ice.LogMessage,System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- Log a LogMessage.
- Note that log may be called by LoggerAdmin
- </summary>
- <param name="message">The message to log.
-
- </param>
- <param name="ctx__">The Context map to send with the invocation.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.RemoteLoggerPrx.begin_log(Ice.LogMessage,Ice.AsyncCallback,System.Object)">
- <summary>
- Log a LogMessage.
- Note that log may be called by LoggerAdmin
- </summary>
- <param name="message">The message to log.
-
- </param>
- <param name="cb__">Asynchronous callback invoked when the operation completes.</param>
- <param name="cookie__">Application data to store in the asynchronous result object.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.RemoteLoggerPrx.begin_log(Ice.LogMessage,System.Collections.Generic.Dictionary{System.String,System.String},Ice.AsyncCallback,System.Object)">
- <summary>
- Log a LogMessage.
- Note that log may be called by LoggerAdmin
- </summary>
- <param name="message">The message to log.
-
- </param>
- <param name="ctx__">The Context map to send with the invocation.</param>
- <param name="cb__">Asynchronous callback invoked when the operation completes.</param>
- <param name="cookie__">Application data to store in the asynchronous result object.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.RemoteLoggerPrx.end_log(Ice.AsyncResult)">
- <summary>
- Log a LogMessage.
- Note that log may be called by LoggerAdmin
- </summary>
- <param name="r__">The asynchronous result object for the invocation.</param>
- </member>
- <member name="T:Ice.LoggerAdminPrx">
- <summary>
- The interface of the admin object that allows an Ice application the attach its
- RemoteLogger to the Logger of this admin object's Ice communicator.
- </summary>
- </member>
- <member name="M:Ice.LoggerAdminPrx.attachRemoteLogger(Ice.RemoteLoggerPrx,Ice.LogMessageType[],System.String[],System.Int32)">
- <summary>
- attachRemoteLogger is called to attach a RemoteLogger object to
- the local Logger.
- attachRemoteLogger calls init on the provided RemoteLogger proxy.
-
- </summary>
- <param name="prx">A proxy to the remote logger.
-
- </param>
- <param name="messageTypes">The list of message types that the remote logger wishes to receive.
- An empty list means no filtering (send all message types).
-
- </param>
- <param name="traceCategories">The categories of traces that the remote logger wishes to receive.
- This parameter is ignored if messageTypes is not empty and does not include trace.
- An empty list means no filtering (send all trace categories).
-
- </param>
- <param name="messageMax">The maximum number of log messages (of all types) to be provided
- to RemoteLogger.init. A negative value requests all messages available.
-
- </param>
- <exception name="RemoteLoggerAlreadyAttachedException">Raised if this remote logger is already
- attached to this admin object.</exception>
- </member>
- <member name="M:Ice.LoggerAdminPrx.attachRemoteLogger(Ice.RemoteLoggerPrx,Ice.LogMessageType[],System.String[],System.Int32,System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- attachRemoteLogger is called to attach a RemoteLogger object to
- the local Logger.
- attachRemoteLogger calls init on the provided RemoteLogger proxy.
-
- </summary>
- <param name="prx">A proxy to the remote logger.
-
- </param>
- <param name="messageTypes">The list of message types that the remote logger wishes to receive.
- An empty list means no filtering (send all message types).
-
- </param>
- <param name="traceCategories">The categories of traces that the remote logger wishes to receive.
- This parameter is ignored if messageTypes is not empty and does not include trace.
- An empty list means no filtering (send all trace categories).
-
- </param>
- <param name="messageMax">The maximum number of log messages (of all types) to be provided
- to RemoteLogger.init. A negative value requests all messages available.
-
- </param>
- <exception name="RemoteLoggerAlreadyAttachedException">Raised if this remote logger is already
- attached to this admin object.</exception>
- <param name="ctx__">The Context map to send with the invocation.</param>
- </member>
- <member name="M:Ice.LoggerAdminPrx.begin_attachRemoteLogger(Ice.RemoteLoggerPrx,Ice.LogMessageType[],System.String[],System.Int32)">
- <summary>
- attachRemoteLogger is called to attach a RemoteLogger object to
- the local Logger.
- attachRemoteLogger calls init on the provided RemoteLogger proxy.
- </summary>
- <param name="prx">A proxy to the remote logger.
-
- </param>
- <param name="messageTypes">The list of message types that the remote logger wishes to receive.
- An empty list means no filtering (send all message types).
-
- </param>
- <param name="traceCategories">The categories of traces that the remote logger wishes to receive.
- This parameter is ignored if messageTypes is not empty and does not include trace.
- An empty list means no filtering (send all trace categories).
-
- </param>
- <param name="messageMax">The maximum number of log messages (of all types) to be provided
- to RemoteLogger.init. A negative value requests all messages available.
-
- </param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.LoggerAdminPrx.begin_attachRemoteLogger(Ice.RemoteLoggerPrx,Ice.LogMessageType[],System.String[],System.Int32,System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- attachRemoteLogger is called to attach a RemoteLogger object to
- the local Logger.
- attachRemoteLogger calls init on the provided RemoteLogger proxy.
- </summary>
- <param name="prx">A proxy to the remote logger.
-
- </param>
- <param name="messageTypes">The list of message types that the remote logger wishes to receive.
- An empty list means no filtering (send all message types).
-
- </param>
- <param name="traceCategories">The categories of traces that the remote logger wishes to receive.
- This parameter is ignored if messageTypes is not empty and does not include trace.
- An empty list means no filtering (send all trace categories).
-
- </param>
- <param name="messageMax">The maximum number of log messages (of all types) to be provided
- to RemoteLogger.init. A negative value requests all messages available.
-
- </param>
- <param name="ctx__">The Context map to send with the invocation.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.LoggerAdminPrx.begin_attachRemoteLogger(Ice.RemoteLoggerPrx,Ice.LogMessageType[],System.String[],System.Int32,Ice.AsyncCallback,System.Object)">
- <summary>
- attachRemoteLogger is called to attach a RemoteLogger object to
- the local Logger.
- attachRemoteLogger calls init on the provided RemoteLogger proxy.
- </summary>
- <param name="prx">A proxy to the remote logger.
-
- </param>
- <param name="messageTypes">The list of message types that the remote logger wishes to receive.
- An empty list means no filtering (send all message types).
-
- </param>
- <param name="traceCategories">The categories of traces that the remote logger wishes to receive.
- This parameter is ignored if messageTypes is not empty and does not include trace.
- An empty list means no filtering (send all trace categories).
-
- </param>
- <param name="messageMax">The maximum number of log messages (of all types) to be provided
- to RemoteLogger.init. A negative value requests all messages available.
-
- </param>
- <param name="cb__">Asynchronous callback invoked when the operation completes.</param>
- <param name="cookie__">Application data to store in the asynchronous result object.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.LoggerAdminPrx.begin_attachRemoteLogger(Ice.RemoteLoggerPrx,Ice.LogMessageType[],System.String[],System.Int32,System.Collections.Generic.Dictionary{System.String,System.String},Ice.AsyncCallback,System.Object)">
- <summary>
- attachRemoteLogger is called to attach a RemoteLogger object to
- the local Logger.
- attachRemoteLogger calls init on the provided RemoteLogger proxy.
- </summary>
- <param name="prx">A proxy to the remote logger.
-
- </param>
- <param name="messageTypes">The list of message types that the remote logger wishes to receive.
- An empty list means no filtering (send all message types).
-
- </param>
- <param name="traceCategories">The categories of traces that the remote logger wishes to receive.
- This parameter is ignored if messageTypes is not empty and does not include trace.
- An empty list means no filtering (send all trace categories).
-
- </param>
- <param name="messageMax">The maximum number of log messages (of all types) to be provided
- to RemoteLogger.init. A negative value requests all messages available.
-
- </param>
- <param name="ctx__">The Context map to send with the invocation.</param>
- <param name="cb__">Asynchronous callback invoked when the operation completes.</param>
- <param name="cookie__">Application data to store in the asynchronous result object.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.LoggerAdminPrx.end_attachRemoteLogger(Ice.AsyncResult)">
- <summary>
- attachRemoteLogger is called to attach a RemoteLogger object to
- the local Logger.
- attachRemoteLogger calls init on the provided RemoteLogger proxy.
- </summary>
- <param name="r__">The asynchronous result object for the invocation.</param>
- </member>
- <member name="M:Ice.LoggerAdminPrx.detachRemoteLogger(Ice.RemoteLoggerPrx)">
- <summary>
- detachRemoteLogger is called to detach a RemoteLogger object from
- the local Logger.
- </summary>
- <param name="prx">A proxy to the remote logger.
-
- </param>
- <returns>True if the provided remote logger proxy was detached, and false otherwise.</returns>
- </member>
- <member name="M:Ice.LoggerAdminPrx.detachRemoteLogger(Ice.RemoteLoggerPrx,System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- detachRemoteLogger is called to detach a RemoteLogger object from
- the local Logger.
- </summary>
- <param name="prx">A proxy to the remote logger.
-
- </param>
- <returns>True if the provided remote logger proxy was detached, and false otherwise.</returns>
- <param name="ctx__">The Context map to send with the invocation.</param>
- </member>
- <member name="M:Ice.LoggerAdminPrx.begin_detachRemoteLogger(Ice.RemoteLoggerPrx)">
- <summary>
- detachRemoteLogger is called to detach a RemoteLogger object from
- the local Logger.
- </summary>
- <param name="prx">A proxy to the remote logger.
-
- </param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.LoggerAdminPrx.begin_detachRemoteLogger(Ice.RemoteLoggerPrx,System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- detachRemoteLogger is called to detach a RemoteLogger object from
- the local Logger.
- </summary>
- <param name="prx">A proxy to the remote logger.
-
- </param>
- <param name="ctx__">The Context map to send with the invocation.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.LoggerAdminPrx.begin_detachRemoteLogger(Ice.RemoteLoggerPrx,Ice.AsyncCallback,System.Object)">
- <summary>
- detachRemoteLogger is called to detach a RemoteLogger object from
- the local Logger.
- </summary>
- <param name="prx">A proxy to the remote logger.
-
- </param>
- <param name="cb__">Asynchronous callback invoked when the operation completes.</param>
- <param name="cookie__">Application data to store in the asynchronous result object.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.LoggerAdminPrx.begin_detachRemoteLogger(Ice.RemoteLoggerPrx,System.Collections.Generic.Dictionary{System.String,System.String},Ice.AsyncCallback,System.Object)">
- <summary>
- detachRemoteLogger is called to detach a RemoteLogger object from
- the local Logger.
- </summary>
- <param name="prx">A proxy to the remote logger.
-
- </param>
- <param name="ctx__">The Context map to send with the invocation.</param>
- <param name="cb__">Asynchronous callback invoked when the operation completes.</param>
- <param name="cookie__">Application data to store in the asynchronous result object.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.LoggerAdminPrx.end_detachRemoteLogger(Ice.AsyncResult)">
- <summary>
- detachRemoteLogger is called to detach a RemoteLogger object from
- the local Logger.
- </summary>
- <param name="r__">The asynchronous result object for the invocation.</param>
- <returns>True if the provided remote logger proxy was detached, and false otherwise.</returns>
- </member>
- <member name="M:Ice.LoggerAdminPrx.getLog(Ice.LogMessageType[],System.String[],System.Int32,System.String@)">
- <summary>
- getLog retrieves log messages recently logged.
- </summary>
- <param name="messageTypes">The list of message types that the caller wishes to receive.
- An empty list means no filtering (send all message types).
-
- </param>
- <param name="traceCategories">The categories of traces that caller wish to receive.
- This parameter is ignored if messageTypes is not empty and does not include trace.
- An empty list means no filtering (send all trace categories).
-
- </param>
- <param name="messageMax">The maximum number of log messages (of all types) to be returned.
- A negative value requests all messages available.
-
- </param>
- <param name="prefix">The prefix of the associated local Logger.
-
- </param>
- <returns>The Log messages.</returns>
- </member>
- <member name="M:Ice.LoggerAdminPrx.getLog(Ice.LogMessageType[],System.String[],System.Int32,System.String@,System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- getLog retrieves log messages recently logged.
- </summary>
- <param name="messageTypes">The list of message types that the caller wishes to receive.
- An empty list means no filtering (send all message types).
-
- </param>
- <param name="traceCategories">The categories of traces that caller wish to receive.
- This parameter is ignored if messageTypes is not empty and does not include trace.
- An empty list means no filtering (send all trace categories).
-
- </param>
- <param name="messageMax">The maximum number of log messages (of all types) to be returned.
- A negative value requests all messages available.
-
- </param>
- <param name="prefix">The prefix of the associated local Logger.
-
- </param>
- <returns>The Log messages.</returns>
- <param name="ctx__">The Context map to send with the invocation.</param>
- </member>
- <member name="M:Ice.LoggerAdminPrx.begin_getLog(Ice.LogMessageType[],System.String[],System.Int32)">
- <summary>
- getLog retrieves log messages recently logged.
- </summary>
- <param name="messageTypes">The list of message types that the caller wishes to receive.
- An empty list means no filtering (send all message types).
-
- </param>
- <param name="traceCategories">The categories of traces that caller wish to receive.
- This parameter is ignored if messageTypes is not empty and does not include trace.
- An empty list means no filtering (send all trace categories).
-
- </param>
- <param name="messageMax">The maximum number of log messages (of all types) to be returned.
- A negative value requests all messages available.
-
- </param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.LoggerAdminPrx.begin_getLog(Ice.LogMessageType[],System.String[],System.Int32,System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- getLog retrieves log messages recently logged.
- </summary>
- <param name="messageTypes">The list of message types that the caller wishes to receive.
- An empty list means no filtering (send all message types).
-
- </param>
- <param name="traceCategories">The categories of traces that caller wish to receive.
- This parameter is ignored if messageTypes is not empty and does not include trace.
- An empty list means no filtering (send all trace categories).
-
- </param>
- <param name="messageMax">The maximum number of log messages (of all types) to be returned.
- A negative value requests all messages available.
-
- </param>
- <param name="ctx__">The Context map to send with the invocation.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.LoggerAdminPrx.begin_getLog(Ice.LogMessageType[],System.String[],System.Int32,Ice.AsyncCallback,System.Object)">
- <summary>
- getLog retrieves log messages recently logged.
- </summary>
- <param name="messageTypes">The list of message types that the caller wishes to receive.
- An empty list means no filtering (send all message types).
-
- </param>
- <param name="traceCategories">The categories of traces that caller wish to receive.
- This parameter is ignored if messageTypes is not empty and does not include trace.
- An empty list means no filtering (send all trace categories).
-
- </param>
- <param name="messageMax">The maximum number of log messages (of all types) to be returned.
- A negative value requests all messages available.
-
- </param>
- <param name="cb__">Asynchronous callback invoked when the operation completes.</param>
- <param name="cookie__">Application data to store in the asynchronous result object.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.LoggerAdminPrx.begin_getLog(Ice.LogMessageType[],System.String[],System.Int32,System.Collections.Generic.Dictionary{System.String,System.String},Ice.AsyncCallback,System.Object)">
- <summary>
- getLog retrieves log messages recently logged.
- </summary>
- <param name="messageTypes">The list of message types that the caller wishes to receive.
- An empty list means no filtering (send all message types).
-
- </param>
- <param name="traceCategories">The categories of traces that caller wish to receive.
- This parameter is ignored if messageTypes is not empty and does not include trace.
- An empty list means no filtering (send all trace categories).
-
- </param>
- <param name="messageMax">The maximum number of log messages (of all types) to be returned.
- A negative value requests all messages available.
-
- </param>
- <param name="ctx__">The Context map to send with the invocation.</param>
- <param name="cb__">Asynchronous callback invoked when the operation completes.</param>
- <param name="cookie__">Application data to store in the asynchronous result object.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.LoggerAdminPrx.end_getLog(System.String@,Ice.AsyncResult)">
- <summary>
- getLog retrieves log messages recently logged.
- </summary>
- <param name="prefix">The prefix of the associated local Logger.
-
- </param>
- <param name="r__">The asynchronous result object for the invocation.</param>
- <returns>The Log messages.</returns>
- </member>
- <member name="T:Ice.RouterOperations_">
- <summary>
- The Ice router interface.
- Routers can be set either globally with
- Communicator.setDefaultRouter, or with ice_router on specific
- proxies.
- </summary>
- </member>
- <member name="M:Ice.RouterOperations_.getClientProxy(Ice.Current)">
- <summary>
- Get the router's client proxy, i.e., the proxy to use for
- forwarding requests from the client to the router.
- If a null proxy is returned, the client will forward requests
- to the router's endpoints.
-
- </summary>
- <returns>The router's client proxy.</returns>
- <param name="current__">The Current object for the invocation.</param>
- </member>
- <member name="M:Ice.RouterOperations_.getServerProxy(Ice.Current)">
- <summary>
- Get the router's server proxy, i.e., the proxy to use for
- forwarding requests from the server to the router.
- </summary>
- <returns>The router's server proxy.</returns>
- <param name="current__">The Current object for the invocation.</param>
- </member>
- <member name="M:Ice.RouterOperations_.addProxies(Ice.ObjectPrx[],Ice.Current)">
- <summary>
- Add new proxy information to the router's routing table.
- </summary>
- <param name="proxies">The proxies to add.
-
- </param>
- <returns>Proxies discarded by the router.</returns>
- <param name="current__">The Current object for the invocation.</param>
- </member>
- <member name="T:Ice.RouterOperationsNC_">
- <summary>
- The Ice router interface.
- Routers can be set either globally with
- Communicator.setDefaultRouter, or with ice_router on specific
- proxies.
- </summary>
- </member>
- <member name="M:Ice.RouterOperationsNC_.getClientProxy">
- <summary>
- Get the router's client proxy, i.e., the proxy to use for
- forwarding requests from the client to the router.
- If a null proxy is returned, the client will forward requests
- to the router's endpoints.
-
- </summary>
- <returns>The router's client proxy.</returns>
- </member>
- <member name="M:Ice.RouterOperationsNC_.getServerProxy">
- <summary>
- Get the router's server proxy, i.e., the proxy to use for
- forwarding requests from the server to the router.
- </summary>
- <returns>The router's server proxy.</returns>
- </member>
- <member name="M:Ice.RouterOperationsNC_.addProxies(Ice.ObjectPrx[])">
- <summary>
- Add new proxy information to the router's routing table.
- </summary>
- <param name="proxies">The proxies to add.
-
- </param>
- <returns>Proxies discarded by the router.</returns>
- </member>
- <member name="T:Ice.RouterFinderOperations_">
- <summary>
- This inferface should be implemented by services implementing the
- Ice::Router interface.
- It should be advertised through an Ice
- object with the identity `Ice/RouterFinder'. This allows clients to
- retrieve the router proxy with just the endpoint information of the
- service.
- </summary>
- </member>
- <member name="M:Ice.RouterFinderOperations_.getRouter(Ice.Current)">
- <summary>
- Get the router proxy implemented by the process hosting this
- finder object.
- The proxy might point to several replicas.
-
- </summary>
- <returns>The router proxy.</returns>
- <param name="current__">The Current object for the invocation.</param>
- </member>
- <member name="T:Ice.RouterFinderOperationsNC_">
- <summary>
- This inferface should be implemented by services implementing the
- Ice::Router interface.
- It should be advertised through an Ice
- object with the identity `Ice/RouterFinder'. This allows clients to
- retrieve the router proxy with just the endpoint information of the
- service.
- </summary>
- </member>
- <member name="M:Ice.RouterFinderOperationsNC_.getRouter">
- <summary>
- Get the router proxy implemented by the process hosting this
- finder object.
- The proxy might point to several replicas.
-
- </summary>
- <returns>The router proxy.</returns>
- </member>
- <member name="T:Ice.RouterPrx">
- <summary>
- The Ice router interface.
- Routers can be set either globally with
- Communicator.setDefaultRouter, or with ice_router on specific
- proxies.
- </summary>
- </member>
- <member name="M:Ice.RouterPrx.getClientProxy">
- <summary>
- Get the router's client proxy, i.e., the proxy to use for
- forwarding requests from the client to the router.
- If a null proxy is returned, the client will forward requests
- to the router's endpoints.
-
- </summary>
- <returns>The router's client proxy.</returns>
- </member>
- <member name="M:Ice.RouterPrx.getClientProxy(System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- Get the router's client proxy, i.e., the proxy to use for
- forwarding requests from the client to the router.
- If a null proxy is returned, the client will forward requests
- to the router's endpoints.
-
- </summary>
- <returns>The router's client proxy.</returns>
- <param name="ctx__">The Context map to send with the invocation.</param>
- </member>
- <member name="M:Ice.RouterPrx.begin_getClientProxy">
- <summary>
- Get the router's client proxy, i.e., the proxy to use for
- forwarding requests from the client to the router.
- If a null proxy is returned, the client will forward requests
- </summary>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.RouterPrx.begin_getClientProxy(System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- Get the router's client proxy, i.e., the proxy to use for
- forwarding requests from the client to the router.
- If a null proxy is returned, the client will forward requests
- </summary>
- <param name="ctx__">The Context map to send with the invocation.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.RouterPrx.begin_getClientProxy(Ice.AsyncCallback,System.Object)">
- <summary>
- Get the router's client proxy, i.e., the proxy to use for
- forwarding requests from the client to the router.
- If a null proxy is returned, the client will forward requests
- </summary>
- <param name="cb__">Asynchronous callback invoked when the operation completes.</param>
- <param name="cookie__">Application data to store in the asynchronous result object.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.RouterPrx.begin_getClientProxy(System.Collections.Generic.Dictionary{System.String,System.String},Ice.AsyncCallback,System.Object)">
- <summary>
- Get the router's client proxy, i.e., the proxy to use for
- forwarding requests from the client to the router.
- If a null proxy is returned, the client will forward requests
- </summary>
- <param name="ctx__">The Context map to send with the invocation.</param>
- <param name="cb__">Asynchronous callback invoked when the operation completes.</param>
- <param name="cookie__">Application data to store in the asynchronous result object.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.RouterPrx.end_getClientProxy(Ice.AsyncResult)">
- <summary>
- Get the router's client proxy, i.e., the proxy to use for
- forwarding requests from the client to the router.
- If a null proxy is returned, the client will forward requests
- </summary>
- <param name="r__">The asynchronous result object for the invocation.</param>
- <returns>The router's client proxy.</returns>
- </member>
- <member name="M:Ice.RouterPrx.getServerProxy">
- <summary>
- Get the router's server proxy, i.e., the proxy to use for
- forwarding requests from the server to the router.
- </summary>
- <returns>The router's server proxy.</returns>
- </member>
- <member name="M:Ice.RouterPrx.getServerProxy(System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- Get the router's server proxy, i.e., the proxy to use for
- forwarding requests from the server to the router.
- </summary>
- <returns>The router's server proxy.</returns>
- <param name="ctx__">The Context map to send with the invocation.</param>
- </member>
- <member name="M:Ice.RouterPrx.begin_getServerProxy">
- <summary>
- Get the router's server proxy, i.e., the proxy to use for
- forwarding requests from the server to the router.
- </summary>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.RouterPrx.begin_getServerProxy(System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- Get the router's server proxy, i.e., the proxy to use for
- forwarding requests from the server to the router.
- </summary>
- <param name="ctx__">The Context map to send with the invocation.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.RouterPrx.begin_getServerProxy(Ice.AsyncCallback,System.Object)">
- <summary>
- Get the router's server proxy, i.e., the proxy to use for
- forwarding requests from the server to the router.
- </summary>
- <param name="cb__">Asynchronous callback invoked when the operation completes.</param>
- <param name="cookie__">Application data to store in the asynchronous result object.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.RouterPrx.begin_getServerProxy(System.Collections.Generic.Dictionary{System.String,System.String},Ice.AsyncCallback,System.Object)">
- <summary>
- Get the router's server proxy, i.e., the proxy to use for
- forwarding requests from the server to the router.
- </summary>
- <param name="ctx__">The Context map to send with the invocation.</param>
- <param name="cb__">Asynchronous callback invoked when the operation completes.</param>
- <param name="cookie__">Application data to store in the asynchronous result object.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.RouterPrx.end_getServerProxy(Ice.AsyncResult)">
- <summary>
- Get the router's server proxy, i.e., the proxy to use for
- forwarding requests from the server to the router.
- </summary>
- <param name="r__">The asynchronous result object for the invocation.</param>
- <returns>The router's server proxy.</returns>
- </member>
- <member name="M:Ice.RouterPrx.addProxies(Ice.ObjectPrx[])">
- <summary>
- Add new proxy information to the router's routing table.
- </summary>
- <param name="proxies">The proxies to add.
-
- </param>
- <returns>Proxies discarded by the router.</returns>
- </member>
- <member name="M:Ice.RouterPrx.addProxies(Ice.ObjectPrx[],System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- Add new proxy information to the router's routing table.
- </summary>
- <param name="proxies">The proxies to add.
-
- </param>
- <returns>Proxies discarded by the router.</returns>
- <param name="ctx__">The Context map to send with the invocation.</param>
- </member>
- <member name="M:Ice.RouterPrx.begin_addProxies(Ice.ObjectPrx[])">
- <summary>
- Add new proxy information to the router's routing table.
- </summary>
- <param name="proxies">The proxies to add.
-
- </param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.RouterPrx.begin_addProxies(Ice.ObjectPrx[],System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- Add new proxy information to the router's routing table.
- </summary>
- <param name="proxies">The proxies to add.
-
- </param>
- <param name="ctx__">The Context map to send with the invocation.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.RouterPrx.begin_addProxies(Ice.ObjectPrx[],Ice.AsyncCallback,System.Object)">
- <summary>
- Add new proxy information to the router's routing table.
- </summary>
- <param name="proxies">The proxies to add.
-
- </param>
- <param name="cb__">Asynchronous callback invoked when the operation completes.</param>
- <param name="cookie__">Application data to store in the asynchronous result object.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.RouterPrx.begin_addProxies(Ice.ObjectPrx[],System.Collections.Generic.Dictionary{System.String,System.String},Ice.AsyncCallback,System.Object)">
- <summary>
- Add new proxy information to the router's routing table.
- </summary>
- <param name="proxies">The proxies to add.
-
- </param>
- <param name="ctx__">The Context map to send with the invocation.</param>
- <param name="cb__">Asynchronous callback invoked when the operation completes.</param>
- <param name="cookie__">Application data to store in the asynchronous result object.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.RouterPrx.end_addProxies(Ice.AsyncResult)">
- <summary>
- Add new proxy information to the router's routing table.
- </summary>
- <param name="r__">The asynchronous result object for the invocation.</param>
- <returns>Proxies discarded by the router.</returns>
- </member>
- <member name="T:Ice.RouterFinderPrx">
- <summary>
- This inferface should be implemented by services implementing the
- Ice::Router interface.
- It should be advertised through an Ice
- object with the identity `Ice/RouterFinder'. This allows clients to
- retrieve the router proxy with just the endpoint information of the
- service.
- </summary>
- </member>
- <member name="M:Ice.RouterFinderPrx.getRouter">
- <summary>
- Get the router proxy implemented by the process hosting this
- finder object.
- The proxy might point to several replicas.
-
- </summary>
- <returns>The router proxy.</returns>
- </member>
- <member name="M:Ice.RouterFinderPrx.getRouter(System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- Get the router proxy implemented by the process hosting this
- finder object.
- The proxy might point to several replicas.
-
- </summary>
- <returns>The router proxy.</returns>
- <param name="ctx__">The Context map to send with the invocation.</param>
- </member>
- <member name="M:Ice.RouterFinderPrx.begin_getRouter">
- <summary>
- Get the router proxy implemented by the process hosting this
- finder object.
- The proxy might point to several replicas.
- </summary>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.RouterFinderPrx.begin_getRouter(System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- Get the router proxy implemented by the process hosting this
- finder object.
- The proxy might point to several replicas.
- </summary>
- <param name="ctx__">The Context map to send with the invocation.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.RouterFinderPrx.begin_getRouter(Ice.AsyncCallback,System.Object)">
- <summary>
- Get the router proxy implemented by the process hosting this
- finder object.
- The proxy might point to several replicas.
- </summary>
- <param name="cb__">Asynchronous callback invoked when the operation completes.</param>
- <param name="cookie__">Application data to store in the asynchronous result object.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.RouterFinderPrx.begin_getRouter(System.Collections.Generic.Dictionary{System.String,System.String},Ice.AsyncCallback,System.Object)">
- <summary>
- Get the router proxy implemented by the process hosting this
- finder object.
- The proxy might point to several replicas.
- </summary>
- <param name="ctx__">The Context map to send with the invocation.</param>
- <param name="cb__">Asynchronous callback invoked when the operation completes.</param>
- <param name="cookie__">Application data to store in the asynchronous result object.</param>
- <returns>An asynchronous result object.</returns>
- </member>
- <member name="M:Ice.RouterFinderPrx.end_getRouter(Ice.AsyncResult)">
- <summary>
- Get the router proxy implemented by the process hosting this
- finder object.
- The proxy might point to several replicas.
- </summary>
- <param name="r__">The asynchronous result object for the invocation.</param>
- <returns>The router proxy.</returns>
- </member>
- <member name="M:Ice.ServantLocator.locate(Ice.Current,System.Object@)">
- <summary>
- Called before a request is dispatched if a
- servant cannot be found in the object adapter's active servant
- map.
- Note that the object adapter does not automatically insert
- the returned servant into its active servant map. This must be
- done by the servant locator implementation, if this is desired.
-
- locate can throw any user exception. If it does, that exception
- is marshaled back to the client. If the Slice definition for the
- corresponding operation includes that user exception, the client
- receives that user exception; otherwise, the client receives
- UnknownUserException.
-
- If locate throws any exception, the Ice run time does not
- call finished.
-
- If you call locate from your own code, you
- must also call finished when you have finished using the
- servant, provided that locate returned a non-null servant;
- otherwise, you will get undefined behavior if you use
- servant locators such as the Freeze Evictor.
-
- </summary>
- <param name="curr">Information about the current operation for which
- a servant is required.
-
- </param>
- <param name="cookie">A "cookie" that will be passed to finished.
-
- </param>
- <returns>The located servant, or null if no suitable servant has
- been found.
-
- </returns>
- </member>
- <member name="M:Ice.ServantLocator.finished(Ice.Current,Ice.Object,System.Object)">
- <summary>
- Called by the object adapter after a request has been
- made.
- This operation is only called if locate was called
- prior to the request and returned a non-null servant. This
- operation can be used for cleanup purposes after a request.
-
- finished can throw any user exception. If it does, that exception
- is marshaled back to the client. If the Slice definition for the
- corresponding operation includes that user exception, the client
- receives that user exception; otherwise, the client receives
- UnknownUserException.
-
- If both the operation and finished throw an exception, the
- exception thrown by finished is marshaled back to the client.
-
- </summary>
- <param name="curr">Information about the current operation call for
- which a servant was located by locate.
-
- </param>
- <param name="servant">The servant that was returned by locate.
-
- </param>
- <param name="cookie">The cookie that was returned by locate.
-
- </param>
- </member>
- <member name="M:Ice.ServantLocator.deactivate(System.String)">
- <summary>
- Called when the object adapter in which this servant locator is
- installed is destroyed.
- </summary>
- <param name="category">Indicates for which category the servant locator
- is being deactivated.
-
- </param>
- </member>
- </members>
- </doc>
|