0ct0pu5
/
tor-router


			
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771
							<!DOCTYPE html>
<html lang="en">
<head>
    
    <meta charset="utf-8">
    <title>TorPool - Documentation</title>
    
    
    <script src="scripts/prettify/prettify.js"></script>
    <script src="scripts/prettify/lang-css.js"></script>
    <!--[if lt IE 9]>
      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
    <link type="text/css" rel="stylesheet" href="styles/prettify.css">
    <link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
</head>
<body>

<input type="checkbox" id="nav-trigger" class="nav-trigger" />
<label for="nav-trigger" class="navicon-button x">
  <div class="navicon"></div>
</label>

<label for="nav-trigger" class="overlay"></label>

<nav>
    
    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="ControlServer.html">ControlServer</a><ul class='methods'><li data-type='method'><a href="ControlServer.html#.instance_info">instance_info</a></li><li data-type='method'><a href="ControlServer.html#close">close</a></li><li data-type='method'><a href="ControlServer.html#createDNSServer">createDNSServer</a></li><li data-type='method'><a href="ControlServer.html#createHTTPServer">createHTTPServer</a></li><li data-type='method'><a href="ControlServer.html#createSOCKSServer">createSOCKSServer</a></li><li data-type='method'><a href="ControlServer.html#createTorPool">createTorPool</a></li><li data-type='method'><a href="ControlServer.html#listen">listen</a></li><li data-type='method'><a href="ControlServer.html#listenTcp">listenTcp</a></li><li data-type='method'><a href="ControlServer.html#listenWs">listenWs</a></li></ul></li><li><a href="DNSServer.html">DNSServer</a><ul class='methods'><li data-type='method'><a href="DNSServer.html#listen">listen</a></li></ul></li><li><a href="HTTPServer.html">HTTPServer</a><ul class='methods'><li data-type='method'><a href="HTTPServer.html#listen">listen</a></li></ul></li><li><a href="SOCKSServer.html">SOCKSServer</a><ul class='methods'><li data-type='method'><a href="SOCKSServer.html#listen">listen</a></li></ul></li><li><a href="TorPool.html">TorPool</a><ul class='methods'><li data-type='method'><a href="TorPool.html#add">add</a></li><li data-type='method'><a href="TorPool.html#add_instance_to_group">add_instance_to_group</a></li><li data-type='method'><a href="TorPool.html#add_instance_to_group_at">add_instance_to_group_at</a></li><li data-type='method'><a href="TorPool.html#add_instance_to_group_by_name">add_instance_to_group_by_name</a></li><li data-type='method'><a href="TorPool.html#create">create</a></li><li data-type='method'><a href="TorPool.html#create_instance">create_instance</a></li><li data-type='method'><a href="TorPool.html#exit">exit</a></li><li data-type='method'><a href="TorPool.html#get_config_at">get_config_at</a></li><li data-type='method'><a href="TorPool.html#get_config_by_name">get_config_by_name</a></li><li data-type='method'><a href="TorPool.html#instance_at">instance_at</a></li><li data-type='method'><a href="TorPool.html#instance_by_name">instance_by_name</a></li><li data-type='method'><a href="TorPool.html#instances_by_group">instances_by_group</a></li><li data-type='method'><a href="TorPool.html#new_identites">new_identites</a></li><li data-type='method'><a href="TorPool.html#new_identites_by_group">new_identites_by_group</a></li><li data-type='method'><a href="TorPool.html#new_identity_at">new_identity_at</a></li><li data-type='method'><a href="TorPool.html#new_identity_by_name">new_identity_by_name</a></li><li data-type='method'><a href="TorPool.html#next">next</a></li><li data-type='method'><a href="TorPool.html#next_by_group">next_by_group</a></li><li data-type='method'><a href="TorPool.html#remove">remove</a></li><li data-type='method'><a href="TorPool.html#remove_at">remove_at</a></li><li data-type='method'><a href="TorPool.html#remove_by_name">remove_by_name</a></li><li data-type='method'><a href="TorPool.html#remove_instance_from_group">remove_instance_from_group</a></li><li data-type='method'><a href="TorPool.html#remove_instance_from_group_at">remove_instance_from_group_at</a></li><li data-type='method'><a href="TorPool.html#remove_instance_from_group_by_name">remove_instance_from_group_by_name</a></li><li data-type='method'><a href="TorPool.html#set_config_all">set_config_all</a></li><li data-type='method'><a href="TorPool.html#set_config_at">set_config_at</a></li><li data-type='method'><a href="TorPool.html#set_config_by_group">set_config_by_group</a></li><li data-type='method'><a href="TorPool.html#set_config_by_name">set_config_by_name</a></li><li data-type='method'><a href="TorPool.html#signal_all">signal_all</a></li><li data-type='method'><a href="TorPool.html#signal_at">signal_at</a></li><li data-type='method'><a href="TorPool.html#signal_by_group">signal_by_group</a></li><li data-type='method'><a href="TorPool.html#signal_by_name">signal_by_name</a></li></ul></li><li><a href="TorProcess.html">TorProcess</a><ul class='methods'><li data-type='method'><a href="TorProcess.html#create">create</a></li><li data-type='method'><a href="TorProcess.html#exit">exit</a></li><li data-type='method'><a href="TorProcess.html#get_config">get_config</a></li><li data-type='method'><a href="TorProcess.html#new_identity">new_identity</a></li><li data-type='method'><a href="TorProcess.html#set_config">set_config</a></li><li data-type='method'><a href="TorProcess.html#signal">signal</a></li></ul></li></ul><h3>Modules</h3><ul><li><a href="module-tor-router.html">tor-router</a></li><li><a href="module-tor-router_ControlServer.html">tor-router/ControlServer</a></li><li><a href="module-tor-router_default_config.html">tor-router/default_config</a></li><li><a href="module-tor-router_default_ports.html">tor-router/default_ports</a></li><li><a href="module-tor-router_DNSServer.html">tor-router/DNSServer</a></li><li><a href="module-tor-router_HTTPServer.html">tor-router/HTTPServer</a></li><li><a href="module-tor-router_launch.html">tor-router/launch</a></li><li><a href="module-tor-router_nconf_load_env.html">tor-router/nconf_load_env</a></li><li><a href="module-tor-router_SOCKSServer.html">tor-router/SOCKSServer</a></li><li><a href="module-tor-router_TorPool.html">tor-router/TorPool</a></li><li><a href="module-tor-router_TorProcess.html">tor-router/TorProcess</a></li><li><a href="module-tor-router_winston_silent_logger.html">tor-router/winston_silent_logger</a></li></ul><h3>Events</h3><ul><li><a href="DNSServer.html#event:instance-connection">instance-connection</a></li><li><a href="HTTPServer.html#event:instance-connection">instance-connection</a></li><li><a href="SOCKSServer.html#event:instance-connection">instance-connection</a></li><li><a href="TorPool.html#event:instance_created">instance_created</a></li><li><a href="TorProcess.html#event:control_listen">control_listen</a></li><li><a href="TorProcess.html#event:controller_ready">controller_ready</a></li><li><a href="TorProcess.html#event:dns_listen">dns_listen</a></li><li><a href="TorProcess.html#event:error">error</a></li><li><a href="TorProcess.html#event:process_exit">process_exit</a></li><li><a href="TorProcess.html#event:ready">ready</a></li><li><a href="TorProcess.html#event:socks_listen">socks_listen</a></li></ul><h3>Global</h3><ul><li><a href="global.html#assembleHost">assembleHost</a></li><li><a href="global.html#cleanUp">cleanUp</a></li><li><a href="global.html#env_whitelist">env_whitelist</a></li><li><a href="global.html#logger">logger</a></li><li><a href="global.html#main">main</a></li><li><a href="global.html#nconf">nconf</a></li><li><a href="global.html#REALM">REALM</a></li><li><a href="global.html#setup_nconf_env">setup_nconf_env</a></li><li><a href="global.html#TOR_ROUTER_PROXY_AGENT">TOR_ROUTER_PROXY_AGENT</a></li></ul>
