GCDAsyncUdpSocket.m 135 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517
  1. //
  2. // GCDAsyncUdpSocket
  3. //
  4. // This class is in the public domain.
  5. // Originally created by Robbie Hanson of Deusty LLC.
  6. // Updated and maintained by Deusty LLC and the Apple development community.
  7. //
  8. // https://github.com/robbiehanson/CocoaAsyncSocket
  9. //
  10. #import "GCDAsyncUdpSocket.h"
  11. #if ! __has_feature(objc_arc)
  12. #warning This file must be compiled with ARC. Use -fobjc-arc flag (or convert project to ARC).
  13. // For more information see: https://github.com/robbiehanson/CocoaAsyncSocket/wiki/ARC
  14. #endif
  15. #if TARGET_OS_IPHONE
  16. #import <CFNetwork/CFNetwork.h>
  17. #import <UIKit/UIKit.h>
  18. #endif
  19. #import <arpa/inet.h>
  20. #import <fcntl.h>
  21. #import <ifaddrs.h>
  22. #import <netdb.h>
  23. #import <net/if.h>
  24. #import <sys/socket.h>
  25. #import <sys/types.h>
  26. #if 0
  27. // Logging Enabled - See log level below
  28. // Logging uses the CocoaLumberjack framework (which is also GCD based).
  29. // https://github.com/robbiehanson/CocoaLumberjack
  30. //
  31. // It allows us to do a lot of logging without significantly slowing down the code.
  32. #import "DDLog.h"
  33. #define LogAsync NO
  34. #define LogContext 65535
  35. #define LogObjc(flg, frmt, ...) LOG_OBJC_MAYBE(LogAsync, logLevel, flg, LogContext, frmt, ##__VA_ARGS__)
  36. #define LogC(flg, frmt, ...) LOG_C_MAYBE(LogAsync, logLevel, flg, LogContext, frmt, ##__VA_ARGS__)
  37. #define LogError(frmt, ...) LogObjc(LOG_FLAG_ERROR, (@"%@: " frmt), THIS_FILE, ##__VA_ARGS__)
  38. #define LogWarn(frmt, ...) LogObjc(LOG_FLAG_WARN, (@"%@: " frmt), THIS_FILE, ##__VA_ARGS__)
  39. #define LogInfo(frmt, ...) LogObjc(LOG_FLAG_INFO, (@"%@: " frmt), THIS_FILE, ##__VA_ARGS__)
  40. #define LogVerbose(frmt, ...) LogObjc(LOG_FLAG_VERBOSE, (@"%@: " frmt), THIS_FILE, ##__VA_ARGS__)
  41. #define LogCError(frmt, ...) LogC(LOG_FLAG_ERROR, (@"%@: " frmt), THIS_FILE, ##__VA_ARGS__)
  42. #define LogCWarn(frmt, ...) LogC(LOG_FLAG_WARN, (@"%@: " frmt), THIS_FILE, ##__VA_ARGS__)
  43. #define LogCInfo(frmt, ...) LogC(LOG_FLAG_INFO, (@"%@: " frmt), THIS_FILE, ##__VA_ARGS__)
  44. #define LogCVerbose(frmt, ...) LogC(LOG_FLAG_VERBOSE, (@"%@: " frmt), THIS_FILE, ##__VA_ARGS__)
  45. #define LogTrace() LogObjc(LOG_FLAG_VERBOSE, @"%@: %@", THIS_FILE, THIS_METHOD)
  46. #define LogCTrace() LogC(LOG_FLAG_VERBOSE, @"%@: %s", THIS_FILE, __FUNCTION__)
  47. // Log levels : off, error, warn, info, verbose
  48. static const int logLevel = LOG_LEVEL_VERBOSE;
  49. #else
  50. // Logging Disabled
  51. #define LogError(frmt, ...) {}
  52. #define LogWarn(frmt, ...) {}
  53. #define LogInfo(frmt, ...) {}
  54. #define LogVerbose(frmt, ...) {}
  55. #define LogCError(frmt, ...) {}
  56. #define LogCWarn(frmt, ...) {}
  57. #define LogCInfo(frmt, ...) {}
  58. #define LogCVerbose(frmt, ...) {}
  59. #define LogTrace() {}
  60. #define LogCTrace(frmt, ...) {}
  61. #endif
  62. /**
  63. * Seeing a return statements within an inner block
  64. * can sometimes be mistaken for a return point of the enclosing method.
  65. * This makes inline blocks a bit easier to read.
  66. **/
  67. #define return_from_block return
  68. /**
  69. * A socket file descriptor is really just an integer.
  70. * It represents the index of the socket within the kernel.
  71. * This makes invalid file descriptor comparisons easier to read.
  72. **/
  73. #define SOCKET_NULL -1
  74. /**
  75. * Just to type less code.
  76. **/
  77. #define AutoreleasedBlock(block) ^{ @autoreleasepool { block(); }}
  78. @class GCDAsyncUdpSendPacket;
  79. NSString *const GCDAsyncUdpSocketException = @"GCDAsyncUdpSocketException";
  80. NSString *const GCDAsyncUdpSocketErrorDomain = @"GCDAsyncUdpSocketErrorDomain";
  81. NSString *const GCDAsyncUdpSocketQueueName = @"GCDAsyncUdpSocket";
  82. NSString *const GCDAsyncUdpSocketThreadName = @"GCDAsyncUdpSocket-CFStream";
  83. enum GCDAsyncUdpSocketFlags
  84. {
  85. kDidCreateSockets = 1 << 0, // If set, the sockets have been created.
  86. kDidBind = 1 << 1, // If set, bind has been called.
  87. kConnecting = 1 << 2, // If set, a connection attempt is in progress.
  88. kDidConnect = 1 << 3, // If set, socket is connected.
  89. kReceiveOnce = 1 << 4, // If set, one-at-a-time receive is enabled
  90. kReceiveContinuous = 1 << 5, // If set, continuous receive is enabled
  91. kIPv4Deactivated = 1 << 6, // If set, socket4 was closed due to bind or connect on IPv6.
  92. kIPv6Deactivated = 1 << 7, // If set, socket6 was closed due to bind or connect on IPv4.
  93. kSend4SourceSuspended = 1 << 8, // If set, send4Source is suspended.
  94. kSend6SourceSuspended = 1 << 9, // If set, send6Source is suspended.
  95. kReceive4SourceSuspended = 1 << 10, // If set, receive4Source is suspended.
  96. kReceive6SourceSuspended = 1 << 11, // If set, receive6Source is suspended.
  97. kSock4CanAcceptBytes = 1 << 12, // If set, we know socket4 can accept bytes. If unset, it's unknown.
  98. kSock6CanAcceptBytes = 1 << 13, // If set, we know socket6 can accept bytes. If unset, it's unknown.
  99. kForbidSendReceive = 1 << 14, // If set, no new send or receive operations are allowed to be queued.
  100. kCloseAfterSends = 1 << 15, // If set, close as soon as no more sends are queued.
  101. kFlipFlop = 1 << 16, // Used to alternate between IPv4 and IPv6 sockets.
  102. #if TARGET_OS_IPHONE
  103. kAddedStreamListener = 1 << 17, // If set, CFStreams have been added to listener thread
  104. #endif
  105. };
  106. enum GCDAsyncUdpSocketConfig
  107. {
  108. kIPv4Disabled = 1 << 0, // If set, IPv4 is disabled
  109. kIPv6Disabled = 1 << 1, // If set, IPv6 is disabled
  110. kPreferIPv4 = 1 << 2, // If set, IPv4 is preferred over IPv6
  111. kPreferIPv6 = 1 << 3, // If set, IPv6 is preferred over IPv4
  112. };
  113. ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
  114. #pragma mark -
  115. ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
  116. @interface GCDAsyncUdpSocket ()
  117. {
  118. #if __has_feature(objc_arc_weak)
  119. __weak id delegate;
  120. #else
  121. __unsafe_unretained id delegate;
  122. #endif
  123. dispatch_queue_t delegateQueue;
  124. GCDAsyncUdpSocketReceiveFilterBlock receiveFilterBlock;
  125. dispatch_queue_t receiveFilterQueue;
  126. BOOL receiveFilterAsync;
  127. GCDAsyncUdpSocketSendFilterBlock sendFilterBlock;
  128. dispatch_queue_t sendFilterQueue;
  129. BOOL sendFilterAsync;
  130. uint32_t flags;
  131. uint16_t config;
  132. uint16_t max4ReceiveSize;
  133. uint32_t max6ReceiveSize;
  134. uint16_t maxSendSize;
  135. int socket4FD;
  136. int socket6FD;
  137. dispatch_queue_t socketQueue;
  138. dispatch_source_t send4Source;
  139. dispatch_source_t send6Source;
  140. dispatch_source_t receive4Source;
  141. dispatch_source_t receive6Source;
  142. dispatch_source_t sendTimer;
  143. GCDAsyncUdpSendPacket *currentSend;
  144. NSMutableArray *sendQueue;
  145. unsigned long socket4FDBytesAvailable;
  146. unsigned long socket6FDBytesAvailable;
  147. uint32_t pendingFilterOperations;
  148. NSData *cachedLocalAddress4;
  149. NSString *cachedLocalHost4;
  150. uint16_t cachedLocalPort4;
  151. NSData *cachedLocalAddress6;
  152. NSString *cachedLocalHost6;
  153. uint16_t cachedLocalPort6;
  154. NSData *cachedConnectedAddress;
  155. NSString *cachedConnectedHost;
  156. uint16_t cachedConnectedPort;
  157. int cachedConnectedFamily;
  158. void *IsOnSocketQueueOrTargetQueueKey;
  159. #if TARGET_OS_IPHONE
  160. CFStreamClientContext streamContext;
  161. CFReadStreamRef readStream4;
  162. CFReadStreamRef readStream6;
  163. CFWriteStreamRef writeStream4;
  164. CFWriteStreamRef writeStream6;
  165. #endif
  166. id userData;
  167. }
  168. - (void)resumeSend4Source;
  169. - (void)resumeSend6Source;
  170. - (void)resumeReceive4Source;
  171. - (void)resumeReceive6Source;
  172. - (void)closeSockets;
  173. - (void)maybeConnect;
  174. - (BOOL)connectWithAddress4:(NSData *)address4 error:(NSError **)errPtr;
  175. - (BOOL)connectWithAddress6:(NSData *)address6 error:(NSError **)errPtr;
  176. - (void)maybeDequeueSend;
  177. - (void)doPreSend;
  178. - (void)doSend;
  179. - (void)endCurrentSend;
  180. - (void)setupSendTimerWithTimeout:(NSTimeInterval)timeout;
  181. - (void)doReceive;
  182. - (void)doReceiveEOF;
  183. - (void)closeWithError:(NSError *)error;
  184. - (BOOL)performMulticastRequest:(int)requestType forGroup:(NSString *)group onInterface:(NSString *)interface error:(NSError **)errPtr;
  185. #if TARGET_OS_IPHONE
  186. - (BOOL)createReadAndWriteStreams:(NSError **)errPtr;
  187. - (BOOL)registerForStreamCallbacks:(NSError **)errPtr;
  188. - (BOOL)addStreamsToRunLoop:(NSError **)errPtr;
  189. - (BOOL)openStreams:(NSError **)errPtr;
  190. - (void)removeStreamsFromRunLoop;
  191. - (void)closeReadAndWriteStreams;
  192. #endif
  193. + (NSString *)hostFromSockaddr4:(const struct sockaddr_in *)pSockaddr4;
  194. + (NSString *)hostFromSockaddr6:(const struct sockaddr_in6 *)pSockaddr6;
  195. + (uint16_t)portFromSockaddr4:(const struct sockaddr_in *)pSockaddr4;
  196. + (uint16_t)portFromSockaddr6:(const struct sockaddr_in6 *)pSockaddr6;
  197. #if TARGET_OS_IPHONE
  198. // Forward declaration
  199. + (void)listenerThread:(id)unused;
  200. #endif
  201. @end
  202. ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
  203. #pragma mark -
  204. ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
  205. /**
  206. * The GCDAsyncUdpSendPacket encompasses the instructions for a single send/write.
  207. **/
  208. @interface GCDAsyncUdpSendPacket : NSObject {
  209. @public
  210. NSData *buffer;
  211. NSTimeInterval timeout;
  212. long tag;
  213. BOOL resolveInProgress;
  214. BOOL filterInProgress;
  215. NSArray *resolvedAddresses;
  216. NSError *resolveError;
  217. NSData *address;
  218. int addressFamily;
  219. }
  220. - (instancetype)initWithData:(NSData *)d timeout:(NSTimeInterval)t tag:(long)i NS_DESIGNATED_INITIALIZER;
  221. @end
  222. @implementation GCDAsyncUdpSendPacket
  223. // Cover the superclass' designated initializer
  224. - (instancetype)init NS_UNAVAILABLE
  225. {
  226. NSAssert(0, @"Use the designated initializer");
  227. return nil;
  228. }
  229. - (instancetype)initWithData:(NSData *)d timeout:(NSTimeInterval)t tag:(long)i
  230. {
  231. if ((self = [super init]))
  232. {
  233. buffer = d;
  234. timeout = t;
  235. tag = i;
  236. resolveInProgress = NO;
  237. }
  238. return self;
  239. }
  240. @end
  241. ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
  242. #pragma mark -
  243. ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
  244. @interface GCDAsyncUdpSpecialPacket : NSObject {
  245. @public
  246. // uint8_t type;
  247. BOOL resolveInProgress;
  248. NSArray *addresses;
  249. NSError *error;
  250. }
  251. - (instancetype)init NS_DESIGNATED_INITIALIZER;
  252. @end
  253. @implementation GCDAsyncUdpSpecialPacket
  254. - (instancetype)init
  255. {
  256. self = [super init];
  257. return self;
  258. }
  259. @end
  260. ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
  261. #pragma mark -
  262. ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
  263. @implementation GCDAsyncUdpSocket
  264. - (instancetype)init
  265. {
  266. LogTrace();
  267. return [self initWithDelegate:nil delegateQueue:NULL socketQueue:NULL];
  268. }
  269. - (instancetype)initWithSocketQueue:(dispatch_queue_t)sq
  270. {
  271. LogTrace();
  272. return [self initWithDelegate:nil delegateQueue:NULL socketQueue:sq];
  273. }
  274. - (instancetype)initWithDelegate:(id<GCDAsyncUdpSocketDelegate>)aDelegate delegateQueue:(dispatch_queue_t)dq
  275. {
  276. LogTrace();
  277. return [self initWithDelegate:aDelegate delegateQueue:dq socketQueue:NULL];
  278. }
  279. - (instancetype)initWithDelegate:(id<GCDAsyncUdpSocketDelegate>)aDelegate delegateQueue:(dispatch_queue_t)dq socketQueue:(dispatch_queue_t)sq
  280. {
  281. LogTrace();
  282. if ((self = [super init]))
  283. {
  284. delegate = aDelegate;
  285. if (dq)
  286. {
  287. delegateQueue = dq;
  288. #if !OS_OBJECT_USE_OBJC
  289. dispatch_retain(delegateQueue);
  290. #endif
  291. }
  292. max4ReceiveSize = 65535;
  293. max6ReceiveSize = 65535;
  294. maxSendSize = 65535;
  295. socket4FD = SOCKET_NULL;
  296. socket6FD = SOCKET_NULL;
  297. if (sq)
  298. {
  299. NSAssert(sq != dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_LOW, 0),
  300. @"The given socketQueue parameter must not be a concurrent queue.");
  301. NSAssert(sq != dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_HIGH, 0),
  302. @"The given socketQueue parameter must not be a concurrent queue.");
  303. NSAssert(sq != dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0),
  304. @"The given socketQueue parameter must not be a concurrent queue.");
  305. socketQueue = sq;
  306. #if !OS_OBJECT_USE_OBJC
  307. dispatch_retain(socketQueue);
  308. #endif
  309. }
  310. else
  311. {
  312. socketQueue = dispatch_queue_create([GCDAsyncUdpSocketQueueName UTF8String], NULL);
  313. }
  314. // The dispatch_queue_set_specific() and dispatch_get_specific() functions take a "void *key" parameter.
  315. // From the documentation:
  316. //
  317. // > Keys are only compared as pointers and are never dereferenced.
  318. // > Thus, you can use a pointer to a static variable for a specific subsystem or
  319. // > any other value that allows you to identify the value uniquely.
  320. //
  321. // We're just going to use the memory address of an ivar.
  322. // Specifically an ivar that is explicitly named for our purpose to make the code more readable.
  323. //
  324. // However, it feels tedious (and less readable) to include the "&" all the time:
  325. // dispatch_get_specific(&IsOnSocketQueueOrTargetQueueKey)
  326. //
  327. // So we're going to make it so it doesn't matter if we use the '&' or not,
  328. // by assigning the value of the ivar to the address of the ivar.
  329. // Thus: IsOnSocketQueueOrTargetQueueKey == &IsOnSocketQueueOrTargetQueueKey;
  330. IsOnSocketQueueOrTargetQueueKey = &IsOnSocketQueueOrTargetQueueKey;
  331. void *nonNullUnusedPointer = (__bridge void *)self;
  332. dispatch_queue_set_specific(socketQueue, IsOnSocketQueueOrTargetQueueKey, nonNullUnusedPointer, NULL);
  333. currentSend = nil;
  334. sendQueue = [[NSMutableArray alloc] initWithCapacity:5];
  335. #if TARGET_OS_IPHONE
  336. [[NSNotificationCenter defaultCenter] addObserver:self
  337. selector:@selector(applicationWillEnterForeground:)
  338. name:UIApplicationWillEnterForegroundNotification
  339. object:nil];
  340. #endif
  341. }
  342. return self;
  343. }
  344. - (void)dealloc
  345. {
  346. LogInfo(@"%@ - %@ (start)", THIS_METHOD, self);
  347. #if TARGET_OS_IPHONE
  348. [[NSNotificationCenter defaultCenter] removeObserver:self];
  349. #endif
  350. if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey))
  351. {
  352. [self closeWithError:nil];
  353. }
  354. else
  355. {
  356. dispatch_sync(socketQueue, ^{
  357. [self closeWithError:nil];
  358. });
  359. }
  360. delegate = nil;
  361. #if !OS_OBJECT_USE_OBJC
  362. if (delegateQueue) dispatch_release(delegateQueue);
  363. #endif
  364. delegateQueue = NULL;
  365. #if !OS_OBJECT_USE_OBJC
  366. if (socketQueue) dispatch_release(socketQueue);
  367. #endif
  368. socketQueue = NULL;
  369. LogInfo(@"%@ - %@ (finish)", THIS_METHOD, self);
  370. }
  371. ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
  372. #pragma mark Configuration
  373. ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
  374. - (id<GCDAsyncUdpSocketDelegate>)delegate
  375. {
  376. if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey))
  377. {
  378. return delegate;
  379. }
  380. else
  381. {
  382. __block id result = nil;
  383. dispatch_sync(socketQueue, ^{
  384. result = self->delegate;
  385. });
  386. return result;
  387. }
  388. }
  389. - (void)setDelegate:(id<GCDAsyncUdpSocketDelegate>)newDelegate synchronously:(BOOL)synchronously
  390. {
  391. dispatch_block_t block = ^{
  392. self->delegate = newDelegate;
  393. };
  394. if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey)) {
  395. block();
  396. }
  397. else {
  398. if (synchronously)
  399. dispatch_sync(socketQueue, block);
  400. else
  401. dispatch_async(socketQueue, block);
  402. }
  403. }
  404. - (void)setDelegate:(id<GCDAsyncUdpSocketDelegate>)newDelegate
  405. {
  406. [self setDelegate:newDelegate synchronously:NO];
  407. }
  408. - (void)synchronouslySetDelegate:(id<GCDAsyncUdpSocketDelegate>)newDelegate
  409. {
  410. [self setDelegate:newDelegate synchronously:YES];
  411. }
  412. - (dispatch_queue_t)delegateQueue
  413. {
  414. if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey))
  415. {
  416. return delegateQueue;
  417. }
  418. else
  419. {
  420. __block dispatch_queue_t result = NULL;
  421. dispatch_sync(socketQueue, ^{
  422. result = self->delegateQueue;
  423. });
  424. return result;
  425. }
  426. }
  427. - (void)setDelegateQueue:(dispatch_queue_t)newDelegateQueue synchronously:(BOOL)synchronously
  428. {
  429. dispatch_block_t block = ^{
  430. #if !OS_OBJECT_USE_OBJC
  431. if (self->delegateQueue) dispatch_release(self->delegateQueue);
  432. if (newDelegateQueue) dispatch_retain(newDelegateQueue);
  433. #endif
  434. self->delegateQueue = newDelegateQueue;
  435. };
  436. if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey)) {
  437. block();
  438. }
  439. else {
  440. if (synchronously)
  441. dispatch_sync(socketQueue, block);
  442. else
  443. dispatch_async(socketQueue, block);
  444. }
  445. }
  446. - (void)setDelegateQueue:(dispatch_queue_t)newDelegateQueue
  447. {
  448. [self setDelegateQueue:newDelegateQueue synchronously:NO];
  449. }
  450. - (void)synchronouslySetDelegateQueue:(dispatch_queue_t)newDelegateQueue
  451. {
  452. [self setDelegateQueue:newDelegateQueue synchronously:YES];
  453. }
  454. - (void)getDelegate:(id<GCDAsyncUdpSocketDelegate> *)delegatePtr delegateQueue:(dispatch_queue_t *)delegateQueuePtr
  455. {
  456. if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey))
  457. {
  458. if (delegatePtr) *delegatePtr = delegate;
  459. if (delegateQueuePtr) *delegateQueuePtr = delegateQueue;
  460. }
  461. else
  462. {
  463. __block id dPtr = NULL;
  464. __block dispatch_queue_t dqPtr = NULL;
  465. dispatch_sync(socketQueue, ^{
  466. dPtr = self->delegate;
  467. dqPtr = self->delegateQueue;
  468. });
  469. if (delegatePtr) *delegatePtr = dPtr;
  470. if (delegateQueuePtr) *delegateQueuePtr = dqPtr;
  471. }
  472. }
  473. - (void)setDelegate:(id<GCDAsyncUdpSocketDelegate>)newDelegate delegateQueue:(dispatch_queue_t)newDelegateQueue synchronously:(BOOL)synchronously
  474. {
  475. dispatch_block_t block = ^{
  476. self->delegate = newDelegate;
  477. #if !OS_OBJECT_USE_OBJC
  478. if (self->delegateQueue) dispatch_release(self->delegateQueue);
  479. if (newDelegateQueue) dispatch_retain(newDelegateQueue);
  480. #endif
  481. self->delegateQueue = newDelegateQueue;
  482. };
  483. if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey)) {
  484. block();
  485. }
  486. else {
  487. if (synchronously)
  488. dispatch_sync(socketQueue, block);
  489. else
  490. dispatch_async(socketQueue, block);
  491. }
  492. }
  493. - (void)setDelegate:(id<GCDAsyncUdpSocketDelegate>)newDelegate delegateQueue:(dispatch_queue_t)newDelegateQueue
  494. {
  495. [self setDelegate:newDelegate delegateQueue:newDelegateQueue synchronously:NO];
  496. }
  497. - (void)synchronouslySetDelegate:(id<GCDAsyncUdpSocketDelegate>)newDelegate delegateQueue:(dispatch_queue_t)newDelegateQueue
  498. {
  499. [self setDelegate:newDelegate delegateQueue:newDelegateQueue synchronously:YES];
  500. }
  501. - (BOOL)isIPv4Enabled
  502. {
  503. // Note: YES means kIPv4Disabled is OFF
  504. __block BOOL result = NO;
  505. dispatch_block_t block = ^{
  506. result = ((self->config & kIPv4Disabled) == 0);
  507. };
  508. if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey))
  509. block();
  510. else
  511. dispatch_sync(socketQueue, block);
  512. return result;
  513. }
  514. - (void)setIPv4Enabled:(BOOL)flag
  515. {
  516. // Note: YES means kIPv4Disabled is OFF
  517. dispatch_block_t block = ^{
  518. LogVerbose(@"%@ %@", THIS_METHOD, (flag ? @"YES" : @"NO"));
  519. if (flag)
  520. self->config &= ~kIPv4Disabled;
  521. else
  522. self->config |= kIPv4Disabled;
  523. };
  524. if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey))
  525. block();
  526. else
  527. dispatch_async(socketQueue, block);
  528. }
  529. - (BOOL)isIPv6Enabled
  530. {
  531. // Note: YES means kIPv6Disabled is OFF
  532. __block BOOL result = NO;
  533. dispatch_block_t block = ^{
  534. result = ((self->config & kIPv6Disabled) == 0);
  535. };
  536. if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey))
  537. block();
  538. else
  539. dispatch_sync(socketQueue, block);
  540. return result;
  541. }
  542. - (void)setIPv6Enabled:(BOOL)flag
  543. {
  544. // Note: YES means kIPv6Disabled is OFF
  545. dispatch_block_t block = ^{
  546. LogVerbose(@"%@ %@", THIS_METHOD, (flag ? @"YES" : @"NO"));
  547. if (flag)
  548. self->config &= ~kIPv6Disabled;
  549. else
  550. self->config |= kIPv6Disabled;
  551. };
  552. if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey))
  553. block();
  554. else
  555. dispatch_async(socketQueue, block);
  556. }
  557. - (BOOL)isIPv4Preferred
  558. {
  559. __block BOOL result = NO;
  560. dispatch_block_t block = ^{
  561. result = (self->config & kPreferIPv4) ? YES : NO;
  562. };
  563. if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey))
  564. block();
  565. else
  566. dispatch_sync(socketQueue, block);
  567. return result;
  568. }
  569. - (BOOL)isIPv6Preferred
  570. {
  571. __block BOOL result = NO;
  572. dispatch_block_t block = ^{
  573. result = (self->config & kPreferIPv6) ? YES : NO;
  574. };
  575. if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey))
  576. block();
  577. else
  578. dispatch_sync(socketQueue, block);
  579. return result;
  580. }
  581. - (BOOL)isIPVersionNeutral
  582. {
  583. __block BOOL result = NO;
  584. dispatch_block_t block = ^{
  585. result = (self->config & (kPreferIPv4 | kPreferIPv6)) == 0;
  586. };
  587. if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey))
  588. block();
  589. else
  590. dispatch_sync(socketQueue, block);
  591. return result;
  592. }
  593. - (void)setPreferIPv4
  594. {
  595. dispatch_block_t block = ^{
  596. LogTrace();
  597. self->config |= kPreferIPv4;
  598. self->config &= ~kPreferIPv6;
  599. };
  600. if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey))
  601. block();
  602. else
  603. dispatch_async(socketQueue, block);
  604. }
  605. - (void)setPreferIPv6
  606. {
  607. dispatch_block_t block = ^{
  608. LogTrace();
  609. self->config &= ~kPreferIPv4;
  610. self->config |= kPreferIPv6;
  611. };
  612. if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey))
  613. block();
  614. else
  615. dispatch_async(socketQueue, block);
  616. }
  617. - (void)setIPVersionNeutral
  618. {
  619. dispatch_block_t block = ^{
  620. LogTrace();
  621. self->config &= ~kPreferIPv4;
  622. self->config &= ~kPreferIPv6;
  623. };
  624. if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey))
  625. block();
  626. else
  627. dispatch_async(socketQueue, block);
  628. }
  629. - (uint16_t)maxReceiveIPv4BufferSize
  630. {
  631. __block uint16_t result = 0;
  632. dispatch_block_t block = ^{
  633. result = self->max4ReceiveSize;
  634. };
  635. if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey))
  636. block();
  637. else
  638. dispatch_sync(socketQueue, block);
  639. return result;
  640. }
  641. - (void)setMaxReceiveIPv4BufferSize:(uint16_t)max
  642. {
  643. dispatch_block_t block = ^{
  644. LogVerbose(@"%@ %u", THIS_METHOD, (unsigned)max);
  645. self->max4ReceiveSize = max;
  646. };
  647. if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey))
  648. block();
  649. else
  650. dispatch_async(socketQueue, block);
  651. }
  652. - (uint32_t)maxReceiveIPv6BufferSize
  653. {
  654. __block uint32_t result = 0;
  655. dispatch_block_t block = ^{
  656. result = self->max6ReceiveSize;
  657. };
  658. if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey))
  659. block();
  660. else
  661. dispatch_sync(socketQueue, block);
  662. return result;
  663. }
  664. - (void)setMaxReceiveIPv6BufferSize:(uint32_t)max
  665. {
  666. dispatch_block_t block = ^{
  667. LogVerbose(@"%@ %u", THIS_METHOD, (unsigned)max);
  668. self->max6ReceiveSize = max;
  669. };
  670. if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey))
  671. block();
  672. else
  673. dispatch_async(socketQueue, block);
  674. }
  675. - (void)setMaxSendBufferSize:(uint16_t)max
  676. {
  677. dispatch_block_t block = ^{
  678. LogVerbose(@"%@ %u", THIS_METHOD, (unsigned)max);
  679. self->maxSendSize = max;
  680. };
  681. if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey))
  682. block();
  683. else
  684. dispatch_async(socketQueue, block);
  685. }
  686. - (uint16_t)maxSendBufferSize
  687. {
  688. __block uint16_t result = 0;
  689. dispatch_block_t block = ^{
  690. result = self->maxSendSize;
  691. };
  692. if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey))
  693. block();
  694. else
  695. dispatch_sync(socketQueue, block);
  696. return result;
  697. }
  698. - (id)userData
  699. {
  700. __block id result = nil;
  701. dispatch_block_t block = ^{
  702. result = self->userData;
  703. };
  704. if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey))
  705. block();
  706. else
  707. dispatch_sync(socketQueue, block);
  708. return result;
  709. }
  710. - (void)setUserData:(id)arbitraryUserData
  711. {
  712. dispatch_block_t block = ^{
  713. if (self->userData != arbitraryUserData)
  714. {
  715. self->userData = arbitraryUserData;
  716. }
  717. };
  718. if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey))
  719. block();
  720. else
  721. dispatch_async(socketQueue, block);
  722. }
  723. ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
  724. #pragma mark Delegate Helpers
  725. ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
  726. - (void)notifyDidConnectToAddress:(NSData *)anAddress
  727. {
  728. LogTrace();
  729. __strong id<GCDAsyncUdpSocketDelegate> theDelegate = delegate;
  730. if (delegateQueue && [theDelegate respondsToSelector:@selector(udpSocket:didConnectToAddress:)])
  731. {
  732. NSData *address = [anAddress copy]; // In case param is NSMutableData
  733. dispatch_async(delegateQueue, ^{ @autoreleasepool {
  734. [theDelegate udpSocket:self didConnectToAddress:address];
  735. }});
  736. }
  737. }
  738. - (void)notifyDidNotConnect:(NSError *)error
  739. {
  740. LogTrace();
  741. __strong id<GCDAsyncUdpSocketDelegate> theDelegate = delegate;
  742. if (delegateQueue && [theDelegate respondsToSelector:@selector(udpSocket:didNotConnect:)])
  743. {
  744. dispatch_async(delegateQueue, ^{ @autoreleasepool {
  745. [theDelegate udpSocket:self didNotConnect:error];
  746. }});
  747. }
  748. }
  749. - (void)notifyDidSendDataWithTag:(long)tag
  750. {
  751. LogTrace();
  752. __strong id<GCDAsyncUdpSocketDelegate> theDelegate = delegate;
  753. if (delegateQueue && [theDelegate respondsToSelector:@selector(udpSocket:didSendDataWithTag:)])
  754. {
  755. dispatch_async(delegateQueue, ^{ @autoreleasepool {
  756. [theDelegate udpSocket:self didSendDataWithTag:tag];
  757. }});
  758. }
  759. }
  760. - (void)notifyDidNotSendDataWithTag:(long)tag dueToError:(NSError *)error
  761. {
  762. LogTrace();
  763. __strong id<GCDAsyncUdpSocketDelegate> theDelegate = delegate;
  764. if (delegateQueue && [theDelegate respondsToSelector:@selector(udpSocket:didNotSendDataWithTag:dueToError:)])
  765. {
  766. dispatch_async(delegateQueue, ^{ @autoreleasepool {
  767. [theDelegate udpSocket:self didNotSendDataWithTag:tag dueToError:error];
  768. }});
  769. }
  770. }
  771. - (void)notifyDidReceiveData:(NSData *)data fromAddress:(NSData *)address withFilterContext:(id)context
  772. {
  773. LogTrace();
  774. SEL selector = @selector(udpSocket:didReceiveData:fromAddress:withFilterContext:);
  775. __strong id<GCDAsyncUdpSocketDelegate> theDelegate = delegate;
  776. if (delegateQueue && [theDelegate respondsToSelector:selector])
  777. {
  778. dispatch_async(delegateQueue, ^{ @autoreleasepool {
  779. [theDelegate udpSocket:self didReceiveData:data fromAddress:address withFilterContext:context];
  780. }});
  781. }
  782. }
  783. - (void)notifyDidCloseWithError:(NSError *)error
  784. {
  785. LogTrace();
  786. __strong id<GCDAsyncUdpSocketDelegate> theDelegate = delegate;
  787. if (delegateQueue && [theDelegate respondsToSelector:@selector(udpSocketDidClose:withError:)])
  788. {
  789. dispatch_async(delegateQueue, ^{ @autoreleasepool {
  790. [theDelegate udpSocketDidClose:self withError:error];
  791. }});
  792. }
  793. }
  794. ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
  795. #pragma mark Errors
  796. ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
  797. - (NSError *)badConfigError:(NSString *)errMsg
  798. {
  799. NSDictionary *userInfo = @{NSLocalizedDescriptionKey : errMsg};
  800. return [NSError errorWithDomain:GCDAsyncUdpSocketErrorDomain
  801. code:GCDAsyncUdpSocketBadConfigError
  802. userInfo:userInfo];
  803. }
  804. - (NSError *)badParamError:(NSString *)errMsg
  805. {
  806. NSDictionary *userInfo = @{NSLocalizedDescriptionKey : errMsg};
  807. return [NSError errorWithDomain:GCDAsyncUdpSocketErrorDomain
  808. code:GCDAsyncUdpSocketBadParamError
  809. userInfo:userInfo];
  810. }
  811. - (NSError *)gaiError:(int)gai_error
  812. {
  813. NSString *errMsg = [NSString stringWithCString:gai_strerror(gai_error) encoding:NSASCIIStringEncoding];
  814. NSDictionary *userInfo = @{NSLocalizedDescriptionKey : errMsg};
  815. return [NSError errorWithDomain:@"kCFStreamErrorDomainNetDB" code:gai_error userInfo:userInfo];
  816. }
  817. - (NSError *)errnoErrorWithReason:(NSString *)reason
  818. {
  819. NSString *errMsg = [NSString stringWithUTF8String:strerror(errno)];
  820. NSDictionary *userInfo;
  821. if (reason)
  822. userInfo = @{NSLocalizedDescriptionKey : errMsg,
  823. NSLocalizedFailureReasonErrorKey : reason};
  824. else
  825. userInfo = @{NSLocalizedDescriptionKey : errMsg};
  826. return [NSError errorWithDomain:NSPOSIXErrorDomain code:errno userInfo:userInfo];
  827. }
  828. - (NSError *)errnoError
  829. {
  830. return [self errnoErrorWithReason:nil];
  831. }
  832. /**
  833. * Returns a standard send timeout error.
  834. **/
  835. - (NSError *)sendTimeoutError
  836. {
  837. NSString *errMsg = NSLocalizedStringWithDefaultValue(@"GCDAsyncUdpSocketSendTimeoutError",
  838. @"GCDAsyncUdpSocket", [NSBundle mainBundle],
  839. @"Send operation timed out", nil);
  840. NSDictionary *userInfo = @{NSLocalizedDescriptionKey : errMsg};
  841. return [NSError errorWithDomain:GCDAsyncUdpSocketErrorDomain
  842. code:GCDAsyncUdpSocketSendTimeoutError
  843. userInfo:userInfo];
  844. }
  845. - (NSError *)socketClosedError
  846. {
  847. NSString *errMsg = NSLocalizedStringWithDefaultValue(@"GCDAsyncUdpSocketClosedError",
  848. @"GCDAsyncUdpSocket", [NSBundle mainBundle],
  849. @"Socket closed", nil);
  850. NSDictionary *userInfo = @{NSLocalizedDescriptionKey : errMsg};
  851. return [NSError errorWithDomain:GCDAsyncUdpSocketErrorDomain code:GCDAsyncUdpSocketClosedError userInfo:userInfo];
  852. }
  853. - (NSError *)otherError:(NSString *)errMsg
  854. {
  855. NSDictionary *userInfo = @{NSLocalizedDescriptionKey : errMsg};
  856. return [NSError errorWithDomain:GCDAsyncUdpSocketErrorDomain
  857. code:GCDAsyncUdpSocketOtherError
  858. userInfo:userInfo];
  859. }
  860. ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
  861. #pragma mark Utilities
  862. ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
  863. - (BOOL)preOp:(NSError **)errPtr
  864. {
  865. NSAssert(dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey), @"Must be dispatched on socketQueue");
  866. if (delegate == nil) // Must have delegate set
  867. {
  868. if (errPtr)
  869. {
  870. NSString *msg = @"Attempting to use socket without a delegate. Set a delegate first.";
  871. *errPtr = [self badConfigError:msg];
  872. }
  873. return NO;
  874. }
  875. if (delegateQueue == NULL) // Must have delegate queue set
  876. {
  877. if (errPtr)
  878. {
  879. NSString *msg = @"Attempting to use socket without a delegate queue. Set a delegate queue first.";
  880. *errPtr = [self badConfigError:msg];
  881. }
  882. return NO;
  883. }
  884. return YES;
  885. }
  886. /**
  887. * This method executes on a global concurrent queue.
  888. * When complete, it executes the given completion block on the socketQueue.
  889. **/
  890. - (void)asyncResolveHost:(NSString *)aHost
  891. port:(uint16_t)port
  892. withCompletionBlock:(void (^)(NSArray *addresses, NSError *error))completionBlock
  893. {
  894. LogTrace();
  895. // Check parameter(s)
  896. if (aHost == nil)
  897. {
  898. NSString *msg = @"The host param is nil. Should be domain name or IP address string.";
  899. NSError *error = [self badParamError:msg];
  900. // We should still use dispatch_async since this method is expected to be asynchronous
  901. dispatch_async(socketQueue, ^{ @autoreleasepool {
  902. completionBlock(nil, error);
  903. }});
  904. return;
  905. }
  906. // It's possible that the given aHost parameter is actually a NSMutableString.
  907. // So we want to copy it now, within this block that will be executed synchronously.
  908. // This way the asynchronous lookup block below doesn't have to worry about it changing.
  909. NSString *host = [aHost copy];
  910. dispatch_queue_t globalConcurrentQueue = dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0);
  911. dispatch_async(globalConcurrentQueue, ^{ @autoreleasepool {
  912. NSMutableArray *addresses = [NSMutableArray arrayWithCapacity:2];
  913. NSError *error = nil;
  914. if ([host isEqualToString:@"localhost"] || [host isEqualToString:@"loopback"])
  915. {
  916. // Use LOOPBACK address
  917. struct sockaddr_in sockaddr4;
  918. memset(&sockaddr4, 0, sizeof(sockaddr4));
  919. sockaddr4.sin_len = sizeof(struct sockaddr_in);
  920. sockaddr4.sin_family = AF_INET;
  921. sockaddr4.sin_port = htons(port);
  922. sockaddr4.sin_addr.s_addr = htonl(INADDR_LOOPBACK);
  923. struct sockaddr_in6 sockaddr6;
  924. memset(&sockaddr6, 0, sizeof(sockaddr6));
  925. sockaddr6.sin6_len = sizeof(struct sockaddr_in6);
  926. sockaddr6.sin6_family = AF_INET6;
  927. sockaddr6.sin6_port = htons(port);
  928. sockaddr6.sin6_addr = in6addr_loopback;
  929. // Wrap the native address structures and add to list
  930. [addresses addObject:[NSData dataWithBytes:&sockaddr4 length:sizeof(sockaddr4)]];
  931. [addresses addObject:[NSData dataWithBytes:&sockaddr6 length:sizeof(sockaddr6)]];
  932. }
  933. else
  934. {
  935. NSString *portStr = [NSString stringWithFormat:@"%hu", port];
  936. struct addrinfo hints, *res, *res0;
  937. memset(&hints, 0, sizeof(hints));
  938. hints.ai_family = PF_UNSPEC;
  939. hints.ai_socktype = SOCK_DGRAM;
  940. hints.ai_protocol = IPPROTO_UDP;
  941. int gai_error = getaddrinfo([host UTF8String], [portStr UTF8String], &hints, &res0);
  942. if (gai_error)
  943. {
  944. error = [self gaiError:gai_error];
  945. }
  946. else
  947. {
  948. for(res = res0; res; res = res->ai_next)
  949. {
  950. if (res->ai_family == AF_INET)
  951. {
  952. // Found IPv4 address
  953. // Wrap the native address structure and add to list
  954. [addresses addObject:[NSData dataWithBytes:res->ai_addr length:res->ai_addrlen]];
  955. }
  956. else if (res->ai_family == AF_INET6)
  957. {
  958. // Fixes connection issues with IPv6, it is the same solution for udp socket.
  959. // https://github.com/robbiehanson/CocoaAsyncSocket/issues/429#issuecomment-222477158
  960. struct sockaddr_in6 *sockaddr = (struct sockaddr_in6 *)(void *)res->ai_addr;
  961. in_port_t *portPtr = &sockaddr->sin6_port;
  962. if ((portPtr != NULL) && (*portPtr == 0)) {
  963. *portPtr = htons(port);
  964. }
  965. // Found IPv6 address
  966. // Wrap the native address structure and add to list
  967. [addresses addObject:[NSData dataWithBytes:res->ai_addr length:res->ai_addrlen]];
  968. }
  969. }
  970. freeaddrinfo(res0);
  971. if ([addresses count] == 0)
  972. {
  973. error = [self gaiError:EAI_FAIL];
  974. }
  975. }
  976. }
  977. dispatch_async(self->socketQueue, ^{ @autoreleasepool {
  978. completionBlock(addresses, error);
  979. }});
  980. }});
  981. }
  982. /**
  983. * This method picks an address from the given list of addresses.
  984. * The address picked depends upon which protocols are disabled, deactived, & preferred.
  985. *
  986. * Returns the address family (AF_INET or AF_INET6) of the picked address,
  987. * or AF_UNSPEC and the corresponding error is there's a problem.
  988. **/
  989. - (int)getAddress:(NSData **)addressPtr error:(NSError **)errorPtr fromAddresses:(NSArray *)addresses
  990. {
  991. NSAssert(dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey), @"Must be dispatched on socketQueue");
  992. NSAssert([addresses count] > 0, @"Expected at least one address");
  993. int resultAF = AF_UNSPEC;
  994. NSData *resultAddress = nil;
  995. NSError *resultError = nil;
  996. // Check for problems
  997. BOOL resolvedIPv4Address = NO;
  998. BOOL resolvedIPv6Address = NO;
  999. for (NSData *address in addresses)
  1000. {
  1001. switch ([[self class] familyFromAddress:address])
  1002. {
  1003. case AF_INET : resolvedIPv4Address = YES; break;
  1004. case AF_INET6 : resolvedIPv6Address = YES; break;
  1005. default : NSAssert(NO, @"Addresses array contains invalid address");
  1006. }
  1007. }
  1008. BOOL isIPv4Disabled = (config & kIPv4Disabled) ? YES : NO;
  1009. BOOL isIPv6Disabled = (config & kIPv6Disabled) ? YES : NO;
  1010. if (isIPv4Disabled && !resolvedIPv6Address)
  1011. {
  1012. NSString *msg = @"IPv4 has been disabled and DNS lookup found no IPv6 address(es).";
  1013. resultError = [self otherError:msg];
  1014. if (addressPtr) *addressPtr = resultAddress;
  1015. if (errorPtr) *errorPtr = resultError;
  1016. return resultAF;
  1017. }
  1018. if (isIPv6Disabled && !resolvedIPv4Address)
  1019. {
  1020. NSString *msg = @"IPv6 has been disabled and DNS lookup found no IPv4 address(es).";
  1021. resultError = [self otherError:msg];
  1022. if (addressPtr) *addressPtr = resultAddress;
  1023. if (errorPtr) *errorPtr = resultError;
  1024. return resultAF;
  1025. }
  1026. BOOL isIPv4Deactivated = (flags & kIPv4Deactivated) ? YES : NO;
  1027. BOOL isIPv6Deactivated = (flags & kIPv6Deactivated) ? YES : NO;
  1028. if (isIPv4Deactivated && !resolvedIPv6Address)
  1029. {
  1030. NSString *msg = @"IPv4 has been deactivated due to bind/connect, and DNS lookup found no IPv6 address(es).";
  1031. resultError = [self otherError:msg];
  1032. if (addressPtr) *addressPtr = resultAddress;
  1033. if (errorPtr) *errorPtr = resultError;
  1034. return resultAF;
  1035. }
  1036. if (isIPv6Deactivated && !resolvedIPv4Address)
  1037. {
  1038. NSString *msg = @"IPv6 has been deactivated due to bind/connect, and DNS lookup found no IPv4 address(es).";
  1039. resultError = [self otherError:msg];
  1040. if (addressPtr) *addressPtr = resultAddress;
  1041. if (errorPtr) *errorPtr = resultError;
  1042. return resultAF;
  1043. }
  1044. // Extract first IPv4 and IPv6 address in list
  1045. BOOL ipv4WasFirstInList = YES;
  1046. NSData *address4 = nil;
  1047. NSData *address6 = nil;
  1048. for (NSData *address in addresses)
  1049. {
  1050. int af = [[self class] familyFromAddress:address];
  1051. if (af == AF_INET)
  1052. {
  1053. if (address4 == nil)
  1054. {
  1055. address4 = address;
  1056. if (address6)
  1057. break;
  1058. else
  1059. ipv4WasFirstInList = YES;
  1060. }
  1061. }
  1062. else // af == AF_INET6
  1063. {
  1064. if (address6 == nil)
  1065. {
  1066. address6 = address;
  1067. if (address4)
  1068. break;
  1069. else
  1070. ipv4WasFirstInList = NO;
  1071. }
  1072. }
  1073. }
  1074. // Determine socket type
  1075. BOOL preferIPv4 = (config & kPreferIPv4) ? YES : NO;
  1076. BOOL preferIPv6 = (config & kPreferIPv6) ? YES : NO;
  1077. BOOL useIPv4 = ((preferIPv4 && address4) || (address6 == nil));
  1078. BOOL useIPv6 = ((preferIPv6 && address6) || (address4 == nil));
  1079. NSAssert(!(preferIPv4 && preferIPv6), @"Invalid config state");
  1080. NSAssert(!(useIPv4 && useIPv6), @"Invalid logic");
  1081. if (useIPv4 || (!useIPv6 && ipv4WasFirstInList))
  1082. {
  1083. resultAF = AF_INET;
  1084. resultAddress = address4;
  1085. }
  1086. else
  1087. {
  1088. resultAF = AF_INET6;
  1089. resultAddress = address6;
  1090. }
  1091. if (addressPtr) *addressPtr = resultAddress;
  1092. if (errorPtr) *errorPtr = resultError;
  1093. return resultAF;
  1094. }
  1095. /**
  1096. * Finds the address(es) of an interface description.
  1097. * An inteface description may be an interface name (en0, en1, lo0) or corresponding IP (192.168.4.34).
  1098. **/
  1099. - (void)convertIntefaceDescription:(NSString *)interfaceDescription
  1100. port:(uint16_t)port
  1101. intoAddress4:(NSData **)interfaceAddr4Ptr
  1102. address6:(NSData **)interfaceAddr6Ptr
  1103. {
  1104. NSData *addr4 = nil;
  1105. NSData *addr6 = nil;
  1106. if (interfaceDescription == nil)
  1107. {
  1108. // ANY address
  1109. struct sockaddr_in sockaddr4;
  1110. memset(&sockaddr4, 0, sizeof(sockaddr4));
  1111. sockaddr4.sin_len = sizeof(sockaddr4);
  1112. sockaddr4.sin_family = AF_INET;
  1113. sockaddr4.sin_port = htons(port);
  1114. sockaddr4.sin_addr.s_addr = htonl(INADDR_ANY);
  1115. struct sockaddr_in6 sockaddr6;
  1116. memset(&sockaddr6, 0, sizeof(sockaddr6));
  1117. sockaddr6.sin6_len = sizeof(sockaddr6);
  1118. sockaddr6.sin6_family = AF_INET6;
  1119. sockaddr6.sin6_port = htons(port);
  1120. sockaddr6.sin6_addr = in6addr_any;
  1121. addr4 = [NSData dataWithBytes:&sockaddr4 length:sizeof(sockaddr4)];
  1122. addr6 = [NSData dataWithBytes:&sockaddr6 length:sizeof(sockaddr6)];
  1123. }
  1124. else if ([interfaceDescription isEqualToString:@"localhost"] ||
  1125. [interfaceDescription isEqualToString:@"loopback"])
  1126. {
  1127. // LOOPBACK address
  1128. struct sockaddr_in sockaddr4;
  1129. memset(&sockaddr4, 0, sizeof(sockaddr4));
  1130. sockaddr4.sin_len = sizeof(struct sockaddr_in);
  1131. sockaddr4.sin_family = AF_INET;
  1132. sockaddr4.sin_port = htons(port);
  1133. sockaddr4.sin_addr.s_addr = htonl(INADDR_LOOPBACK);
  1134. struct sockaddr_in6 sockaddr6;
  1135. memset(&sockaddr6, 0, sizeof(sockaddr6));
  1136. sockaddr6.sin6_len = sizeof(struct sockaddr_in6);
  1137. sockaddr6.sin6_family = AF_INET6;
  1138. sockaddr6.sin6_port = htons(port);
  1139. sockaddr6.sin6_addr = in6addr_loopback;
  1140. addr4 = [NSData dataWithBytes:&sockaddr4 length:sizeof(sockaddr4)];
  1141. addr6 = [NSData dataWithBytes:&sockaddr6 length:sizeof(sockaddr6)];
  1142. }
  1143. else
  1144. {
  1145. const char *iface = [interfaceDescription UTF8String];
  1146. struct ifaddrs *addrs;
  1147. const struct ifaddrs *cursor;
  1148. if ((getifaddrs(&addrs) == 0))
  1149. {
  1150. cursor = addrs;
  1151. while (cursor != NULL)
  1152. {
  1153. if ((addr4 == nil) && (cursor->ifa_addr->sa_family == AF_INET))
  1154. {
  1155. // IPv4
  1156. struct sockaddr_in *addr = (struct sockaddr_in *)(void *)cursor->ifa_addr;
  1157. if (strcmp(cursor->ifa_name, iface) == 0)
  1158. {
  1159. // Name match
  1160. struct sockaddr_in nativeAddr4 = *addr;
  1161. nativeAddr4.sin_port = htons(port);
  1162. addr4 = [NSData dataWithBytes:&nativeAddr4 length:sizeof(nativeAddr4)];
  1163. }
  1164. else
  1165. {
  1166. char ip[INET_ADDRSTRLEN];
  1167. const char *conversion;
  1168. conversion = inet_ntop(AF_INET, &addr->sin_addr, ip, sizeof(ip));
  1169. if ((conversion != NULL) && (strcmp(ip, iface) == 0))
  1170. {
  1171. // IP match
  1172. struct sockaddr_in nativeAddr4 = *addr;
  1173. nativeAddr4.sin_port = htons(port);
  1174. addr4 = [NSData dataWithBytes:&nativeAddr4 length:sizeof(nativeAddr4)];
  1175. }
  1176. }
  1177. }
  1178. else if ((addr6 == nil) && (cursor->ifa_addr->sa_family == AF_INET6))
  1179. {
  1180. // IPv6
  1181. const struct sockaddr_in6 *addr = (const struct sockaddr_in6 *)(const void *)cursor->ifa_addr;
  1182. if (strcmp(cursor->ifa_name, iface) == 0)
  1183. {
  1184. // Name match
  1185. struct sockaddr_in6 nativeAddr6 = *addr;
  1186. nativeAddr6.sin6_port = htons(port);
  1187. addr6 = [NSData dataWithBytes:&nativeAddr6 length:sizeof(nativeAddr6)];
  1188. }
  1189. else
  1190. {
  1191. char ip[INET6_ADDRSTRLEN];
  1192. const char *conversion;
  1193. conversion = inet_ntop(AF_INET6, &addr->sin6_addr, ip, sizeof(ip));
  1194. if ((conversion != NULL) && (strcmp(ip, iface) == 0))
  1195. {
  1196. // IP match
  1197. struct sockaddr_in6 nativeAddr6 = *addr;
  1198. nativeAddr6.sin6_port = htons(port);
  1199. addr6 = [NSData dataWithBytes:&nativeAddr6 length:sizeof(nativeAddr6)];
  1200. }
  1201. }
  1202. }
  1203. cursor = cursor->ifa_next;
  1204. }
  1205. freeifaddrs(addrs);
  1206. }
  1207. }
  1208. if (interfaceAddr4Ptr) *interfaceAddr4Ptr = addr4;
  1209. if (interfaceAddr6Ptr) *interfaceAddr6Ptr = addr6;
  1210. }
  1211. /**
  1212. * Converts a numeric hostname into its corresponding address.
  1213. * The hostname is expected to be an IPv4 or IPv6 address represented as a human-readable string. (e.g. 192.168.4.34)
  1214. **/
  1215. - (void)convertNumericHost:(NSString *)numericHost
  1216. port:(uint16_t)port
  1217. intoAddress4:(NSData **)addr4Ptr
  1218. address6:(NSData **)addr6Ptr
  1219. {
  1220. NSData *addr4 = nil;
  1221. NSData *addr6 = nil;
  1222. if (numericHost)
  1223. {
  1224. NSString *portStr = [NSString stringWithFormat:@"%hu", port];
  1225. struct addrinfo hints, *res, *res0;
  1226. memset(&hints, 0, sizeof(hints));
  1227. hints.ai_family = PF_UNSPEC;
  1228. hints.ai_socktype = SOCK_DGRAM;
  1229. hints.ai_protocol = IPPROTO_UDP;
  1230. hints.ai_flags = AI_NUMERICHOST; // No name resolution should be attempted
  1231. if (getaddrinfo([numericHost UTF8String], [portStr UTF8String], &hints, &res0) == 0)
  1232. {
  1233. for (res = res0; res; res = res->ai_next)
  1234. {
  1235. if ((addr4 == nil) && (res->ai_family == AF_INET))
  1236. {
  1237. // Found IPv4 address
  1238. // Wrap the native address structure
  1239. addr4 = [NSData dataWithBytes:res->ai_addr length:res->ai_addrlen];
  1240. }
  1241. else if ((addr6 == nil) && (res->ai_family == AF_INET6))
  1242. {
  1243. // Found IPv6 address
  1244. // Wrap the native address structure
  1245. addr6 = [NSData dataWithBytes:res->ai_addr length:res->ai_addrlen];
  1246. }
  1247. }
  1248. freeaddrinfo(res0);
  1249. }
  1250. }
  1251. if (addr4Ptr) *addr4Ptr = addr4;
  1252. if (addr6Ptr) *addr6Ptr = addr6;
  1253. }
  1254. - (BOOL)isConnectedToAddress4:(NSData *)someAddr4
  1255. {
  1256. NSAssert(dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey), @"Must be dispatched on socketQueue");
  1257. NSAssert(flags & kDidConnect, @"Not connected");
  1258. NSAssert(cachedConnectedAddress, @"Expected cached connected address");
  1259. if (cachedConnectedFamily != AF_INET)
  1260. {
  1261. return NO;
  1262. }
  1263. const struct sockaddr_in *sSockaddr4 = (const struct sockaddr_in *)[someAddr4 bytes];
  1264. const struct sockaddr_in *cSockaddr4 = (const struct sockaddr_in *)[cachedConnectedAddress bytes];
  1265. if (memcmp(&sSockaddr4->sin_addr, &cSockaddr4->sin_addr, sizeof(struct in_addr)) != 0)
  1266. {
  1267. return NO;
  1268. }
  1269. if (memcmp(&sSockaddr4->sin_port, &cSockaddr4->sin_port, sizeof(in_port_t)) != 0)
  1270. {
  1271. return NO;
  1272. }
  1273. return YES;
  1274. }
  1275. - (BOOL)isConnectedToAddress6:(NSData *)someAddr6
  1276. {
  1277. NSAssert(dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey), @"Must be dispatched on socketQueue");
  1278. NSAssert(flags & kDidConnect, @"Not connected");
  1279. NSAssert(cachedConnectedAddress, @"Expected cached connected address");
  1280. if (cachedConnectedFamily != AF_INET6)
  1281. {
  1282. return NO;
  1283. }
  1284. const struct sockaddr_in6 *sSockaddr6 = (const struct sockaddr_in6 *)[someAddr6 bytes];
  1285. const struct sockaddr_in6 *cSockaddr6 = (const struct sockaddr_in6 *)[cachedConnectedAddress bytes];
  1286. if (memcmp(&sSockaddr6->sin6_addr, &cSockaddr6->sin6_addr, sizeof(struct in6_addr)) != 0)
  1287. {
  1288. return NO;
  1289. }
  1290. if (memcmp(&sSockaddr6->sin6_port, &cSockaddr6->sin6_port, sizeof(in_port_t)) != 0)
  1291. {
  1292. return NO;
  1293. }
  1294. return YES;
  1295. }
  1296. - (unsigned int)indexOfInterfaceAddr4:(NSData *)interfaceAddr4
  1297. {
  1298. if (interfaceAddr4 == nil)
  1299. return 0;
  1300. if ([interfaceAddr4 length] != sizeof(struct sockaddr_in))
  1301. return 0;
  1302. int result = 0;
  1303. const struct sockaddr_in *ifaceAddr = (const struct sockaddr_in *)[interfaceAddr4 bytes];
  1304. struct ifaddrs *addrs;
  1305. const struct ifaddrs *cursor;
  1306. if ((getifaddrs(&addrs) == 0))
  1307. {
  1308. cursor = addrs;
  1309. while (cursor != NULL)
  1310. {
  1311. if (cursor->ifa_addr->sa_family == AF_INET)
  1312. {
  1313. // IPv4
  1314. const struct sockaddr_in *addr = (const struct sockaddr_in *)(const void *)cursor->ifa_addr;
  1315. if (memcmp(&addr->sin_addr, &ifaceAddr->sin_addr, sizeof(struct in_addr)) == 0)
  1316. {
  1317. result = if_nametoindex(cursor->ifa_name);
  1318. break;
  1319. }
  1320. }
  1321. cursor = cursor->ifa_next;
  1322. }
  1323. freeifaddrs(addrs);
  1324. }
  1325. return result;
  1326. }
  1327. - (unsigned int)indexOfInterfaceAddr6:(NSData *)interfaceAddr6
  1328. {
  1329. if (interfaceAddr6 == nil)
  1330. return 0;
  1331. if ([interfaceAddr6 length] != sizeof(struct sockaddr_in6))
  1332. return 0;
  1333. int result = 0;
  1334. const struct sockaddr_in6 *ifaceAddr = (const struct sockaddr_in6 *)[interfaceAddr6 bytes];
  1335. struct ifaddrs *addrs;
  1336. const struct ifaddrs *cursor;
  1337. if ((getifaddrs(&addrs) == 0))
  1338. {
  1339. cursor = addrs;
  1340. while (cursor != NULL)
  1341. {
  1342. if (cursor->ifa_addr->sa_family == AF_INET6)
  1343. {
  1344. // IPv6
  1345. const struct sockaddr_in6 *addr = (const struct sockaddr_in6 *)(const void *)cursor->ifa_addr;
  1346. if (memcmp(&addr->sin6_addr, &ifaceAddr->sin6_addr, sizeof(struct in6_addr)) == 0)
  1347. {
  1348. result = if_nametoindex(cursor->ifa_name);
  1349. break;
  1350. }
  1351. }
  1352. cursor = cursor->ifa_next;
  1353. }
  1354. freeifaddrs(addrs);
  1355. }
  1356. return result;
  1357. }
  1358. - (void)setupSendAndReceiveSourcesForSocket4
  1359. {
  1360. LogTrace();
  1361. NSAssert(dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey), @"Must be dispatched on socketQueue");
  1362. send4Source = dispatch_source_create(DISPATCH_SOURCE_TYPE_WRITE, socket4FD, 0, socketQueue);
  1363. receive4Source = dispatch_source_create(DISPATCH_SOURCE_TYPE_READ, socket4FD, 0, socketQueue);
  1364. // Setup event handlers
  1365. dispatch_source_set_event_handler(send4Source, ^{ @autoreleasepool {
  1366. LogVerbose(@"send4EventBlock");
  1367. LogVerbose(@"dispatch_source_get_data(send4Source) = %lu", dispatch_source_get_data(send4Source));
  1368. self->flags |= kSock4CanAcceptBytes;
  1369. // If we're ready to send data, do so immediately.
  1370. // Otherwise pause the send source or it will continue to fire over and over again.
  1371. if (self->currentSend == nil)
  1372. {
  1373. LogVerbose(@"Nothing to send");
  1374. [self suspendSend4Source];
  1375. }
  1376. else if (self->currentSend->resolveInProgress)
  1377. {
  1378. LogVerbose(@"currentSend - waiting for address resolve");
  1379. [self suspendSend4Source];
  1380. }
  1381. else if (self->currentSend->filterInProgress)
  1382. {
  1383. LogVerbose(@"currentSend - waiting on sendFilter");
  1384. [self suspendSend4Source];
  1385. }
  1386. else
  1387. {
  1388. [self doSend];
  1389. }
  1390. }});
  1391. dispatch_source_set_event_handler(receive4Source, ^{ @autoreleasepool {
  1392. LogVerbose(@"receive4EventBlock");
  1393. self->socket4FDBytesAvailable = dispatch_source_get_data(self->receive4Source);
  1394. LogVerbose(@"socket4FDBytesAvailable: %lu", socket4FDBytesAvailable);
  1395. if (self->socket4FDBytesAvailable > 0)
  1396. [self doReceive];
  1397. else
  1398. [self doReceiveEOF];
  1399. }});
  1400. // Setup cancel handlers
  1401. __block int socketFDRefCount = 2;
  1402. int theSocketFD = socket4FD;
  1403. #if !OS_OBJECT_USE_OBJC
  1404. dispatch_source_t theSendSource = send4Source;
  1405. dispatch_source_t theReceiveSource = receive4Source;
  1406. #endif
  1407. dispatch_source_set_cancel_handler(send4Source, ^{
  1408. LogVerbose(@"send4CancelBlock");
  1409. #if !OS_OBJECT_USE_OBJC
  1410. LogVerbose(@"dispatch_release(send4Source)");
  1411. dispatch_release(theSendSource);
  1412. #endif
  1413. if (--socketFDRefCount == 0)
  1414. {
  1415. LogVerbose(@"close(socket4FD)");
  1416. close(theSocketFD);
  1417. }
  1418. });
  1419. dispatch_source_set_cancel_handler(receive4Source, ^{
  1420. LogVerbose(@"receive4CancelBlock");
  1421. #if !OS_OBJECT_USE_OBJC
  1422. LogVerbose(@"dispatch_release(receive4Source)");
  1423. dispatch_release(theReceiveSource);
  1424. #endif
  1425. if (--socketFDRefCount == 0)
  1426. {
  1427. LogVerbose(@"close(socket4FD)");
  1428. close(theSocketFD);
  1429. }
  1430. });
  1431. // We will not be able to receive until the socket is bound to a port,
  1432. // either explicitly via bind, or implicitly by connect or by sending data.
  1433. //
  1434. // But we should be able to send immediately.
  1435. socket4FDBytesAvailable = 0;
  1436. flags |= kSock4CanAcceptBytes;
  1437. flags |= kSend4SourceSuspended;
  1438. flags |= kReceive4SourceSuspended;
  1439. }
  1440. - (void)setupSendAndReceiveSourcesForSocket6
  1441. {
  1442. LogTrace();
  1443. NSAssert(dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey), @"Must be dispatched on socketQueue");
  1444. send6Source = dispatch_source_create(DISPATCH_SOURCE_TYPE_WRITE, socket6FD, 0, socketQueue);
  1445. receive6Source = dispatch_source_create(DISPATCH_SOURCE_TYPE_READ, socket6FD, 0, socketQueue);
  1446. // Setup event handlers
  1447. dispatch_source_set_event_handler(send6Source, ^{ @autoreleasepool {
  1448. LogVerbose(@"send6EventBlock");
  1449. LogVerbose(@"dispatch_source_get_data(send6Source) = %lu", dispatch_source_get_data(send6Source));
  1450. self->flags |= kSock6CanAcceptBytes;
  1451. // If we're ready to send data, do so immediately.
  1452. // Otherwise pause the send source or it will continue to fire over and over again.
  1453. if (self->currentSend == nil)
  1454. {
  1455. LogVerbose(@"Nothing to send");
  1456. [self suspendSend6Source];
  1457. }
  1458. else if (self->currentSend->resolveInProgress)
  1459. {
  1460. LogVerbose(@"currentSend - waiting for address resolve");
  1461. [self suspendSend6Source];
  1462. }
  1463. else if (self->currentSend->filterInProgress)
  1464. {
  1465. LogVerbose(@"currentSend - waiting on sendFilter");
  1466. [self suspendSend6Source];
  1467. }
  1468. else
  1469. {
  1470. [self doSend];
  1471. }
  1472. }});
  1473. dispatch_source_set_event_handler(receive6Source, ^{ @autoreleasepool {
  1474. LogVerbose(@"receive6EventBlock");
  1475. self->socket6FDBytesAvailable = dispatch_source_get_data(self->receive6Source);
  1476. LogVerbose(@"socket6FDBytesAvailable: %lu", socket6FDBytesAvailable);
  1477. if (self->socket6FDBytesAvailable > 0)
  1478. [self doReceive];
  1479. else
  1480. [self doReceiveEOF];
  1481. }});
  1482. // Setup cancel handlers
  1483. __block int socketFDRefCount = 2;
  1484. int theSocketFD = socket6FD;
  1485. #if !OS_OBJECT_USE_OBJC
  1486. dispatch_source_t theSendSource = send6Source;
  1487. dispatch_source_t theReceiveSource = receive6Source;
  1488. #endif
  1489. dispatch_source_set_cancel_handler(send6Source, ^{
  1490. LogVerbose(@"send6CancelBlock");
  1491. #if !OS_OBJECT_USE_OBJC
  1492. LogVerbose(@"dispatch_release(send6Source)");
  1493. dispatch_release(theSendSource);
  1494. #endif
  1495. if (--socketFDRefCount == 0)
  1496. {
  1497. LogVerbose(@"close(socket6FD)");
  1498. close(theSocketFD);
  1499. }
  1500. });
  1501. dispatch_source_set_cancel_handler(receive6Source, ^{
  1502. LogVerbose(@"receive6CancelBlock");
  1503. #if !OS_OBJECT_USE_OBJC
  1504. LogVerbose(@"dispatch_release(receive6Source)");
  1505. dispatch_release(theReceiveSource);
  1506. #endif
  1507. if (--socketFDRefCount == 0)
  1508. {
  1509. LogVerbose(@"close(socket6FD)");
  1510. close(theSocketFD);
  1511. }
  1512. });
  1513. // We will not be able to receive until the socket is bound to a port,
  1514. // either explicitly via bind, or implicitly by connect or by sending data.
  1515. //
  1516. // But we should be able to send immediately.
  1517. socket6FDBytesAvailable = 0;
  1518. flags |= kSock6CanAcceptBytes;
  1519. flags |= kSend6SourceSuspended;
  1520. flags |= kReceive6SourceSuspended;
  1521. }
  1522. - (BOOL)createSocket4:(BOOL)useIPv4 socket6:(BOOL)useIPv6 error:(NSError * __autoreleasing *)errPtr
  1523. {
  1524. LogTrace();
  1525. NSAssert(dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey), @"Must be dispatched on socketQueue");
  1526. NSAssert(((flags & kDidCreateSockets) == 0), @"Sockets have already been created");
  1527. // CreateSocket Block
  1528. // This block will be invoked below.
  1529. int(^createSocket)(int) = ^int (int domain) {
  1530. int socketFD = socket(domain, SOCK_DGRAM, 0);
  1531. if (socketFD == SOCKET_NULL)
  1532. {
  1533. if (errPtr)
  1534. *errPtr = [self errnoErrorWithReason:@"Error in socket() function"];
  1535. return SOCKET_NULL;
  1536. }
  1537. int status;
  1538. // Set socket options
  1539. status = fcntl(socketFD, F_SETFL, O_NONBLOCK);
  1540. if (status == -1)
  1541. {
  1542. if (errPtr)
  1543. *errPtr = [self errnoErrorWithReason:@"Error enabling non-blocking IO on socket (fcntl)"];
  1544. close(socketFD);
  1545. return SOCKET_NULL;
  1546. }
  1547. int reuseaddr = 1;
  1548. status = setsockopt(socketFD, SOL_SOCKET, SO_REUSEADDR, &reuseaddr, sizeof(reuseaddr));
  1549. if (status == -1)
  1550. {
  1551. if (errPtr)
  1552. *errPtr = [self errnoErrorWithReason:@"Error enabling address reuse (setsockopt)"];
  1553. close(socketFD);
  1554. return SOCKET_NULL;
  1555. }
  1556. int nosigpipe = 1;
  1557. status = setsockopt(socketFD, SOL_SOCKET, SO_NOSIGPIPE, &nosigpipe, sizeof(nosigpipe));
  1558. if (status == -1)
  1559. {
  1560. if (errPtr)
  1561. *errPtr = [self errnoErrorWithReason:@"Error disabling sigpipe (setsockopt)"];
  1562. close(socketFD);
  1563. return SOCKET_NULL;
  1564. }
  1565. /**
  1566. * The theoretical maximum size of any IPv4 UDP packet is UINT16_MAX = 65535.
  1567. * The theoretical maximum size of any IPv6 UDP packet is UINT32_MAX = 4294967295.
  1568. *
  1569. * The default maximum size of the UDP buffer in iOS is 9216 bytes.
  1570. *
  1571. * This is the reason of #222(GCD does not necessarily return the size of an entire UDP packet) and
  1572. * #535(GCDAsyncUDPSocket can not send data when data is greater than 9K)
  1573. *
  1574. *
  1575. * Enlarge the maximum size of UDP packet.
  1576. * I can not ensure the protocol type now so that the max size is set to 65535 :)
  1577. **/
  1578. status = setsockopt(socketFD, SOL_SOCKET, SO_SNDBUF, (const char*)&self->maxSendSize, sizeof(int));
  1579. if (status == -1)
  1580. {
  1581. if (errPtr)
  1582. *errPtr = [self errnoErrorWithReason:@"Error setting send buffer size (setsockopt)"];
  1583. close(socketFD);
  1584. return SOCKET_NULL;
  1585. }
  1586. status = setsockopt(socketFD, SOL_SOCKET, SO_RCVBUF, (const char*)&self->maxSendSize, sizeof(int));
  1587. if (status == -1)
  1588. {
  1589. if (errPtr)
  1590. *errPtr = [self errnoErrorWithReason:@"Error setting receive buffer size (setsockopt)"];
  1591. close(socketFD);
  1592. return SOCKET_NULL;
  1593. }
  1594. return socketFD;
  1595. };
  1596. // Create sockets depending upon given configuration.
  1597. if (useIPv4)
  1598. {
  1599. LogVerbose(@"Creating IPv4 socket");
  1600. socket4FD = createSocket(AF_INET);
  1601. if (socket4FD == SOCKET_NULL)
  1602. {
  1603. // errPtr set in local createSocket() block
  1604. return NO;
  1605. }
  1606. }
  1607. if (useIPv6)
  1608. {
  1609. LogVerbose(@"Creating IPv6 socket");
  1610. socket6FD = createSocket(AF_INET6);
  1611. if (socket6FD == SOCKET_NULL)
  1612. {
  1613. // errPtr set in local createSocket() block
  1614. if (socket4FD != SOCKET_NULL)
  1615. {
  1616. close(socket4FD);
  1617. socket4FD = SOCKET_NULL;
  1618. }
  1619. return NO;
  1620. }
  1621. }
  1622. // Setup send and receive sources
  1623. if (useIPv4)
  1624. [self setupSendAndReceiveSourcesForSocket4];
  1625. if (useIPv6)
  1626. [self setupSendAndReceiveSourcesForSocket6];
  1627. flags |= kDidCreateSockets;
  1628. return YES;
  1629. }
  1630. - (BOOL)createSockets:(NSError **)errPtr
  1631. {
  1632. LogTrace();
  1633. BOOL useIPv4 = [self isIPv4Enabled];
  1634. BOOL useIPv6 = [self isIPv6Enabled];
  1635. return [self createSocket4:useIPv4 socket6:useIPv6 error:errPtr];
  1636. }
  1637. - (void)suspendSend4Source
  1638. {
  1639. if (send4Source && !(flags & kSend4SourceSuspended))
  1640. {
  1641. LogVerbose(@"dispatch_suspend(send4Source)");
  1642. dispatch_suspend(send4Source);
  1643. flags |= kSend4SourceSuspended;
  1644. }
  1645. }
  1646. - (void)suspendSend6Source
  1647. {
  1648. if (send6Source && !(flags & kSend6SourceSuspended))
  1649. {
  1650. LogVerbose(@"dispatch_suspend(send6Source)");
  1651. dispatch_suspend(send6Source);
  1652. flags |= kSend6SourceSuspended;
  1653. }
  1654. }
  1655. - (void)resumeSend4Source
  1656. {
  1657. if (send4Source && (flags & kSend4SourceSuspended))
  1658. {
  1659. LogVerbose(@"dispatch_resume(send4Source)");
  1660. dispatch_resume(send4Source);
  1661. flags &= ~kSend4SourceSuspended;
  1662. }
  1663. }
  1664. - (void)resumeSend6Source
  1665. {
  1666. if (send6Source && (flags & kSend6SourceSuspended))
  1667. {
  1668. LogVerbose(@"dispatch_resume(send6Source)");
  1669. dispatch_resume(send6Source);
  1670. flags &= ~kSend6SourceSuspended;
  1671. }
  1672. }
  1673. - (void)suspendReceive4Source
  1674. {
  1675. if (receive4Source && !(flags & kReceive4SourceSuspended))
  1676. {
  1677. LogVerbose(@"dispatch_suspend(receive4Source)");
  1678. dispatch_suspend(receive4Source);
  1679. flags |= kReceive4SourceSuspended;
  1680. }
  1681. }
  1682. - (void)suspendReceive6Source
  1683. {
  1684. if (receive6Source && !(flags & kReceive6SourceSuspended))
  1685. {
  1686. LogVerbose(@"dispatch_suspend(receive6Source)");
  1687. dispatch_suspend(receive6Source);
  1688. flags |= kReceive6SourceSuspended;
  1689. }
  1690. }
  1691. - (void)resumeReceive4Source
  1692. {
  1693. if (receive4Source && (flags & kReceive4SourceSuspended))
  1694. {
  1695. LogVerbose(@"dispatch_resume(receive4Source)");
  1696. dispatch_resume(receive4Source);
  1697. flags &= ~kReceive4SourceSuspended;
  1698. }
  1699. }
  1700. - (void)resumeReceive6Source
  1701. {
  1702. if (receive6Source && (flags & kReceive6SourceSuspended))
  1703. {
  1704. LogVerbose(@"dispatch_resume(receive6Source)");
  1705. dispatch_resume(receive6Source);
  1706. flags &= ~kReceive6SourceSuspended;
  1707. }
  1708. }
  1709. - (void)closeSocket4
  1710. {
  1711. if (socket4FD != SOCKET_NULL)
  1712. {
  1713. LogVerbose(@"dispatch_source_cancel(send4Source)");
  1714. dispatch_source_cancel(send4Source);
  1715. LogVerbose(@"dispatch_source_cancel(receive4Source)");
  1716. dispatch_source_cancel(receive4Source);
  1717. // For some crazy reason (in my opinion), cancelling a dispatch source doesn't
  1718. // invoke the cancel handler if the dispatch source is paused.
  1719. // So we have to unpause the source if needed.
  1720. // This allows the cancel handler to be run, which in turn releases the source and closes the socket.
  1721. [self resumeSend4Source];
  1722. [self resumeReceive4Source];
  1723. // The sockets will be closed by the cancel handlers of the corresponding source
  1724. send4Source = NULL;
  1725. receive4Source = NULL;
  1726. socket4FD = SOCKET_NULL;
  1727. // Clear socket states
  1728. socket4FDBytesAvailable = 0;
  1729. flags &= ~kSock4CanAcceptBytes;
  1730. // Clear cached info
  1731. cachedLocalAddress4 = nil;
  1732. cachedLocalHost4 = nil;
  1733. cachedLocalPort4 = 0;
  1734. }
  1735. }
  1736. - (void)closeSocket6
  1737. {
  1738. if (socket6FD != SOCKET_NULL)
  1739. {
  1740. LogVerbose(@"dispatch_source_cancel(send6Source)");
  1741. dispatch_source_cancel(send6Source);
  1742. LogVerbose(@"dispatch_source_cancel(receive6Source)");
  1743. dispatch_source_cancel(receive6Source);
  1744. // For some crazy reason (in my opinion), cancelling a dispatch source doesn't
  1745. // invoke the cancel handler if the dispatch source is paused.
  1746. // So we have to unpause the source if needed.
  1747. // This allows the cancel handler to be run, which in turn releases the source and closes the socket.
  1748. [self resumeSend6Source];
  1749. [self resumeReceive6Source];
  1750. send6Source = NULL;
  1751. receive6Source = NULL;
  1752. // The sockets will be closed by the cancel handlers of the corresponding source
  1753. socket6FD = SOCKET_NULL;
  1754. // Clear socket states
  1755. socket6FDBytesAvailable = 0;
  1756. flags &= ~kSock6CanAcceptBytes;
  1757. // Clear cached info
  1758. cachedLocalAddress6 = nil;
  1759. cachedLocalHost6 = nil;
  1760. cachedLocalPort6 = 0;
  1761. }
  1762. }
  1763. - (void)closeSockets
  1764. {
  1765. [self closeSocket4];
  1766. [self closeSocket6];
  1767. flags &= ~kDidCreateSockets;
  1768. }
  1769. ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
  1770. #pragma mark Diagnostics
  1771. ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
  1772. - (BOOL)getLocalAddress:(NSData **)dataPtr
  1773. host:(NSString **)hostPtr
  1774. port:(uint16_t *)portPtr
  1775. forSocket:(int)socketFD
  1776. withFamily:(int)socketFamily
  1777. {
  1778. NSData *data = nil;
  1779. NSString *host = nil;
  1780. uint16_t port = 0;
  1781. if (socketFamily == AF_INET)
  1782. {
  1783. struct sockaddr_in sockaddr4;
  1784. socklen_t sockaddr4len = sizeof(sockaddr4);
  1785. if (getsockname(socketFD, (struct sockaddr *)&sockaddr4, &sockaddr4len) == 0)
  1786. {
  1787. data = [NSData dataWithBytes:&sockaddr4 length:sockaddr4len];
  1788. host = [[self class] hostFromSockaddr4:&sockaddr4];
  1789. port = [[self class] portFromSockaddr4:&sockaddr4];
  1790. }
  1791. else
  1792. {
  1793. LogWarn(@"Error in getsockname: %@", [self errnoError]);
  1794. }
  1795. }
  1796. else if (socketFamily == AF_INET6)
  1797. {
  1798. struct sockaddr_in6 sockaddr6;
  1799. socklen_t sockaddr6len = sizeof(sockaddr6);
  1800. if (getsockname(socketFD, (struct sockaddr *)&sockaddr6, &sockaddr6len) == 0)
  1801. {
  1802. data = [NSData dataWithBytes:&sockaddr6 length:sockaddr6len];
  1803. host = [[self class] hostFromSockaddr6:&sockaddr6];
  1804. port = [[self class] portFromSockaddr6:&sockaddr6];
  1805. }
  1806. else
  1807. {
  1808. LogWarn(@"Error in getsockname: %@", [self errnoError]);
  1809. }
  1810. }
  1811. if (dataPtr) *dataPtr = data;
  1812. if (hostPtr) *hostPtr = host;
  1813. if (portPtr) *portPtr = port;
  1814. return (data != nil);
  1815. }
  1816. - (void)maybeUpdateCachedLocalAddress4Info
  1817. {
  1818. NSAssert(dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey), @"Must be dispatched on socketQueue");
  1819. if ( cachedLocalAddress4 || ((flags & kDidBind) == 0) || (socket4FD == SOCKET_NULL) )
  1820. {
  1821. return;
  1822. }
  1823. NSData *address = nil;
  1824. NSString *host = nil;
  1825. uint16_t port = 0;
  1826. if ([self getLocalAddress:&address host:&host port:&port forSocket:socket4FD withFamily:AF_INET])
  1827. {
  1828. cachedLocalAddress4 = address;
  1829. cachedLocalHost4 = host;
  1830. cachedLocalPort4 = port;
  1831. }
  1832. }
  1833. - (void)maybeUpdateCachedLocalAddress6Info
  1834. {
  1835. NSAssert(dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey), @"Must be dispatched on socketQueue");
  1836. if ( cachedLocalAddress6 || ((flags & kDidBind) == 0) || (socket6FD == SOCKET_NULL) )
  1837. {
  1838. return;
  1839. }
  1840. NSData *address = nil;
  1841. NSString *host = nil;
  1842. uint16_t port = 0;
  1843. if ([self getLocalAddress:&address host:&host port:&port forSocket:socket6FD withFamily:AF_INET6])
  1844. {
  1845. cachedLocalAddress6 = address;
  1846. cachedLocalHost6 = host;
  1847. cachedLocalPort6 = port;
  1848. }
  1849. }
  1850. - (NSData *)localAddress
  1851. {
  1852. __block NSData *result = nil;
  1853. dispatch_block_t block = ^{
  1854. if (self->socket4FD != SOCKET_NULL)
  1855. {
  1856. [self maybeUpdateCachedLocalAddress4Info];
  1857. result = self->cachedLocalAddress4;
  1858. }
  1859. else
  1860. {
  1861. [self maybeUpdateCachedLocalAddress6Info];
  1862. result = self->cachedLocalAddress6;
  1863. }
  1864. };
  1865. if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey))
  1866. block();
  1867. else
  1868. dispatch_sync(socketQueue, AutoreleasedBlock(block));
  1869. return result;
  1870. }
  1871. - (NSString *)localHost
  1872. {
  1873. __block NSString *result = nil;
  1874. dispatch_block_t block = ^{
  1875. if (self->socket4FD != SOCKET_NULL)
  1876. {
  1877. [self maybeUpdateCachedLocalAddress4Info];
  1878. result = self->cachedLocalHost4;
  1879. }
  1880. else
  1881. {
  1882. [self maybeUpdateCachedLocalAddress6Info];
  1883. result = self->cachedLocalHost6;
  1884. }
  1885. };
  1886. if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey))
  1887. block();
  1888. else
  1889. dispatch_sync(socketQueue, AutoreleasedBlock(block));
  1890. return result;
  1891. }
  1892. - (uint16_t)localPort
  1893. {
  1894. __block uint16_t result = 0;
  1895. dispatch_block_t block = ^{
  1896. if (self->socket4FD != SOCKET_NULL)
  1897. {
  1898. [self maybeUpdateCachedLocalAddress4Info];
  1899. result = self->cachedLocalPort4;
  1900. }
  1901. else
  1902. {
  1903. [self maybeUpdateCachedLocalAddress6Info];
  1904. result = self->cachedLocalPort6;
  1905. }
  1906. };
  1907. if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey))
  1908. block();
  1909. else
  1910. dispatch_sync(socketQueue, AutoreleasedBlock(block));
  1911. return result;
  1912. }
  1913. - (NSData *)localAddress_IPv4
  1914. {
  1915. __block NSData *result = nil;
  1916. dispatch_block_t block = ^{
  1917. [self maybeUpdateCachedLocalAddress4Info];
  1918. result = self->cachedLocalAddress4;
  1919. };
  1920. if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey))
  1921. block();
  1922. else
  1923. dispatch_sync(socketQueue, AutoreleasedBlock(block));
  1924. return result;
  1925. }
  1926. - (NSString *)localHost_IPv4
  1927. {
  1928. __block NSString *result = nil;
  1929. dispatch_block_t block = ^{
  1930. [self maybeUpdateCachedLocalAddress4Info];
  1931. result = self->cachedLocalHost4;
  1932. };
  1933. if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey))
  1934. block();
  1935. else
  1936. dispatch_sync(socketQueue, AutoreleasedBlock(block));
  1937. return result;
  1938. }
  1939. - (uint16_t)localPort_IPv4
  1940. {
  1941. __block uint16_t result = 0;
  1942. dispatch_block_t block = ^{
  1943. [self maybeUpdateCachedLocalAddress4Info];
  1944. result = self->cachedLocalPort4;
  1945. };
  1946. if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey))
  1947. block();
  1948. else
  1949. dispatch_sync(socketQueue, AutoreleasedBlock(block));
  1950. return result;
  1951. }
  1952. - (NSData *)localAddress_IPv6
  1953. {
  1954. __block NSData *result = nil;
  1955. dispatch_block_t block = ^{
  1956. [self maybeUpdateCachedLocalAddress6Info];
  1957. result = self->cachedLocalAddress6;
  1958. };
  1959. if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey))
  1960. block();
  1961. else
  1962. dispatch_sync(socketQueue, AutoreleasedBlock(block));
  1963. return result;
  1964. }
  1965. - (NSString *)localHost_IPv6
  1966. {
  1967. __block NSString *result = nil;
  1968. dispatch_block_t block = ^{
  1969. [self maybeUpdateCachedLocalAddress6Info];
  1970. result = self->cachedLocalHost6;
  1971. };
  1972. if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey))
  1973. block();
  1974. else
  1975. dispatch_sync(socketQueue, AutoreleasedBlock(block));
  1976. return result;
  1977. }
  1978. - (uint16_t)localPort_IPv6
  1979. {
  1980. __block uint16_t result = 0;
  1981. dispatch_block_t block = ^{
  1982. [self maybeUpdateCachedLocalAddress6Info];
  1983. result = self->cachedLocalPort6;
  1984. };
  1985. if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey))
  1986. block();
  1987. else
  1988. dispatch_sync(socketQueue, AutoreleasedBlock(block));
  1989. return result;
  1990. }
  1991. - (void)maybeUpdateCachedConnectedAddressInfo
  1992. {
  1993. NSAssert(dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey), @"Must be dispatched on socketQueue");
  1994. if (cachedConnectedAddress || (flags & kDidConnect) == 0)
  1995. {
  1996. return;
  1997. }
  1998. NSData *data = nil;
  1999. NSString *host = nil;
  2000. uint16_t port = 0;
  2001. int family = AF_UNSPEC;
  2002. if (socket4FD != SOCKET_NULL)
  2003. {
  2004. struct sockaddr_in sockaddr4;
  2005. socklen_t sockaddr4len = sizeof(sockaddr4);
  2006. if (getpeername(socket4FD, (struct sockaddr *)&sockaddr4, &sockaddr4len) == 0)
  2007. {
  2008. data = [NSData dataWithBytes:&sockaddr4 length:sockaddr4len];
  2009. host = [[self class] hostFromSockaddr4:&sockaddr4];
  2010. port = [[self class] portFromSockaddr4:&sockaddr4];
  2011. family = AF_INET;
  2012. }
  2013. else
  2014. {
  2015. LogWarn(@"Error in getpeername: %@", [self errnoError]);
  2016. }
  2017. }
  2018. else if (socket6FD != SOCKET_NULL)
  2019. {
  2020. struct sockaddr_in6 sockaddr6;
  2021. socklen_t sockaddr6len = sizeof(sockaddr6);
  2022. if (getpeername(socket6FD, (struct sockaddr *)&sockaddr6, &sockaddr6len) == 0)
  2023. {
  2024. data = [NSData dataWithBytes:&sockaddr6 length:sockaddr6len];
  2025. host = [[self class] hostFromSockaddr6:&sockaddr6];
  2026. port = [[self class] portFromSockaddr6:&sockaddr6];
  2027. family = AF_INET6;
  2028. }
  2029. else
  2030. {
  2031. LogWarn(@"Error in getpeername: %@", [self errnoError]);
  2032. }
  2033. }
  2034. cachedConnectedAddress = data;
  2035. cachedConnectedHost = host;
  2036. cachedConnectedPort = port;
  2037. cachedConnectedFamily = family;
  2038. }
  2039. - (NSData *)connectedAddress
  2040. {
  2041. __block NSData *result = nil;
  2042. dispatch_block_t block = ^{
  2043. [self maybeUpdateCachedConnectedAddressInfo];
  2044. result = self->cachedConnectedAddress;
  2045. };
  2046. if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey))
  2047. block();
  2048. else
  2049. dispatch_sync(socketQueue, AutoreleasedBlock(block));
  2050. return result;
  2051. }
  2052. - (NSString *)connectedHost
  2053. {
  2054. __block NSString *result = nil;
  2055. dispatch_block_t block = ^{
  2056. [self maybeUpdateCachedConnectedAddressInfo];
  2057. result = self->cachedConnectedHost;
  2058. };
  2059. if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey))
  2060. block();
  2061. else
  2062. dispatch_sync(socketQueue, AutoreleasedBlock(block));
  2063. return result;
  2064. }
  2065. - (uint16_t)connectedPort
  2066. {
  2067. __block uint16_t result = 0;
  2068. dispatch_block_t block = ^{
  2069. [self maybeUpdateCachedConnectedAddressInfo];
  2070. result = self->cachedConnectedPort;
  2071. };
  2072. if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey))
  2073. block();
  2074. else
  2075. dispatch_sync(socketQueue, AutoreleasedBlock(block));
  2076. return result;
  2077. }
  2078. - (BOOL)isConnected
  2079. {
  2080. __block BOOL result = NO;
  2081. dispatch_block_t block = ^{
  2082. result = (self->flags & kDidConnect) ? YES : NO;
  2083. };
  2084. if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey))
  2085. block();
  2086. else
  2087. dispatch_sync(socketQueue, block);
  2088. return result;
  2089. }
  2090. - (BOOL)isClosed
  2091. {
  2092. __block BOOL result = YES;
  2093. dispatch_block_t block = ^{
  2094. result = (self->flags & kDidCreateSockets) ? NO : YES;
  2095. };
  2096. if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey))
  2097. block();
  2098. else
  2099. dispatch_sync(socketQueue, block);
  2100. return result;
  2101. }
  2102. - (BOOL)isIPv4
  2103. {
  2104. __block BOOL result = NO;
  2105. dispatch_block_t block = ^{
  2106. if (self->flags & kDidCreateSockets)
  2107. {
  2108. result = (self->socket4FD != SOCKET_NULL);
  2109. }
  2110. else
  2111. {
  2112. result = [self isIPv4Enabled];
  2113. }
  2114. };
  2115. if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey))
  2116. block();
  2117. else
  2118. dispatch_sync(socketQueue, block);
  2119. return result;
  2120. }
  2121. - (BOOL)isIPv6
  2122. {
  2123. __block BOOL result = NO;
  2124. dispatch_block_t block = ^{
  2125. if (self->flags & kDidCreateSockets)
  2126. {
  2127. result = (self->socket6FD != SOCKET_NULL);
  2128. }
  2129. else
  2130. {
  2131. result = [self isIPv6Enabled];
  2132. }
  2133. };
  2134. if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey))
  2135. block();
  2136. else
  2137. dispatch_sync(socketQueue, block);
  2138. return result;
  2139. }
  2140. ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
  2141. #pragma mark Binding
  2142. ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
  2143. /**
  2144. * This method runs through the various checks required prior to a bind attempt.
  2145. * It is shared between the various bind methods.
  2146. **/
  2147. - (BOOL)preBind:(NSError **)errPtr
  2148. {
  2149. if (![self preOp:errPtr])
  2150. {
  2151. return NO;
  2152. }
  2153. if (flags & kDidBind)
  2154. {
  2155. if (errPtr)
  2156. {
  2157. NSString *msg = @"Cannot bind a socket more than once.";
  2158. *errPtr = [self badConfigError:msg];
  2159. }
  2160. return NO;
  2161. }
  2162. if ((flags & kConnecting) || (flags & kDidConnect))
  2163. {
  2164. if (errPtr)
  2165. {
  2166. NSString *msg = @"Cannot bind after connecting. If needed, bind first, then connect.";
  2167. *errPtr = [self badConfigError:msg];
  2168. }
  2169. return NO;
  2170. }
  2171. BOOL isIPv4Disabled = (config & kIPv4Disabled) ? YES : NO;
  2172. BOOL isIPv6Disabled = (config & kIPv6Disabled) ? YES : NO;
  2173. if (isIPv4Disabled && isIPv6Disabled) // Must have IPv4 or IPv6 enabled
  2174. {
  2175. if (errPtr)
  2176. {
  2177. NSString *msg = @"Both IPv4 and IPv6 have been disabled. Must enable at least one protocol first.";
  2178. *errPtr = [self badConfigError:msg];
  2179. }
  2180. return NO;
  2181. }
  2182. return YES;
  2183. }
  2184. - (BOOL)bindToPort:(uint16_t)port error:(NSError **)errPtr
  2185. {
  2186. return [self bindToPort:port interface:nil error:errPtr];
  2187. }
  2188. - (BOOL)bindToPort:(uint16_t)port interface:(NSString *)interface error:(NSError **)errPtr
  2189. {
  2190. __block BOOL result = NO;
  2191. __block NSError *err = nil;
  2192. dispatch_block_t block = ^{ @autoreleasepool {
  2193. // Run through sanity checks
  2194. if (![self preBind:&err])
  2195. {
  2196. return_from_block;
  2197. }
  2198. // Check the given interface
  2199. NSData *interface4 = nil;
  2200. NSData *interface6 = nil;
  2201. [self convertIntefaceDescription:interface port:port intoAddress4:&interface4 address6:&interface6];
  2202. if ((interface4 == nil) && (interface6 == nil))
  2203. {
  2204. NSString *msg = @"Unknown interface. Specify valid interface by name (e.g. \"en1\") or IP address.";
  2205. err = [self badParamError:msg];
  2206. return_from_block;
  2207. }
  2208. BOOL isIPv4Disabled = (self->config & kIPv4Disabled) ? YES : NO;
  2209. BOOL isIPv6Disabled = (self->config & kIPv6Disabled) ? YES : NO;
  2210. if (isIPv4Disabled && (interface6 == nil))
  2211. {
  2212. NSString *msg = @"IPv4 has been disabled and specified interface doesn't support IPv6.";
  2213. err = [self badParamError:msg];
  2214. return_from_block;
  2215. }
  2216. if (isIPv6Disabled && (interface4 == nil))
  2217. {
  2218. NSString *msg = @"IPv6 has been disabled and specified interface doesn't support IPv4.";
  2219. err = [self badParamError:msg];
  2220. return_from_block;
  2221. }
  2222. // Determine protocol(s)
  2223. BOOL useIPv4 = !isIPv4Disabled && (interface4 != nil);
  2224. BOOL useIPv6 = !isIPv6Disabled && (interface6 != nil);
  2225. // Create the socket(s) if needed
  2226. if ((self->flags & kDidCreateSockets) == 0)
  2227. {
  2228. if (![self createSocket4:useIPv4 socket6:useIPv6 error:&err])
  2229. {
  2230. return_from_block;
  2231. }
  2232. }
  2233. // Bind the socket(s)
  2234. LogVerbose(@"Binding socket to port(%hu) interface(%@)", port, interface);
  2235. if (useIPv4)
  2236. {
  2237. int status = bind(self->socket4FD, (const struct sockaddr *)[interface4 bytes], (socklen_t)[interface4 length]);
  2238. if (status == -1)
  2239. {
  2240. [self closeSockets];
  2241. NSString *reason = @"Error in bind() function";
  2242. err = [self errnoErrorWithReason:reason];
  2243. return_from_block;
  2244. }
  2245. }
  2246. if (useIPv6)
  2247. {
  2248. int status = bind(self->socket6FD, (const struct sockaddr *)[interface6 bytes], (socklen_t)[interface6 length]);
  2249. if (status == -1)
  2250. {
  2251. [self closeSockets];
  2252. NSString *reason = @"Error in bind() function";
  2253. err = [self errnoErrorWithReason:reason];
  2254. return_from_block;
  2255. }
  2256. }
  2257. // Update flags
  2258. self->flags |= kDidBind;
  2259. if (!useIPv4) self->flags |= kIPv4Deactivated;
  2260. if (!useIPv6) self->flags |= kIPv6Deactivated;
  2261. result = YES;
  2262. }};
  2263. if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey))
  2264. block();
  2265. else
  2266. dispatch_sync(socketQueue, block);
  2267. if (err)
  2268. LogError(@"Error binding to port/interface: %@", err);
  2269. if (errPtr)
  2270. *errPtr = err;
  2271. return result;
  2272. }
  2273. - (BOOL)bindToAddress:(NSData *)localAddr error:(NSError **)errPtr
  2274. {
  2275. __block BOOL result = NO;
  2276. __block NSError *err = nil;
  2277. dispatch_block_t block = ^{ @autoreleasepool {
  2278. // Run through sanity checks
  2279. if (![self preBind:&err])
  2280. {
  2281. return_from_block;
  2282. }
  2283. // Check the given address
  2284. int addressFamily = [[self class] familyFromAddress:localAddr];
  2285. if (addressFamily == AF_UNSPEC)
  2286. {
  2287. NSString *msg = @"A valid IPv4 or IPv6 address was not given";
  2288. err = [self badParamError:msg];
  2289. return_from_block;
  2290. }
  2291. NSData *localAddr4 = (addressFamily == AF_INET) ? localAddr : nil;
  2292. NSData *localAddr6 = (addressFamily == AF_INET6) ? localAddr : nil;
  2293. BOOL isIPv4Disabled = (self->config & kIPv4Disabled) ? YES : NO;
  2294. BOOL isIPv6Disabled = (self->config & kIPv6Disabled) ? YES : NO;
  2295. if (isIPv4Disabled && localAddr4)
  2296. {
  2297. NSString *msg = @"IPv4 has been disabled and an IPv4 address was passed.";
  2298. err = [self badParamError:msg];
  2299. return_from_block;
  2300. }
  2301. if (isIPv6Disabled && localAddr6)
  2302. {
  2303. NSString *msg = @"IPv6 has been disabled and an IPv6 address was passed.";
  2304. err = [self badParamError:msg];
  2305. return_from_block;
  2306. }
  2307. // Determine protocol(s)
  2308. BOOL useIPv4 = !isIPv4Disabled && (localAddr4 != nil);
  2309. BOOL useIPv6 = !isIPv6Disabled && (localAddr6 != nil);
  2310. // Create the socket(s) if needed
  2311. if ((self->flags & kDidCreateSockets) == 0)
  2312. {
  2313. if (![self createSocket4:useIPv4 socket6:useIPv6 error:&err])
  2314. {
  2315. return_from_block;
  2316. }
  2317. }
  2318. // Bind the socket(s)
  2319. if (useIPv4)
  2320. {
  2321. LogVerbose(@"Binding socket to address(%@:%hu)",
  2322. [[self class] hostFromAddress:localAddr4],
  2323. [[self class] portFromAddress:localAddr4]);
  2324. int status = bind(self->socket4FD, (const struct sockaddr *)[localAddr4 bytes], (socklen_t)[localAddr4 length]);
  2325. if (status == -1)
  2326. {
  2327. [self closeSockets];
  2328. NSString *reason = @"Error in bind() function";
  2329. err = [self errnoErrorWithReason:reason];
  2330. return_from_block;
  2331. }
  2332. }
  2333. else
  2334. {
  2335. LogVerbose(@"Binding socket to address(%@:%hu)",
  2336. [[self class] hostFromAddress:localAddr6],
  2337. [[self class] portFromAddress:localAddr6]);
  2338. int status = bind(self->socket6FD, (const struct sockaddr *)[localAddr6 bytes], (socklen_t)[localAddr6 length]);
  2339. if (status == -1)
  2340. {
  2341. [self closeSockets];
  2342. NSString *reason = @"Error in bind() function";
  2343. err = [self errnoErrorWithReason:reason];
  2344. return_from_block;
  2345. }
  2346. }
  2347. // Update flags
  2348. self->flags |= kDidBind;
  2349. if (!useIPv4) self->flags |= kIPv4Deactivated;
  2350. if (!useIPv6) self->flags |= kIPv6Deactivated;
  2351. result = YES;
  2352. }};
  2353. if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey))
  2354. block();
  2355. else
  2356. dispatch_sync(socketQueue, block);
  2357. if (err)
  2358. LogError(@"Error binding to address: %@", err);
  2359. if (errPtr)
  2360. *errPtr = err;
  2361. return result;
  2362. }
  2363. ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
  2364. #pragma mark Connecting
  2365. ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
  2366. /**
  2367. * This method runs through the various checks required prior to a connect attempt.
  2368. * It is shared between the various connect methods.
  2369. **/
  2370. - (BOOL)preConnect:(NSError **)errPtr
  2371. {
  2372. if (![self preOp:errPtr])
  2373. {
  2374. return NO;
  2375. }
  2376. if ((flags & kConnecting) || (flags & kDidConnect))
  2377. {
  2378. if (errPtr)
  2379. {
  2380. NSString *msg = @"Cannot connect a socket more than once.";
  2381. *errPtr = [self badConfigError:msg];
  2382. }
  2383. return NO;
  2384. }
  2385. BOOL isIPv4Disabled = (config & kIPv4Disabled) ? YES : NO;
  2386. BOOL isIPv6Disabled = (config & kIPv6Disabled) ? YES : NO;
  2387. if (isIPv4Disabled && isIPv6Disabled) // Must have IPv4 or IPv6 enabled
  2388. {
  2389. if (errPtr)
  2390. {
  2391. NSString *msg = @"Both IPv4 and IPv6 have been disabled. Must enable at least one protocol first.";
  2392. *errPtr = [self badConfigError:msg];
  2393. }
  2394. return NO;
  2395. }
  2396. return YES;
  2397. }
  2398. - (BOOL)connectToHost:(NSString *)host onPort:(uint16_t)port error:(NSError **)errPtr
  2399. {
  2400. __block BOOL result = NO;
  2401. __block NSError *err = nil;
  2402. dispatch_block_t block = ^{ @autoreleasepool {
  2403. // Run through sanity checks.
  2404. if (![self preConnect:&err])
  2405. {
  2406. return_from_block;
  2407. }
  2408. // Check parameter(s)
  2409. if (host == nil)
  2410. {
  2411. NSString *msg = @"The host param is nil. Should be domain name or IP address string.";
  2412. err = [self badParamError:msg];
  2413. return_from_block;
  2414. }
  2415. // Create the socket(s) if needed
  2416. if ((self->flags & kDidCreateSockets) == 0)
  2417. {
  2418. if (![self createSockets:&err])
  2419. {
  2420. return_from_block;
  2421. }
  2422. }
  2423. // Create special connect packet
  2424. GCDAsyncUdpSpecialPacket *packet = [[GCDAsyncUdpSpecialPacket alloc] init];
  2425. packet->resolveInProgress = YES;
  2426. // Start asynchronous DNS resolve for host:port on background queue
  2427. LogVerbose(@"Dispatching DNS resolve for connect...");
  2428. [self asyncResolveHost:host port:port withCompletionBlock:^(NSArray *addresses, NSError *error) {
  2429. // The asyncResolveHost:port:: method asynchronously dispatches a task onto the global concurrent queue,
  2430. // and immediately returns. Once the async resolve task completes,
  2431. // this block is executed on our socketQueue.
  2432. packet->resolveInProgress = NO;
  2433. packet->addresses = addresses;
  2434. packet->error = error;
  2435. [self maybeConnect];
  2436. }];
  2437. // Updates flags, add connect packet to send queue, and pump send queue
  2438. self->flags |= kConnecting;
  2439. [self->sendQueue addObject:packet];
  2440. [self maybeDequeueSend];
  2441. result = YES;
  2442. }};
  2443. if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey))
  2444. block();
  2445. else
  2446. dispatch_sync(socketQueue, block);
  2447. if (err)
  2448. LogError(@"Error connecting to host/port: %@", err);
  2449. if (errPtr)
  2450. *errPtr = err;
  2451. return result;
  2452. }
  2453. - (BOOL)connectToAddress:(NSData *)remoteAddr error:(NSError **)errPtr
  2454. {
  2455. __block BOOL result = NO;
  2456. __block NSError *err = nil;
  2457. dispatch_block_t block = ^{ @autoreleasepool {
  2458. // Run through sanity checks.
  2459. if (![self preConnect:&err])
  2460. {
  2461. return_from_block;
  2462. }
  2463. // Check parameter(s)
  2464. if (remoteAddr == nil)
  2465. {
  2466. NSString *msg = @"The address param is nil. Should be a valid address.";
  2467. err = [self badParamError:msg];
  2468. return_from_block;
  2469. }
  2470. // Create the socket(s) if needed
  2471. if ((self->flags & kDidCreateSockets) == 0)
  2472. {
  2473. if (![self createSockets:&err])
  2474. {
  2475. return_from_block;
  2476. }
  2477. }
  2478. // The remoteAddr parameter could be of type NSMutableData.
  2479. // So we copy it to be safe.
  2480. NSData *address = [remoteAddr copy];
  2481. NSArray *addresses = [NSArray arrayWithObject:address];
  2482. GCDAsyncUdpSpecialPacket *packet = [[GCDAsyncUdpSpecialPacket alloc] init];
  2483. packet->addresses = addresses;
  2484. // Updates flags, add connect packet to send queue, and pump send queue
  2485. self->flags |= kConnecting;
  2486. [self->sendQueue addObject:packet];
  2487. [self maybeDequeueSend];
  2488. result = YES;
  2489. }};
  2490. if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey))
  2491. block();
  2492. else
  2493. dispatch_sync(socketQueue, block);
  2494. if (err)
  2495. LogError(@"Error connecting to address: %@", err);
  2496. if (errPtr)
  2497. *errPtr = err;
  2498. return result;
  2499. }
  2500. - (void)maybeConnect
  2501. {
  2502. LogTrace();
  2503. NSAssert(dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey), @"Must be dispatched on socketQueue");
  2504. BOOL sendQueueReady = [currentSend isKindOfClass:[GCDAsyncUdpSpecialPacket class]];
  2505. if (sendQueueReady)
  2506. {
  2507. GCDAsyncUdpSpecialPacket *connectPacket = (GCDAsyncUdpSpecialPacket *)currentSend;
  2508. if (connectPacket->resolveInProgress)
  2509. {
  2510. LogVerbose(@"Waiting for DNS resolve...");
  2511. }
  2512. else
  2513. {
  2514. if (connectPacket->error)
  2515. {
  2516. [self notifyDidNotConnect:connectPacket->error];
  2517. }
  2518. else
  2519. {
  2520. NSData *address = nil;
  2521. NSError *error = nil;
  2522. int addressFamily = [self getAddress:&address error:&error fromAddresses:connectPacket->addresses];
  2523. // Perform connect
  2524. BOOL result = NO;
  2525. switch (addressFamily)
  2526. {
  2527. case AF_INET : result = [self connectWithAddress4:address error:&error]; break;
  2528. case AF_INET6 : result = [self connectWithAddress6:address error:&error]; break;
  2529. }
  2530. if (result)
  2531. {
  2532. flags |= kDidBind;
  2533. flags |= kDidConnect;
  2534. cachedConnectedAddress = address;
  2535. cachedConnectedHost = [[self class] hostFromAddress:address];
  2536. cachedConnectedPort = [[self class] portFromAddress:address];
  2537. cachedConnectedFamily = addressFamily;
  2538. [self notifyDidConnectToAddress:address];
  2539. }
  2540. else
  2541. {
  2542. [self notifyDidNotConnect:error];
  2543. }
  2544. }
  2545. flags &= ~kConnecting;
  2546. [self endCurrentSend];
  2547. [self maybeDequeueSend];
  2548. }
  2549. }
  2550. }
  2551. - (BOOL)connectWithAddress4:(NSData *)address4 error:(NSError **)errPtr
  2552. {
  2553. LogTrace();
  2554. NSAssert(dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey), @"Must be dispatched on socketQueue");
  2555. int status = connect(socket4FD, (const struct sockaddr *)[address4 bytes], (socklen_t)[address4 length]);
  2556. if (status != 0)
  2557. {
  2558. if (errPtr)
  2559. *errPtr = [self errnoErrorWithReason:@"Error in connect() function"];
  2560. return NO;
  2561. }
  2562. [self closeSocket6];
  2563. flags |= kIPv6Deactivated;
  2564. return YES;
  2565. }
  2566. - (BOOL)connectWithAddress6:(NSData *)address6 error:(NSError **)errPtr
  2567. {
  2568. LogTrace();
  2569. NSAssert(dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey), @"Must be dispatched on socketQueue");
  2570. int status = connect(socket6FD, (const struct sockaddr *)[address6 bytes], (socklen_t)[address6 length]);
  2571. if (status != 0)
  2572. {
  2573. if (errPtr)
  2574. *errPtr = [self errnoErrorWithReason:@"Error in connect() function"];
  2575. return NO;
  2576. }
  2577. [self closeSocket4];
  2578. flags |= kIPv4Deactivated;
  2579. return YES;
  2580. }
  2581. ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
  2582. #pragma mark Multicast
  2583. ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
  2584. - (BOOL)preJoin:(NSError **)errPtr
  2585. {
  2586. if (![self preOp:errPtr])
  2587. {
  2588. return NO;
  2589. }
  2590. if (!(flags & kDidBind))
  2591. {
  2592. if (errPtr)
  2593. {
  2594. NSString *msg = @"Must bind a socket before joining a multicast group.";
  2595. *errPtr = [self badConfigError:msg];
  2596. }
  2597. return NO;
  2598. }
  2599. if ((flags & kConnecting) || (flags & kDidConnect))
  2600. {
  2601. if (errPtr)
  2602. {
  2603. NSString *msg = @"Cannot join a multicast group if connected.";
  2604. *errPtr = [self badConfigError:msg];
  2605. }
  2606. return NO;
  2607. }
  2608. return YES;
  2609. }
  2610. - (BOOL)joinMulticastGroup:(NSString *)group error:(NSError **)errPtr
  2611. {
  2612. return [self joinMulticastGroup:group onInterface:nil error:errPtr];
  2613. }
  2614. - (BOOL)joinMulticastGroup:(NSString *)group onInterface:(NSString *)interface error:(NSError **)errPtr
  2615. {
  2616. // IP_ADD_MEMBERSHIP == IPV6_JOIN_GROUP
  2617. return [self performMulticastRequest:IP_ADD_MEMBERSHIP forGroup:group onInterface:interface error:errPtr];
  2618. }
  2619. - (BOOL)leaveMulticastGroup:(NSString *)group error:(NSError **)errPtr
  2620. {
  2621. return [self leaveMulticastGroup:group onInterface:nil error:errPtr];
  2622. }
  2623. - (BOOL)leaveMulticastGroup:(NSString *)group onInterface:(NSString *)interface error:(NSError **)errPtr
  2624. {
  2625. // IP_DROP_MEMBERSHIP == IPV6_LEAVE_GROUP
  2626. return [self performMulticastRequest:IP_DROP_MEMBERSHIP forGroup:group onInterface:interface error:errPtr];
  2627. }
  2628. - (BOOL)performMulticastRequest:(int)requestType
  2629. forGroup:(NSString *)group
  2630. onInterface:(NSString *)interface
  2631. error:(NSError **)errPtr
  2632. {
  2633. __block BOOL result = NO;
  2634. __block NSError *err = nil;
  2635. dispatch_block_t block = ^{ @autoreleasepool {
  2636. // Run through sanity checks
  2637. if (![self preJoin:&err])
  2638. {
  2639. return_from_block;
  2640. }
  2641. // Convert group to address
  2642. NSData *groupAddr4 = nil;
  2643. NSData *groupAddr6 = nil;
  2644. [self convertNumericHost:group port:0 intoAddress4:&groupAddr4 address6:&groupAddr6];
  2645. if ((groupAddr4 == nil) && (groupAddr6 == nil))
  2646. {
  2647. NSString *msg = @"Unknown group. Specify valid group IP address.";
  2648. err = [self badParamError:msg];
  2649. return_from_block;
  2650. }
  2651. // Convert interface to address
  2652. NSData *interfaceAddr4 = nil;
  2653. NSData *interfaceAddr6 = nil;
  2654. [self convertIntefaceDescription:interface port:0 intoAddress4:&interfaceAddr4 address6:&interfaceAddr6];
  2655. if ((interfaceAddr4 == nil) && (interfaceAddr6 == nil))
  2656. {
  2657. NSString *msg = @"Unknown interface. Specify valid interface by name (e.g. \"en1\") or IP address.";
  2658. err = [self badParamError:msg];
  2659. return_from_block;
  2660. }
  2661. // Perform join
  2662. if ((self->socket4FD != SOCKET_NULL) && groupAddr4 && interfaceAddr4)
  2663. {
  2664. const struct sockaddr_in *nativeGroup = (const struct sockaddr_in *)[groupAddr4 bytes];
  2665. const struct sockaddr_in *nativeIface = (const struct sockaddr_in *)[interfaceAddr4 bytes];
  2666. struct ip_mreq imreq;
  2667. imreq.imr_multiaddr = nativeGroup->sin_addr;
  2668. imreq.imr_interface = nativeIface->sin_addr;
  2669. int status = setsockopt(self->socket4FD, IPPROTO_IP, requestType, (const void *)&imreq, sizeof(imreq));
  2670. if (status != 0)
  2671. {
  2672. err = [self errnoErrorWithReason:@"Error in setsockopt() function"];
  2673. return_from_block;
  2674. }
  2675. // Using IPv4 only
  2676. [self closeSocket6];
  2677. result = YES;
  2678. }
  2679. else if ((self->socket6FD != SOCKET_NULL) && groupAddr6 && interfaceAddr6)
  2680. {
  2681. const struct sockaddr_in6 *nativeGroup = (const struct sockaddr_in6 *)[groupAddr6 bytes];
  2682. struct ipv6_mreq imreq;
  2683. imreq.ipv6mr_multiaddr = nativeGroup->sin6_addr;
  2684. imreq.ipv6mr_interface = [self indexOfInterfaceAddr6:interfaceAddr6];
  2685. int status = setsockopt(self->socket6FD, IPPROTO_IPV6, requestType, (const void *)&imreq, sizeof(imreq));
  2686. if (status != 0)
  2687. {
  2688. err = [self errnoErrorWithReason:@"Error in setsockopt() function"];
  2689. return_from_block;
  2690. }
  2691. // Using IPv6 only
  2692. [self closeSocket4];
  2693. result = YES;
  2694. }
  2695. else
  2696. {
  2697. NSString *msg = @"Socket, group, and interface do not have matching IP versions";
  2698. err = [self badParamError:msg];
  2699. return_from_block;
  2700. }
  2701. }};
  2702. if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey))
  2703. block();
  2704. else
  2705. dispatch_sync(socketQueue, block);
  2706. if (errPtr)
  2707. *errPtr = err;
  2708. return result;
  2709. }
  2710. ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
  2711. #pragma mark Reuse port
  2712. ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
  2713. - (BOOL)enableReusePort:(BOOL)flag error:(NSError **)errPtr
  2714. {
  2715. __block BOOL result = NO;
  2716. __block NSError *err = nil;
  2717. dispatch_block_t block = ^{ @autoreleasepool {
  2718. if (![self preOp:&err])
  2719. {
  2720. return_from_block;
  2721. }
  2722. if ((self->flags & kDidCreateSockets) == 0)
  2723. {
  2724. if (![self createSockets:&err])
  2725. {
  2726. return_from_block;
  2727. }
  2728. }
  2729. int value = flag ? 1 : 0;
  2730. if (self->socket4FD != SOCKET_NULL)
  2731. {
  2732. int error = setsockopt(self->socket4FD, SOL_SOCKET, SO_REUSEPORT, (const void *)&value, sizeof(value));
  2733. if (error)
  2734. {
  2735. err = [self errnoErrorWithReason:@"Error in setsockopt() function"];
  2736. return_from_block;
  2737. }
  2738. result = YES;
  2739. }
  2740. if (self->socket6FD != SOCKET_NULL)
  2741. {
  2742. int error = setsockopt(self->socket6FD, SOL_SOCKET, SO_REUSEPORT, (const void *)&value, sizeof(value));
  2743. if (error)
  2744. {
  2745. err = [self errnoErrorWithReason:@"Error in setsockopt() function"];
  2746. return_from_block;
  2747. }
  2748. result = YES;
  2749. }
  2750. }};
  2751. if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey))
  2752. block();
  2753. else
  2754. dispatch_sync(socketQueue, block);
  2755. if (errPtr)
  2756. *errPtr = err;
  2757. return result;
  2758. }
  2759. ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
  2760. #pragma mark Broadcast
  2761. ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
  2762. - (BOOL)enableBroadcast:(BOOL)flag error:(NSError **)errPtr
  2763. {
  2764. __block BOOL result = NO;
  2765. __block NSError *err = nil;
  2766. dispatch_block_t block = ^{ @autoreleasepool {
  2767. if (![self preOp:&err])
  2768. {
  2769. return_from_block;
  2770. }
  2771. if ((self->flags & kDidCreateSockets) == 0)
  2772. {
  2773. if (![self createSockets:&err])
  2774. {
  2775. return_from_block;
  2776. }
  2777. }
  2778. if (self->socket4FD != SOCKET_NULL)
  2779. {
  2780. int value = flag ? 1 : 0;
  2781. int error = setsockopt(self->socket4FD, SOL_SOCKET, SO_BROADCAST, (const void *)&value, sizeof(value));
  2782. if (error)
  2783. {
  2784. err = [self errnoErrorWithReason:@"Error in setsockopt() function"];
  2785. return_from_block;
  2786. }
  2787. result = YES;
  2788. }
  2789. // IPv6 does not implement broadcast, the ability to send a packet to all hosts on the attached link.
  2790. // The same effect can be achieved by sending a packet to the link-local all hosts multicast group.
  2791. }};
  2792. if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey))
  2793. block();
  2794. else
  2795. dispatch_sync(socketQueue, block);
  2796. if (errPtr)
  2797. *errPtr = err;
  2798. return result;
  2799. }
  2800. ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
  2801. #pragma mark Sending
  2802. ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
  2803. - (void)sendData:(NSData *)data withTag:(long)tag
  2804. {
  2805. [self sendData:data withTimeout:-1.0 tag:tag];
  2806. }
  2807. - (void)sendData:(NSData *)data withTimeout:(NSTimeInterval)timeout tag:(long)tag
  2808. {
  2809. LogTrace();
  2810. if ([data length] == 0)
  2811. {
  2812. LogWarn(@"Ignoring attempt to send nil/empty data.");
  2813. return;
  2814. }
  2815. GCDAsyncUdpSendPacket *packet = [[GCDAsyncUdpSendPacket alloc] initWithData:data timeout:timeout tag:tag];
  2816. dispatch_async(socketQueue, ^{ @autoreleasepool {
  2817. [self->sendQueue addObject:packet];
  2818. [self maybeDequeueSend];
  2819. }});
  2820. }
  2821. - (void)sendData:(NSData *)data
  2822. toHost:(NSString *)host
  2823. port:(uint16_t)port
  2824. withTimeout:(NSTimeInterval)timeout
  2825. tag:(long)tag
  2826. {
  2827. LogTrace();
  2828. if ([data length] == 0)
  2829. {
  2830. LogWarn(@"Ignoring attempt to send nil/empty data.");
  2831. return;
  2832. }
  2833. GCDAsyncUdpSendPacket *packet = [[GCDAsyncUdpSendPacket alloc] initWithData:data timeout:timeout tag:tag];
  2834. packet->resolveInProgress = YES;
  2835. [self asyncResolveHost:host port:port withCompletionBlock:^(NSArray *addresses, NSError *error) {
  2836. // The asyncResolveHost:port:: method asynchronously dispatches a task onto the global concurrent queue,
  2837. // and immediately returns. Once the async resolve task completes,
  2838. // this block is executed on our socketQueue.
  2839. packet->resolveInProgress = NO;
  2840. packet->resolvedAddresses = addresses;
  2841. packet->resolveError = error;
  2842. if (packet == self->currentSend)
  2843. {
  2844. LogVerbose(@"currentSend - address resolved");
  2845. [self doPreSend];
  2846. }
  2847. }];
  2848. dispatch_async(socketQueue, ^{ @autoreleasepool {
  2849. [self->sendQueue addObject:packet];
  2850. [self maybeDequeueSend];
  2851. }});
  2852. }
  2853. - (void)sendData:(NSData *)data toAddress:(NSData *)remoteAddr withTimeout:(NSTimeInterval)timeout tag:(long)tag
  2854. {
  2855. LogTrace();
  2856. if ([data length] == 0)
  2857. {
  2858. LogWarn(@"Ignoring attempt to send nil/empty data.");
  2859. return;
  2860. }
  2861. GCDAsyncUdpSendPacket *packet = [[GCDAsyncUdpSendPacket alloc] initWithData:data timeout:timeout tag:tag];
  2862. packet->addressFamily = [GCDAsyncUdpSocket familyFromAddress:remoteAddr];
  2863. packet->address = remoteAddr;
  2864. dispatch_async(socketQueue, ^{ @autoreleasepool {
  2865. [self->sendQueue addObject:packet];
  2866. [self maybeDequeueSend];
  2867. }});
  2868. }
  2869. - (void)setSendFilter:(GCDAsyncUdpSocketSendFilterBlock)filterBlock withQueue:(dispatch_queue_t)filterQueue
  2870. {
  2871. [self setSendFilter:filterBlock withQueue:filterQueue isAsynchronous:YES];
  2872. }
  2873. - (void)setSendFilter:(GCDAsyncUdpSocketSendFilterBlock)filterBlock
  2874. withQueue:(dispatch_queue_t)filterQueue
  2875. isAsynchronous:(BOOL)isAsynchronous
  2876. {
  2877. GCDAsyncUdpSocketSendFilterBlock newFilterBlock = NULL;
  2878. dispatch_queue_t newFilterQueue = NULL;
  2879. if (filterBlock)
  2880. {
  2881. NSAssert(filterQueue, @"Must provide a dispatch_queue in which to run the filter block.");
  2882. newFilterBlock = [filterBlock copy];
  2883. newFilterQueue = filterQueue;
  2884. #if !OS_OBJECT_USE_OBJC
  2885. dispatch_retain(newFilterQueue);
  2886. #endif
  2887. }
  2888. dispatch_block_t block = ^{
  2889. #if !OS_OBJECT_USE_OBJC
  2890. if (self->sendFilterQueue) dispatch_release(self->sendFilterQueue);
  2891. #endif
  2892. self->sendFilterBlock = newFilterBlock;
  2893. self->sendFilterQueue = newFilterQueue;
  2894. self->sendFilterAsync = isAsynchronous;
  2895. };
  2896. if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey))
  2897. block();
  2898. else
  2899. dispatch_async(socketQueue, block);
  2900. }
  2901. - (void)maybeDequeueSend
  2902. {
  2903. LogTrace();
  2904. NSAssert(dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey), @"Must be dispatched on socketQueue");
  2905. // If we don't have a send operation already in progress
  2906. if (currentSend == nil)
  2907. {
  2908. // Create the sockets if needed
  2909. if ((flags & kDidCreateSockets) == 0)
  2910. {
  2911. NSError *err = nil;
  2912. if (![self createSockets:&err])
  2913. {
  2914. [self closeWithError:err];
  2915. return;
  2916. }
  2917. }
  2918. while ([sendQueue count] > 0)
  2919. {
  2920. // Dequeue the next object in the queue
  2921. currentSend = [sendQueue objectAtIndex:0];
  2922. [sendQueue removeObjectAtIndex:0];
  2923. if ([currentSend isKindOfClass:[GCDAsyncUdpSpecialPacket class]])
  2924. {
  2925. [self maybeConnect];
  2926. return; // The maybeConnect method, if it connects, will invoke this method again
  2927. }
  2928. else if (currentSend->resolveError)
  2929. {
  2930. // Notify delegate
  2931. [self notifyDidNotSendDataWithTag:currentSend->tag dueToError:currentSend->resolveError];
  2932. // Clear currentSend
  2933. currentSend = nil;
  2934. continue;
  2935. }
  2936. else
  2937. {
  2938. // Start preprocessing checks on the send packet
  2939. [self doPreSend];
  2940. break;
  2941. }
  2942. }
  2943. if ((currentSend == nil) && (flags & kCloseAfterSends))
  2944. {
  2945. [self closeWithError:nil];
  2946. }
  2947. }
  2948. }
  2949. /**
  2950. * This method is called after a sendPacket has been dequeued.
  2951. * It performs various preprocessing checks on the packet,
  2952. * and queries the sendFilter (if set) to determine if the packet can be sent.
  2953. *
  2954. * If the packet passes all checks, it will be passed on to the doSend method.
  2955. **/
  2956. - (void)doPreSend
  2957. {
  2958. LogTrace();
  2959. //
  2960. // 1. Check for problems with send packet
  2961. //
  2962. BOOL waitingForResolve = NO;
  2963. NSError *error = nil;
  2964. if (flags & kDidConnect)
  2965. {
  2966. // Connected socket
  2967. if (currentSend->resolveInProgress || currentSend->resolvedAddresses || currentSend->resolveError)
  2968. {
  2969. NSString *msg = @"Cannot specify destination of packet for connected socket";
  2970. error = [self badConfigError:msg];
  2971. }
  2972. else
  2973. {
  2974. currentSend->address = cachedConnectedAddress;
  2975. currentSend->addressFamily = cachedConnectedFamily;
  2976. }
  2977. }
  2978. else
  2979. {
  2980. // Non-Connected socket
  2981. if (currentSend->resolveInProgress)
  2982. {
  2983. // We're waiting for the packet's destination to be resolved.
  2984. waitingForResolve = YES;
  2985. }
  2986. else if (currentSend->resolveError)
  2987. {
  2988. error = currentSend->resolveError;
  2989. }
  2990. else if (currentSend->address == nil)
  2991. {
  2992. if (currentSend->resolvedAddresses == nil)
  2993. {
  2994. NSString *msg = @"You must specify destination of packet for a non-connected socket";
  2995. error = [self badConfigError:msg];
  2996. }
  2997. else
  2998. {
  2999. // Pick the proper address to use (out of possibly several resolved addresses)
  3000. NSData *address = nil;
  3001. int addressFamily = AF_UNSPEC;
  3002. addressFamily = [self getAddress:&address error:&error fromAddresses:currentSend->resolvedAddresses];
  3003. currentSend->address = address;
  3004. currentSend->addressFamily = addressFamily;
  3005. }
  3006. }
  3007. }
  3008. if (waitingForResolve)
  3009. {
  3010. // We're waiting for the packet's destination to be resolved.
  3011. LogVerbose(@"currentSend - waiting for address resolve");
  3012. if (flags & kSock4CanAcceptBytes) {
  3013. [self suspendSend4Source];
  3014. }
  3015. if (flags & kSock6CanAcceptBytes) {
  3016. [self suspendSend6Source];
  3017. }
  3018. return;
  3019. }
  3020. if (error)
  3021. {
  3022. // Unable to send packet due to some error.
  3023. // Notify delegate and move on.
  3024. [self notifyDidNotSendDataWithTag:currentSend->tag dueToError:error];
  3025. [self endCurrentSend];
  3026. [self maybeDequeueSend];
  3027. return;
  3028. }
  3029. //
  3030. // 2. Query sendFilter (if applicable)
  3031. //
  3032. if (sendFilterBlock && sendFilterQueue)
  3033. {
  3034. // Query sendFilter
  3035. if (sendFilterAsync)
  3036. {
  3037. // Scenario 1 of 3 - Need to asynchronously query sendFilter
  3038. currentSend->filterInProgress = YES;
  3039. GCDAsyncUdpSendPacket *sendPacket = currentSend;
  3040. dispatch_async(sendFilterQueue, ^{ @autoreleasepool {
  3041. BOOL allowed = self->sendFilterBlock(sendPacket->buffer, sendPacket->address, sendPacket->tag);
  3042. dispatch_async(self->socketQueue, ^{ @autoreleasepool {
  3043. sendPacket->filterInProgress = NO;
  3044. if (sendPacket == self->currentSend)
  3045. {
  3046. if (allowed)
  3047. {
  3048. [self doSend];
  3049. }
  3050. else
  3051. {
  3052. LogVerbose(@"currentSend - silently dropped by sendFilter");
  3053. [self notifyDidSendDataWithTag:self->currentSend->tag];
  3054. [self endCurrentSend];
  3055. [self maybeDequeueSend];
  3056. }
  3057. }
  3058. }});
  3059. }});
  3060. }
  3061. else
  3062. {
  3063. // Scenario 2 of 3 - Need to synchronously query sendFilter
  3064. __block BOOL allowed = YES;
  3065. dispatch_sync(sendFilterQueue, ^{ @autoreleasepool {
  3066. allowed = self->sendFilterBlock(self->currentSend->buffer, self->currentSend->address, self->currentSend->tag);
  3067. }});
  3068. if (allowed)
  3069. {
  3070. [self doSend];
  3071. }
  3072. else
  3073. {
  3074. LogVerbose(@"currentSend - silently dropped by sendFilter");
  3075. [self notifyDidSendDataWithTag:currentSend->tag];
  3076. [self endCurrentSend];
  3077. [self maybeDequeueSend];
  3078. }
  3079. }
  3080. }
  3081. else // if (!sendFilterBlock || !sendFilterQueue)
  3082. {
  3083. // Scenario 3 of 3 - No sendFilter. Just go straight into sending.
  3084. [self doSend];
  3085. }
  3086. }
  3087. /**
  3088. * This method performs the actual sending of data in the currentSend packet.
  3089. * It should only be called if the
  3090. **/
  3091. - (void)doSend
  3092. {
  3093. LogTrace();
  3094. NSAssert(currentSend != nil, @"Invalid logic");
  3095. // Perform the actual send
  3096. ssize_t result = 0;
  3097. if (flags & kDidConnect)
  3098. {
  3099. // Connected socket
  3100. const void *buffer = [currentSend->buffer bytes];
  3101. size_t length = (size_t)[currentSend->buffer length];
  3102. if (currentSend->addressFamily == AF_INET)
  3103. {
  3104. result = send(socket4FD, buffer, length, 0);
  3105. LogVerbose(@"send(socket4FD) = %d", result);
  3106. }
  3107. else
  3108. {
  3109. result = send(socket6FD, buffer, length, 0);
  3110. LogVerbose(@"send(socket6FD) = %d", result);
  3111. }
  3112. }
  3113. else
  3114. {
  3115. // Non-Connected socket
  3116. const void *buffer = [currentSend->buffer bytes];
  3117. size_t length = (size_t)[currentSend->buffer length];
  3118. const void *dst = [currentSend->address bytes];
  3119. socklen_t dstSize = (socklen_t)[currentSend->address length];
  3120. if (currentSend->addressFamily == AF_INET)
  3121. {
  3122. result = sendto(socket4FD, buffer, length, 0, dst, dstSize);
  3123. LogVerbose(@"sendto(socket4FD) = %d", result);
  3124. }
  3125. else
  3126. {
  3127. result = sendto(socket6FD, buffer, length, 0, dst, dstSize);
  3128. LogVerbose(@"sendto(socket6FD) = %d", result);
  3129. }
  3130. }
  3131. // If the socket wasn't bound before, it is now
  3132. if ((flags & kDidBind) == 0)
  3133. {
  3134. flags |= kDidBind;
  3135. }
  3136. // Check the results.
  3137. //
  3138. // From the send() & sendto() manpage:
  3139. //
  3140. // Upon successful completion, the number of bytes which were sent is returned.
  3141. // Otherwise, -1 is returned and the global variable errno is set to indicate the error.
  3142. BOOL waitingForSocket = NO;
  3143. NSError *socketError = nil;
  3144. if (result == 0)
  3145. {
  3146. waitingForSocket = YES;
  3147. }
  3148. else if (result < 0)
  3149. {
  3150. if (errno == EAGAIN)
  3151. waitingForSocket = YES;
  3152. else
  3153. socketError = [self errnoErrorWithReason:@"Error in send() function."];
  3154. }
  3155. if (waitingForSocket)
  3156. {
  3157. // Not enough room in the underlying OS socket send buffer.
  3158. // Wait for a notification of available space.
  3159. LogVerbose(@"currentSend - waiting for socket");
  3160. if (!(flags & kSock4CanAcceptBytes)) {
  3161. [self resumeSend4Source];
  3162. }
  3163. if (!(flags & kSock6CanAcceptBytes)) {
  3164. [self resumeSend6Source];
  3165. }
  3166. if ((sendTimer == NULL) && (currentSend->timeout >= 0.0))
  3167. {
  3168. // Unable to send packet right away.
  3169. // Start timer to timeout the send operation.
  3170. [self setupSendTimerWithTimeout:currentSend->timeout];
  3171. }
  3172. }
  3173. else if (socketError)
  3174. {
  3175. [self closeWithError:socketError];
  3176. }
  3177. else // done
  3178. {
  3179. [self notifyDidSendDataWithTag:currentSend->tag];
  3180. [self endCurrentSend];
  3181. [self maybeDequeueSend];
  3182. }
  3183. }
  3184. /**
  3185. * Releases all resources associated with the currentSend.
  3186. **/
  3187. - (void)endCurrentSend
  3188. {
  3189. if (sendTimer)
  3190. {
  3191. dispatch_source_cancel(sendTimer);
  3192. #if !OS_OBJECT_USE_OBJC
  3193. dispatch_release(sendTimer);
  3194. #endif
  3195. sendTimer = NULL;
  3196. }
  3197. currentSend = nil;
  3198. }
  3199. /**
  3200. * Performs the operations to timeout the current send operation, and move on.
  3201. **/
  3202. - (void)doSendTimeout
  3203. {
  3204. LogTrace();
  3205. [self notifyDidNotSendDataWithTag:currentSend->tag dueToError:[self sendTimeoutError]];
  3206. [self endCurrentSend];
  3207. [self maybeDequeueSend];
  3208. }
  3209. /**
  3210. * Sets up a timer that fires to timeout the current send operation.
  3211. * This method should only be called once per send packet.
  3212. **/
  3213. - (void)setupSendTimerWithTimeout:(NSTimeInterval)timeout
  3214. {
  3215. NSAssert(sendTimer == NULL, @"Invalid logic");
  3216. NSAssert(timeout >= 0.0, @"Invalid logic");
  3217. LogTrace();
  3218. sendTimer = dispatch_source_create(DISPATCH_SOURCE_TYPE_TIMER, 0, 0, socketQueue);
  3219. dispatch_source_set_event_handler(sendTimer, ^{ @autoreleasepool {
  3220. [self doSendTimeout];
  3221. }});
  3222. dispatch_time_t tt = dispatch_time(DISPATCH_TIME_NOW, (int64_t)(timeout * NSEC_PER_SEC));
  3223. dispatch_source_set_timer(sendTimer, tt, DISPATCH_TIME_FOREVER, 0);
  3224. dispatch_resume(sendTimer);
  3225. }
  3226. ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
  3227. #pragma mark Receiving
  3228. ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
  3229. - (BOOL)receiveOnce:(NSError **)errPtr
  3230. {
  3231. LogTrace();
  3232. __block BOOL result = NO;
  3233. __block NSError *err = nil;
  3234. dispatch_block_t block = ^{
  3235. if ((self->flags & kReceiveOnce) == 0)
  3236. {
  3237. if ((self->flags & kDidCreateSockets) == 0)
  3238. {
  3239. NSString *msg = @"Must bind socket before you can receive data. "
  3240. @"You can do this explicitly via bind, or implicitly via connect or by sending data.";
  3241. err = [self badConfigError:msg];
  3242. return_from_block;
  3243. }
  3244. self->flags |= kReceiveOnce; // Enable
  3245. self->flags &= ~kReceiveContinuous; // Disable
  3246. dispatch_async(self->socketQueue, ^{ @autoreleasepool {
  3247. [self doReceive];
  3248. }});
  3249. }
  3250. result = YES;
  3251. };
  3252. if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey))
  3253. block();
  3254. else
  3255. dispatch_sync(socketQueue, block);
  3256. if (err)
  3257. LogError(@"Error in beginReceiving: %@", err);
  3258. if (errPtr)
  3259. *errPtr = err;
  3260. return result;
  3261. }
  3262. - (BOOL)beginReceiving:(NSError **)errPtr
  3263. {
  3264. LogTrace();
  3265. __block BOOL result = NO;
  3266. __block NSError *err = nil;
  3267. dispatch_block_t block = ^{
  3268. if ((self->flags & kReceiveContinuous) == 0)
  3269. {
  3270. if ((self->flags & kDidCreateSockets) == 0)
  3271. {
  3272. NSString *msg = @"Must bind socket before you can receive data. "
  3273. @"You can do this explicitly via bind, or implicitly via connect or by sending data.";
  3274. err = [self badConfigError:msg];
  3275. return_from_block;
  3276. }
  3277. self->flags |= kReceiveContinuous; // Enable
  3278. self->flags &= ~kReceiveOnce; // Disable
  3279. dispatch_async(self->socketQueue, ^{ @autoreleasepool {
  3280. [self doReceive];
  3281. }});
  3282. }
  3283. result = YES;
  3284. };
  3285. if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey))
  3286. block();
  3287. else
  3288. dispatch_sync(socketQueue, block);
  3289. if (err)
  3290. LogError(@"Error in beginReceiving: %@", err);
  3291. if (errPtr)
  3292. *errPtr = err;
  3293. return result;
  3294. }
  3295. - (void)pauseReceiving
  3296. {
  3297. LogTrace();
  3298. dispatch_block_t block = ^{
  3299. self->flags &= ~kReceiveOnce; // Disable
  3300. self->flags &= ~kReceiveContinuous; // Disable
  3301. if (self->socket4FDBytesAvailable > 0) {
  3302. [self suspendReceive4Source];
  3303. }
  3304. if (self->socket6FDBytesAvailable > 0) {
  3305. [self suspendReceive6Source];
  3306. }
  3307. };
  3308. if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey))
  3309. block();
  3310. else
  3311. dispatch_async(socketQueue, block);
  3312. }
  3313. - (void)setReceiveFilter:(GCDAsyncUdpSocketReceiveFilterBlock)filterBlock withQueue:(dispatch_queue_t)filterQueue
  3314. {
  3315. [self setReceiveFilter:filterBlock withQueue:filterQueue isAsynchronous:YES];
  3316. }
  3317. - (void)setReceiveFilter:(GCDAsyncUdpSocketReceiveFilterBlock)filterBlock
  3318. withQueue:(dispatch_queue_t)filterQueue
  3319. isAsynchronous:(BOOL)isAsynchronous
  3320. {
  3321. GCDAsyncUdpSocketReceiveFilterBlock newFilterBlock = NULL;
  3322. dispatch_queue_t newFilterQueue = NULL;
  3323. if (filterBlock)
  3324. {
  3325. NSAssert(filterQueue, @"Must provide a dispatch_queue in which to run the filter block.");
  3326. newFilterBlock = [filterBlock copy];
  3327. newFilterQueue = filterQueue;
  3328. #if !OS_OBJECT_USE_OBJC
  3329. dispatch_retain(newFilterQueue);
  3330. #endif
  3331. }
  3332. dispatch_block_t block = ^{
  3333. #if !OS_OBJECT_USE_OBJC
  3334. if (self->receiveFilterQueue) dispatch_release(self->receiveFilterQueue);
  3335. #endif
  3336. self->receiveFilterBlock = newFilterBlock;
  3337. self->receiveFilterQueue = newFilterQueue;
  3338. self->receiveFilterAsync = isAsynchronous;
  3339. };
  3340. if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey))
  3341. block();
  3342. else
  3343. dispatch_async(socketQueue, block);
  3344. }
  3345. - (void)doReceive
  3346. {
  3347. LogTrace();
  3348. if ((flags & (kReceiveOnce | kReceiveContinuous)) == 0)
  3349. {
  3350. LogVerbose(@"Receiving is paused...");
  3351. if (socket4FDBytesAvailable > 0) {
  3352. [self suspendReceive4Source];
  3353. }
  3354. if (socket6FDBytesAvailable > 0) {
  3355. [self suspendReceive6Source];
  3356. }
  3357. return;
  3358. }
  3359. if ((flags & kReceiveOnce) && (pendingFilterOperations > 0))
  3360. {
  3361. LogVerbose(@"Receiving is temporarily paused (pending filter operations)...");
  3362. if (socket4FDBytesAvailable > 0) {
  3363. [self suspendReceive4Source];
  3364. }
  3365. if (socket6FDBytesAvailable > 0) {
  3366. [self suspendReceive6Source];
  3367. }
  3368. return;
  3369. }
  3370. if ((socket4FDBytesAvailable == 0) && (socket6FDBytesAvailable == 0))
  3371. {
  3372. LogVerbose(@"No data available to receive...");
  3373. if (socket4FDBytesAvailable == 0) {
  3374. [self resumeReceive4Source];
  3375. }
  3376. if (socket6FDBytesAvailable == 0) {
  3377. [self resumeReceive6Source];
  3378. }
  3379. return;
  3380. }
  3381. // Figure out if we should receive on socket4 or socket6
  3382. BOOL doReceive4;
  3383. if (flags & kDidConnect)
  3384. {
  3385. // Connected socket
  3386. doReceive4 = (socket4FD != SOCKET_NULL);
  3387. }
  3388. else
  3389. {
  3390. // Non-Connected socket
  3391. if (socket4FDBytesAvailable > 0)
  3392. {
  3393. if (socket6FDBytesAvailable > 0)
  3394. {
  3395. // Bytes available on socket4 & socket6
  3396. doReceive4 = (flags & kFlipFlop) ? YES : NO;
  3397. flags ^= kFlipFlop; // flags = flags xor kFlipFlop; (toggle flip flop bit)
  3398. }
  3399. else {
  3400. // Bytes available on socket4, but not socket6
  3401. doReceive4 = YES;
  3402. }
  3403. }
  3404. else {
  3405. // Bytes available on socket6, but not socket4
  3406. doReceive4 = NO;
  3407. }
  3408. }
  3409. // Perform socket IO
  3410. ssize_t result = 0;
  3411. NSData *data = nil;
  3412. NSData *addr4 = nil;
  3413. NSData *addr6 = nil;
  3414. if (doReceive4)
  3415. {
  3416. NSAssert(socket4FDBytesAvailable > 0, @"Invalid logic");
  3417. LogVerbose(@"Receiving on IPv4");
  3418. struct sockaddr_in sockaddr4;
  3419. socklen_t sockaddr4len = sizeof(sockaddr4);
  3420. // #222: GCD does not necessarily return the size of an entire UDP packet
  3421. // from dispatch_source_get_data(), so we must use the maximum packet size.
  3422. size_t bufSize = max4ReceiveSize;
  3423. void *buf = malloc(bufSize);
  3424. result = recvfrom(socket4FD, buf, bufSize, 0, (struct sockaddr *)&sockaddr4, &sockaddr4len);
  3425. LogVerbose(@"recvfrom(socket4FD) = %i", (int)result);
  3426. if (result > 0)
  3427. {
  3428. if ((size_t)result >= socket4FDBytesAvailable)
  3429. socket4FDBytesAvailable = 0;
  3430. else
  3431. socket4FDBytesAvailable -= result;
  3432. if ((size_t)result != bufSize) {
  3433. buf = realloc(buf, result);
  3434. }
  3435. data = [NSData dataWithBytesNoCopy:buf length:result freeWhenDone:YES];
  3436. addr4 = [NSData dataWithBytes:&sockaddr4 length:sockaddr4len];
  3437. }
  3438. else
  3439. {
  3440. LogVerbose(@"recvfrom(socket4FD) = %@", [self errnoError]);
  3441. socket4FDBytesAvailable = 0;
  3442. free(buf);
  3443. }
  3444. }
  3445. else
  3446. {
  3447. NSAssert(socket6FDBytesAvailable > 0, @"Invalid logic");
  3448. LogVerbose(@"Receiving on IPv6");
  3449. struct sockaddr_in6 sockaddr6;
  3450. socklen_t sockaddr6len = sizeof(sockaddr6);
  3451. // #222: GCD does not necessarily return the size of an entire UDP packet
  3452. // from dispatch_source_get_data(), so we must use the maximum packet size.
  3453. size_t bufSize = max6ReceiveSize;
  3454. void *buf = malloc(bufSize);
  3455. result = recvfrom(socket6FD, buf, bufSize, 0, (struct sockaddr *)&sockaddr6, &sockaddr6len);
  3456. LogVerbose(@"recvfrom(socket6FD) -> %i", (int)result);
  3457. if (result > 0)
  3458. {
  3459. if ((size_t)result >= socket6FDBytesAvailable)
  3460. socket6FDBytesAvailable = 0;
  3461. else
  3462. socket6FDBytesAvailable -= result;
  3463. if ((size_t)result != bufSize) {
  3464. buf = realloc(buf, result);
  3465. }
  3466. data = [NSData dataWithBytesNoCopy:buf length:result freeWhenDone:YES];
  3467. addr6 = [NSData dataWithBytes:&sockaddr6 length:sockaddr6len];
  3468. }
  3469. else
  3470. {
  3471. LogVerbose(@"recvfrom(socket6FD) = %@", [self errnoError]);
  3472. socket6FDBytesAvailable = 0;
  3473. free(buf);
  3474. }
  3475. }
  3476. BOOL waitingForSocket = NO;
  3477. BOOL notifiedDelegate = NO;
  3478. BOOL ignored = NO;
  3479. NSError *socketError = nil;
  3480. if (result == 0)
  3481. {
  3482. waitingForSocket = YES;
  3483. }
  3484. else if (result < 0)
  3485. {
  3486. if (errno == EAGAIN)
  3487. waitingForSocket = YES;
  3488. else
  3489. socketError = [self errnoErrorWithReason:@"Error in recvfrom() function"];
  3490. }
  3491. else
  3492. {
  3493. if (flags & kDidConnect)
  3494. {
  3495. if (addr4 && ![self isConnectedToAddress4:addr4])
  3496. ignored = YES;
  3497. if (addr6 && ![self isConnectedToAddress6:addr6])
  3498. ignored = YES;
  3499. }
  3500. NSData *addr = (addr4 != nil) ? addr4 : addr6;
  3501. if (!ignored)
  3502. {
  3503. if (receiveFilterBlock && receiveFilterQueue)
  3504. {
  3505. // Run data through filter, and if approved, notify delegate
  3506. __block id filterContext = nil;
  3507. __block BOOL allowed = NO;
  3508. if (receiveFilterAsync)
  3509. {
  3510. pendingFilterOperations++;
  3511. dispatch_async(receiveFilterQueue, ^{ @autoreleasepool {
  3512. allowed = self->receiveFilterBlock(data, addr, &filterContext);
  3513. // Transition back to socketQueue to get the current delegate / delegateQueue
  3514. dispatch_async(self->socketQueue, ^{ @autoreleasepool {
  3515. self->pendingFilterOperations--;
  3516. if (allowed)
  3517. {
  3518. [self notifyDidReceiveData:data fromAddress:addr withFilterContext:filterContext];
  3519. }
  3520. else
  3521. {
  3522. LogVerbose(@"received packet silently dropped by receiveFilter");
  3523. }
  3524. if (self->flags & kReceiveOnce)
  3525. {
  3526. if (allowed)
  3527. {
  3528. // The delegate has been notified,
  3529. // so our receive once operation has completed.
  3530. self->flags &= ~kReceiveOnce;
  3531. }
  3532. else if (self->pendingFilterOperations == 0)
  3533. {
  3534. // All pending filter operations have completed,
  3535. // and none were allowed through.
  3536. // Our receive once operation hasn't completed yet.
  3537. [self doReceive];
  3538. }
  3539. }
  3540. }});
  3541. }});
  3542. }
  3543. else // if (!receiveFilterAsync)
  3544. {
  3545. dispatch_sync(receiveFilterQueue, ^{ @autoreleasepool {
  3546. allowed = self->receiveFilterBlock(data, addr, &filterContext);
  3547. }});
  3548. if (allowed)
  3549. {
  3550. [self notifyDidReceiveData:data fromAddress:addr withFilterContext:filterContext];
  3551. notifiedDelegate = YES;
  3552. }
  3553. else
  3554. {
  3555. LogVerbose(@"received packet silently dropped by receiveFilter");
  3556. ignored = YES;
  3557. }
  3558. }
  3559. }
  3560. else // if (!receiveFilterBlock || !receiveFilterQueue)
  3561. {
  3562. [self notifyDidReceiveData:data fromAddress:addr withFilterContext:nil];
  3563. notifiedDelegate = YES;
  3564. }
  3565. }
  3566. }
  3567. if (waitingForSocket)
  3568. {
  3569. // Wait for a notification of available data.
  3570. if (socket4FDBytesAvailable == 0) {
  3571. [self resumeReceive4Source];
  3572. }
  3573. if (socket6FDBytesAvailable == 0) {
  3574. [self resumeReceive6Source];
  3575. }
  3576. }
  3577. else if (socketError)
  3578. {
  3579. [self closeWithError:socketError];
  3580. }
  3581. else
  3582. {
  3583. if (flags & kReceiveContinuous)
  3584. {
  3585. // Continuous receive mode
  3586. [self doReceive];
  3587. }
  3588. else
  3589. {
  3590. // One-at-a-time receive mode
  3591. if (notifiedDelegate)
  3592. {
  3593. // The delegate has been notified (no set filter).
  3594. // So our receive once operation has completed.
  3595. flags &= ~kReceiveOnce;
  3596. }
  3597. else if (ignored)
  3598. {
  3599. [self doReceive];
  3600. }
  3601. else
  3602. {
  3603. // Waiting on asynchronous receive filter...
  3604. }
  3605. }
  3606. }
  3607. }
  3608. - (void)doReceiveEOF
  3609. {
  3610. LogTrace();
  3611. [self closeWithError:[self socketClosedError]];
  3612. }
  3613. ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
  3614. #pragma mark Closing
  3615. ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
  3616. - (void)closeWithError:(NSError *)error
  3617. {
  3618. LogVerbose(@"closeWithError: %@", error);
  3619. NSAssert(dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey), @"Must be dispatched on socketQueue");
  3620. if (currentSend) [self endCurrentSend];
  3621. [sendQueue removeAllObjects];
  3622. // If a socket has been created, we should notify the delegate.
  3623. BOOL shouldCallDelegate = (flags & kDidCreateSockets) ? YES : NO;
  3624. // Close all sockets, send/receive sources, cfstreams, etc
  3625. #if TARGET_OS_IPHONE
  3626. [self removeStreamsFromRunLoop];
  3627. [self closeReadAndWriteStreams];
  3628. #endif
  3629. [self closeSockets];
  3630. // Clear all flags (config remains as is)
  3631. flags = 0;
  3632. if (shouldCallDelegate)
  3633. {
  3634. [self notifyDidCloseWithError:error];
  3635. }
  3636. }
  3637. - (void)close
  3638. {
  3639. LogTrace();
  3640. dispatch_block_t block = ^{ @autoreleasepool {
  3641. [self closeWithError:nil];
  3642. }};
  3643. if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey))
  3644. block();
  3645. else
  3646. dispatch_sync(socketQueue, block);
  3647. }
  3648. - (void)closeAfterSending
  3649. {
  3650. LogTrace();
  3651. dispatch_block_t block = ^{ @autoreleasepool {
  3652. self->flags |= kCloseAfterSends;
  3653. if (self->currentSend == nil && [self->sendQueue count] == 0)
  3654. {
  3655. [self closeWithError:nil];
  3656. }
  3657. }};
  3658. if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey))
  3659. block();
  3660. else
  3661. dispatch_async(socketQueue, block);
  3662. }
  3663. ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
  3664. #pragma mark CFStream
  3665. ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
  3666. #if TARGET_OS_IPHONE
  3667. static NSThread *listenerThread;
  3668. + (void)ignore:(id)_
  3669. {}
  3670. + (void)startListenerThreadIfNeeded
  3671. {
  3672. static dispatch_once_t predicate;
  3673. dispatch_once(&predicate, ^{
  3674. listenerThread = [[NSThread alloc] initWithTarget:self
  3675. selector:@selector(listenerThread:)
  3676. object:nil];
  3677. [listenerThread start];
  3678. });
  3679. }
  3680. + (void)listenerThread:(id)unused
  3681. {
  3682. @autoreleasepool {
  3683. [[NSThread currentThread] setName:GCDAsyncUdpSocketThreadName];
  3684. LogInfo(@"ListenerThread: Started");
  3685. // We can't run the run loop unless it has an associated input source or a timer.
  3686. // So we'll just create a timer that will never fire - unless the server runs for a decades.
  3687. [NSTimer scheduledTimerWithTimeInterval:[[NSDate distantFuture] timeIntervalSinceNow]
  3688. target:self
  3689. selector:@selector(ignore:)
  3690. userInfo:nil
  3691. repeats:YES];
  3692. [[NSRunLoop currentRunLoop] run];
  3693. LogInfo(@"ListenerThread: Stopped");
  3694. }
  3695. }
  3696. + (void)addStreamListener:(GCDAsyncUdpSocket *)asyncUdpSocket
  3697. {
  3698. LogTrace();
  3699. NSAssert([NSThread currentThread] == listenerThread, @"Invoked on wrong thread");
  3700. CFRunLoopRef runLoop = CFRunLoopGetCurrent();
  3701. if (asyncUdpSocket->readStream4)
  3702. CFReadStreamScheduleWithRunLoop(asyncUdpSocket->readStream4, runLoop, kCFRunLoopDefaultMode);
  3703. if (asyncUdpSocket->readStream6)
  3704. CFReadStreamScheduleWithRunLoop(asyncUdpSocket->readStream6, runLoop, kCFRunLoopDefaultMode);
  3705. if (asyncUdpSocket->writeStream4)
  3706. CFWriteStreamScheduleWithRunLoop(asyncUdpSocket->writeStream4, runLoop, kCFRunLoopDefaultMode);
  3707. if (asyncUdpSocket->writeStream6)
  3708. CFWriteStreamScheduleWithRunLoop(asyncUdpSocket->writeStream6, runLoop, kCFRunLoopDefaultMode);
  3709. }
  3710. + (void)removeStreamListener:(GCDAsyncUdpSocket *)asyncUdpSocket
  3711. {
  3712. LogTrace();
  3713. NSAssert([NSThread currentThread] == listenerThread, @"Invoked on wrong thread");
  3714. CFRunLoopRef runLoop = CFRunLoopGetCurrent();
  3715. if (asyncUdpSocket->readStream4)
  3716. CFReadStreamUnscheduleFromRunLoop(asyncUdpSocket->readStream4, runLoop, kCFRunLoopDefaultMode);
  3717. if (asyncUdpSocket->readStream6)
  3718. CFReadStreamUnscheduleFromRunLoop(asyncUdpSocket->readStream6, runLoop, kCFRunLoopDefaultMode);
  3719. if (asyncUdpSocket->writeStream4)
  3720. CFWriteStreamUnscheduleFromRunLoop(asyncUdpSocket->writeStream4, runLoop, kCFRunLoopDefaultMode);
  3721. if (asyncUdpSocket->writeStream6)
  3722. CFWriteStreamUnscheduleFromRunLoop(asyncUdpSocket->writeStream6, runLoop, kCFRunLoopDefaultMode);
  3723. }
  3724. static void CFReadStreamCallback(CFReadStreamRef stream, CFStreamEventType type, void *pInfo)
  3725. {
  3726. @autoreleasepool {
  3727. GCDAsyncUdpSocket *asyncUdpSocket = (__bridge GCDAsyncUdpSocket *)pInfo;
  3728. switch(type)
  3729. {
  3730. case kCFStreamEventOpenCompleted:
  3731. {
  3732. LogCVerbose(@"CFReadStreamCallback - Open");
  3733. break;
  3734. }
  3735. case kCFStreamEventHasBytesAvailable:
  3736. {
  3737. LogCVerbose(@"CFReadStreamCallback - HasBytesAvailable");
  3738. break;
  3739. }
  3740. case kCFStreamEventErrorOccurred:
  3741. case kCFStreamEventEndEncountered:
  3742. {
  3743. NSError *error = (__bridge_transfer NSError *)CFReadStreamCopyError(stream);
  3744. if (error == nil && type == kCFStreamEventEndEncountered)
  3745. {
  3746. error = [asyncUdpSocket socketClosedError];
  3747. }
  3748. dispatch_async(asyncUdpSocket->socketQueue, ^{ @autoreleasepool {
  3749. LogCVerbose(@"CFReadStreamCallback - %@",
  3750. (type == kCFStreamEventErrorOccurred) ? @"Error" : @"EndEncountered");
  3751. if (stream != asyncUdpSocket->readStream4 &&
  3752. stream != asyncUdpSocket->readStream6 )
  3753. {
  3754. LogCVerbose(@"CFReadStreamCallback - Ignored");
  3755. return_from_block;
  3756. }
  3757. [asyncUdpSocket closeWithError:error];
  3758. }});
  3759. break;
  3760. }
  3761. default:
  3762. {
  3763. LogCError(@"CFReadStreamCallback - UnknownType: %i", (int)type);
  3764. }
  3765. }
  3766. }
  3767. }
  3768. static void CFWriteStreamCallback(CFWriteStreamRef stream, CFStreamEventType type, void *pInfo)
  3769. {
  3770. @autoreleasepool {
  3771. GCDAsyncUdpSocket *asyncUdpSocket = (__bridge GCDAsyncUdpSocket *)pInfo;
  3772. switch(type)
  3773. {
  3774. case kCFStreamEventOpenCompleted:
  3775. {
  3776. LogCVerbose(@"CFWriteStreamCallback - Open");
  3777. break;
  3778. }
  3779. case kCFStreamEventCanAcceptBytes:
  3780. {
  3781. LogCVerbose(@"CFWriteStreamCallback - CanAcceptBytes");
  3782. break;
  3783. }
  3784. case kCFStreamEventErrorOccurred:
  3785. case kCFStreamEventEndEncountered:
  3786. {
  3787. NSError *error = (__bridge_transfer NSError *)CFWriteStreamCopyError(stream);
  3788. if (error == nil && type == kCFStreamEventEndEncountered)
  3789. {
  3790. error = [asyncUdpSocket socketClosedError];
  3791. }
  3792. dispatch_async(asyncUdpSocket->socketQueue, ^{ @autoreleasepool {
  3793. LogCVerbose(@"CFWriteStreamCallback - %@",
  3794. (type == kCFStreamEventErrorOccurred) ? @"Error" : @"EndEncountered");
  3795. if (stream != asyncUdpSocket->writeStream4 &&
  3796. stream != asyncUdpSocket->writeStream6 )
  3797. {
  3798. LogCVerbose(@"CFWriteStreamCallback - Ignored");
  3799. return_from_block;
  3800. }
  3801. [asyncUdpSocket closeWithError:error];
  3802. }});
  3803. break;
  3804. }
  3805. default:
  3806. {
  3807. LogCError(@"CFWriteStreamCallback - UnknownType: %i", (int)type);
  3808. }
  3809. }
  3810. }
  3811. }
  3812. - (BOOL)createReadAndWriteStreams:(NSError **)errPtr
  3813. {
  3814. LogTrace();
  3815. NSAssert(dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey), @"Must be dispatched on socketQueue");
  3816. NSError *err = nil;
  3817. if (readStream4 || writeStream4 || readStream6 || writeStream6)
  3818. {
  3819. // Streams already created
  3820. return YES;
  3821. }
  3822. if (socket4FD == SOCKET_NULL && socket6FD == SOCKET_NULL)
  3823. {
  3824. err = [self otherError:@"Cannot create streams without a file descriptor"];
  3825. goto Failed;
  3826. }
  3827. // Create streams
  3828. LogVerbose(@"Creating read and write stream(s)...");
  3829. if (socket4FD != SOCKET_NULL)
  3830. {
  3831. CFStreamCreatePairWithSocket(NULL, (CFSocketNativeHandle)socket4FD, &readStream4, &writeStream4);
  3832. if (!readStream4 || !writeStream4)
  3833. {
  3834. err = [self otherError:@"Error in CFStreamCreatePairWithSocket() [IPv4]"];
  3835. goto Failed;
  3836. }
  3837. }
  3838. if (socket6FD != SOCKET_NULL)
  3839. {
  3840. CFStreamCreatePairWithSocket(NULL, (CFSocketNativeHandle)socket6FD, &readStream6, &writeStream6);
  3841. if (!readStream6 || !writeStream6)
  3842. {
  3843. err = [self otherError:@"Error in CFStreamCreatePairWithSocket() [IPv6]"];
  3844. goto Failed;
  3845. }
  3846. }
  3847. // Ensure the CFStream's don't close our underlying socket
  3848. CFReadStreamSetProperty(readStream4, kCFStreamPropertyShouldCloseNativeSocket, kCFBooleanFalse);
  3849. CFWriteStreamSetProperty(writeStream4, kCFStreamPropertyShouldCloseNativeSocket, kCFBooleanFalse);
  3850. CFReadStreamSetProperty(readStream6, kCFStreamPropertyShouldCloseNativeSocket, kCFBooleanFalse);
  3851. CFWriteStreamSetProperty(writeStream6, kCFStreamPropertyShouldCloseNativeSocket, kCFBooleanFalse);
  3852. return YES;
  3853. Failed:
  3854. if (readStream4)
  3855. {
  3856. CFReadStreamClose(readStream4);
  3857. CFRelease(readStream4);
  3858. readStream4 = NULL;
  3859. }
  3860. if (writeStream4)
  3861. {
  3862. CFWriteStreamClose(writeStream4);
  3863. CFRelease(writeStream4);
  3864. writeStream4 = NULL;
  3865. }
  3866. if (readStream6)
  3867. {
  3868. CFReadStreamClose(readStream6);
  3869. CFRelease(readStream6);
  3870. readStream6 = NULL;
  3871. }
  3872. if (writeStream6)
  3873. {
  3874. CFWriteStreamClose(writeStream6);
  3875. CFRelease(writeStream6);
  3876. writeStream6 = NULL;
  3877. }
  3878. if (errPtr)
  3879. *errPtr = err;
  3880. return NO;
  3881. }
  3882. - (BOOL)registerForStreamCallbacks:(NSError **)errPtr
  3883. {
  3884. LogTrace();
  3885. NSAssert(dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey), @"Must be dispatched on socketQueue");
  3886. NSAssert(readStream4 || writeStream4 || readStream6 || writeStream6, @"Read/Write streams are null");
  3887. NSError *err = nil;
  3888. streamContext.version = 0;
  3889. streamContext.info = (__bridge void *)self;
  3890. streamContext.retain = nil;
  3891. streamContext.release = nil;
  3892. streamContext.copyDescription = nil;
  3893. CFOptionFlags readStreamEvents = kCFStreamEventErrorOccurred | kCFStreamEventEndEncountered;
  3894. CFOptionFlags writeStreamEvents = kCFStreamEventErrorOccurred | kCFStreamEventEndEncountered;
  3895. // readStreamEvents |= (kCFStreamEventOpenCompleted | kCFStreamEventHasBytesAvailable);
  3896. // writeStreamEvents |= (kCFStreamEventOpenCompleted | kCFStreamEventCanAcceptBytes);
  3897. if (socket4FD != SOCKET_NULL)
  3898. {
  3899. if (readStream4 == NULL || writeStream4 == NULL)
  3900. {
  3901. err = [self otherError:@"Read/Write stream4 is null"];
  3902. goto Failed;
  3903. }
  3904. BOOL r1 = CFReadStreamSetClient(readStream4, readStreamEvents, &CFReadStreamCallback, &streamContext);
  3905. BOOL r2 = CFWriteStreamSetClient(writeStream4, writeStreamEvents, &CFWriteStreamCallback, &streamContext);
  3906. if (!r1 || !r2)
  3907. {
  3908. err = [self otherError:@"Error in CFStreamSetClient(), [IPv4]"];
  3909. goto Failed;
  3910. }
  3911. }
  3912. if (socket6FD != SOCKET_NULL)
  3913. {
  3914. if (readStream6 == NULL || writeStream6 == NULL)
  3915. {
  3916. err = [self otherError:@"Read/Write stream6 is null"];
  3917. goto Failed;
  3918. }
  3919. BOOL r1 = CFReadStreamSetClient(readStream6, readStreamEvents, &CFReadStreamCallback, &streamContext);
  3920. BOOL r2 = CFWriteStreamSetClient(writeStream6, writeStreamEvents, &CFWriteStreamCallback, &streamContext);
  3921. if (!r1 || !r2)
  3922. {
  3923. err = [self otherError:@"Error in CFStreamSetClient() [IPv6]"];
  3924. goto Failed;
  3925. }
  3926. }
  3927. return YES;
  3928. Failed:
  3929. if (readStream4) {
  3930. CFReadStreamSetClient(readStream4, kCFStreamEventNone, NULL, NULL);
  3931. }
  3932. if (writeStream4) {
  3933. CFWriteStreamSetClient(writeStream4, kCFStreamEventNone, NULL, NULL);
  3934. }
  3935. if (readStream6) {
  3936. CFReadStreamSetClient(readStream6, kCFStreamEventNone, NULL, NULL);
  3937. }
  3938. if (writeStream6) {
  3939. CFWriteStreamSetClient(writeStream6, kCFStreamEventNone, NULL, NULL);
  3940. }
  3941. if (errPtr) *errPtr = err;
  3942. return NO;
  3943. }
  3944. - (BOOL)addStreamsToRunLoop:(NSError **)errPtr
  3945. {
  3946. LogTrace();
  3947. NSAssert(dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey), @"Must be dispatched on socketQueue");
  3948. NSAssert(readStream4 || writeStream4 || readStream6 || writeStream6, @"Read/Write streams are null");
  3949. if (!(flags & kAddedStreamListener))
  3950. {
  3951. [[self class] startListenerThreadIfNeeded];
  3952. [[self class] performSelector:@selector(addStreamListener:)
  3953. onThread:listenerThread
  3954. withObject:self
  3955. waitUntilDone:YES];
  3956. flags |= kAddedStreamListener;
  3957. }
  3958. return YES;
  3959. }
  3960. - (BOOL)openStreams:(NSError **)errPtr
  3961. {
  3962. LogTrace();
  3963. NSAssert(dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey), @"Must be dispatched on socketQueue");
  3964. NSAssert(readStream4 || writeStream4 || readStream6 || writeStream6, @"Read/Write streams are null");
  3965. NSError *err = nil;
  3966. if (socket4FD != SOCKET_NULL)
  3967. {
  3968. BOOL r1 = CFReadStreamOpen(readStream4);
  3969. BOOL r2 = CFWriteStreamOpen(writeStream4);
  3970. if (!r1 || !r2)
  3971. {
  3972. err = [self otherError:@"Error in CFStreamOpen() [IPv4]"];
  3973. goto Failed;
  3974. }
  3975. }
  3976. if (socket6FD != SOCKET_NULL)
  3977. {
  3978. BOOL r1 = CFReadStreamOpen(readStream6);
  3979. BOOL r2 = CFWriteStreamOpen(writeStream6);
  3980. if (!r1 || !r2)
  3981. {
  3982. err = [self otherError:@"Error in CFStreamOpen() [IPv6]"];
  3983. goto Failed;
  3984. }
  3985. }
  3986. return YES;
  3987. Failed:
  3988. if (errPtr) *errPtr = err;
  3989. return NO;
  3990. }
  3991. - (void)removeStreamsFromRunLoop
  3992. {
  3993. LogTrace();
  3994. NSAssert(dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey), @"Must be dispatched on socketQueue");
  3995. if (flags & kAddedStreamListener)
  3996. {
  3997. [[self class] performSelector:@selector(removeStreamListener:)
  3998. onThread:listenerThread
  3999. withObject:self
  4000. waitUntilDone:YES];
  4001. flags &= ~kAddedStreamListener;
  4002. }
  4003. }
  4004. - (void)closeReadAndWriteStreams
  4005. {
  4006. LogTrace();
  4007. if (readStream4)
  4008. {
  4009. CFReadStreamSetClient(readStream4, kCFStreamEventNone, NULL, NULL);
  4010. CFReadStreamClose(readStream4);
  4011. CFRelease(readStream4);
  4012. readStream4 = NULL;
  4013. }
  4014. if (writeStream4)
  4015. {
  4016. CFWriteStreamSetClient(writeStream4, kCFStreamEventNone, NULL, NULL);
  4017. CFWriteStreamClose(writeStream4);
  4018. CFRelease(writeStream4);
  4019. writeStream4 = NULL;
  4020. }
  4021. if (readStream6)
  4022. {
  4023. CFReadStreamSetClient(readStream6, kCFStreamEventNone, NULL, NULL);
  4024. CFReadStreamClose(readStream6);
  4025. CFRelease(readStream6);
  4026. readStream6 = NULL;
  4027. }
  4028. if (writeStream6)
  4029. {
  4030. CFWriteStreamSetClient(writeStream6, kCFStreamEventNone, NULL, NULL);
  4031. CFWriteStreamClose(writeStream6);
  4032. CFRelease(writeStream6);
  4033. writeStream6 = NULL;
  4034. }
  4035. }
  4036. #endif
  4037. #if TARGET_OS_IPHONE
  4038. - (void)applicationWillEnterForeground:(NSNotification *)notification
  4039. {
  4040. LogTrace();
  4041. // If the application was backgrounded, then iOS may have shut down our sockets.
  4042. // So we take a quick look to see if any of them received an EOF.
  4043. dispatch_block_t block = ^{ @autoreleasepool {
  4044. [self resumeReceive4Source];
  4045. [self resumeReceive6Source];
  4046. }};
  4047. if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey))
  4048. block();
  4049. else
  4050. dispatch_async(socketQueue, block);
  4051. }
  4052. #endif
  4053. ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
  4054. #pragma mark Advanced
  4055. ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
  4056. /**
  4057. * See header file for big discussion of this method.
  4058. **/
  4059. - (void)markSocketQueueTargetQueue:(dispatch_queue_t)socketNewTargetQueue
  4060. {
  4061. void *nonNullUnusedPointer = (__bridge void *)self;
  4062. dispatch_queue_set_specific(socketNewTargetQueue, IsOnSocketQueueOrTargetQueueKey, nonNullUnusedPointer, NULL);
  4063. }
  4064. /**
  4065. * See header file for big discussion of this method.
  4066. **/
  4067. - (void)unmarkSocketQueueTargetQueue:(dispatch_queue_t)socketOldTargetQueue
  4068. {
  4069. dispatch_queue_set_specific(socketOldTargetQueue, IsOnSocketQueueOrTargetQueueKey, NULL, NULL);
  4070. }
  4071. - (void)performBlock:(dispatch_block_t)block
  4072. {
  4073. if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey))
  4074. block();
  4075. else
  4076. dispatch_sync(socketQueue, block);
  4077. }
  4078. - (int)socketFD
  4079. {
  4080. if (! dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey))
  4081. {
  4082. LogWarn(@"%@: %@ - Method only available from within the context of a performBlock: invocation",
  4083. THIS_FILE, THIS_METHOD);
  4084. return SOCKET_NULL;
  4085. }
  4086. if (socket4FD != SOCKET_NULL)
  4087. return socket4FD;
  4088. else
  4089. return socket6FD;
  4090. }
  4091. - (int)socket4FD
  4092. {
  4093. if (! dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey))
  4094. {
  4095. LogWarn(@"%@: %@ - Method only available from within the context of a performBlock: invocation",
  4096. THIS_FILE, THIS_METHOD);
  4097. return SOCKET_NULL;
  4098. }
  4099. return socket4FD;
  4100. }
  4101. - (int)socket6FD
  4102. {
  4103. if (! dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey))
  4104. {
  4105. LogWarn(@"%@: %@ - Method only available from within the context of a performBlock: invocation",
  4106. THIS_FILE, THIS_METHOD);
  4107. return SOCKET_NULL;
  4108. }
  4109. return socket6FD;
  4110. }
  4111. #if TARGET_OS_IPHONE
  4112. - (CFReadStreamRef)readStream
  4113. {
  4114. if (! dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey))
  4115. {
  4116. LogWarn(@"%@: %@ - Method only available from within the context of a performBlock: invocation",
  4117. THIS_FILE, THIS_METHOD);
  4118. return NULL;
  4119. }
  4120. NSError *err = nil;
  4121. if (![self createReadAndWriteStreams:&err])
  4122. {
  4123. LogError(@"Error creating CFStream(s): %@", err);
  4124. return NULL;
  4125. }
  4126. // Todo...
  4127. if (readStream4)
  4128. return readStream4;
  4129. else
  4130. return readStream6;
  4131. }
  4132. - (CFWriteStreamRef)writeStream
  4133. {
  4134. if (! dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey))
  4135. {
  4136. LogWarn(@"%@: %@ - Method only available from within the context of a performBlock: invocation",
  4137. THIS_FILE, THIS_METHOD);
  4138. return NULL;
  4139. }
  4140. NSError *err = nil;
  4141. if (![self createReadAndWriteStreams:&err])
  4142. {
  4143. LogError(@"Error creating CFStream(s): %@", err);
  4144. return NULL;
  4145. }
  4146. if (writeStream4)
  4147. return writeStream4;
  4148. else
  4149. return writeStream6;
  4150. }
  4151. - (BOOL)enableBackgroundingOnSockets
  4152. {
  4153. if (! dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey))
  4154. {
  4155. LogWarn(@"%@: %@ - Method only available from within the context of a performBlock: invocation",
  4156. THIS_FILE, THIS_METHOD);
  4157. return NO;
  4158. }
  4159. // Why is this commented out?
  4160. // See comments below.
  4161. // NSError *err = nil;
  4162. // if (![self createReadAndWriteStreams:&err])
  4163. // {
  4164. // LogError(@"Error creating CFStream(s): %@", err);
  4165. // return NO;
  4166. // }
  4167. //
  4168. // LogVerbose(@"Enabling backgrouding on socket");
  4169. //
  4170. // BOOL r1, r2;
  4171. //
  4172. // if (readStream4 && writeStream4)
  4173. // {
  4174. // r1 = CFReadStreamSetProperty(readStream4, kCFStreamNetworkServiceType, kCFStreamNetworkServiceTypeVoIP);
  4175. // r2 = CFWriteStreamSetProperty(writeStream4, kCFStreamNetworkServiceType, kCFStreamNetworkServiceTypeVoIP);
  4176. //
  4177. // if (!r1 || !r2)
  4178. // {
  4179. // LogError(@"Error setting voip type (IPv4)");
  4180. // return NO;
  4181. // }
  4182. // }
  4183. //
  4184. // if (readStream6 && writeStream6)
  4185. // {
  4186. // r1 = CFReadStreamSetProperty(readStream6, kCFStreamNetworkServiceType, kCFStreamNetworkServiceTypeVoIP);
  4187. // r2 = CFWriteStreamSetProperty(writeStream6, kCFStreamNetworkServiceType, kCFStreamNetworkServiceTypeVoIP);
  4188. //
  4189. // if (!r1 || !r2)
  4190. // {
  4191. // LogError(@"Error setting voip type (IPv6)");
  4192. // return NO;
  4193. // }
  4194. // }
  4195. //
  4196. // return YES;
  4197. // The above code will actually appear to work.
  4198. // The methods will return YES, and everything will appear fine.
  4199. //
  4200. // One tiny problem: the sockets will still get closed when the app gets backgrounded.
  4201. //
  4202. // Apple does not officially support backgrounding UDP sockets.
  4203. return NO;
  4204. }
  4205. #endif
  4206. ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
  4207. #pragma mark Class Methods
  4208. ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
  4209. + (NSString *)hostFromSockaddr4:(const struct sockaddr_in *)pSockaddr4
  4210. {
  4211. char addrBuf[INET_ADDRSTRLEN];
  4212. if (inet_ntop(AF_INET, &pSockaddr4->sin_addr, addrBuf, (socklen_t)sizeof(addrBuf)) == NULL)
  4213. {
  4214. addrBuf[0] = '\0';
  4215. }
  4216. return [NSString stringWithCString:addrBuf encoding:NSASCIIStringEncoding];
  4217. }
  4218. + (NSString *)hostFromSockaddr6:(const struct sockaddr_in6 *)pSockaddr6
  4219. {
  4220. char addrBuf[INET6_ADDRSTRLEN];
  4221. if (inet_ntop(AF_INET6, &pSockaddr6->sin6_addr, addrBuf, (socklen_t)sizeof(addrBuf)) == NULL)
  4222. {
  4223. addrBuf[0] = '\0';
  4224. }
  4225. return [NSString stringWithCString:addrBuf encoding:NSASCIIStringEncoding];
  4226. }
  4227. + (uint16_t)portFromSockaddr4:(const struct sockaddr_in *)pSockaddr4
  4228. {
  4229. return ntohs(pSockaddr4->sin_port);
  4230. }
  4231. + (uint16_t)portFromSockaddr6:(const struct sockaddr_in6 *)pSockaddr6
  4232. {
  4233. return ntohs(pSockaddr6->sin6_port);
  4234. }
  4235. + (NSString *)hostFromAddress:(NSData *)address
  4236. {
  4237. NSString *host = nil;
  4238. [self getHost:&host port:NULL family:NULL fromAddress:address];
  4239. return host;
  4240. }
  4241. + (uint16_t)portFromAddress:(NSData *)address
  4242. {
  4243. uint16_t port = 0;
  4244. [self getHost:NULL port:&port family:NULL fromAddress:address];
  4245. return port;
  4246. }
  4247. + (int)familyFromAddress:(NSData *)address
  4248. {
  4249. int af = AF_UNSPEC;
  4250. [self getHost:NULL port:NULL family:&af fromAddress:address];
  4251. return af;
  4252. }
  4253. + (BOOL)isIPv4Address:(NSData *)address
  4254. {
  4255. int af = AF_UNSPEC;
  4256. [self getHost:NULL port:NULL family:&af fromAddress:address];
  4257. return (af == AF_INET);
  4258. }
  4259. + (BOOL)isIPv6Address:(NSData *)address
  4260. {
  4261. int af = AF_UNSPEC;
  4262. [self getHost:NULL port:NULL family:&af fromAddress:address];
  4263. return (af == AF_INET6);
  4264. }
  4265. + (BOOL)getHost:(NSString **)hostPtr port:(uint16_t *)portPtr fromAddress:(NSData *)address
  4266. {
  4267. return [self getHost:hostPtr port:portPtr family:NULL fromAddress:address];
  4268. }
  4269. + (BOOL)getHost:(NSString **)hostPtr port:(uint16_t *)portPtr family:(int *)afPtr fromAddress:(NSData *)address
  4270. {
  4271. if ([address length] >= sizeof(struct sockaddr))
  4272. {
  4273. const struct sockaddr *addrX = (const struct sockaddr *)[address bytes];
  4274. if (addrX->sa_family == AF_INET)
  4275. {
  4276. if ([address length] >= sizeof(struct sockaddr_in))
  4277. {
  4278. const struct sockaddr_in *addr4 = (const struct sockaddr_in *)(const void *)addrX;
  4279. if (hostPtr) *hostPtr = [self hostFromSockaddr4:addr4];
  4280. if (portPtr) *portPtr = [self portFromSockaddr4:addr4];
  4281. if (afPtr) *afPtr = AF_INET;
  4282. return YES;
  4283. }
  4284. }
  4285. else if (addrX->sa_family == AF_INET6)
  4286. {
  4287. if ([address length] >= sizeof(struct sockaddr_in6))
  4288. {
  4289. const struct sockaddr_in6 *addr6 = (const struct sockaddr_in6 *)(const void *)addrX;
  4290. if (hostPtr) *hostPtr = [self hostFromSockaddr6:addr6];
  4291. if (portPtr) *portPtr = [self portFromSockaddr6:addr6];
  4292. if (afPtr) *afPtr = AF_INET6;
  4293. return YES;
  4294. }
  4295. }
  4296. }
  4297. if (hostPtr) *hostPtr = nil;
  4298. if (portPtr) *portPtr = 0;
  4299. if (afPtr) *afPtr = AF_UNSPEC;
  4300. return NO;
  4301. }
  4302. @end