GCDAsyncUdpSocket.m 139 KB

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