</nav>

<div id="main">
    
    <h1 class="page-title">TorPool</h1>
    

<section>

<header>
    
        <h2>
        TorPool
        </h2>
        
            <div class="class-description">Class that represents a pool of Tor processes.</div>
        
    
</header>

<article>
    
        <div class="container-overview">
        
            
    <h2>Constructor</h2>
    

    <h4 class="name" id="TorPool"><span class="type-signature"></span>new TorPool<span class="signature">(tor_path, default_config<span class="signature-attributes">opt</span>, data_directory, load_balance_method, granax_options<span class="signature-attributes">opt</span>, logger<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>

    
<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="TorPool.js.html">TorPool.js</a>, <a href="TorPool.js.html#line38">line 38</a>
    </li></ul></dd>
    

</dl>


<div class="description">
    Creates an instance of `TorPool`.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>tor_path</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
                <td class="attributes">
                

                </td>
            

            <td class="description last">Path to the Tor executable.</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>default_config</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>
|

<span class="param-type">function</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">Default configuration that will be passed to all Tor instances created. Can be a function. See <a href="https://bit.ly/2QrmI3o">Tor Documentation</a> for all possible options</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>data_directory</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
                <td class="attributes">
                

                </td>
            

            <td class="description last">Parent directory for the data directory of each proccess.</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>load_balance_method</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
                <td class="attributes">
                

                </td>
            

            <td class="description last">Name of the load balance method to use. See TorPool#load_balance_methods.</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>granax_options</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">Object containing options that will be passed to granax for each instance.</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>logger</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">A winston logger. If not provided no logging will occur.</td>
        </tr>

    
    </tbody>
</table>


        </div>
    

        <h3 class="subsection-title">Extends</h3>

        
    <ul>
        <li>EventEmitter</li>
    </ul>


        <h3 class="subsection-title">Members</h3>

        
<h4 class="name" id=".load_balance_methods"><span class="type-signature">(static, readonly) </span>load_balance_methods<span class="type-signature"> :function</span></h4>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="TorPool.js.html">TorPool.js</a>, <a href="TorPool.js.html#line350">line 350</a>
    </li></ul></dd>
    

</dl>


<div class="description">
    Returns an enumeration of load balance methods as functions
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">function</span>


        </li>
    </ul>


<h4 class="name" id="data_directory"><span class="type-signature"></span>data_directory<span class="type-signature"> :string</span></h4>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="TorPool.js.html">TorPool.js</a>, <a href="TorPool.js.html#line63">line 63</a>
    </li></ul></dd>
    

</dl>


<div class="description">
    Parent directory for the data directory of each proccess.
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">string</span>


        </li>
    </ul>


<h4 class="name" id="default_tor_config"><span class="type-signature"></span>default_tor_config<span class="type-signature"> :Object|function</span></h4>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="TorPool.js.html">TorPool.js</a>, <a href="TorPool.js.html#line327">line 327</a>
    </li></ul></dd>
    

</dl>


<div class="description">
    Getter
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Object</span>
|

<span class="param-type">function</span>


        </li>
    </ul>


<h4 class="name" id="default_tor_config"><span class="type-signature"></span>default_tor_config<span class="type-signature"></span></h4>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="TorPool.js.html">TorPool.js</a>, <a href="TorPool.js.html#line341">line 341</a>
    </li></ul></dd>
    

</dl>


<div class="description">
    Setter
</div>


<h4 class="name" id="granax_options"><span class="type-signature"></span>granax_options<span class="type-signature"> :Logger</span></h4>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="TorPool.js.html">TorPool.js</a>, <a href="TorPool.js.html#line91">line 91</a>
    </li></ul></dd>
    

</dl>


<div class="description">
    Object containing options that will be passed to granax for each instance.
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Logger</span>


        </li>
    </ul>


<h4 class="name" id="group_names"><span class="type-signature">(readonly) </span>group_names<span class="type-signature"> :Set.&lt;string></span></h4>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="TorPool.js.html">TorPool.js</a>, <a href="TorPool.js.html#line100">line 100</a>
    </li></ul></dd>
    

</dl>


<div class="description">
    Returns a Set containing the names of all of the groups.
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Set.&lt;string></span>


        </li>
    </ul>


<h4 class="name" id="groups"><span class="type-signature">(readonly) </span>groups<span class="type-signature"> :<a href="global.html#InstanceGroupCollection">InstanceGroupCollection</a></span></h4>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="TorPool.js.html">TorPool.js</a>, <a href="TorPool.js.html#line238">line 238</a>
    </li></ul></dd>
    

</dl>


<div class="description">
    Represents all groups currently in the pool.
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><a href="global.html#InstanceGroupCollection">InstanceGroupCollection</a></span>


        </li>
    </ul>


<h4 class="name" id="instance_names"><span class="type-signature">(readonly) </span>instance_names<span class="type-signature"> :<a href="Array.html">Array</a>.&lt;string></span></h4>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="TorPool.js.html">TorPool.js</a>, <a href="TorPool.js.html#line386">line 386</a>
    </li></ul></dd>
    

</dl>


<div class="description">
    An array containing the names of the instances in the pool.
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><a href="Array.html">Array</a>.&lt;string></span>


        </li>
    </ul>


<h4 class="name" id="instances"><span class="type-signature">(readonly) </span>instances<span class="type-signature"> :<a href="Array.html">Array</a>.&lt;<a href="TorProcess.html">TorProcess</a>></span></h4>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="TorPool.js.html">TorPool.js</a>, <a href="TorPool.js.html#line376">line 376</a>
    </li></ul></dd>
    

</dl>


<div class="description">
    An array containing all instances in the pool.
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><a href="Array.html">Array</a>.&lt;<a href="TorProcess.html">TorProcess</a>></span>


        </li>
    </ul>


<h4 class="name" id="load_balance_method"><span class="type-signature"></span>load_balance_method<span class="type-signature"> :string</span></h4>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="TorPool.js.html">TorPool.js</a>, <a href="TorPool.js.html#line70">line 70</a>
    </li></ul></dd>
    

</dl>


<div class="description">
    Name of the load balance method to use.
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">string</span>


        </li>
    </ul>


<h4 class="name" id="logger"><span class="type-signature"></span>logger<span class="type-signature"> :Logger</span></h4>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="TorPool.js.html">TorPool.js</a>, <a href="TorPool.js.html#line84">line 84</a>
    </li></ul></dd>
    

</dl>


<div class="description">
    The winston logger.
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Logger</span>


        </li>
    </ul>


<h4 class="name" id="tor_path"><span class="type-signature"></span>tor_path<span class="type-signature"> :string</span></h4>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="TorPool.js.html">TorPool.js</a>, <a href="TorPool.js.html#line77">line 77</a>
    </li></ul></dd>
    

</dl>


<div class="description">
    Path to the Tor executable.
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">string</span>


        </li>
    </ul>


        <h3 class="subsection-title">Methods</h3>

        
    <h4 class="name" id="add"><span class="type-signature">(async) </span>add<span class="signature">(instance_definitions)</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="Array.html">Array</a>.&lt;<a href="TorProcess.html">TorProcess</a>>>}</span></h4>

    
