GCDAsyncUdpSocket.m 135 KB

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