<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="TorPool.js.html">TorPool.js</a>, <a href="TorPool.js.html#line443">line 443</a>
    </li></ul></dd>
    

</dl>


<div class="description">
    Adds one or more instances to the pool from an array of definitions or single definition.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>instance_definitions</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="Array.html">Array</a>.&lt;<a href="global.html#InstanceDefinition">InstanceDefinition</a>></span>
|

<span class="param-type"><a href="global.html#InstanceDefinition">InstanceDefinition</a></span>


            </td>

            
            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>


<h5>Throws:</h5>

        
    <div class="param-desc">
    
        If `instance_definitions` is falsy.
    
    </div>


<h5>Returns:</h5>

        
<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise.&lt;<a href="Array.html">Array</a>.&lt;<a href="TorProcess.html">TorProcess</a>>></span>


    </dd>
</dl>

    
    <h4 class="name" id="add_instance_to_group"><span class="type-signature"></span>add_instance_to_group<span class="signature">(group, instance)</span><span class="type-signature"></span></h4>

    
<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="TorPool.js.html">TorPool.js</a>, <a href="TorPool.js.html#line132">line 132</a>
    </li></ul></dd>
    

</dl>


<div class="description">
    Adds an instance to a group. If the group doesn't exist it will be created.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>group</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">The group to add the instance to.</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>instance</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="TorProcess.html">TorProcess</a></span>


            </td>

            
            <td class="description last">The instance in question.</td>
        </tr>

    
    </tbody>
</table>


    <h4 class="name" id="add_instance_to_group_at"><span class="type-signature"></span>add_instance_to_group_at<span class="signature">(group, instance_index)</span><span class="type-signature"></span></h4>

    
<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="TorPool.js.html">TorPool.js</a>, <a href="TorPool.js.html#line160">line 160</a>
    </li></ul></dd>
    

</dl>


<div class="description">
    Adds an instance to a group by the index of the instance in the pool. If the group doesn't exist it will be created.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>group</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">The group to add the instance to.</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>instance_index</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            </td>

            
            <td class="description last">The index of the instance in question.</td>
        </tr>

    
    </tbody>
</table>


<h5>Throws:</h5>

        
    <div class="param-desc">
    
        If an instance with the index provided does not exist.
    
    </div>


    <h4 class="name" id="add_instance_to_group_by_name"><span class="type-signature"></span>add_instance_to_group_by_name<span class="signature">(group, instance_name)</span><span class="type-signature"></span></h4>

    
<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="TorPool.js.html">TorPool.js</a>, <a href="TorPool.js.html#line144">line 144</a>
    </li></ul></dd>
    

</dl>


<div class="description">
    Adds an instance to a group by the <a href="TorProcess.html#instance_name">TorProcess#instance_name</a> property on the instance. If the group doesn't exist it will be created.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>group</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">The group to add the instance to.</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>instance_name</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">The name of the instance in question.</td>
        </tr>

    
    </tbody>
</table>


<h5>Throws:</h5>

        
    <div class="param-desc">
    
        If an instance with the name provided does not exist
    
    </div>


    <h4 class="name" id="create"><span class="type-signature">(async) </span>create<span class="signature">(instance_definitions)</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="Array.html">Array</a>.&lt;<a href="TorProcess.html">TorProcess</a>>>}</span></h4>

    
<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="TorPool.js.html">TorPool.js</a>, <a href="TorPool.js.html#line459">line 459</a>
    </li></ul></dd>
    

</dl>


<div class="description">
    Creates one or more instances to the pool from either an array of definitions, a single definition or a number.
If a number is provided it will create n instances with empty definitions (e.g. `TorPool.create(5)` will create 5 instances).
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>instance_definitions</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="Array.html">Array</a>.&lt;<a href="global.html#InstanceDefinition">InstanceDefinition</a>></span>
|

<span class="param-type"><a href="global.html#InstanceDefinition">InstanceDefinition</a></span>
|

<span class="param-type">number</span>


            </td>

            
            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>


<h5>Throws:</h5>

        
    <div class="param-desc">
    
        If `instances` is falsy.
    
    </div>


<h5>Returns:</h5>

        
<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise.&lt;<a href="Array.html">Array</a>.&lt;<a href="TorProcess.html">TorProcess</a>>></span>


    </dd>
</dl>

    
    <h4 class="name" id="create_instance"><span class="type-signature">(async) </span>create_instance<span class="signature">(instance_definition<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="TorProcess.html">TorProcess</a>>}</span></h4>

    
<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="TorPool.js.html">TorPool.js</a>, <a href="TorPool.js.html#line400">line 400</a>
    </li></ul></dd>
    

</dl>


<div class="description">
    Creates an instance then adds it to the pool from the provided definiton. 
Instance will be added (and Promise will resolve) after the instance is fully bootstrapped.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>instance_definition</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="global.html#InstanceDefinition">InstanceDefinition</a></span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                    <code>{}</code>
                
                </td>
            

            <td class="description last">Instance definition that will be used to create the instance.</td>
        </tr>

    
    </tbody>
</table>


<h5>Throws:</h5>

        
    <div class="param-desc">
    
        If an instance with the same InstanceDefinition#Name already exists.
    
    </div>


<h5>Returns:</h5>

        
<div class="param-desc">
    - The instance that was created.
</div>


<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise.&lt;<a href="TorProcess.html">TorProcess</a>></span>


    </dd>
</dl>

    
    <h4 class="name" id="exit"><span class="type-signature">(async) </span>exit<span class="signature">()</span><span class="type-signature"> &rarr; {Promise}</span></h4>

    
<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="TorPool.js.html">TorPool.js</a>, <a href="TorPool.js.html#line561">line 561</a>
    </li></ul></dd>
    

</dl>


<div class="description">
    Kills the Tor processes of all instances in the pool.
</div>


<h5>Returns:</h5>

        
<div class="param-desc">
    - Resolves when all instances have been killed.
</div>


<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>


    </dd>
</dl>

    
    <h4 class="name" id="get_config_at"><span class="type-signature">(async) </span>get_config_at<span class="signature">(index, keyword)</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="Array.html">Array</a>.&lt;string>>}</span></h4>

    
<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="TorPool.js.html">TorPool.js</a>, <a href="TorPool.js.html#line663">line 663</a>
    </li></ul></dd>
    

</dl>


<div class="description">
    Get a configuration value from the instance at the index in the pool via the control protocol.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>index</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            </td>

            
            <td class="description last">Index of the instance in the pool.</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>keyword</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">Name of the configuration property.</td>
        </tr>

    
    </tbody>
</table>


<h5>Throws:</h5>

        
    <div class="param-desc">
    
        When no instance exists at the provided index.
    
    </div>


<h5>Returns:</h5>

        
<div class="param-desc">
    - The configuration property's value.
</div>


<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise.&lt;<a href="Array.html">Array</a>.&lt;string>></span>


    </dd>
</dl>

    
    <h4 class="name" id="get_config_by_name"><span class="type-signature">(async) </span>get_config_by_name<span class="signature">(name, keyword)</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="Array.html">Array</a>.&lt;string>>}</span></h4>

    
<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="TorPool.js.html">TorPool.js</a>, <a href="TorPool.js.html#line626">line 626</a>
    </li></ul></dd>
    

</dl>


<div class="description">
    Get a configuration value from the instance whose TorProcess.instance_name matches the provided name via the control protocol.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>name</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">Name of the instance.</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>keyword</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">Name of the configuration property.</td>
        </tr>

    
    </tbody>
</table>


<h5>Throws:</h5>

        
    <div class="param-desc">
    
        When no instance matched the provided name.
    
    </div>


<h5>Returns:</h5>

        
<div class="param-desc">
    - The configuration property's value.
</div>


<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise.&lt;<a href="Array.html">Array</a>.&lt;string>></span>


    </dd>
</dl>

    
    <h4 class="name" id="instance_at"><span class="type-signature"></span>instance_at<span class="signature">(index)</span><span class="type-signature"> &rarr; {<a href="TorProcess.html">TorProcess</a>}</span></h4>

    
<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="TorPool.js.html">TorPool.js</a>, <a href="TorPool.js.html#line484">line 484</a>
    </li></ul></dd>
    

</dl>


<div class="description">
    Returns the instance located at the provided index in the pool. 
Is equivalent to `<a href="TorPool.html#instances">TorPool#instances</a>[index]`
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>index</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            </td>

            
            <td class="description last">Index of the instance in the pool</td>
        </tr>

    
    </tbody>
</table>


<h5>Returns:</h5>

        
<div class="param-desc">
    - Matching instance
</div>


<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="TorProcess.html">TorProcess</a></span>


    </dd>
</dl>

    
    <h4 class="name" id="instance_by_name"><span class="type-signature"></span>instance_by_name<span class="signature">(name)</span><span class="type-signature"> &rarr; {<a href="TorProcess.html">TorProcess</a>}</span></h4>

    
<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="TorPool.js.html">TorPool.js</a>, <a href="TorPool.js.html#line474">line 474</a>
    </li></ul></dd>
    

</dl>


<div class="description">
    Searches for an instance with the matching <a href="TorProcess.html#instance_name">TorProcess#instance_name</a> property.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>name</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">Name of the instance to search for</td>
        </tr>

    
    </tbody>
</table>


<h5>Returns:</h5>

        
<div class="param-desc">
    - Matching instance
</div>


<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="TorProcess.html">TorProcess</a></span>


    </dd>
</dl>

    
    <h4 class="name" id="instances_by_group"><span class="type-signature"></span>instances_by_group<span class="signature">(group_name)</span><span class="type-signature"> &rarr; {<a href="Array.html">Array</a>.&lt;string>}</span></h4>

    
<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="TorPool.js.html">TorPool.js</a>, <a href="TorPool.js.html#line112">line 112</a>
    </li></ul></dd>
    

</dl>


<div class="description">
    Returns an array containing all of the instances in a group.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>group_name</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">The group to query.</td>
        </tr>

    
    </tbody>
</table>


<h5>Throws:</h5>

        
    <div class="param-desc">
    
        If the provided group does not exist
    
    </div>


<h5>Returns:</h5>

        
<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Array.html">Array</a>.&lt;string></span>


    </dd>
</dl>

    
    <h4 class="name" id="new_identites"><span class="type-signature">(async) </span>new_identites<span class="signature">()</span><span class="type-signature"> &rarr; {Promise}</span></h4>

    
<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="TorPool.js.html">TorPool.js</a>, <a href="TorPool.js.html#line572">line 572</a>
    </li></ul></dd>
    

</dl>


<div class="description">
    Gets new identities for all instances in the pool.
</div>


<h5>Returns:</h5>

        
<div class="param-desc">
    - Resolves when all instances have new identities.
</div>


<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>


    </dd>
</dl>

    
    <h4 class="name" id="new_identites_by_group"><span class="type-signature">(async) </span>new_identites_by_group<span class="signature">(group)</span><span class="type-signature"> &rarr; {Promise}</span></h4>

    
<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="TorPool.js.html">TorPool.js</a>, <a href="TorPool.js.html#line583">line 583</a>
    </li></ul></dd>
    

</dl>


<div class="description">
    Gets new identities for all instances in a group.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>group</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">Name of the group.</td>
        </tr>

    
    </tbody>
</table>


<h5>Returns:</h5>

        
<div class="param-desc">
    - Resolves when all instances in the group have new identities.
</div>


<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>


    </dd>
</dl>

    
    <h4 class="name" id="new_identity_at"><span class="type-signature">(async) </span>new_identity_at<span class="signature">(index)</span><span class="type-signature"> &rarr; {Promise}</span></h4>

    
<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="TorPool.js.html">TorPool.js</a>, <a href="TorPool.js.html#line594">line 594</a>
    </li></ul></dd>
    

</dl>


<div class="description">
    Gets a new identity for the instance at the provided index in the pool.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>index</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            </td>

            
            <td class="description last">Index of the instance in the pool.</td>
        </tr>

    
    </tbody>
</table>


<h5>Returns:</h5>

        
<div class="param-desc">
    - Resolves when the instance has a new identity.
</div>


<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>


    </dd>
</dl>

    
    <h4 class="name" id="new_identity_by_name"><span class="type-signature">(async) </span>new_identity_by_name<span class="signature">(name)</span><span class="type-signature"> &rarr; {Promise}</span></h4>

    
<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="TorPool.js.html">TorPool.js</a>, <a href="TorPool.js.html#line607">line 607</a>
    </li></ul></dd>
    

</dl>


<div class="description">
    Gets a new identity for the instance whose TorProcess.instance_name matches the provided name.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>name</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">Name of the instance.</td>
        </tr>

    
    </tbody>
</table>


<h5>Throws:</h5>

        
    <div class="param-desc">
    
        When no instance matched the provided name.
    
    </div>


<h5>Returns:</h5>

        
<div class="param-desc">
    - Resolves when the instance has a new identity.
</div>


<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>


    </dd>
</dl>

    
    <h4 class="name" id="next"><span class="type-signature"></span>next<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="TorProcess.html">TorProcess</a>}</span></h4>

    
<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="TorPool.js.html">TorPool.js</a>, <a href="TorPool.js.html#line536">line 536</a>
    </li></ul></dd>
    

</dl>


<div class="description">
    Runs the load balance function (<a href="TorPool.html#load_balance_method">TorPool#load_balance_method</a>) on the array of instances in the pool and returns the first instance in the array.
</div>


<h5>Returns:</h5>

        
<div class="param-desc">
    - The first instance in the modified array.
</div>


<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="TorProcess.html">TorProcess</a></span>


    </dd>
</dl>

    
    <h4 class="name" id="next_by_group"><span class="type-signature"></span>next_by_group<span class="signature">(group)</span><span class="type-signature"> &rarr; {<a href="TorProcess.html">TorProcess</a>}</span></h4>

    
<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="TorPool.js.html">TorPool.js</a>, <a href="TorPool.js.html#line549">line 549</a>
    </li></ul></dd>
    

    <dt class="tag-todo">To Do:</dt>
    <dd class="tag-todo">
        <ul>
            <li>Load balance methods other than "round_robin" to be used</li>
        </ul>
    </dd>
    
</dl>


<div class="description">
    Rotates the array containing instances in the group provided so that the second element becomes the first element and the first element becomes the last element.
[1,2,3] -> [2,3,1]
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>group</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">Name of the group</td>
        </tr>

    
    </tbody>
</table>


<h5>Returns:</h5>

        
<div class="param-desc">
    - The first element in the modified array
</div>


<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="TorProcess.html">TorProcess</a></span>


    </dd>
</dl>

    
    <h4 class="name" id="remove"><span class="type-signature">(async) </span>remove<span class="signature">(instances, start_at<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise}</span></h4>

    
<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="TorPool.js.html">TorPool.js</a>, <a href="TorPool.js.html#line495">line 495</a>
    </li></ul></dd>
    

</dl>


<div class="description">
    Removes a number of instances from the pool and kills their Tor processes.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>instances</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            </td>

            
                <td class="attributes">
                

                </td>
            

                <td class="default">
                
                </td>
            

            <td class="description last">Number of instances to remove</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>start_at</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                    <code>0</code>
                
                </td>
            

            <td class="description last">Index to start removing from</td>
        </tr>

    
    </tbody>
</table>


<h5>Returns:</h5>

        
<div class="param-desc">
    - Promise will resolve when the processes are dead
</div>


<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>


    </dd>
</dl>

    
    <h4 class="name" id="remove_at"><span class="type-signature">(async) </span>remove_at<span class="signature">(instance_index)</span><span class="type-signature"> &rarr; {Promise}</span></h4>

    
<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="TorPool.js.html">TorPool.js</a>, <a href="TorPool.js.html#line507">line 507</a>
    </li></ul></dd>
    

</dl>


<div class="description">
    Removes an instance at the provided index and kills its Tor process.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>instance_index</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            </td>

            
            <td class="description last">Index of the instance to remove</td>
        </tr>

    
    </tbody>
</table>


<h5>Returns:</h5>

        
<div class="param-desc">
    - Promise will resolve when the process is dead
</div>


<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>


    </dd>
</dl>

    
    <h4 class="name" id="remove_by_name"><span class="type-signature">(async) </span>remove_by_name<span class="signature">(instance_name)</span><span class="type-signature"> &rarr; {Promise}</span></h4>

    
<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="TorPool.js.html">TorPool.js</a>, <a href="TorPool.js.html#line523">line 523</a>
    </li></ul></dd>
    

</dl>


<div class="description">
    Removes an instance whose <a href="TorProcess.html#instance_name">TorProcess#instance_name</a> property matches the provided name and kills its Tor process.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>instance_name</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">Name of the instance to remove</td>
        </tr>

    
    </tbody>
</table>


<h5>Returns:</h5>

        
<div class="param-desc">
    - Promise will resolve when the process is dead
</div>


<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>


    </dd>
</dl>

    
    <h4 class="name" id="remove_instance_from_group"><span class="type-signature"></span>remove_instance_from_group<span class="signature">(group, instance)</span><span class="type-signature"></span></h4>

    
<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="TorPool.js.html">TorPool.js</a>, <a href="TorPool.js.html#line174">line 174</a>
    </li></ul></dd>
    

</dl>


<div class="description">
    Removes an instance from a group.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>group</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">The group to remove the instance from.</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>instance</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="TorProcess.html">TorProcess</a></span>


            </td>

            
            <td class="description last">The instance in question.</td>
        </tr>

    
    </tbody>
</table>


    <h4 class="name" id="remove_instance_from_group_at"><span class="type-signature"></span>remove_instance_from_group_at<span class="signature">(group, instance_index)</span><span class="type-signature"></span></h4>

    
<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="TorPool.js.html">TorPool.js</a>, <a href="TorPool.js.html#line202">line 202</a>
    </li></ul></dd>
    

</dl>


<div class="description">
    Removes an instance from a group by the index of the instance in the pool.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>group</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">The group to remove the instance from.</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>instance_index</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            </td>

            
            <td class="description last">The index of the instance in question.</td>
        </tr>

    
    </tbody>
</table>


<h5>Throws:</h5>

        
    <div class="param-desc">
    
        If an instance with the index provided does not exist.
    
    </div>


    <h4 class="name" id="remove_instance_from_group_by_name"><span class="type-signature"></span>remove_instance_from_group_by_name<span class="signature">(group, instance_name)</span><span class="type-signature"></span></h4>

    
<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="TorPool.js.html">TorPool.js</a>, <a href="TorPool.js.html#line186">line 186</a>
    </li></ul></dd>
    

</dl>


<div class="description">
    Removes an instance from a group by the <a href="TorProcess.html#instance_name">TorProcess#instance_name</a> property on the instance.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>group</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">The group to remove the instance from.</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>instance_name</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">The name of the instance in question.</td>
        </tr>

    
    </tbody>
</table>


<h5>Throws:</h5>

        
    <div class="param-desc">
    
        If an instance with the name provided does not exist.
    
    </div>


    <h4 class="name" id="set_config_all"><span class="type-signature">(async) </span>set_config_all<span class="signature">(keyword, value)</span><span class="type-signature"> &rarr; {Promise}</span></h4>

    
<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="TorPool.js.html">TorPool.js</a>, <a href="TorPool.js.html#line713">line 713</a>
    </li></ul></dd>
    

</dl>


<div class="description">
    Set a configuration value for all instances in the pool via the control protocol.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>keyword</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">Name of the configuration property.</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>value</code></td>
            

            <td class="type">
            
                
<span class="param-type">any</span>


            </td>

            
            <td class="description last">Value to set the configuration property to.</td>
        </tr>

    
    </tbody>
</table>


<h5>Returns:</h5>

        
<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>


    </dd>
</dl>

    
    <h4 class="name" id="set_config_at"><span class="type-signature">(async) </span>set_config_at<span class="signature">(index, keyword, value)</span><span class="type-signature"> &rarr; {Promise}</span></h4>

    
<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="TorPool.js.html">TorPool.js</a>, <a href="TorPool.js.html#line682">line 682</a>
    </li></ul></dd>
    

</dl>


<div class="description">
    Set a configuration value for the instance at the index in the pool via the control protocol.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>index</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            </td>

            
            <td class="description last">Index of the instance in the pool.</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>keyword</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">Name of the configuration property.</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>value</code></td>
            

            <td class="type">
            
                
<span class="param-type">any</span>


            </td>

            
            <td class="description last">Value to set the configuration property to.</td>
        </tr>

    
    </tbody>
</table>


<h5>Throws:</h5>

        
    <div class="param-desc">
    
        When no instance exists at the provided index.
    
    </div>


<h5>Returns:</h5>

        
<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>


    </dd>
</dl>

    
    <h4 class="name" id="set_config_by_group"><span class="type-signature">(async) </span>set_config_by_group<span class="signature">(group, keyword, value)</span><span class="type-signature"> &rarr; {Promise}</span></h4>

    
<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="TorPool.js.html">TorPool.js</a>, <a href="TorPool.js.html#line700">line 700</a>
    </li></ul></dd>
    

</dl>


<div class="description">
    Set a configuration value for all instances in the provided group via the control protocol.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>group</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">Name of the group.</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>keyword</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">Name of the configuration property.</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>value</code></td>
            

            <td class="type">
            
                
<span class="param-type">any</span>


            </td>

            
            <td class="description last">Value to set the configuration property to.</td>
        </tr>

    
    </tbody>
</table>


<h5>Throws:</h5>

        
    <div class="param-desc">
    
        When the provided group does not exist.
    
    </div>


<h5>Returns:</h5>

        
<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>


    </dd>
</dl>

    
    <h4 class="name" id="set_config_by_name"><span class="type-signature">(async) </span>set_config_by_name<span class="signature">(name, keyword, value)</span><span class="type-signature"> &rarr; {Promise}</span></h4>

    
<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="TorPool.js.html">TorPool.js</a>, <a href="TorPool.js.html#line645">line 645</a>
    </li></ul></dd>
    

</dl>


<div class="description">
    Set a configuration value for the instance whose TorProcess.instance_name matches the provided name via the control protocol.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>name</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">Name of the instance.</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>keyword</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">Name of the configuration property.</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>value</code></td>
            

            <td class="type">
            
                
<span class="param-type">any</span>


            </td>

            
            <td class="description last">Value to set the configuration property to.</td>
        </tr>

    
    </tbody>
</table>


<h5>Throws:</h5>

        
    <div class="param-desc">
    
        When no instance matched the provided name.
    
    </div>


<h5>Returns:</h5>

        
<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>


    </dd>
</dl>

    
    <h4 class="name" id="signal_all"><span class="type-signature">(async) </span>signal_all<span class="signature">(signal)</span><span class="type-signature"> &rarr; {Promise}</span></h4>

    
<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="TorPool.js.html">TorPool.js</a>, <a href="TorPool.js.html#line725">line 725</a>
    </li></ul></dd>
    

</dl>


<div class="description">
    Send a signal via the control protocol to all instances in the pool.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>signal</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">The signal to send.</td>
        </tr>

    
    </tbody>
</table>


<h5>Returns:</h5>

        
<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>


    </dd>
</dl>

    
    <h4 class="name" id="signal_at"><span class="type-signature">(async) </span>signal_at<span class="signature">(index, signal)</span><span class="type-signature"> &rarr; {Promise}</span></h4>

    
<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="TorPool.js.html">TorPool.js</a>, <a href="TorPool.js.html#line755">line 755</a>
    </li></ul></dd>
    

</dl>


<div class="description">
    Send a signal via the control protocol to an instance at the provided index in the pool.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>index</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            </td>

            
            <td class="description last">Index of the instance in the pool.</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>signal</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">The signal to send.</td>
        </tr>

    
    </tbody>
</table>


<h5>Returns:</h5>

        
<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>


    </dd>
</dl>

    
    <h4 class="name" id="signal_by_group"><span class="type-signature">(async) </span>signal_by_group<span class="signature">(group, signal)</span><span class="type-signature"> &rarr; {Promise}</span></h4>

    
<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="TorPool.js.html">TorPool.js</a>, <a href="TorPool.js.html#line773">line 773</a>
    </li></ul></dd>
    

</dl>


<div class="description">
    Send a signal via the control protocol to all instances in the provided group.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>group</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">Name of the group.</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>signal</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">The signal to send.</td>
        </tr>

    
    </tbody>
</table>


<h5>Throws:</h5>

        
    <div class="param-desc">
    
        When the provided group does not exist.
    
    </div>


<h5>Returns:</h5>

        
<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>


    </dd>
</dl>

    
    <h4 class="name" id="signal_by_name"><span class="type-signature">(async) </span>signal_by_name<span class="signature">(name, signal)</span><span class="type-signature"> &rarr; {Promise}</span></h4>

    
<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="TorPool.js.html">TorPool.js</a>, <a href="TorPool.js.html#line738">line 738</a>
    </li></ul></dd>
    

</dl>


<div class="description">
    Send a signal via the control protocol to an instance whose <a href="TorProcess.html#instance_name">TorProcess#instance_name</a> property matches the provided name.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>name</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">Name of the instance.</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>signal</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">The signal to send.</td>
        </tr>

    
    </tbody>
</table>


<h5>Returns:</h5>

        
<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>


    </dd>
</dl>

    
        <h3 class="subsection-title">Events</h3>

        
    <h4 class="name" id="event:instance_created">instance_created</h4>

    
<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="TorPool.js.html">TorPool.js</a>, <a href="TorPool.js.html#line422">line 422</a>
    </li></ul></dd>
    

</dl>


<div class="description">
    Fires when an instance has been created.
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><a href="TorProcess.html">TorProcess</a></span>


        </li>
    </ul>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>instance</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="TorProcess.html">TorProcess</a></span>


            </td>

            
            <td class="description last">The instance that was created.</td>
        </tr>

    
    </tbody>
</table>


</article>

</section>


</div>

<br class="clear">

<footer>
    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Sep 25 2018 12:53:23 GMT-0400 (Eastern Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
</footer>

<script>prettyPrint();</script>
<script src="scripts/linenumber.js"></script>


</body>
</html>