Geen omschrijving

SharpPcap.xml 182KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>/home/cmorgan/hdd/sharppcap_git/SharpPcap/bin/Release/SharpPcap</name>
  5. </assembly>
  6. <members>
  7. <member name="T:SharpPcap.AirPcap.AirPcapAdapterBus">
  8. <summary>
  9. Adapter bus types
  10. </summary>
  11. </member>
  12. <member name="F:SharpPcap.AirPcap.AirPcapAdapterBus.Usb">
  13. <summary>
  14. Usb
  15. </summary>
  16. </member>
  17. <member name="F:SharpPcap.AirPcap.AirPcapAdapterBus.Pci">
  18. <summary>
  19. Pci
  20. </summary>
  21. </member>
  22. <member name="F:SharpPcap.AirPcap.AirPcapAdapterBus.PciExpress">
  23. <summary>
  24. PciExpress
  25. </summary>
  26. </member>
  27. <member name="F:SharpPcap.AirPcap.AirPcapAdapterBus.MiniPci">
  28. <summary>
  29. MiniPci
  30. </summary>
  31. </member>
  32. <member name="F:SharpPcap.AirPcap.AirPcapAdapterBus.MiniPciExpress">
  33. <summary>
  34. MiniPciExpress
  35. </summary>
  36. </member>
  37. <member name="F:SharpPcap.AirPcap.AirPcapAdapterBus.Cardbus">
  38. <summary>
  39. Cardbus
  40. </summary>
  41. </member>
  42. <member name="F:SharpPcap.AirPcap.AirPcapAdapterBus.Expresscard">
  43. <summary>
  44. Expresscard
  45. </summary>
  46. </member>
  47. <member name="T:SharpPcap.AirPcap.AirPcapAdapterId">
  48. <summary>
  49. Types of airpcap adapters
  50. </summary>
  51. </member>
  52. <member name="F:SharpPcap.AirPcap.AirPcapAdapterId.Classic">
  53. <summary>
  54. Class
  55. </summary>
  56. </member>
  57. <member name="F:SharpPcap.AirPcap.AirPcapAdapterId.ClassicRelease2">
  58. <summary>
  59. Class release 2
  60. </summary>
  61. </member>
  62. <member name="F:SharpPcap.AirPcap.AirPcapAdapterId.Tx">
  63. <summary>
  64. AirPcap TX
  65. </summary>
  66. </member>
  67. <member name="F:SharpPcap.AirPcap.AirPcapAdapterId.Ex">
  68. <summary>
  69. AirPcap EX
  70. </summary>
  71. </member>
  72. <member name="F:SharpPcap.AirPcap.AirPcapAdapterId.N">
  73. <summary>
  74. AirPcap N
  75. </summary>
  76. </member>
  77. <member name="F:SharpPcap.AirPcap.AirPcapAdapterId.Nx">
  78. <summary>
  79. AirPcap Nx
  80. </summary>
  81. </member>
  82. <member name="T:SharpPcap.AirPcap.AirPcapBands">
  83. <summary>
  84. Frequency bands
  85. </summary>
  86. </member>
  87. <member name="F:SharpPcap.AirPcap.AirPcapBands._2GHZ">
  88. <summary>2.4 GHz band</summary>
  89. </member>
  90. <member name="F:SharpPcap.AirPcap.AirPcapBands._5GHZ">
  91. <summary>5 GHz band</summary>
  92. </member>
  93. <member name="T:SharpPcap.AirPcap.AirPcapChannelInfo">
  94. <summary>
  95. Channel info
  96. </summary>
  97. </member>
  98. <member name="P:SharpPcap.AirPcap.AirPcapChannelInfo.Frequency">
  99. <summary>
  100. Channel frequency, in MHz
  101. </summary>
  102. </member>
  103. <member name="P:SharpPcap.AirPcap.AirPcapChannelInfo.ExtChannel">
  104. <summary>
  105. 802.11n specific. Offset of the extension channel in case of 40MHz channels.
  106. Possible values are -1, 0 +1:
  107. - -1 means that the extension channel should be below the control channel (e.g. Control = 5 and Extension = 1)
  108. - 0 means that no extension channel should be used (20MHz channels or legacy mode)
  109. - +1 means that the extension channel should be above the control channel (e.g. Control = 1 and Extension = 5)
  110. In case of 802.11a/b/g channels (802.11n legacy mode), this field should be set to 0.
  111. </summary>
  112. </member>
  113. <member name="P:SharpPcap.AirPcap.AirPcapChannelInfo.Flags">
  114. <summary>
  115. Channel Flags. The only flag supported at this time is \ref AIRPCAP_CIF_TX_ENABLED.
  116. </summary>
  117. </member>
  118. <member name="M:SharpPcap.AirPcap.AirPcapChannelInfo.ToString">
  119. <summary>
  120. ToString() override
  121. </summary>
  122. <returns>
  123. A <see cref="T:System.String" /></returns>
  124. </member>
  125. <member name="T:SharpPcap.AirPcap.AirPcapChannelInfoFlags">
  126. <summary>
  127. Channel info flags
  128. </summary>
  129. </member>
  130. <member name="F:SharpPcap.AirPcap.AirPcapChannelInfoFlags.None">
  131. <summary>
  132. No flags set
  133. </summary>
  134. </member>
  135. <member name="F:SharpPcap.AirPcap.AirPcapChannelInfoFlags.TxEnable">
  136. <summary>
  137. Channel info flag: the channel is enabled for transmission, too.
  138. To comply with the electomagnetic emission regulations of the different countries, the AirPcap hardware can be programmed
  139. to block transmission on specific channels. This flag is set by AirpcapGetDeviceSupportedChannels() to indicate that a
  140. channel in the list supports transmission.
  141. </summary>
  142. </member>
  143. <member name="T:SharpPcap.AirPcap.AirPcapDecryptionState">
  144. <summary>
  145. Type of decryption the adapter performs.
  146. An adapter can be instructed to turn decryption (based on the device-configured keys configured
  147. with \ref AirpcapSetDeviceKeys()) on or off.
  148. </summary>
  149. </member>
  150. <member name="F:SharpPcap.AirPcap.AirPcapDecryptionState.DecryptionOn">
  151. <summary>This adapter performs decryption</summary>
  152. </member>
  153. <member name="F:SharpPcap.AirPcap.AirPcapDecryptionState.DecryptionOff">
  154. <summary>This adapter does not perform decryption</summary>
  155. </member>
  156. <member name="T:SharpPcap.AirPcap.AirPcapDevice">
  157. <summary>
  158. AirPcap device
  159. </summary>
  160. </member>
  161. <member name="T:SharpPcap.AirPcap.AirPcapDevice.LedState">
  162. <summary>
  163. Led states
  164. </summary>
  165. </member>
  166. <member name="F:SharpPcap.AirPcap.AirPcapDevice.LedState.On">
  167. <summary>
  168. Led on
  169. </summary>
  170. </member>
  171. <member name="F:SharpPcap.AirPcap.AirPcapDevice.LedState.Off">
  172. <summary>
  173. Led off
  174. </summary>
  175. </member>
  176. <member name="F:SharpPcap.AirPcap.AirPcapDevice.MacAddressSizeInBytes">
  177. <summary>
  178. TODO: Get this from packet.net or another place in System.Net.xxx?
  179. </summary>
  180. </member>
  181. <member name="P:SharpPcap.AirPcap.AirPcapDevice.AirPcapDeviceHandle">
  182. <summary>
  183. Handle to the device
  184. </summary>
  185. </member>
  186. <member name="P:SharpPcap.AirPcap.AirPcapDevice.LastError">
  187. <summary>
  188. The last pcap error associated with this pcap device
  189. </summary>
  190. </member>
  191. <member name="P:SharpPcap.AirPcap.AirPcapDevice.Capabilities">
  192. <summary>
  193. Device capabilities, whether the device can transmit, its id, model name etc
  194. </summary>
  195. </member>
  196. <member name="P:SharpPcap.AirPcap.AirPcapDevice.Channel">
  197. <summary>
  198. Adapter channel
  199. </summary>
  200. </member>
  201. <member name="P:SharpPcap.AirPcap.AirPcapDevice.Frequency">
  202. <summary>
  203. Adapter frequency
  204. </summary>
  205. </member>
  206. <member name="P:SharpPcap.AirPcap.AirPcapDevice.ChannelInfo">
  207. <summary>
  208. Channel information
  209. </summary>
  210. </member>
  211. <member name="P:SharpPcap.AirPcap.AirPcapDevice.DeviceKeys">
  212. <summary>
  213. Decryption keys that are currently associated with the specified device
  214. </summary>
  215. </member>
  216. <member name="P:SharpPcap.AirPcap.AirPcapDevice.DriverKeys">
  217. <summary>
  218. Global list of decryption keys that AirPcap is using with all the devices.
  219. </summary>
  220. </member>
  221. <member name="P:SharpPcap.AirPcap.AirPcapDevice.DecryptionState">
  222. <summary>
  223. Tells if decryption of the incoming frames with the <b>device-specific</b> keys.
  224. </summary>
  225. </member>
  226. <member name="P:SharpPcap.AirPcap.AirPcapDevice.DriverDecryptionState">
  227. <summary>
  228. Tells if this open instance is configured to perform the decryption of the incoming frames with the <b>global</b> set of keys.
  229. </summary>
  230. </member>
  231. <member name="P:SharpPcap.AirPcap.AirPcapDevice.FcsPresence">
  232. <summary>
  233. Configures the adapter on whether to include the MAC Frame Check Sequence in the captured packets.
  234. </summary>
  235. </member>
  236. <member name="P:SharpPcap.AirPcap.AirPcapDevice.FcsValidation">
  237. <summary>
  238. The kinds of frames that the device will capture
  239. By default all frames are captured
  240. </summary>
  241. </member>
  242. <member name="P:SharpPcap.AirPcap.AirPcapDevice.KernelBufferSize">
  243. <summary>
  244. Kernel packet buffer size for this adapter in bytes
  245. </summary>
  246. </member>
  247. <member name="P:SharpPcap.AirPcap.AirPcapDevice.LedCount">
  248. <summary>
  249. Number of leds on this adapter
  250. </summary>
  251. </member>
  252. <member name="P:SharpPcap.AirPcap.AirPcapDevice.AirPcapLinkType">
  253. <summary>
  254. Link type
  255. </summary>
  256. </member>
  257. <member name="P:SharpPcap.AirPcap.AirPcapDevice.LinkType">
  258. <summary>
  259. Link type in terms of PacketDotNet.LinkLayers
  260. </summary>
  261. </member>
  262. <member name="P:SharpPcap.AirPcap.AirPcapDevice.MacAddress">
  263. <summary>
  264. Mac address
  265. </summary>
  266. </member>
  267. <member name="P:SharpPcap.AirPcap.AirPcapDevice.MacFlags">
  268. <summary>
  269. Mac flags
  270. </summary>
  271. </member>
  272. <member name="P:SharpPcap.AirPcap.AirPcapDevice.Statistics">
  273. <summary>
  274. Adapter statistics
  275. </summary>
  276. </member>
  277. <member name="P:SharpPcap.AirPcap.AirPcapDevice.SupportedChannels">
  278. <summary>
  279. List of supported channels
  280. </summary>
  281. </member>
  282. <member name="P:SharpPcap.AirPcap.AirPcapDevice.TxPower">
  283. <summary>
  284. Transmit power
  285. </summary>
  286. </member>
  287. <member name="P:SharpPcap.AirPcap.AirPcapDevice.Timestamp">
  288. <summary>
  289. Device timestamp
  290. </summary>
  291. </member>
  292. <member name="M:SharpPcap.AirPcap.AirPcapDevice.ThrowIfNotOpen">
  293. <summary>
  294. See ThrowIfNotOpen(string ExceptionString)
  295. </summary>
  296. </member>
  297. <member name="M:SharpPcap.AirPcap.AirPcapDevice.GetLastError(System.IntPtr)">
  298. <summary>
  299. Retrieve the last error string for a given pcap_t* device
  300. </summary>
  301. <param name="AirPcapDeviceHandle">
  302. A <see cref="T:System.IntPtr" /></param>
  303. <returns>
  304. A <see cref="T:System.String" /></returns>
  305. </member>
  306. <member name="M:SharpPcap.AirPcap.AirPcapDevice.Open">
  307. <summary>
  308. Open a device
  309. </summary>
  310. </member>
  311. <member name="M:SharpPcap.AirPcap.AirPcapDevice.Open(SharpPcap.DeviceMode)">
  312. <summary>
  313. Open the device. To start capturing call the 'StartCapture' function
  314. </summary>
  315. <param name="mode">
  316. A <see cref="T:SharpPcap.DeviceMode" /></param>
  317. </member>
  318. <member name="M:SharpPcap.AirPcap.AirPcapDevice.Open(SharpPcap.DeviceMode,System.Int32)">
  319. <summary>
  320. Open the device. To start capturing call the 'StartCapture' function
  321. </summary>
  322. <param name="mode">
  323. A <see cref="T:SharpPcap.DeviceMode" /></param>
  324. <param name="read_timeout">
  325. A <see cref="T:System.Int32" /></param>
  326. </member>
  327. <member name="M:SharpPcap.AirPcap.AirPcapDevice.Open(SharpPcap.WinPcap.OpenFlags,System.Int32)">
  328. <summary>
  329. Opens an Airpcap device with optional WinPcap.OpenFlags
  330. </summary>
  331. <param name="flags">
  332. A <see cref="!:WinPcap.OpenFlags" /></param>
  333. <param name="read_timeout">
  334. A <see cref="T:System.Int32" /></param>
  335. </member>
  336. <member name="M:SharpPcap.AirPcap.AirPcapDevice.Close">
  337. <summary>
  338. Close a device
  339. </summary>
  340. </member>
  341. <member name="M:SharpPcap.AirPcap.AirPcapDevice.KeyCollectionSize(System.Int32)">
  342. <summary>
  343. Size in bytes of a key collection with a given count of keys
  344. </summary>
  345. <param name="keyCount">
  346. </param>
  347. <returns>
  348. </returns>
  349. </member>
  350. <member name="M:SharpPcap.AirPcap.AirPcapDevice.IntPtrToKeys(System.IntPtr)">
  351. <summary>
  352. Convert a AirpcapKeysCollection unmanaged buffer to a list of managed keys
  353. </summary>
  354. <param name="pKeysCollection">
  355. </param>
  356. <returns>
  357. </returns>
  358. </member>
  359. <member name="M:SharpPcap.AirPcap.AirPcapDevice.KeysToIntPtr(System.Collections.Generic.List{SharpPcap.AirPcap.AirPcapKey})">
  360. <summary>
  361. Convert an array of keys into unmanaged memory
  362. </summary>
  363. <param name="value">
  364. </param>
  365. <returns>
  366. </returns>
  367. </member>
  368. <member name="M:SharpPcap.AirPcap.AirPcapDevice.Led(System.Int32,SharpPcap.AirPcap.AirPcapDevice.LedState)">
  369. <summary>
  370. Constructor
  371. </summary>
  372. <param name="ledIndex">
  373. A <see cref="T:System.Int32" /></param>
  374. <param name="newLedState">
  375. A <see cref="T:SharpPcap.AirPcap.AirPcapDevice.LedState" /></param>
  376. </member>
  377. <member name="M:SharpPcap.AirPcap.AirPcapDevice.CaptureThread">
  378. <summary>
  379. AirPcap specific capture thread
  380. </summary>
  381. </member>
  382. <member name="M:SharpPcap.AirPcap.AirPcapDevice.MarshalPackets(System.IntPtr,System.IntPtr,System.Collections.Generic.List{SharpPcap.RawCapture}@)">
  383. <summary>
  384. Marshal a chunk of captured packets into a packet list
  385. </summary>
  386. <param name="packetsBuffer">
  387. </param>
  388. <param name="bufferEnd">
  389. </param>
  390. <param name="packets">
  391. </param>
  392. </member>
  393. <member name="T:SharpPcap.AirPcap.AirPcapDeviceCapabilities">
  394. <summary>
  395. Capabilities for the adapter
  396. </summary>
  397. </member>
  398. <member name="F:SharpPcap.AirPcap.AirPcapDeviceCapabilities.AdapterId">
  399. <summary>
  400. An id that identifies the adapter model
  401. </summary>
  402. </member>
  403. <member name="F:SharpPcap.AirPcap.AirPcapDeviceCapabilities.AdapterModelName">
  404. <summary>
  405. String containing a printable adapter model
  406. </summary>
  407. </member>
  408. <member name="F:SharpPcap.AirPcap.AirPcapDeviceCapabilities.AdapterBus">
  409. <summary>
  410. The type of bus the adapter is plugged to
  411. </summary>
  412. </member>
  413. <member name="F:SharpPcap.AirPcap.AirPcapDeviceCapabilities.SupportedMedia">
  414. <summary>
  415. An OR combination of the media that the device supports. Possible values are: \ref AIRPCAP_MEDIUM_802_11_A,
  416. \ref AIRPCAP_MEDIUM_802_11_B, \ref AIRPCAP_MEDIUM_802_11_G or \ref AIRPCAP_MEDIUM_802_11_N.
  417. Not supported at the moment.
  418. </summary>
  419. </member>
  420. <member name="F:SharpPcap.AirPcap.AirPcapDeviceCapabilities.SupportedBands">
  421. <summary>
  422. An OR combination of the bands that the device supports. Can be one of: \ref AIRPCAP_BAND_2GHZ,
  423. \ref AIRPCAP_BAND_5GHZ.
  424. </summary>
  425. </member>
  426. <member name="P:SharpPcap.AirPcap.AirPcapDeviceCapabilities.CanTransmit">
  427. <summary>
  428. TRUE if the adapter is able to perform frame injection.
  429. </summary>
  430. </member>
  431. <member name="P:SharpPcap.AirPcap.AirPcapDeviceCapabilities.CanSetTransmitPower">
  432. <summary>
  433. TRUE if the adapter's transmit power is can be specified by the user application.
  434. </summary>
  435. </member>
  436. <member name="P:SharpPcap.AirPcap.AirPcapDeviceCapabilities.ExternalAntennaPlug">
  437. <summary>
  438. TRUE if the adapter supports plugging one or more external antennas.
  439. </summary>
  440. </member>
  441. <member name="M:SharpPcap.AirPcap.AirPcapDeviceCapabilities.ToString">
  442. <summary>
  443. ToString() overload
  444. </summary>
  445. <returns>
  446. A <see cref="T:System.String" /></returns>
  447. </member>
  448. <member name="T:SharpPcap.AirPcap.AirPcapDeviceDescription">
  449. <summary>
  450. Adapter description
  451. </summary>
  452. </member>
  453. <member name="P:SharpPcap.AirPcap.AirPcapDeviceDescription.Name">
  454. <summary>
  455. Device name
  456. </summary>
  457. </member>
  458. <member name="P:SharpPcap.AirPcap.AirPcapDeviceDescription.Description">
  459. <summary>
  460. Device description
  461. </summary>
  462. </member>
  463. <member name="M:SharpPcap.AirPcap.AirPcapDeviceDescription.ToString">
  464. <summary>
  465. ToString() override
  466. </summary>
  467. <returns>
  468. A <see cref="T:System.String" /></returns>
  469. </member>
  470. <member name="T:SharpPcap.AirPcap.AirPcapDeviceList">
  471. <summary>
  472. AirPcap device list
  473. </summary>
  474. </member>
  475. <member name="M:SharpPcap.AirPcap.AirPcapDeviceList.#ctor">
  476. <summary>
  477. Represents a strongly typed, read-only list of PcapDevices.
  478. </summary>
  479. </member>
  480. <member name="P:SharpPcap.AirPcap.AirPcapDeviceList.Item(System.String)">
  481. <param name="Name">The name or description of the pcap interface to get.</param>
  482. </member>
  483. <member name="P:SharpPcap.AirPcap.AirPcapDeviceList.Instance">
  484. <summary>
  485. Method to retrieve this classes singleton instance
  486. </summary>
  487. </member>
  488. <member name="M:SharpPcap.AirPcap.AirPcapDeviceList.New">
  489. <summary>
  490. Caution: Use the singlton instance unless you know why you need to call this.
  491. One use is for multiple filters on the same physical device. To apply multiple
  492. filters open the same physical device multiple times, one for each
  493. filter by calling this routine and picking the same device out of each list.
  494. </summary>
  495. <returns>
  496. A <see cref="T:SharpPcap.CaptureDeviceList" /></returns>
  497. </member>
  498. <member name="M:SharpPcap.AirPcap.AirPcapDeviceList.GetDevices">
  499. <summary>
  500. Retrieve an array of AirPcapDevices
  501. </summary>
  502. <returns>
  503. </returns>
  504. </member>
  505. <member name="M:SharpPcap.AirPcap.AirPcapDeviceList.Refresh">
  506. <summary>
  507. Refresh the device list
  508. </summary>
  509. </member>
  510. <!--FIXME: Invalid documentation markup was found for member M:SharpPcap.AirPcap.AirPcapDeviceList.GetAirPcapDevices-->
  511. <member name="T:SharpPcap.AirPcap.AirPcapDeviceTimestamp">
  512. <summary>
  513. Defines the internal AirPcap device timestamp
  514. </summary>
  515. </member>
  516. <member name="F:SharpPcap.AirPcap.AirPcapDeviceTimestamp.DeviceTimestamp">
  517. <summary>Current value of the device counter, in microseconds.</summary>
  518. </member>
  519. <member name="F:SharpPcap.AirPcap.AirPcapDeviceTimestamp.SoftwareTimestampBefore">
  520. <summary>Value of the software counter used to timestamp packets before reading the device counter, in microseconds.</summary>
  521. </member>
  522. <member name="F:SharpPcap.AirPcap.AirPcapDeviceTimestamp.SoftwareTimestampAfter">
  523. <summary>Value of the software counter used to timestamp packets after reading the device counter, in microseconds.</summary>
  524. </member>
  525. <member name="M:SharpPcap.AirPcap.AirPcapDeviceTimestamp.ToString">
  526. <summary>
  527. ToString() override
  528. </summary>
  529. <returns>
  530. A <see cref="T:System.String" /></returns>
  531. </member>
  532. <member name="T:SharpPcap.AirPcap.AirPcapKey">
  533. <summary>
  534. WEB key container
  535. </summary>
  536. </member>
  537. <member name="M:SharpPcap.AirPcap.AirPcapKey.#ctor(SharpPcap.AirPcap.AirPcapKeyType,System.Byte[])">
  538. <summary>
  539. Constructor
  540. </summary>
  541. <param name="Type">
  542. </param>
  543. <param name="Data">
  544. </param>
  545. </member>
  546. <member name="F:SharpPcap.AirPcap.AirPcapKey.WepKeyMaxSize">
  547. <summary>
  548. Number of bytes in a wep key
  549. </summary>
  550. </member>
  551. <member name="F:SharpPcap.AirPcap.AirPcapKey.Type">
  552. <summary>
  553. Type of key, can be on of: \ref AIRPCAP_KEYTYPE_WEP, \ref AIRPCAP_KEYTYPE_TKIP, \ref AIRPCAP_KEYTYPE_CCMP. Only AIRPCAP_KEYTYPE_WEP is supported by the driver at the moment.
  554. </summary>
  555. </member>
  556. <member name="F:SharpPcap.AirPcap.AirPcapKey.Data">
  557. <summary>
  558. Key data
  559. </summary>
  560. </member>
  561. <member name="M:SharpPcap.AirPcap.AirPcapKey.ToString">
  562. <summary>
  563. </summary>
  564. <returns>
  565. A <see cref="T:System.String" /></returns>
  566. </member>
  567. <member name="T:SharpPcap.AirPcap.AirPcapKeyType">
  568. <summary>
  569. Type of keys in the adapter
  570. </summary>
  571. </member>
  572. <member name="F:SharpPcap.AirPcap.AirPcapKeyType.Wep">
  573. <summary>
  574. Key type: WEP. The key can have an arbitrary length smaller than 32 bytes.
  575. </summary>
  576. </member>
  577. <member name="F:SharpPcap.AirPcap.AirPcapKeyType.Tkip">
  578. <summary>
  579. Key type: TKIP (WPA). NOT SUPPORTED YET by AirPcap
  580. </summary>
  581. </member>
  582. <member name="F:SharpPcap.AirPcap.AirPcapKeyType.Ccmp">
  583. <summary>
  584. Key type: CCMP (WPA2). NOT SUPPORTED YET by AirPcap
  585. </summary>
  586. </member>
  587. <member name="T:SharpPcap.AirPcap.AirPcapMacFlags">
  588. <summary>
  589. Mac flags
  590. </summary>
  591. </member>
  592. <member name="F:SharpPcap.AirPcap.AirPcapMacFlags.MonitorModeOn">
  593. <summary>
  594. If set, the device is configured to work in monitor mode.
  595. When monitor mode is on, the device captures all the frames transmitted on the channel. This includes:
  596. - unicast packets
  597. - multicast packets
  598. - broadcast packets
  599. - control and management packets
  600. When monitor mode is off, the device has a filter on unicast packets to capture only the packets whose MAC
  601. destination address equals the device's address. This means the following frames will be received:
  602. - unicast packets whose destination is the address of the device
  603. - multicast packets
  604. - broadcast packets
  605. - beacons and probe requests
  606. </summary>
  607. </member>
  608. <member name="F:SharpPcap.AirPcap.AirPcapMacFlags.AckFramesOn">
  609. <summary>
  610. If set, the device will acknowledge the data frames sent to its address. This is useful when the device needs to interact with other devices on the
  611. 802.11 network, bacause handling the ACKs in software is normally too slow.
  612. </summary>
  613. </member>
  614. <member name="T:SharpPcap.AirPcap.AirPcapMediumType">
  615. <summary>
  616. Medium type
  617. </summary>
  618. </member>
  619. <member name="F:SharpPcap.AirPcap.AirPcapMediumType._802_11_A">
  620. <summary>802.11a medium</summary>
  621. </member>
  622. <member name="F:SharpPcap.AirPcap.AirPcapMediumType._802_11_B">
  623. <summary>802.11b medium</summary>
  624. </member>
  625. <member name="F:SharpPcap.AirPcap.AirPcapMediumType._802_11_G">
  626. <summary>802.11g medium</summary>
  627. </member>
  628. <member name="F:SharpPcap.AirPcap.AirPcapMediumType._802_11_N">
  629. <summary>802.11n medium</summary>
  630. </member>
  631. <member name="T:SharpPcap.AirPcap.AirPcapPacketHeader">
  632. <summary>
  633. Packet header
  634. </summary>
  635. </member>
  636. <member name="P:SharpPcap.AirPcap.AirPcapPacketHeader.TsSec">
  637. <summary>
  638. Seconds field
  639. </summary>
  640. </member>
  641. <member name="P:SharpPcap.AirPcap.AirPcapPacketHeader.TsUsec">
  642. <summary>
  643. Microseconds field
  644. </summary>
  645. </member>
  646. <member name="P:SharpPcap.AirPcap.AirPcapPacketHeader.Caplen">
  647. <summary>
  648. Number of bytes captured
  649. </summary>
  650. </member>
  651. <member name="P:SharpPcap.AirPcap.AirPcapPacketHeader.Originallen">
  652. <summary>
  653. On-line packet size in bytes
  654. </summary>
  655. </member>
  656. <member name="P:SharpPcap.AirPcap.AirPcapPacketHeader.Hdrlen">
  657. <summary>
  658. Header length in bytes
  659. </summary>
  660. </member>
  661. <member name="M:SharpPcap.AirPcap.AirPcapPacketHeader.ToString">
  662. <summary>
  663. ToString() override
  664. </summary>
  665. <returns>
  666. A <see cref="T:System.String" /></returns>
  667. </member>
  668. <member name="T:SharpPcap.AirPcap.AirPcapSafeNativeMethods">
  669. <summary>
  670. Per http://msdn.microsoft.com/en-us/ms182161.aspx
  671. </summary>
  672. </member>
  673. <member name="M:SharpPcap.AirPcap.AirPcapSafeNativeMethods.AirpcapGetVersion(System.UInt32@,System.UInt32@,System.UInt32@,System.UInt32@)">
  674. <summary>
  675. Sets variables to the particular version being used
  676. </summary>
  677. <param name="VersionMajor">Pointer to a variable that will be filled with the major version number</param>
  678. <param name="VersionMinor">Pointer to a variable that will be filled with the minor version number</param>
  679. <param name="VersionRev">Pointer to a variable that will be filled with the revision number</param>
  680. <param name="VersionBuild">Pointer to a variable that will be filled with the build number</param>
  681. </member>
  682. <member name="M:SharpPcap.AirPcap.AirPcapSafeNativeMethods.AirpcapGetLastError(System.IntPtr)">
  683. <summary>
  684. Returns the last error related to the specified handle
  685. </summary>
  686. <param name="AdapterHandle">Handle to an open adapter</param>
  687. <returns>String with the last error, a PCHAR</returns>
  688. </member>
  689. <member name="M:SharpPcap.AirPcap.AirPcapSafeNativeMethods.AirpcapGetDeviceList(System.IntPtr@,System.Text.StringBuilder)">
  690. <summary>
  691. Returns the list of available devices
  692. </summary>
  693. <param name="PPAllDevs">Address to a caller allocated pointer. On success this pointer will receive the head of a list of available devices.</param>
  694. <param name="Ebuf">String that will contain error information if FALSE is returned. The size of the string must be AIRPCAP_ERRBUF_SIZE bytes.</param>
  695. <returns>TRUE on success. FALSE is returned on failure, in which case Ebuf is filled in with an appropriate error message.</returns>
  696. </member>
  697. <member name="M:SharpPcap.AirPcap.AirPcapSafeNativeMethods.AirpcapFreeDeviceList(System.IntPtr)">
  698. <summary>
  699. Frees a list of devices returned by AirpcapGetDeviceList()
  700. </summary>
  701. <param name="PAllDevs">Head of the list of devices returned by AirpcapGetDeviceList()</param>
  702. <returns>
  703. </returns>
  704. </member>
  705. <member name="M:SharpPcap.AirPcap.AirPcapSafeNativeMethods.AirpcapOpen(System.String,System.Text.StringBuilder)">
  706. <summary>
  707. Opens an adapter
  708. </summary>
  709. <param name="DeviceName">Name of the device to open. Use AirpcapGetDeviceList() to get the list of devices.</param>
  710. <param name="Ebuf">String that will contain error information in case of failure. The size of the string must be AIRPCAP_ERRBUF_SIZE bytes.</param>
  711. <returns>A PAirpcapHandle handle on success. NULL is returned on failure, in which case Ebuf is filled in with an appropriate error message.</returns>
  712. </member>
  713. <member name="M:SharpPcap.AirPcap.AirPcapSafeNativeMethods.AirpcapClose(System.IntPtr)">
  714. <summary>
  715. Closes an adapter
  716. </summary>
  717. <param name="AdapterHandle">Handle to the adapter to close.</param>
  718. </member>
  719. <member name="M:SharpPcap.AirPcap.AirPcapSafeNativeMethods.AirpcapGetDeviceCapabilities(System.IntPtr,System.IntPtr@)">
  720. <summary>
  721. Get the capabilities of a device
  722. NOTE: The PCapabilities structure returned by AirpcapGetDeviceCapabilities() must be considered invalid
  723. after the adapter has been closed.
  724. </summary>
  725. <param name="AdapterHandle">Handle to the adapter</param>
  726. <param name="PCapabilities">Pointer to a library-allocated AirpcapDeviceCapabilities structure that contains
  727. the capabilities of the adapter</param>
  728. <returns>True on success</returns>
  729. </member>
  730. <member name="M:SharpPcap.AirPcap.AirPcapSafeNativeMethods.AirpcapSetDeviceMacFlags(System.IntPtr,SharpPcap.AirPcap.AirPcapMacFlags)">
  731. <summary>
  732. Sets the device's monitor mode and acknowledgment settings.
  733. When an adapter is plugged into the system, it's always configured with monitor mode ON and acknowledgment settings OFF.
  734. These values are not stored persistently, so if you want to turn monitor mode off, you will need to do it
  735. every time you attach the adapter.
  736. \note currently, the AirPcap adapter supports frames acknowleging when the adapter is NOT in monitor mode. This means that
  737. the combinations in which the two flags have the same value will cause AirpcapSetDeviceMacFlags() to fail.
  738. </summary>
  739. <param name="AdapterHandle">Handle to the adapter</param>
  740. <param name="AirpcapMacFlags">Flags word, that contains a bitwise-OR combination of the following flags: \ref AIRPCAP_MF_MONITOR_MODE_ON and \ref AIRPCAP_MF_ACK_FRAMES_ON .</param>
  741. <returns>TRUE on success</returns>
  742. </member>
  743. <member name="M:SharpPcap.AirPcap.AirPcapSafeNativeMethods.AirpcapGetDeviceMacFlags(System.IntPtr,SharpPcap.AirPcap.AirPcapMacFlags@)">
  744. <summary>
  745. Gets the device's monitor mode and acknowledgement settings
  746. When an adapter is plugged into the system, it's always configured with monitor mode ON and acknowledgment settings OFF.
  747. These values are not stored persistently, so if you want to turn monitor mode off, you will need to do it
  748. every time you attach the adapter.
  749. </summary>
  750. <param name="AdapterHandle">Handle to the adapter</param>
  751. <param name="PAirpcapMacFlags">User-provided flags word, that will be filled by the function with an OR combination of the
  752. following flags: \ref AIRPCAP_MF_MONITOR_MODE_ON and \ref AIRPCAP_MF_ACK_FRAMES_ON.</param>
  753. <returns>TRUE on success</returns>
  754. </member>
  755. <member name="M:SharpPcap.AirPcap.AirPcapSafeNativeMethods.AirpcapSetLinkType(System.IntPtr,SharpPcap.AirPcap.AirPcapLinkTypes)">
  756. <summary>
  757. Sets the link type of an adapter
  758. the "link type" determines how the driver will encode the packets captured from the network.
  759. Aircap supports two link types:
  760. - \ref AIRPCAP_LT_802_11, to capture 802.11 frames (including control frames) without any
  761. power information. Look at the "Capture_no_radio" example application in the developer's pack
  762. for a reference on how to decode 802.11 frames with this link type.
  763. - \ref AIRPCAP_LT_802_11_PLUS_RADIO, to capture 802.11 frames (including control frames) with a radiotap header
  764. that contains power and channel information. More information about the radiotap header can be found in the
  765. \ref radiotap section. Moreover, the "Capture_radio" example application in
  766. the developer's pack can be used as a reference on how to decode 802.11 frames with radiotap headers.
  767. - \ref AIRPCAP_LT_802_11_PLUS_PPI, to capture 802.11 frames (including control frames) with a Per Packet Information (PPI)
  768. header that contains per-packet meta information like channel and power information. More details on the PPI header can
  769. be found in the PPI online documentation (TODO).
  770. </summary>
  771. <param name="AdapterHandle">
  772. </param>
  773. <param name="NewLinkType">the "link type", i.e. the format of the frames that will be received from the adapter.</param>
  774. <returns>TRUE on success</returns>
  775. </member>
  776. <member name="M:SharpPcap.AirPcap.AirPcapSafeNativeMethods.AirpcapGetLinkType(System.IntPtr,SharpPcap.AirPcap.AirPcapLinkTypes@)">
  777. <summary>
  778. Gets the link type of the specified adapter
  779. the "link type" determines how the driver will encode the packets captured from the network.
  780. Aircap supports two link types:
  781. - \ref AIRPCAP_LT_802_11, to capture 802.11 frames (including control frames) without any
  782. power information. Look at the "Capture_no_radio" example application in the developer's pack
  783. for a reference on how to decode 802.11 frames with this link type.
  784. - \ref AIRPCAP_LT_802_11_PLUS_RADIO, to capture 802.11 frames (including control frames) with a radiotap header
  785. that contains power and channel information. More information about the radiotap header can be found int the
  786. \ref radiotap section. Moreover, the "Capture_radio" example application in
  787. the developer's pack can be used as a reference on how to decode 802.11 frames with radiotap headers.
  788. - \ref AIRPCAP_LT_802_11_PLUS_PPI, to capture 802.11 frames (including control frames) with a Per Packet Information (PPI)
  789. header that contains per-packet meta information like channel and power information. More details on the PPI header can
  790. be found in the PPI online documentation (TODO).
  791. </summary>
  792. <param name="AdapterHandle">Handle to the adapter</param>
  793. <param name="PLinkType">Pointer to a caller allocated AirpcapLinkType variable that will contain
  794. the link type of the adapter</param>
  795. <returns>TRUE on success</returns>
  796. </member>
  797. <member name="M:SharpPcap.AirPcap.AirPcapSafeNativeMethods.AirpcapSetFcsPresence(System.IntPtr,System.Boolean)">
  798. <summary>
  799. Configures the adapter on whether to include the MAC Frame Check Sequence in the captured packets.
  800. In the default configuration, the adapter includes the FCS in the captured packets. The MAC Frame Check Sequence
  801. is 4 bytes and is located at the end of the 802.11 packet, with \ref AIRPCAP_LT_802_11, \ref AIRPCAP_LT_802_11_PLUS_RADIO and
  802. \ref AIRPCAP_LT_802_11_PLUS_PPI link types.
  803. When the FCS inclusion is turned on, and if the link type is \ref AIRPCAP_LT_802_11_PLUS_RADIO, the radiotap header
  804. that precedes each frame has two additional fields at the end: Padding and FCS. These two fields are not present
  805. when FCS inclusion is off.
  806. </summary>
  807. <param name="AdapterHandle">Handle to the adapter</param>
  808. <param name="IsFcsPresent">TRUE if the packets should include the FCS, FALSE otherwise</param>
  809. <returns>TRUE on success</returns>
  810. </member>
  811. <member name="M:SharpPcap.AirPcap.AirPcapSafeNativeMethods.AirpcapGetFcsPresence(System.IntPtr,System.Boolean@)">
  812. <summary>
  813. PIsFcsPresent is tue if the specified adapter includes the MAC Frame Check Sequence in the captured packets
  814. In the default configuration, the adapter includes the FCS in the captured packets. The MAC Frame Check Sequence
  815. is 4 bytes and is located at the end of the 802.11 packet, with \ref AIRPCAP_LT_802_11, \ref AIRPCAP_LT_802_11_PLUS_RADIO and
  816. \ref AIRPCAP_LT_802_11_PLUS_PPI link types.
  817. When the FCS inclusion is turned on, and if the link type is \ref AIRPCAP_LT_802_11_PLUS_RADIO, the radiotap header
  818. that precedes each frame has two additional fields at the end: Padding and FCS. These two fields are not present
  819. when FCS inclusion is off.
  820. </summary>
  821. <param name="AdapterHandle">Handle to the adapter</param>
  822. <param name="PIsFcsPresent">User-provided variable that will be set to true if the adapter is including the FCS</param>
  823. <returns>TRUE if the operation is successful. FALSE otherwise.</returns>
  824. </member>
  825. <member name="M:SharpPcap.AirPcap.AirPcapSafeNativeMethods.AirpcapSetFcsValidation(System.IntPtr,SharpPcap.AirPcap.AirPcapValidationType)">
  826. <summary>
  827. Configures the adapter to accept or drop frames with an incorrect Frame Check sequence (FCS)
  828. NOTE: By default the driver is configured in \ref AIRPCAP_VT_ACCEPT_EVERYTHING mode
  829. </summary>
  830. <param name="AdapterHandle">Handle to the adapter</param>
  831. <param name="ValidationType">The type of validation the driver will perform. See the documentation of \ref AirpcapValidationType for details.</param>
  832. <returns>TRUE on success</returns>
  833. </member>
  834. <member name="M:SharpPcap.AirPcap.AirPcapSafeNativeMethods.AirpcapGetFcsValidation(System.IntPtr,SharpPcap.AirPcap.AirPcapValidationType@)">
  835. <summary>
  836. Checks if the specified adapter is configured to capture frames with incorrect an incorrect Frame Check Sequence (FCS).
  837. \note By default, the driver is configured in \ref AIRPCAP_VT_ACCEPT_EVERYTHING mode.
  838. </summary>
  839. <param name="AdapterHandle">Handle to the adapter</param>
  840. <param name="ValidationType">Pointer to a user supplied variable that will contain the type of validation the driver will perform. See the documentation of \ref AirpcapValidationType for details.</param>
  841. <returns>TRUE if the operation is successful, FALSE otherwise</returns>
  842. </member>
  843. <member name="M:SharpPcap.AirPcap.AirPcapSafeNativeMethods.AirpcapSetDeviceKeys(System.IntPtr,System.IntPtr)">
  844. <summary>
  845. Sets the list of decryption keys that AirPcap is going to use with the specified device.
  846. AirPcap is able to use a set of decryption keys to decrypt the traffic transmitted on a specific SSID. If one of the
  847. keys corresponds to the one the frame has been encrypted with, the driver will perform decryption and return the cleartext frames
  848. to the application.
  849. This function allows to set the <b>device-specific</b> set of keys. These keys will be used by the specified device only,
  850. and will not be used by other airpcap devices besides the specified one.
  851. At this time, the only supported decryption method is WEP.
  852. The keys are applied to the packets in the same order they appear in the KeysCollection structure until the packet is
  853. correctly decrypted, therefore putting frequently used keys at the beginning of the structure improves performance.
  854. \note When you change the set of keys from an open capture instance, the change will be
  855. immediately reflected on all the other capture instances on the same device.
  856. </summary>
  857. <param name="AdapterHandle">Handle to the adapter</param>
  858. <param name="KeysCollection">Pointer to a \ref PAirpcapKeysCollection structure that contains the keys to be set in the device.</param>
  859. <returns>TRUE if the operation is successful. FALSE otherwise.</returns>
  860. </member>
  861. <member name="M:SharpPcap.AirPcap.AirPcapSafeNativeMethods.AirpcapGetDeviceKeys(System.IntPtr,System.IntPtr,System.UInt32@)">
  862. <summary>
  863. Returns the list of decryption keys that are currently associated with the specified device
  864. This function returns the <b>device-specific</b> set of keys. These keys are used by the specified device only,
  865. and not by other airpcap devices besides the specified one.
  866. AirPcap is able to use a set of decryption keys to decrypt the traffic transmitted on a specific SSID. If one of the
  867. keys corresponds to the one the frame has been encrypted with, the driver will perform decryption and return the cleartext frames
  868. to the application.
  869. AirPcap supports, for every device, multiple keys at the same time.
  870. The configured decryption keys are device-specific, therefore AirpcapGetDeviceKeys() will return a different set of keys
  871. when called on different devices.
  872. At this time, the only supported decryption method is WEP.
  873. </summary>
  874. <param name="AdapterHandle">Handle to an open adapter</param>
  875. <param name="KeysCollection">User-allocated PAirpcapKeysCollection structure that will be filled with the keys.</param>
  876. <param name="PKeysCollectionSize">- \b IN: pointer to a user-allocated variable that contains the length of the KeysCollection structure, in bytes.
  877. - \b OUT: amount of data moved by AirPcap in the buffer pointed by KeysBuffer, in bytes.</param>
  878. <returns>TRUE if the operation is successful. If an error occurs, the return value is FALSE and KeysCollectionSize is zero.
  879. If the provided buffer is too small to contain the keys, the return value is FALSE and KeysCollectionSize contains the
  880. needed KeysCollection length, in bytes. If the device doesn't have any decryption key configured, the return value is TRUE, and
  881. KeysCollectionSize will be zero.</returns>
  882. </member>
  883. <member name="M:SharpPcap.AirPcap.AirPcapSafeNativeMethods.AirpcapSetDriverKeys(System.IntPtr,System.IntPtr)">
  884. <summary>
  885. Set the global list of decryption keys that AirPcap is going to use with all the devices.
  886. The AirPcap driver is able to use a set of decryption keys to decrypt the traffic transmitted on a specific SSID. If one of the
  887. keys corresponds to the one the frame has been encrypted with, the driver will perform decryption and return the cleartext frames
  888. to the application.
  889. This function allows to set the <b>global</b> set of keys. These keys will be used by all the devices plugged in
  890. the machine.
  891. At this time, the only supported decryption method is WEP.
  892. The keys are applied to the packets in the same order they appear in the KeysCollection structure until the packet is
  893. correctly decrypted, therefore putting frequently used keys at the beginning of the structure improves performance.
  894. \note When you change the set of keys from an open capture instance, the change will be
  895. immediately reflected on all the other capture instances.
  896. </summary>
  897. <param name="AdapterHandle">Handle to an open adapter</param>
  898. <param name="KeysCollection">Pointer to a \ref PAirpcapKeysCollection structure that contains the keys to be set globally.</param>
  899. <returns>TRUE if the operation is successful. FALSE otherwise.</returns>
  900. </member>
  901. <member name="M:SharpPcap.AirPcap.AirPcapSafeNativeMethods.AirpcapGetDriverKeys(System.IntPtr,System.IntPtr,System.UInt32@)">
  902. <summary>
  903. Returns the global list of decryption keys that AirPcap is using with all the devices.
  904. This function returns the <b>global</b> set of keys. These keys will be used by all the devices plugged in
  905. the machine.
  906. The AirPcap driver is able to use a set of decryption keys to decrypt the traffic transmitted on a specific SSID. If one of the
  907. keys corresponds to the one the frame has been encrypted with, the driver will perform decryption and return the cleartext frames
  908. to the application.
  909. At this time, the only supported decryption method is WEP.
  910. </summary>
  911. <param name="AdapterHandle">Handle to an adapter</param>
  912. <param name="KeysCollection">User-allocated PAirpcapKeysCollection structure that will be filled with the keys.</param>
  913. <param name="PKeysCollectionSize">- \b IN: pointer to a user-allocated variable that contains the length of the KeysCollection structure, in bytes.
  914. - \b OUT: amount of data moved by AirPcap in the buffer pointed by KeysBuffer, in bytes.</param>
  915. <returns>TRUE if the operation is successful. If an error occurs, the return value is FALSE and KeysCollectionSize is zero.
  916. If the provided buffer is too small to contain the keys, the return value is FALSE and KeysCollectionSize contains the
  917. needed KeysCollection length, in bytes. If no global decryption keys are configured, the return value is TRUE, and
  918. KeysCollectionSize will be zero.</returns>
  919. </member>
  920. <member name="M:SharpPcap.AirPcap.AirPcapSafeNativeMethods.AirpcapSetDecryptionState(System.IntPtr,SharpPcap.AirPcap.AirPcapDecryptionState)">
  921. <summary>
  922. Turns on or off the decryption of the incoming frames with the <b>device-specific</b> keys.
  923. The device-specific decryption keys can be configured with the \ref AirpcapSetDeviceKeys() function.
  924. \note By default, the driver is configured with \ref AIRPCAP_DECRYPTION_ON.
  925. </summary>
  926. <param name="AdapterHandle">Handle to the adapter</param>
  927. <param name="Enable">Either AIRPCAP_DECRYPTION_ON or AIRPCAP_DECRYPTION_OFF</param>
  928. <returns>TRUE on success</returns>
  929. </member>
  930. <member name="M:SharpPcap.AirPcap.AirPcapSafeNativeMethods.AirpcapGetDecryptionState(System.IntPtr,SharpPcap.AirPcap.AirPcapDecryptionState@)">
  931. <summary>
  932. Tells if this open instance is configured to perform the decryption of the incoming frames with the <b>device-specific</b> keys.
  933. The device-specific decryption keys can be configured with the \ref AirpcapSetDeviceKeys() function.
  934. \note By default, the driver is configured with \ref AIRPCAP_DECRYPTION_ON.
  935. </summary>
  936. <param name="AdapterHandle">Handle to the adapter</param>
  937. <param name="PEnable">Pointer to a user supplied variable that will contain the decryption configuration. See \ref PAirpcapDecryptionState for details.</param>
  938. <returns>TRUE if the operation is successful, FALSE otherwise</returns>
  939. </member>
  940. <member name="M:SharpPcap.AirPcap.AirPcapSafeNativeMethods.AirpcapSetDriverDecryptionState(System.IntPtr,SharpPcap.AirPcap.AirPcapDecryptionState)">
  941. <summary>
  942. Turns on or off the decryption of the incoming frames with the <b>global</b> set of keys.
  943. The global decryption keys can be configured with the \ref AirpcapSetDriverKeys() function.
  944. \note By default, the driver is configured with \ref AIRPCAP_DECRYPTION_ON.
  945. </summary>
  946. <param name="AdapterHandle">Handle to the adapter</param>
  947. <param name="Enable">Either \ref AIRPCAP_DECRYPTION_ON or \ref AIRPCAP_DECRYPTION_OFF</param>
  948. <returns>TRUE on success</returns>
  949. </member>
  950. <member name="M:SharpPcap.AirPcap.AirPcapSafeNativeMethods.AirpcapGetDriverDecryptionState(System.IntPtr,SharpPcap.AirPcap.AirPcapDecryptionState@)">
  951. <summary>
  952. Tells if this open instance is configured to perform the decryption of the incoming frames with the <b>global</b> set of keys.
  953. The global decryption keys can be configured with the \ref AirpcapSetDriverKeys() function.
  954. \note By default, the driver is configured with \ref AIRPCAP_DECRYPTION_ON.
  955. </summary>
  956. <param name="AdapterHandle">Handle to the adapter</param>
  957. <param name="PEnable">Pointer to a user supplied variable that will contain the decryption configuration. See \ref PAirpcapDecryptionState for details.</param>
  958. <returns>TRUE if the operation is successful. FALSE otherwise.</returns>
  959. </member>
  960. <member name="M:SharpPcap.AirPcap.AirPcapSafeNativeMethods.AirpcapSetDeviceChannel(System.IntPtr,System.UInt32)">
  961. <summary>
  962. Sets the radio channel of a device
  963. The list of available channels can be retrieved with \ref AirpcapGetDeviceSupportedChannels(). The default channel setting is 6.
  964. \note This is a device-related function: when you change the channel from an open capture instance, the change will be
  965. immediately reflected on all the other capture instances.
  966. </summary>
  967. <param name="AdapterHandle">Handle to the adapter</param>
  968. <param name="Channel">The new channel to set</param>
  969. <returns>TRUE on success</returns>
  970. </member>
  971. <member name="M:SharpPcap.AirPcap.AirPcapSafeNativeMethods.AirpcapGetDeviceChannel(System.IntPtr,System.UInt32@)">
  972. <summary>
  973. Gets the radio channel of a device
  974. The list of available channels can be retrieved with \ref AirpcapGetDeviceSupportedChannels(). The default channel setting is 6.
  975. \note This is a device-related function: when you change the channel from an open capture instance, the change will be
  976. immediately reflected on all the other capture instances.
  977. </summary>
  978. <param name="AdapterHandle">Handle to the adapter</param>
  979. <param name="PChannel">Pointer to a user-supplied variable into which the function will copy the currently configured radio channel.</param>
  980. <returns>TRUE on success</returns>
  981. </member>
  982. <member name="M:SharpPcap.AirPcap.AirPcapSafeNativeMethods.AirpcapSetDeviceChannelEx(System.IntPtr,SharpPcap.AirPcap.AirPcapUnmanagedStructures.AirpcapChannelInfo)">
  983. <summary>
  984. Sets the channel of a device through its radio frequency. In case of 802.11n enabled devices, it sets the extension channel, if used.
  985. \note This is a device-related function: when you change the channel from an open capture instance, the change will be
  986. immediately reflected on all the other capture instances.
  987. </summary>
  988. <param name="AdapterHandle">Handle to the adapter</param>
  989. <param name="ChannelInfo">The new channel information to set</param>
  990. <returns>TRUE on success</returns>
  991. </member>
  992. <member name="M:SharpPcap.AirPcap.AirPcapSafeNativeMethods.AirpcapGetDeviceChannelEx(System.IntPtr,SharpPcap.AirPcap.AirPcapUnmanagedStructures.AirpcapChannelInfo@)">
  993. <summary>
  994. Gets the channel of a device through its radio frequency. In case of 802.11n enabled devices, it gets the extension channel, if in use.
  995. \note This is a device-related function: when you change the channel from an open capture instance, the change will be
  996. immediately reflected on all the other capture instances.
  997. </summary>
  998. <param name="AdapterHandle">Handle to the adapter</param>
  999. <param name="PChannelInfo">Pointer to a user-supplied variable into which the function will copy the currently configured channel information.</param>
  1000. <returns>TRUE on success</returns>
  1001. </member>
  1002. <member name="M:SharpPcap.AirPcap.AirPcapSafeNativeMethods.AirpcapGetDeviceSupportedChannels(System.IntPtr,System.IntPtr@,System.UInt32@)">
  1003. <summary>
  1004. Gets the list of supported channels for a given device. In case of a 802.11n capable device, information related to supported extension channels is also reported.
  1005. Every control channel is listed multiple times, one for each different supported extension channel. For example channel 6 (2437MHz) is usually listed three times:
  1006. - <b>Frequency 2437 Extension +1</b>. Control channel is 6, extension channel is 10.
  1007. - <b>Frequency 2437 Extension 0</b>. Control channel is 6, no extension channel is used (20MHz channel and legacy mode).
  1008. - <b>Frequency 2437 Extension -1</b>. Control channel is 6, extension channel is 2.
  1009. \note The supported channels are not listed in any specific order.
  1010. </summary>
  1011. <param name="AdapterHandle">Handle to the adapter</param>
  1012. <param name="ppChannelInfo">Pointer to a user-supplied variable that will point to an array of supported channel. Such list must not be freed by the caller</param>
  1013. <param name="pNumChannelInfo">Number of channels returned in the array</param>
  1014. <returns>TRUE on success</returns>
  1015. </member>
  1016. <member name="M:SharpPcap.AirPcap.AirPcapSafeNativeMethods.AirpcapConvertFrequencyToChannel(System.UInt32,System.UInt32@,System.UInt32@)">
  1017. <summary>
  1018. Converts a frequency to the corresponding channel
  1019. </summary>
  1020. <param name="Frequency">Frequency of the channel in MHz</param>
  1021. <param name="PChannel">Pointer to a user-supplied variable that will contain the channel number on success</param>
  1022. <param name="PBand">Pointer to a user-supplied variable that will contain the band (a orb/g) of the given channel</param>
  1023. <returns>TRUE on success, i.e. the frequency corresponds to a valid a or b/g channel</returns>
  1024. </member>
  1025. <member name="M:SharpPcap.AirPcap.AirPcapSafeNativeMethods.AirpcapConvertChannelToFrequency(System.UInt32,System.UInt32@)">
  1026. <summary>
  1027. Converts a given channel to the corresponding frequency
  1028. Because of the overlap of channels with respect to 1-14BG and 1-14A, this function will give precidence to BG.
  1029. Thus, the channels are returned as follows:
  1030. - <b>Channel 0:</b> 5000MHz
  1031. - <b>Channels 1-14:</b> 2412MHz - 2484MHz
  1032. - <b>Channels 15-239:</b> 5005MHz - 6195MHz
  1033. - <b>Channels 240-255:</b> 4920MHz - 4995MHz
  1034. </summary>
  1035. <param name="Channel">Channel number to be converted</param>
  1036. <param name="PFrequency">Pointer to a user-supplied variable that will contain the channel frequency in MHz on success&gt;</param>
  1037. <returns>
  1038. </returns>
  1039. </member>
  1040. <member name="M:SharpPcap.AirPcap.AirPcapSafeNativeMethods.AirpcapSetKernelBuffer(System.IntPtr,System.UInt32)">
  1041. <summary>
  1042. Sets the size of the kernel packet buffer for this adapter
  1043. Every AirPcap open instance has an associated kernel buffer, whose default size is 1 Mbyte.
  1044. This function can be used to change the size of this buffer, and can be called at any time.
  1045. A bigger kernel buffer size decreases the risk of dropping packets during network bursts or when the
  1046. application is busy, at the cost of higher kernel memory usage.
  1047. \note Don't use this function unless you know what you are doing. Due to caching issues and bigger non-paged
  1048. memory consumption, bigger buffer sizes can decrease the capture performace instead of improving it.
  1049. </summary>
  1050. <param name="AdapterHandle">Handle to the adapter</param>
  1051. <param name="BufferSize">New size in bytes</param>
  1052. <returns>TRUE on success</returns>
  1053. </member>
  1054. <member name="M:SharpPcap.AirPcap.AirPcapSafeNativeMethods.AirpcapGetKernelBufferSize(System.IntPtr,System.UInt32@)">
  1055. <summary>
  1056. Gets the size of the kernel packet buffer for this adapter
  1057. Every AirPcap open instance has an associated kernel buffer, whose default size is 1 Mbyte.
  1058. This function can be used to get the size of this buffer.
  1059. </summary>
  1060. <param name="AdapterHandle">Handle to the adapter</param>
  1061. <param name="PSizeBytes">User-allocated variable that will be filled with the size of the kernel buffer.</param>
  1062. <returns>TRUE on success</returns>
  1063. </member>
  1064. <member name="M:SharpPcap.AirPcap.AirPcapSafeNativeMethods.AirpcapSetTxPower(System.IntPtr,System.UInt32)">
  1065. <summary>
  1066. Sets the power of the frames transmitted by adapter
  1067. The transmit power value is monotonically increasing with higher power levels. 1 is the minimum allowed transmit power.
  1068. \note The maximum transmit power on each channel is limited by FCC regulations. Therefore, the maximum transmit power
  1069. changes from channel to channel. When the channel is changed with \ref AirpcapSetDeviceChannel() or
  1070. \ref AirpcapSetDeviceChannelEx() the power is set to the maximum allowd value for that channel. You can read this
  1071. value with \ref AirpcapGetTxPower(). Not all the AirPcap adapters support setting the transmit power; you can use
  1072. \ref AirpcapGetDeviceCapabilities() to find if the current adapter supports this feature.
  1073. </summary>
  1074. <param name="AdapterHandle">Handle to the adapter</param>
  1075. <param name="Power">The transmit power. Setting a zero power makes the adapter select the
  1076. highest possible power for the current channel.</param>
  1077. <returns>TRUE on success. False on failure or if the adapter doesn't support setting the transmit power.</returns>
  1078. </member>
  1079. <member name="M:SharpPcap.AirPcap.AirPcapSafeNativeMethods.AirpcapGetTxPower(System.IntPtr,System.UInt32@)">
  1080. <summary>
  1081. Returns the current transmit power level of the adapter
  1082. The transmit power value is monotonically increasing with higher power levels. 0 is the minimum allowed power.
  1083. \note The maximum transmit power on each channel is limited by FCC regulations. Therefore, the maximum transmit power
  1084. changes from channel to channel. When the channel is changed with \ref AirpcapSetDeviceChannel() or
  1085. \ref AirpcapSetDeviceChannelEx() the power is set to the maximum allowd value for that channel. Not all the AirPcap
  1086. adapters support setting the transmit power; you can use \ref AirpcapGetDeviceCapabilities() to find if the current
  1087. adapter supports this feature.
  1088. </summary>
  1089. <param name="AdapterHandle">Handle to the adapter</param>
  1090. <param name="PPower">User-allocated variable that will be filled with the size of the transmit power</param>
  1091. <returns>TRUE on success, false on failure or if the adapter doesn't support getting the transmit power</returns>
  1092. </member>
  1093. <member name="M:SharpPcap.AirPcap.AirPcapSafeNativeMethods.AirpcapStoreCurConfigAsAdapterDefault(System.IntPtr)">
  1094. <summary>
  1095. Saves the configuration of the specified adapter in the registry, so that it becomes the default for this adapter.
  1096. Almost all the AirPcap calls that modify the configuration (\ref AirpcapSetLinkType(), \ref AirpcapSetFcsPresence(),
  1097. \ref AirpcapSetFcsValidation(), \ref AirpcapSetKernelBuffer(), \ref AirpcapSetMinToCopy())
  1098. affect only the referenced AirPcap open instance. This means that if you do another \ref AirpcapOpen() on the same
  1099. adapter, the configuration changes will not be remembered, and the new adapter handle will have default configuration
  1100. settings.
  1101. Exceptions to this rule are the \ref AirpcapSetDeviceChannel() and \ref AirpcapSetDeviceKeys() functions: a channel change is
  1102. reflected on all the open instances, and remembered until the next call to \ref AirpcapSetDeviceChannel(), until the adapter
  1103. is unplugged, or until the machine is powered off. Same thing for the configuration of the WEP keys.
  1104. AirpcapStoreCurConfigAsAdapterDefault() stores the configuration of the give open instance as the default for the adapter:
  1105. all the instances opened in the future will have the same configuration that this adapter currently has.
  1106. The configuration is stored in the registry, therefore it is remembered even when the adapter is unplugged or the
  1107. machine is turned off. However, an adapter doesn't bring its configuration with it from machine to machine.
  1108. the configuration information saved in the registry includes the following parameters:
  1109. - channel
  1110. - kernel buffer size
  1111. - mintocopy
  1112. - link type
  1113. - CRC presence
  1114. - Encryption keys
  1115. - Encryption Enabled/Disabled state
  1116. The configuration is device-specific. This means that changing the configuration of a device
  1117. doesn't modify the one of the other devices that are currently used or that will be used in the future.
  1118. \note AirpcapStoreCurConfigAsAdapterDefault() must have exclusive access to the adapter -- it
  1119. will fail if more than one AirPcap handle is opened at the same time for this device.
  1120. AirpcapStoreCurConfigAsAdapterDefault() needs administrator privileges. It will fail if the calling user
  1121. is not a local machine administrator.
  1122. </summary>
  1123. <param name="AdapterHandle">Handle to an adapter</param>
  1124. <returns>TRUE on success. FALSE on failure.</returns>
  1125. </member>
  1126. <member name="M:SharpPcap.AirPcap.AirPcapSafeNativeMethods.AirpcapSetFilter(System.IntPtr,System.IntPtr,System.UInt32)">
  1127. <summary>
  1128. Sets the BPF kernel filter for an adapter
  1129. The AirPcap driver is able to perform kernel-level filtering using the standard BPF pseudo-machine format. You can read
  1130. the WinPcap documentation at http://www.winpcap.org/devel.htm for more details on the BPF filtering mechaism.
  1131. A filter can be automatically created by using the pcap_compile() function of the WinPcap API. This function
  1132. converts a human readable text expression with the tcpdump/libpcap syntax into a BPF program.
  1133. If your program doesn't link wpcap, but you need to generate the code for a particular filter, you can run WinDump
  1134. with the -d or -dd or -ddd flags to obtain the pseudocode.
  1135. </summary>
  1136. <param name="AdapterHandle">Handle to the adapter</param>
  1137. <param name="Instructions"> pointer to the first BPF instruction in the array. Corresponds to the bf_insns
  1138. in a bpf_program structure (see the WinPcap documentation at http://www.winpcap.org/devel.htm).
  1139. \param Len Number of instructions in the array pointed by the previous field. Corresponds to the bf_len in
  1140. a a bpf_program structure (see the WinPcap documentation at http://www.winpcap.org/devel.htm).</param>
  1141. <param name="Len">
  1142. </param>
  1143. <returns>TRUE on success</returns>
  1144. </member>
  1145. <member name="M:SharpPcap.AirPcap.AirPcapSafeNativeMethods.AirpcapGetMacAddress(System.IntPtr,System.IntPtr)">
  1146. <summary>
  1147. Returns the MAC address of a device
  1148. </summary>
  1149. <param name="AdapterHandle">Handle to the adapter</param>
  1150. <param name="PMacAddress">Pointer to a user allocated \ref AirpcapMacAddress structure that will receive the MAC address on success. </param>
  1151. <returns>TRUE on success</returns>
  1152. </member>
  1153. <member name="M:SharpPcap.AirPcap.AirPcapSafeNativeMethods.AirpcapSetMacAddress(System.IntPtr,System.IntPtr)">
  1154. <summary>
  1155. Sets the MAC address of a device
  1156. Using this function, the programmer can change the MAC address of the device. This is useful when disabling monitor
  1157. mode with \ref AirpcapSetDeviceMacFlags(), because the device will acknowledge the data frames sent to its MAC address.
  1158. \note The address change is temporary: when the device is unplugged or when the host PC is turned off, the address is reset to the original
  1159. value.
  1160. </summary>
  1161. <param name="AdapterHandle">Handle to the adapter</param>
  1162. <param name="PMacAddress">Pointer to a user-initialized structure containing the MAC address</param>
  1163. <returns>TRUE on success. FALSE on failure, or if the adapter doesn't support changing the address.</returns>
  1164. </member>
  1165. <member name="M:SharpPcap.AirPcap.AirPcapSafeNativeMethods.AirpcapSetMinToCopy(System.IntPtr,System.UInt32)">
  1166. <summary>
  1167. Sets the mintocopy parameter for an open adapter
  1168. When the number of bytes in the kernel buffer changes from less than mintocopy bytes to greater than or equal to mintocopy bytes,
  1169. the read event is signalled (see \ref AirpcapGetReadEvent()). A high value for mintocopy results in poor responsiveness since the
  1170. driver may signal the application "long" after the arrival of the packet. And a high value results in low CPU loading
  1171. by minimizing the number of user/kernel context switches.
  1172. A low MinToCopy results in good responsiveness since the driver will signal the application close to the arrival time of
  1173. the packet. This has higher CPU loading over the first approach.
  1174. </summary>
  1175. <param name="AdapterHandle">Handle to the adapter</param>
  1176. <param name="MinToCopy">is the mintocopy size in bytes</param>
  1177. <returns>TRUE on success</returns>
  1178. </member>
  1179. <member name="M:SharpPcap.AirPcap.AirPcapSafeNativeMethods.AirpcapGetReadEvent(System.IntPtr,System.IntPtr@)">
  1180. <summary>
  1181. Gets an event that is signalled when packets are available in the kernel buffer (see \ref AirpcapSetMinToCopy()).
  1182. \note The event is signalled when at least mintocopy bytes are present in the kernel buffer (see \ref AirpcapSetMinToCopy()).
  1183. This event can be used by WaitForSingleObject() and WaitForMultipleObjects() to create blocking behavior when reading
  1184. packets from one or more adapters (see \ref AirpcapRead()).
  1185. </summary>
  1186. <param name="AdapterHandle">Handle to the adapter</param>
  1187. <param name="PReadEvent">Pointer to a user-supplied handle in which the read event will be copied.</param>
  1188. <returns>TRUE on success</returns>
  1189. </member>
  1190. <member name="M:SharpPcap.AirPcap.AirPcapSafeNativeMethods.AirpcapRead(System.IntPtr,System.IntPtr,System.UInt32,System.UInt32@)">
  1191. <summary>
  1192. Fills a user-provided buffer with zero or more packets that have been captured on the referenced adapter.
  1193. 802.11 frames are returned by the driver in buffers. Every 802.11 frame in the buffer is preceded by a \ref AirpcapBpfHeader structure.
  1194. The suggested way to use an AirPcap adapter is through the pcap API exported by wpcap.dll. If this is not
  1195. possible, the Capture_radio and Capture_no_radio examples in the AirPcap developer's pack show how to properly decode the
  1196. packets in the read buffer returned by AirpcapRead().
  1197. \note This function is NOT blocking. Blocking behavior can be obtained using the event returned
  1198. by \ref AirpcapGetReadEvent(). See also \ref AirpcapSetMinToCopy().
  1199. </summary>
  1200. <param name="AdapterHandle">Handle to the adapter</param>
  1201. <param name="Buffer">pointer to the buffer that will be filled with captured packets.</param>
  1202. <param name="BufSize">size of the input buffer that will contain the packets, in bytes.</param>
  1203. <param name="PReceievedBytes">Pointer to a user supplied variable that will receive the number of bytes copied by AirpcapRead.
  1204. Can be smaller than BufSize.</param>
  1205. <returns>TRUE on success</returns>
  1206. </member>
  1207. <member name="M:SharpPcap.AirPcap.AirPcapSafeNativeMethods.AirpcapWrite(System.IntPtr,System.IntPtr,System.UInt32)">
  1208. <summary>
  1209. Transmits a packet
  1210. The packet will be transmitted on the channel the device is currently set. To change the device adapter, use the
  1211. \ref AirpcapSetDeviceChannel() function.
  1212. If the link type of the adapter is AIRPCAP_LT_802_11, the buffer pointed by TxPacket should contain just the 802.11
  1213. packet, without additional information. The packet will be transmitted at 1Mbps.
  1214. If the link type of the adapter is AIRPCAP_LT_802_11_PLUS_RADIO, the buffer pointed by TxPacket should contain a radiotap
  1215. header followed by the 802.11 packet. AirpcapWrite will use the rate information in the radiotap header when
  1216. transmitting the packet.
  1217. If the link type of the adapter is AIRPCAP_LT_802_11_PLUS_PPI, the buffer pointed by TxPacket should contain a PPI header
  1218. followed by the 802.11 packet. AirpcapWrite will use the rate information in the PPI header when transmitting the packet.
  1219. If the packet should be transmitted at a 802.11n rate, the packet must include a PPI 802.11n MAC+PHY Extension header, containing
  1220. the rate expressed in terms of MCS, short/long guard interval (SGI/LGI) and 20MHz or 40MHz channel. When the MAC+PHY Extension header is present,
  1221. the rate field in the PPI 802.11-Common header is ignored.
  1222. By default on 802.11n-capable AirPcap adapters, packets are transmitted with no A-MPDU aggregation. A-MPDU aggregation is controlled by the
  1223. adapter, but it's possible to give a hint to the hardware to aggregate some packets by setting the "Aggregate" and "More aggregates" flags in
  1224. the PPI 802.11n MAC+PHY extension header.
  1225. </summary>
  1226. <param name="AdapterHandle">Handle to the adapter</param>
  1227. <param name="TxPacket">Pointer to a buffer that contains the packet to be transmitted.</param>
  1228. <param name="PacketLen">Length of the buffer pointed by the TxPacket argument, in bytes</param>
  1229. <returns>TRUE on success</returns>
  1230. </member>
  1231. <member name="M:SharpPcap.AirPcap.AirPcapSafeNativeMethods.AirpcapGetStats(System.IntPtr,System.IntPtr)">
  1232. <summary>
  1233. Gets per-adapter WinPcap-compatible capture statistics.
  1234. </summary>
  1235. <param name="AdapterHandle">Handle to the adapter</param>
  1236. <param name="PStats">Pointer to a user-allocated AirpcapStats structure that will be filled with statistical information.</param>
  1237. <returns>TRUE on success</returns>
  1238. </member>
  1239. <member name="M:SharpPcap.AirPcap.AirPcapSafeNativeMethods.AirpcapGetLedsNumber(System.IntPtr,System.UInt32@)">
  1240. <summary>
  1241. Gets the number of LEDs the referenced adapter has available
  1242. </summary>
  1243. <param name="AdapterHandle">Handle to the adapter</param>
  1244. <param name="NumberOfLeds">Number of LEDs available on this adapter</param>
  1245. <returns>
  1246. </returns>
  1247. </member>
  1248. <member name="M:SharpPcap.AirPcap.AirPcapSafeNativeMethods.AirpcapTurnLedOn(System.IntPtr,System.UInt32)">
  1249. <summary>
  1250. Turns on one of the adapter's LEDs.
  1251. </summary>
  1252. <param name="AdapterHandle">Handle to the adapter</param>
  1253. <param name="LedNumber">Zero-based identifier of the LED to turn on</param>
  1254. <returns>
  1255. </returns>
  1256. </member>
  1257. <member name="M:SharpPcap.AirPcap.AirPcapSafeNativeMethods.AirpcapTurnLedOff(System.IntPtr,System.UInt32)">
  1258. <summary>
  1259. Turns off one of the adapter's LEDs.
  1260. </summary>
  1261. <param name="AdapterHandle">Handle to the adapter</param>
  1262. <param name="LedNumber">Zero-based identifier of the LED to turn off.</param>
  1263. <returns>
  1264. </returns>
  1265. </member>
  1266. <member name="M:SharpPcap.AirPcap.AirPcapSafeNativeMethods.AirpcapGetDeviceTimestamp(System.IntPtr,System.IntPtr)">
  1267. <summary>
  1268. Gets the current value of the device counter used to timestamp packets.
  1269. </summary>
  1270. <param name="AdapterHandle">Handle to the adapter</param>
  1271. <param name="PTimestamp">Pointer to a caller allocated 64bit integer that will receive the device
  1272. timestamp, in microseconds.</param>
  1273. <returns>TRUE on success</returns>
  1274. </member>
  1275. <member name="T:SharpPcap.AirPcap.AirPcapStatistics">
  1276. <summary>
  1277. Device statistics
  1278. </summary>
  1279. </member>
  1280. <member name="P:SharpPcap.AirPcap.AirPcapStatistics.ReceivedPackets">
  1281. <value>
  1282. Number of packets received
  1283. </value>
  1284. </member>
  1285. <member name="P:SharpPcap.AirPcap.AirPcapStatistics.DroppedPackets">
  1286. <value>
  1287. Number of packets dropped
  1288. </value>
  1289. </member>
  1290. <member name="P:SharpPcap.AirPcap.AirPcapStatistics.InterfaceDroppedPackets">
  1291. <value>
  1292. Number of interface dropped packets
  1293. </value>
  1294. </member>
  1295. <member name="P:SharpPcap.AirPcap.AirPcapStatistics.CapturedPackets">
  1296. <summary>
  1297. Number of packets that pass the BPF filter, find place in the kernel buffer and
  1298. therefore reach the application.
  1299. </summary>
  1300. </member>
  1301. <member name="M:SharpPcap.AirPcap.AirPcapStatistics.ToString">
  1302. <summary>
  1303. ToString override
  1304. </summary>
  1305. <returns>
  1306. </returns>
  1307. </member>
  1308. <member name="T:SharpPcap.AirPcap.AirPcapUnmanagedStructures.AirpcapChannelInfo">
  1309. <summary>
  1310. Channel information
  1311. Used by \ref AirpcapSetDeviceChannelEx(), \ref AirpcapGetDeviceChannelEx(), \ref AirpcapGetDeviceSupportedChannels()
  1312. </summary>
  1313. </member>
  1314. <member name="F:SharpPcap.AirPcap.AirPcapUnmanagedStructures.AirpcapChannelInfo.Frequency">
  1315. <summary>
  1316. Channel frequency, in MHz
  1317. UINT
  1318. </summary>
  1319. </member>
  1320. <member name="F:SharpPcap.AirPcap.AirPcapUnmanagedStructures.AirpcapChannelInfo.ExtChannel">
  1321. <summary>
  1322. 802.11n specific. Offset of the extension channel in case of 40MHz channels.
  1323. Possible values are -1, 0 +1:
  1324. - -1 means that the extension channel should be below the control channel (e.g. Control = 5 and Extension = 1)
  1325. - 0 means that no extension channel should be used (20MHz channels or legacy mode)
  1326. - +1 means that the extension channel should be above the control channel (e.g. Control = 1 and Extension = 5)
  1327. In case of 802.11a/b/g channels (802.11n legacy mode), this field should be set to 0.
  1328. CHAR
  1329. </summary>
  1330. </member>
  1331. <member name="F:SharpPcap.AirPcap.AirPcapUnmanagedStructures.AirpcapChannelInfo.Flags">
  1332. <summary>
  1333. Channel Flags. The only flag supported at this time is \ref AIRPCAP_CIF_TX_ENABLED.
  1334. UCHAR
  1335. </summary>
  1336. </member>
  1337. <member name="F:SharpPcap.AirPcap.AirPcapUnmanagedStructures.AirpcapChannelInfo.Reserved1">
  1338. <summary>
  1339. Reserved. It should be set to {0,0}.
  1340. </summary>
  1341. </member>
  1342. <member name="T:SharpPcap.AirPcap.AirPcapUnmanagedStructures.AirpcapStats">
  1343. <summary>
  1344. Capture statistics
  1345. Returned by AirpcapGetStats()
  1346. </summary>
  1347. </member>
  1348. <member name="F:SharpPcap.AirPcap.AirPcapUnmanagedStructures.AirpcapStats.Recvs">
  1349. <summary>
  1350. Number of packets that the driver received by the adapter
  1351. from the beginning of the current capture. This value includes the packets
  1352. dropped because of buffer full.
  1353. </summary>
  1354. </member>
  1355. <member name="F:SharpPcap.AirPcap.AirPcapUnmanagedStructures.AirpcapStats.Drops">
  1356. <summary>
  1357. Number of packets that the driver dropped from the beginning of a capture.
  1358. A packet is lost when the the buffer of the driver is full.
  1359. </summary>
  1360. </member>
  1361. <member name="F:SharpPcap.AirPcap.AirPcapUnmanagedStructures.AirpcapStats.IfDrops">
  1362. <summary>
  1363. Packets dropped by the card before going to the USB bus.
  1364. Not supported at the moment.
  1365. </summary>
  1366. </member>
  1367. <member name="F:SharpPcap.AirPcap.AirPcapUnmanagedStructures.AirpcapStats.Capt">
  1368. <summary>
  1369. Number of packets that pass the BPF filter, find place in the kernel buffer and
  1370. therefore reach the application.
  1371. </summary>
  1372. </member>
  1373. <member name="T:SharpPcap.AirPcap.AirPcapUnmanagedStructures.AirpcapDeviceCapabilities">
  1374. <summary>
  1375. Device capabilities
  1376. Returned by AirpcapGetDeviceCapabilities()
  1377. </summary>
  1378. </member>
  1379. <member name="F:SharpPcap.AirPcap.AirPcapUnmanagedStructures.AirpcapDeviceCapabilities.AdapterId">
  1380. <summary>
  1381. An id that identifies the adapter model
  1382. </summary>
  1383. </member>
  1384. <member name="F:SharpPcap.AirPcap.AirPcapUnmanagedStructures.AirpcapDeviceCapabilities.AdapterModelName">
  1385. <summary>
  1386. String containing a printable adapter model
  1387. </summary>
  1388. </member>
  1389. <member name="F:SharpPcap.AirPcap.AirPcapUnmanagedStructures.AirpcapDeviceCapabilities.AdapterBus">
  1390. <summary>
  1391. The type of bus the adapter is plugged to
  1392. </summary>
  1393. </member>
  1394. <member name="F:SharpPcap.AirPcap.AirPcapUnmanagedStructures.AirpcapDeviceCapabilities.CanTransmit">
  1395. <summary>
  1396. TRUE if the adapter is able to perform frame injection.
  1397. </summary>
  1398. </member>
  1399. <member name="F:SharpPcap.AirPcap.AirPcapUnmanagedStructures.AirpcapDeviceCapabilities.CanSetTransmitPower">
  1400. <summary>
  1401. TRUE if the adapter's transmit power is can be specified by the user application.
  1402. </summary>
  1403. </member>
  1404. <member name="F:SharpPcap.AirPcap.AirPcapUnmanagedStructures.AirpcapDeviceCapabilities.ExternalAntennaPlug">
  1405. <summary>
  1406. TRUE if the adapter supports plugging one or more external antennas.
  1407. </summary>
  1408. </member>
  1409. <member name="F:SharpPcap.AirPcap.AirPcapUnmanagedStructures.AirpcapDeviceCapabilities.SupportedMedia">
  1410. <summary>
  1411. An OR combination of the media that the device supports. Possible values are: \ref AIRPCAP_MEDIUM_802_11_A,
  1412. \ref AIRPCAP_MEDIUM_802_11_B, \ref AIRPCAP_MEDIUM_802_11_G or \ref AIRPCAP_MEDIUM_802_11_N.
  1413. Not supported at the moment.
  1414. </summary>
  1415. </member>
  1416. <member name="F:SharpPcap.AirPcap.AirPcapUnmanagedStructures.AirpcapDeviceCapabilities.SupportedBands">
  1417. <summary>
  1418. An OR combination of the bands that the device supports. Can be one of: \ref AIRPCAP_BAND_2GHZ,
  1419. \ref AIRPCAP_BAND_5GHZ.
  1420. </summary>
  1421. </member>
  1422. <member name="T:SharpPcap.AirPcap.AirPcapUnmanagedStructures.AirpcapKey">
  1423. <summary>
  1424. WEB key container
  1425. </summary>
  1426. </member>
  1427. <member name="F:SharpPcap.AirPcap.AirPcapUnmanagedStructures.AirpcapKey.KeyType">
  1428. <summary>
  1429. Type of key, can be on of: \ref AIRPCAP_KEYTYPE_WEP, \ref AIRPCAP_KEYTYPE_TKIP, \ref AIRPCAP_KEYTYPE_CCMP. Only AIRPCAP_KEYTYPE_WEP is supported by the driver at the moment.
  1430. </summary>
  1431. </member>
  1432. <member name="F:SharpPcap.AirPcap.AirPcapUnmanagedStructures.AirpcapKey.KeyLen">
  1433. <summary>
  1434. Length of the key in bytes
  1435. </summary>
  1436. </member>
  1437. <member name="F:SharpPcap.AirPcap.AirPcapUnmanagedStructures.AirpcapKey.KeyData">
  1438. <summary>
  1439. Key data
  1440. </summary>
  1441. </member>
  1442. <member name="T:SharpPcap.AirPcap.AirPcapUnmanagedStructures.AirpcapChannelBand">
  1443. <summary>
  1444. frequency Band.
  1445. 802.11 adapters can support different frequency bands, the most important of which are: 2.4GHz (802.11b/g/n)
  1446. and 5GHz (802.11a/n).
  1447. </summary>
  1448. </member>
  1449. <member name="F:SharpPcap.AirPcap.AirPcapUnmanagedStructures.AirpcapChannelBand.AIRPCAP_CB_AUTO">
  1450. <summary>Automatically pick the best frequency band</summary>
  1451. </member>
  1452. <member name="F:SharpPcap.AirPcap.AirPcapUnmanagedStructures.AirpcapChannelBand.AIRPCAP_CB_2_4_GHZ">
  1453. <summary>2.4 GHz frequency band</summary>
  1454. </member>
  1455. <member name="F:SharpPcap.AirPcap.AirPcapUnmanagedStructures.AirpcapChannelBand.AIRPCAP_CB_4_GHZ">
  1456. <summary>4 GHz frequency band</summary>
  1457. </member>
  1458. <member name="F:SharpPcap.AirPcap.AirPcapUnmanagedStructures.AirpcapChannelBand.AIRPCAP_CB_5_GHZ">
  1459. <summary>5 GHz frequency band</summary>
  1460. </member>
  1461. <member name="T:SharpPcap.AirPcap.AirPcapUnmanagedStructures.AirpcapDeviceDescription">
  1462. <summary>
  1463. Entry in the list returned by \ref AirpcapGetDeviceList().
  1464. </summary>
  1465. </member>
  1466. <member name="F:SharpPcap.AirPcap.AirPcapUnmanagedStructures.AirpcapDeviceDescription.next">
  1467. <summary>
  1468. Next element in the list
  1469. struct _AirpcapDeviceDescription*
  1470. </summary>
  1471. </member>
  1472. <member name="F:SharpPcap.AirPcap.AirPcapUnmanagedStructures.AirpcapDeviceDescription.Name">
  1473. <summary>
  1474. Device name
  1475. PCHAR
  1476. </summary>
  1477. </member>
  1478. <member name="F:SharpPcap.AirPcap.AirPcapUnmanagedStructures.AirpcapDeviceDescription.Description">
  1479. <summary>
  1480. Device description
  1481. PCHAR
  1482. </summary>
  1483. </member>
  1484. <member name="F:SharpPcap.AirPcap.AirPcapUnmanagedStructures.AirpcapKeysCollection.nKeys">
  1485. <summary>
  1486. Number of keys in the collection
  1487. </summary>
  1488. </member>
  1489. <member name="T:SharpPcap.AirPcap.AirPcapUnmanagedStructures.AirpcapBpfHeader">
  1490. <summary>
  1491. Packet header
  1492. This structure defines the BPF that preceeds every packet delivered to the application
  1493. </summary>
  1494. </member>
  1495. <member name="F:SharpPcap.AirPcap.AirPcapUnmanagedStructures.AirpcapBpfHeader.TsSec">
  1496. <summary>
  1497. Timestamp associated with the captured packet. SECONDS.
  1498. UINT
  1499. </summary>
  1500. </member>
  1501. <member name="F:SharpPcap.AirPcap.AirPcapUnmanagedStructures.AirpcapBpfHeader.TsUsec">
  1502. <summary>
  1503. Timestamp associated with the captured packet. MICROSECONDS.
  1504. UINT
  1505. </summary>
  1506. </member>
  1507. <member name="F:SharpPcap.AirPcap.AirPcapUnmanagedStructures.AirpcapBpfHeader.Caplen">
  1508. <summary>
  1509. Length of captured portion. The captured portion <b>can be different</b> from the original packet, because it is possible (with a proper filter) to instruct the driver to capture only a portion of the packets.
  1510. </summary>
  1511. </member>
  1512. <member name="F:SharpPcap.AirPcap.AirPcapUnmanagedStructures.AirpcapBpfHeader.Originallen">
  1513. <summary>
  1514. Original length of packet
  1515. UINT
  1516. </summary>
  1517. </member>
  1518. <member name="F:SharpPcap.AirPcap.AirPcapUnmanagedStructures.AirpcapBpfHeader.Hdrlen">
  1519. <summary>
  1520. Length of bpf header (this struct plus alignment padding). In some cases, a padding could be added between the end of this structure and the packet data for performance reasons. This field can be used to retrieve the actual data of the packet.
  1521. USHORT
  1522. </summary>
  1523. </member>
  1524. <member name="T:SharpPcap.AirPcap.AirPcapUnmanagedStructures.AirpcapDeviceTimestamp">
  1525. <summary>
  1526. Structure used to read the free running counter on a device
  1527. This structure contains the current value of the counter used by the device to timestamp packets (when the hardware supports hardware timestamps).
  1528. This structure also contains the value of the software counter (used to timestamp packets in software), before and after the hardware counter is read
  1529. on the device.
  1530. </summary>
  1531. </member>
  1532. <member name="F:SharpPcap.AirPcap.AirPcapUnmanagedStructures.AirpcapDeviceTimestamp.DeviceTimestamp">
  1533. <summary>Current value of the device counter, in microseconds.</summary>
  1534. </member>
  1535. <member name="F:SharpPcap.AirPcap.AirPcapUnmanagedStructures.AirpcapDeviceTimestamp.SoftwareTimestampBefore">
  1536. <summary>Value of the software counter used to timestamp packets before reading the device counter, in microseconds.</summary>
  1537. </member>
  1538. <member name="F:SharpPcap.AirPcap.AirPcapUnmanagedStructures.AirpcapDeviceTimestamp.SoftwareTimestampAfter">
  1539. <summary>Value of the software counter used to timestamp packets after reading the device counter, in microseconds.</summary>
  1540. </member>
  1541. <member name="T:SharpPcap.AirPcap.AirPcapValidationType">
  1542. <summary>
  1543. Type of frame validation the adapter performs.
  1544. An adapter can be instructed to accept different kind of frames: correct frames only, frames with wrong Frame Check Sequence (FCS) only, all frames.
  1545. </summary>
  1546. </member>
  1547. <member name="F:SharpPcap.AirPcap.AirPcapValidationType.ACCEPT_EVERYTHING">
  1548. <summary>Accept all the frames the device captures</summary>
  1549. </member>
  1550. <member name="F:SharpPcap.AirPcap.AirPcapValidationType.ACCEPT_CORRECT_FRAMES">
  1551. <summary>Accept correct frames only, i.e. frames with correct Frame Check Sequence (FCS).</summary>
  1552. </member>
  1553. <member name="F:SharpPcap.AirPcap.AirPcapValidationType.ACCEPT_CORRUPT_FRAMES">
  1554. <summary>Accept corrupt frames only, i.e. frames with worng Frame Check Sequence (FCS).</summary>
  1555. </member>
  1556. <member name="F:SharpPcap.AirPcap.AirPcapValidationType.UNKNOWN">
  1557. <summary>Unknown validation type. You should see it only in case of error.</summary>
  1558. </member>
  1559. <member name="T:SharpPcap.AirPcap.AirPcapVersion">
  1560. <summary>
  1561. Version
  1562. </summary>
  1563. </member>
  1564. <member name="M:SharpPcap.AirPcap.AirPcapVersion.Version(System.UInt32@,System.UInt32@,System.UInt32@,System.UInt32@)">
  1565. <summary>
  1566. Returns the version in separate fields
  1567. </summary>
  1568. <param name="Major">
  1569. </param>
  1570. <param name="Minor">
  1571. </param>
  1572. <param name="Rev">
  1573. </param>
  1574. <param name="Build">
  1575. </param>
  1576. <returns>
  1577. </returns>
  1578. </member>
  1579. <member name="M:SharpPcap.AirPcap.AirPcapVersion.VersionString">
  1580. <summary>
  1581. Returns the version in a.b.c.d format
  1582. </summary>
  1583. <returns>
  1584. </returns>
  1585. </member>
  1586. <member name="T:SharpPcap.CaptureDeviceList">
  1587. <summary>
  1588. List of available capture devices
  1589. </summary>
  1590. </member>
  1591. <member name="M:SharpPcap.CaptureDeviceList.#ctor">
  1592. <summary>
  1593. Represents a strongly typed, read-only list of PcapDevices.
  1594. </summary>
  1595. </member>
  1596. <member name="P:SharpPcap.CaptureDeviceList.Item(System.String)">
  1597. <param name="Name">The name or description of the pcap interface to get.</param>
  1598. </member>
  1599. <member name="P:SharpPcap.CaptureDeviceList.Instance">
  1600. <summary>
  1601. Method to retrieve this classes singleton instance
  1602. </summary>
  1603. </member>
  1604. <member name="M:SharpPcap.CaptureDeviceList.New">
  1605. <summary>
  1606. Caution: Use the singlton instance unless you know why you need to call this.
  1607. One use is for multiple filters on the same physical device. To apply multiple
  1608. filters open the same physical device multiple times, one for each
  1609. filter by calling this routine and picking the same device out of each list.
  1610. </summary>
  1611. <returns>
  1612. A <see cref="T:SharpPcap.CaptureDeviceList" /></returns>
  1613. </member>
  1614. <member name="M:SharpPcap.CaptureDeviceList.GetDevices">
  1615. <summary>
  1616. Retrieve a list of the current devices
  1617. </summary>
  1618. <returns>
  1619. A <see cref="!:List&lt;ICaptureDevice&gt;" /></returns>
  1620. </member>
  1621. <member name="M:SharpPcap.CaptureDeviceList.Refresh">
  1622. <summary>
  1623. Refresh the device list
  1624. </summary>
  1625. </member>
  1626. <member name="T:SharpPcap.PcapException">
  1627. <summary>
  1628. General Pcap Exception.
  1629. </summary>
  1630. </member>
  1631. <member name="T:SharpPcap.LibPcap.PcapHeader">
  1632. <summary>
  1633. A wrapper for libpcap's pcap_pkthdr structure
  1634. </summary>
  1635. </member>
  1636. <member name="M:SharpPcap.LibPcap.PcapHeader.#ctor(System.IntPtr)">
  1637. <summary>
  1638. A wrapper class for libpcap's pcap_pkthdr structure
  1639. </summary>
  1640. </member>
  1641. <member name="M:SharpPcap.LibPcap.PcapHeader.#ctor(System.UInt32,System.UInt32,System.UInt32,System.UInt32)">
  1642. <summary>
  1643. Constructs a new PcapHeader
  1644. </summary>
  1645. <param name="seconds">The seconds value of the packet's timestamp</param>
  1646. <param name="microseconds">The microseconds value of the packet's timestamp</param>
  1647. <param name="packetLength">The actual length of the packet</param>
  1648. <param name="captureLength">The length of the capture</param>
  1649. </member>
  1650. <member name="F:SharpPcap.LibPcap.PcapHeader.epochTicks">
  1651. <summary>
  1652. DateTime(1970, 1, 1).Ticks, saves cpu cycles in the Date property
  1653. </summary>
  1654. </member>
  1655. <member name="F:SharpPcap.LibPcap.PcapHeader.Seconds">
  1656. <summary>
  1657. The seconds value of the packet's timestamp
  1658. </summary>
  1659. </member>
  1660. <member name="F:SharpPcap.LibPcap.PcapHeader.MicroSeconds">
  1661. <summary>
  1662. The microseconds value of the packet's timestamp
  1663. </summary>
  1664. </member>
  1665. <member name="F:SharpPcap.LibPcap.PcapHeader.PacketLength">
  1666. <summary>
  1667. The length of the packet on the line
  1668. </summary>
  1669. </member>
  1670. <member name="F:SharpPcap.LibPcap.PcapHeader.CaptureLength">
  1671. <summary>
  1672. The the bytes actually captured. If the capture length
  1673. is small CaptureLength might be less than PacketLength
  1674. </summary>
  1675. </member>
  1676. <member name="P:SharpPcap.LibPcap.PcapHeader.Date">
  1677. <summary>
  1678. Return the DateTime value of this pcap header
  1679. </summary>
  1680. </member>
  1681. <member name="M:SharpPcap.LibPcap.PcapHeader.FromPointer(System.IntPtr)">
  1682. <summary>
  1683. Get a PcapHeader structure from a pcap_pkthdr pointer.
  1684. </summary>
  1685. </member>
  1686. <member name="M:SharpPcap.LibPcap.PcapHeader.MarshalToIntPtr">
  1687. <summary>
  1688. Marshal this structure into the platform dependent version and return
  1689. and IntPtr to that memory
  1690. NOTE: IntPtr MUST BE FREED via Marshal.FreeHGlobal()
  1691. </summary>
  1692. <returns>
  1693. A <see cref="T:System.IntPtr" /></returns>
  1694. </member>
  1695. <member name="T:SharpPcap.Pcap">
  1696. <summary>
  1697. Constants and static helper methods
  1698. </summary>
  1699. </member>
  1700. <member name="F:SharpPcap.Pcap.InfinitePacketCount">
  1701. <summary>Represents the infinite number for packet captures </summary>
  1702. </member>
  1703. <member name="P:SharpPcap.Pcap.Version">
  1704. <summary>
  1705. Returns the pcap version string retrieved via a call to pcap_lib_version()
  1706. </summary>
  1707. </member>
  1708. <member name="T:SharpPcap.Version">
  1709. <summary>
  1710. Helper class/method to retrieve the version of the SharpPcap assembly
  1711. </summary>
  1712. </member>
  1713. <member name="P:SharpPcap.Version.VersionString">
  1714. <summary>
  1715. Returns the current version string of the SharpPcap library
  1716. </summary>
  1717. <returns>the current version string of the SharpPcap library</returns>
  1718. </member>
  1719. <member name="T:SharpPcap.LibPcap.PcapUnmanagedStructures.pcap_if">
  1720. <summary>
  1721. Item in a list of interfaces.
  1722. </summary>
  1723. </member>
  1724. <member name="T:SharpPcap.LibPcap.PcapUnmanagedStructures.pcap_addr">
  1725. <summary>
  1726. Representation of an interface address.
  1727. </summary>
  1728. </member>
  1729. <member name="T:SharpPcap.LibPcap.PcapUnmanagedStructures.sockaddr">
  1730. <summary>
  1731. Structure used by kernel to store a generic address
  1732. Look at the sa_family value to determine which specific structure to use
  1733. 'struct sockaddr'
  1734. </summary>
  1735. </member>
  1736. <member name="T:SharpPcap.LibPcap.PcapUnmanagedStructures.in_addr">
  1737. <summary>
  1738. Structure that holds an ipv4 address
  1739. </summary>
  1740. </member>
  1741. <member name="T:SharpPcap.LibPcap.PcapUnmanagedStructures.sockaddr_in">
  1742. <summary>
  1743. Structure that holds an ipv4 address
  1744. 'struct sockaddr'
  1745. </summary>
  1746. </member>
  1747. <member name="T:SharpPcap.LibPcap.PcapUnmanagedStructures.sockaddr_in6">
  1748. <summary>
  1749. Structure that holds an ipv6 address
  1750. NOTE: we cast the 'struct sockaddr*' to this structure based on the sa_family type
  1751. 'struct sockaddr_in6'
  1752. </summary>
  1753. </member>
  1754. <member name="T:SharpPcap.LibPcap.PcapUnmanagedStructures.sockaddr_ll">
  1755. <summary>
  1756. Structure to represent a low level address, like a hardware address
  1757. </summary>
  1758. </member>
  1759. <member name="T:SharpPcap.LibPcap.PcapUnmanagedStructures.timeval_unix">
  1760. <summary>
  1761. Windows and Unix differ in their memory models and make it difficult to
  1762. support struct timeval in a single library, like this one, across
  1763. multiple platforms.
  1764. See http://en.wikipedia.org/wiki/64bit#Specific_data_models
  1765. The issue is that struct timeval { long tv_sec; long tv_usec; }
  1766. has different sizes on Linux 32 and 64bit but the same size on
  1767. Windows 32 and 64 bit
  1768. Thanks to Jon Pryor for his help in figuring out both the issue with Linux
  1769. 32/64bit and the issue between Windows and Unix
  1770. </summary>
  1771. </member>
  1772. <member name="T:SharpPcap.LibPcap.PcapUnmanagedStructures.timeval_windows">
  1773. <summary>
  1774. Windows version of struct timeval, the longs are 32bit even on 64-bit versions of Windows
  1775. </summary>
  1776. </member>
  1777. <member name="T:SharpPcap.LibPcap.PcapUnmanagedStructures.pcap_pkthdr_unix">
  1778. <summary>
  1779. Each packet in the dump file is prepended with this generic header.
  1780. This gets around the problem of different headers for different
  1781. packet interfaces.
  1782. </summary>
  1783. </member>
  1784. <member name="T:SharpPcap.LibPcap.PcapUnmanagedStructures.pcap_pkthdr_windows">
  1785. <summary>
  1786. Each packet in the dump file is prepended with this generic header.
  1787. This gets around the problem of different headers for different
  1788. packet interfaces.
  1789. </summary>
  1790. </member>
  1791. <member name="T:SharpPcap.LibPcap.PcapUnmanagedStructures.PCAP_PKTDATA">
  1792. <summary>
  1793. Packet data bytes
  1794. NOTE: This struct doesn't exist in header files, it is a construct to map to an
  1795. unmanaged byte array
  1796. </summary>
  1797. </member>
  1798. <member name="T:SharpPcap.LibPcap.PcapUnmanagedStructures.bpf_program">
  1799. <summary>
  1800. A BPF pseudo-assembly program for packet filtering
  1801. </summary>
  1802. </member>
  1803. <member name="T:SharpPcap.LibPcap.PcapUnmanagedStructures.pcap_send_queue">
  1804. <summary>
  1805. A queue of raw packets that will be sent to the network with pcap_sendqueue_transmit()
  1806. </summary>
  1807. </member>
  1808. <member name="T:SharpPcap.LibPcap.PcapUnmanagedStructures.PcapStatReturnValue">
  1809. <summary>
  1810. Define the return values from int pcap_stats()
  1811. </summary>
  1812. </member>
  1813. <member name="T:SharpPcap.LibPcap.PcapUnmanagedStructures.pcap_stat_unix">
  1814. <summary>
  1815. Unix version of 'struct pcap_stat'
  1816. Uses the same trick as timeval_unix
  1817. </summary>
  1818. </member>
  1819. <member name="F:SharpPcap.LibPcap.PcapUnmanagedStructures.pcap_stat_unix.ps_recv">
  1820. <summary>
  1821. Packets received
  1822. </summary>
  1823. </member>
  1824. <member name="F:SharpPcap.LibPcap.PcapUnmanagedStructures.pcap_stat_unix.ps_drop">
  1825. <summary>
  1826. Packets dropped
  1827. </summary>
  1828. </member>
  1829. <member name="F:SharpPcap.LibPcap.PcapUnmanagedStructures.pcap_stat_unix.ps_ifdrop">
  1830. <summary>
  1831. Drops by interface (maybe not yet supported)
  1832. </summary>
  1833. </member>
  1834. <member name="T:SharpPcap.LibPcap.PcapUnmanagedStructures.pcap_stat_windows">
  1835. <summary>
  1836. Windows version of 'struct pcap_stat'
  1837. </summary>
  1838. </member>
  1839. <member name="F:SharpPcap.LibPcap.PcapUnmanagedStructures.pcap_stat_windows.ps_recv">
  1840. <summary>
  1841. Packets received
  1842. </summary>
  1843. </member>
  1844. <member name="F:SharpPcap.LibPcap.PcapUnmanagedStructures.pcap_stat_windows.ps_drop">
  1845. <summary>
  1846. Packets dropped
  1847. </summary>
  1848. </member>
  1849. <member name="F:SharpPcap.LibPcap.PcapUnmanagedStructures.pcap_stat_windows.ps_ifdrop">
  1850. <summary>
  1851. Drops by interface (maybe not yet supported)
  1852. </summary>
  1853. </member>
  1854. <member name="F:SharpPcap.LibPcap.PcapUnmanagedStructures.pcap_stat_windows.bs_capt">
  1855. <summary>
  1856. Packets that reach the application
  1857. WIN32 only, based on struct pcap_stat in pcap.h
  1858. </summary>
  1859. </member>
  1860. <member name="T:SharpPcap.LibPcap.LibPcapSafeNativeMethods">
  1861. <summary>
  1862. Per http://msdn.microsoft.com/en-us/ms182161.aspx
  1863. </summary>
  1864. </member>
  1865. <member name="T:SharpPcap.LibPcap.LibPcapSafeNativeMethods.pcap_handler">
  1866. <summary>
  1867. The delegate declaration for PcapHandler requires an UnmanagedFunctionPointer attribute.
  1868. Without this it fires for one time and then throws null pointer exception
  1869. </summary>
  1870. </member>
  1871. <member name="M:SharpPcap.LibPcap.LibPcapSafeNativeMethods.pcap_dump_open(System.IntPtr,System.String)">
  1872. <summary>Open a file to write packets. </summary>
  1873. </member>
  1874. <member name="M:SharpPcap.LibPcap.LibPcapSafeNativeMethods.pcap_dump(System.IntPtr,System.IntPtr,System.IntPtr)">
  1875. <summary>
  1876. Save a packet to disk.
  1877. </summary>
  1878. </member>
  1879. <member name="M:SharpPcap.LibPcap.LibPcapSafeNativeMethods.pcap_close(System.IntPtr)">
  1880. <summary> close the files associated with p and deallocates resources.</summary>
  1881. </member>
  1882. <member name="M:SharpPcap.LibPcap.LibPcapSafeNativeMethods.pcap_next_ex(System.IntPtr,System.IntPtr@,System.IntPtr@)">
  1883. <summary>
  1884. To avoid callback, this returns one packet at a time
  1885. </summary>
  1886. </member>
  1887. <member name="M:SharpPcap.LibPcap.LibPcapSafeNativeMethods.pcap_sendpacket(System.IntPtr,System.IntPtr,System.Int32)">
  1888. <summary>
  1889. Send a raw packet.<br />
  1890. This function allows to send a raw packet to the network.
  1891. The MAC CRC doesn't need to be included, because it is transparently calculated
  1892. and added by the network interface driver.
  1893. </summary>
  1894. <param name="adaptHandle">the interface that will be used to send the packet</param>
  1895. <param name="data">contains the data of the packet to send (including the various protocol headers)</param>
  1896. <param name="size">the dimension of the buffer pointed by data</param>
  1897. <returns>0 if the packet is succesfully sent, -1 otherwise.</returns>
  1898. </member>
  1899. <member name="M:SharpPcap.LibPcap.LibPcapSafeNativeMethods.pcap_compile(System.IntPtr,System.IntPtr,System.String,System.Int32,System.UInt32)">
  1900. <summary>
  1901. Compile a packet filter, converting an high level filtering expression (see Filtering expression syntax) in a program that can be interpreted by the kernel-level filtering engine.
  1902. </summary>
  1903. </member>
  1904. <member name="M:SharpPcap.LibPcap.LibPcapSafeNativeMethods.pcap_freecode(System.IntPtr)">
  1905. <summary>
  1906. Free up allocated memory pointed to by a bpf_program struct generated by pcap_compile()
  1907. </summary>
  1908. </member>
  1909. <member name="M:SharpPcap.LibPcap.LibPcapSafeNativeMethods.pcap_geterr(System.IntPtr)">
  1910. <summary>
  1911. return the error text pertaining to the last pcap library error.
  1912. </summary>
  1913. </member>
  1914. <member name="M:SharpPcap.LibPcap.LibPcapSafeNativeMethods.pcap_lib_version">
  1915. <summary>Returns a pointer to a string giving information about the version of the libpcap library being used; note that it contains more information than just a version number. </summary>
  1916. </member>
  1917. <member name="M:SharpPcap.LibPcap.LibPcapSafeNativeMethods.pcap_dump_file(System.IntPtr)">
  1918. <summary>return the standard I/O stream of the 'savefile' opened by pcap_dump_open().</summary>
  1919. </member>
  1920. <member name="M:SharpPcap.LibPcap.LibPcapSafeNativeMethods.pcap_dump_flush(System.IntPtr)">
  1921. <summary>Flushes the output buffer to the 'savefile', so that any packets
  1922. written with pcap_dump() but not yet written to the 'savefile' will be written.
  1923. -1 is returned on error, 0 on success. </summary>
  1924. </member>
  1925. <member name="M:SharpPcap.LibPcap.LibPcapSafeNativeMethods.pcap_dump_close(System.IntPtr)">
  1926. <summary>Closes a savefile. </summary>
  1927. </member>
  1928. <member name="M:SharpPcap.LibPcap.LibPcapSafeNativeMethods.pcap_datalink(System.IntPtr)">
  1929. <summary> Return the link layer of an adapter. </summary>
  1930. </member>
  1931. <member name="M:SharpPcap.LibPcap.LibPcapSafeNativeMethods.pcap_setnonblock(System.IntPtr,System.Int32,System.Text.StringBuilder)">
  1932. <summary>
  1933. Set nonblocking mode. pcap_loop() and pcap_next() doesnt work in nonblocking mode!
  1934. </summary>
  1935. </member>
  1936. <member name="M:SharpPcap.LibPcap.LibPcapSafeNativeMethods.pcap_getnonblock(System.IntPtr,System.Text.StringBuilder)">
  1937. <summary>
  1938. Get nonblocking mode, returns allways 0 for savefiles.
  1939. </summary>
  1940. </member>
  1941. <member name="M:SharpPcap.LibPcap.LibPcapSafeNativeMethods.pcap_dispatch(System.IntPtr,System.Int32,SharpPcap.LibPcap.LibPcapSafeNativeMethods.pcap_handler,System.IntPtr)">
  1942. <summary>
  1943. Read packets until cnt packets are processed or an error occurs.
  1944. </summary>
  1945. </member>
  1946. <member name="M:SharpPcap.LibPcap.LibPcapSafeNativeMethods.pcap_get_selectable_fd(System.IntPtr)">
  1947. <summary>
  1948. Retrieves a selectable file descriptor
  1949. </summary>
  1950. <param name="adaptHandle">
  1951. A <see cref="T:System.IntPtr" /></param>
  1952. <returns>
  1953. A <see cref="T:System.Int32" /></returns>
  1954. </member>
  1955. <member name="M:SharpPcap.LibPcap.LibPcapSafeNativeMethods.pcap_stats(System.IntPtr,System.IntPtr)">
  1956. <summary>
  1957. Fills in the pcap_stat structure passed to the function
  1958. based on the pcap_t adapter
  1959. </summary>
  1960. <param name="adapter">
  1961. A <see cref="T:System.IntPtr" /></param>
  1962. <param name="stat">
  1963. A <see cref="T:System.IntPtr" /></param>
  1964. <returns>
  1965. A <see cref="T:System.Int32" /></returns>
  1966. </member>
  1967. <member name="M:SharpPcap.LibPcap.LibPcapSafeNativeMethods.pcap_snapshot(System.IntPtr)">
  1968. <summary>
  1969. Returns the snapshot length
  1970. </summary>
  1971. <param name="adapter">
  1972. A <see cref="T:System.IntPtr" /></param>
  1973. <returns>
  1974. A <see cref="T:System.Int32" /></returns>
  1975. </member>
  1976. <member name="M:SharpPcap.LibPcap.LibPcapSafeNativeMethods.pcap_fileno(System.IntPtr)">
  1977. <summary>
  1978. Returns the file descriptor number from which captured packets are read,
  1979. if a network device was opened with pcap_create() and pcap_activate() or
  1980. with pcap_open_live(), or -1, if a ``savefile'' was opened with
  1981. pcap_open_offline()
  1982. Libpcap specific method
  1983. </summary>
  1984. <param name="adapter">
  1985. A <see cref="T:System.IntPtr" /></param>
  1986. <returns>
  1987. A <see cref="T:System.Int32" /></returns>
  1988. </member>
  1989. <member name="T:SharpPcap.LibPcap.PcapDevice">
  1990. <summary>
  1991. Base class for all pcap devices
  1992. </summary>
  1993. </member>
  1994. <member name="F:SharpPcap.LibPcap.PcapDevice.captureThread">
  1995. <summary>
  1996. Thread that is performing the background packet capture
  1997. </summary>
  1998. </member>
  1999. <member name="F:SharpPcap.LibPcap.PcapDevice.shouldCaptureThreadStop">
  2000. <summary>
  2001. Flag that indicates that a capture thread should stop
  2002. </summary>
  2003. </member>
  2004. <member name="F:SharpPcap.LibPcap.PcapDevice.MonoUnixFound">
  2005. <summary>
  2006. If Environment.OSVersion.Platform is unix and MonoUnixFound is true
  2007. then we can support proper termination of the capture loop
  2008. </summary>
  2009. <returns>
  2010. A <see cref="T:System.Boolean" /></returns>
  2011. </member>
  2012. <member name="F:SharpPcap.LibPcap.PcapDevice.m_pcapIf">
  2013. <summary>
  2014. Low level interface object that contains device specific information
  2015. </summary>
  2016. </member>
  2017. <member name="F:SharpPcap.LibPcap.PcapDevice.m_pcapAdapterHandle">
  2018. <summary>
  2019. Handle to a pcap adapter, not equal to IntPtr.Zero if an adapter is open
  2020. </summary>
  2021. </member>
  2022. <member name="F:SharpPcap.LibPcap.PcapDevice.m_pcapPacketCount">
  2023. <summary>
  2024. Number of packets that this adapter should capture
  2025. </summary>
  2026. </member>
  2027. <member name="F:SharpPcap.LibPcap.PcapDevice.isOpen">
  2028. <summary>
  2029. Cached open and linkType variables, avoids a unsafe pointer comparison
  2030. and a pinvoke call for each packet retrieved as MarshalRawPacket
  2031. retrieves the LinkType
  2032. </summary>
  2033. </member>
  2034. <member name="E:SharpPcap.LibPcap.PcapDevice.OnPacketArrival">
  2035. <summary>
  2036. Fires whenever a new packet is processed, either when the packet arrives
  2037. from the network device or when the packet is read from the on-disk file.<br />
  2038. For network captured packets this event is invoked only when working in "PcapMode.Capture" mode.
  2039. </summary>
  2040. </member>
  2041. <member name="E:SharpPcap.LibPcap.PcapDevice.OnCaptureStopped">
  2042. <summary>
  2043. Fired when the capture process of this pcap device is stopped
  2044. </summary>
  2045. </member>
  2046. <member name="P:SharpPcap.LibPcap.PcapDevice.Started">
  2047. <summary>
  2048. Return a value indicating if the capturing process of this adapter is started
  2049. </summary>
  2050. </member>
  2051. <member name="P:SharpPcap.LibPcap.PcapDevice.StopCaptureTimeout">
  2052. <summary>
  2053. Maximum time within which the capture thread must join the main thread (on
  2054. <see cref="M:SharpPcap.LibPcap.PcapDevice.StopCapture" />) or else the thread is aborted and an exception thrown.
  2055. </summary>
  2056. </member>
  2057. <member name="P:SharpPcap.LibPcap.PcapDevice.Name">
  2058. <summary>
  2059. Device name
  2060. </summary>
  2061. </member>
  2062. <member name="P:SharpPcap.LibPcap.PcapDevice.Description">
  2063. <summary>
  2064. Description
  2065. </summary>
  2066. </member>
  2067. <member name="P:SharpPcap.LibPcap.PcapDevice.IsOnPacketArrivalNull">
  2068. <summary>
  2069. Implemented because there isn't any way to perform
  2070. if(OnPacketArrival == null) isn't permitted outside of the containing class
  2071. this operation results in a CS0070 compile error
  2072. </summary>
  2073. <returns>
  2074. A <see cref="T:System.Boolean" /></returns>
  2075. </member>
  2076. <member name="P:SharpPcap.LibPcap.PcapDevice.Interface">
  2077. <value>
  2078. Low level pcap device values
  2079. </value>
  2080. </member>
  2081. <member name="P:SharpPcap.LibPcap.PcapDevice.Opened">
  2082. <summary>
  2083. Return a value indicating if this adapter is opened
  2084. </summary>
  2085. </member>
  2086. <member name="P:SharpPcap.LibPcap.PcapDevice.PcapHandle">
  2087. <summary>
  2088. The underlying pcap device handle
  2089. </summary>
  2090. </member>
  2091. <member name="P:SharpPcap.LibPcap.PcapDevice.LastError">
  2092. <summary>
  2093. The last pcap error associated with this pcap device
  2094. </summary>
  2095. </member>
  2096. <member name="P:SharpPcap.LibPcap.PcapDevice.LinkType">
  2097. <summary>
  2098. Link type in terms of PacketDotNet.LinkLayers
  2099. </summary>
  2100. </member>
  2101. <member name="P:SharpPcap.LibPcap.PcapDevice.Statistics">
  2102. <summary>
  2103. Retrieves pcap statistics
  2104. </summary>
  2105. <returns>
  2106. A <see cref="T:SharpPcap.LibPcap.PcapStatistics" /></returns>
  2107. </member>
  2108. <member name="P:SharpPcap.LibPcap.PcapDevice.MacAddress">
  2109. <summary>
  2110. Mac address of the physical device
  2111. </summary>
  2112. </member>
  2113. <member name="P:SharpPcap.LibPcap.PcapDevice.Filter">
  2114. <summary>
  2115. Kernel level filtering expression associated with this device.
  2116. For more info on filter expression syntax, see:
  2117. http://www.winpcap.org/docs/docs31/html/group__language.html
  2118. </summary>
  2119. </member>
  2120. <member name="M:SharpPcap.LibPcap.PcapDevice.UnixSetupMonoUnixNative">
  2121. <summary>
  2122. Setup the reflection type and methodinfo for invocation of
  2123. Mono.Unix.Native.Syscall.poll() to avoid timeouts when
  2124. stopping the capture thread
  2125. </summary>
  2126. </member>
  2127. <member name="M:SharpPcap.LibPcap.PcapDevice.StartCapture">
  2128. <summary>
  2129. Starts the capturing process via a background thread
  2130. OnPacketArrival() will be called for each captured packet
  2131. </summary>
  2132. </member>
  2133. <member name="M:SharpPcap.LibPcap.PcapDevice.StopCapture">
  2134. <summary>
  2135. Stops the capture process
  2136. Throws an exception if the stop capture timeout is exceeded and the
  2137. capture thread was aborted
  2138. </summary>
  2139. </member>
  2140. <member name="M:SharpPcap.LibPcap.PcapDevice.Capture">
  2141. <summary>
  2142. Synchronously capture packets on this device. Method blocks forever.
  2143. </summary>
  2144. </member>
  2145. <member name="M:SharpPcap.LibPcap.PcapDevice.Capture(System.Int32)">
  2146. <summary>
  2147. Synchronously captures packets on this network device. This method will block
  2148. until capturing is finished.
  2149. </summary>
  2150. <param name="packetCount">The number of packets to be captured.
  2151. -1 means capture indefiniately</param>
  2152. </member>
  2153. <member name="M:SharpPcap.LibPcap.PcapDevice.CaptureThread">
  2154. <summary>
  2155. The capture thread
  2156. </summary>
  2157. </member>
  2158. <member name="M:SharpPcap.LibPcap.PcapDevice.GetLastError(System.IntPtr)">
  2159. <summary>
  2160. Retrieve the last error string for a given pcap_t* device
  2161. </summary>
  2162. <param name="deviceHandle">
  2163. A <see cref="T:System.IntPtr" /></param>
  2164. <returns>
  2165. A <see cref="T:System.String" /></returns>
  2166. </member>
  2167. <member name="M:SharpPcap.LibPcap.PcapDevice.Open">
  2168. <summary>
  2169. Open the device with class specific options
  2170. </summary>
  2171. </member>
  2172. <member name="M:SharpPcap.LibPcap.PcapDevice.Open(SharpPcap.DeviceMode)">
  2173. <summary>
  2174. Open the device. To start capturing call the 'StartCapture' function
  2175. </summary>
  2176. <param name="mode">
  2177. A <see cref="T:SharpPcap.DeviceMode" /></param>
  2178. </member>
  2179. <member name="M:SharpPcap.LibPcap.PcapDevice.Open(SharpPcap.DeviceMode,System.Int32)">
  2180. <summary>
  2181. Open the device. To start capturing call the 'StartCapture' function
  2182. </summary>
  2183. <param name="mode">
  2184. A <see cref="T:SharpPcap.DeviceMode" /></param>
  2185. <param name="read_timeout">
  2186. A <see cref="T:System.Int32" /></param>
  2187. </member>
  2188. <member name="M:SharpPcap.LibPcap.PcapDevice.Close">
  2189. <summary>
  2190. Closes this adapter
  2191. </summary>
  2192. </member>
  2193. <member name="M:SharpPcap.LibPcap.PcapDevice.SendPacketArrivalEvent(SharpPcap.RawCapture)">
  2194. <summary>
  2195. Notify the OnPacketArrival delegates about a newly captured packet
  2196. </summary>
  2197. <param name="p">
  2198. A <see cref="T:SharpPcap.RawCapture" /></param>
  2199. </member>
  2200. <member name="M:SharpPcap.LibPcap.PcapDevice.SendCaptureStoppedEvent(SharpPcap.CaptureStoppedEventStatus)">
  2201. <summary>
  2202. Notify the delegates that are subscribed to the capture stopped event
  2203. </summary>
  2204. <param name="status">
  2205. A <see cref="T:SharpPcap.CaptureStoppedEventStatus" /></param>
  2206. </member>
  2207. <member name="M:SharpPcap.LibPcap.PcapDevice.GetNextPacket">
  2208. <summary>
  2209. Gets the next packet captured on this device
  2210. </summary>
  2211. <returns>The next packet captured on this device</returns>
  2212. </member>
  2213. <member name="M:SharpPcap.LibPcap.PcapDevice.GetNextPacket(SharpPcap.RawCapture@)">
  2214. <summary>
  2215. Gets the next packet captured on this device
  2216. </summary>
  2217. <param name="p">
  2218. A <see cref="T:SharpPcap.RawCapture" /></param>
  2219. <returns>
  2220. A <see cref="T:System.Int32" /> that contains the result code
  2221. </returns>
  2222. </member>
  2223. <member name="M:SharpPcap.LibPcap.PcapDevice.GetNextPacketPointers(System.IntPtr@,System.IntPtr@)">
  2224. <summary>
  2225. Gets pointers to the next PCAP header and packet data.
  2226. Data is only valid until next call to GetNextPacketNative.
  2227. Advanced use only. Intended to allow unmanaged code to avoid the overhead of
  2228. marshalling PcapHeader and packet contents to allocated memory.
  2229. </summary>
  2230. </member>
  2231. <member name="M:SharpPcap.LibPcap.PcapDevice.PacketHandler(System.IntPtr,System.IntPtr,System.IntPtr)">
  2232. <summary>
  2233. Pcap_loop callback method.
  2234. </summary>
  2235. </member>
  2236. <member name="M:SharpPcap.LibPcap.PcapDevice.MarshalRawPacket(System.IntPtr,System.IntPtr)">
  2237. <summary>
  2238. Convert an unmanaged packet into a managed PacketDotNet.RawPacket
  2239. </summary>
  2240. <param name="header">
  2241. A <see cref="T:System.IntPtr" /></param>
  2242. <param name="data">
  2243. A <see cref="T:System.IntPtr" /></param>
  2244. <returns>
  2245. A <see cref="T:SharpPcap.RawCapture" /></returns>
  2246. </member>
  2247. <member name="M:SharpPcap.LibPcap.PcapDevice.SetFilter(System.String)">
  2248. <summary>
  2249. Assign a filter to this device given a filterExpression
  2250. </summary>
  2251. <param name="filterExpression">The filter expression to compile</param>
  2252. </member>
  2253. <member name="M:SharpPcap.LibPcap.PcapDevice.CompileFilter(System.IntPtr,System.String,System.UInt32,System.IntPtr@,System.String@)">
  2254. or unmanaged memory will be leaked</member>
  2255. <member name="M:SharpPcap.LibPcap.PcapDevice.FreeBpfProgram(System.IntPtr)">
  2256. <summary>
  2257. Free memory allocated in CompileFilter()
  2258. </summary>
  2259. <param name="bpfProgram">
  2260. A <see cref="T:System.IntPtr" /></param>
  2261. </member>
  2262. <member name="M:SharpPcap.LibPcap.PcapDevice.CheckFilter(System.String,System.String@)">
  2263. <summary>
  2264. Returns true if the filter expression was able to be compiled into a
  2265. program without errors
  2266. </summary>
  2267. </member>
  2268. <member name="M:SharpPcap.LibPcap.PcapDevice.SendPacket(PacketDotNet.Packet)">
  2269. <summary>
  2270. Sends a raw packet throgh this device
  2271. </summary>
  2272. <param name="p">The packet to send</param>
  2273. </member>
  2274. <member name="M:SharpPcap.LibPcap.PcapDevice.SendPacket(PacketDotNet.Packet,System.Int32)">
  2275. <summary>
  2276. Sends a raw packet throgh this device
  2277. </summary>
  2278. <param name="p">The packet to send</param>
  2279. <param name="size">The number of bytes to send</param>
  2280. </member>
  2281. <member name="M:SharpPcap.LibPcap.PcapDevice.SendPacket(System.Byte[])">
  2282. <summary>
  2283. Sends a raw packet throgh this device
  2284. </summary>
  2285. <param name="p">The packet bytes to send</param>
  2286. </member>
  2287. <member name="M:SharpPcap.LibPcap.PcapDevice.SendPacket(System.Byte[],System.Int32)">
  2288. <summary>
  2289. Sends a raw packet throgh this device
  2290. </summary>
  2291. <param name="p">The packet bytes to send</param>
  2292. <param name="size">The number of bytes to send</param>
  2293. </member>
  2294. <member name="M:SharpPcap.LibPcap.PcapDevice.ThrowIfNotOpen(System.String)">
  2295. <summary>
  2296. Helper method for checking that the adapter is open, throws an
  2297. exception with a string of ExceptionString if the device isn't open
  2298. </summary>
  2299. <param name="ExceptionString">
  2300. A <see cref="T:System.String" /></param>
  2301. </member>
  2302. <member name="M:SharpPcap.LibPcap.PcapDevice.ToString">
  2303. <summary>
  2304. Override the default ToString() implementation
  2305. </summary>
  2306. <returns>
  2307. A <see cref="T:System.String" /></returns>
  2308. </member>
  2309. <member name="T:SharpPcap.LibPcap.PcapAddress">
  2310. <summary>
  2311. Managed representation of the unmanaged pcap_addr structure
  2312. </summary>
  2313. </member>
  2314. <member name="P:SharpPcap.LibPcap.PcapAddress.Addr">
  2315. <summary>
  2316. The address value of this PcapAddress, null if none is present
  2317. </summary>
  2318. </member>
  2319. <member name="P:SharpPcap.LibPcap.PcapAddress.Netmask">
  2320. <summary>
  2321. Netmask of this PcapAddress, null if none is present
  2322. </summary>
  2323. </member>
  2324. <member name="P:SharpPcap.LibPcap.PcapAddress.Broadaddr">
  2325. <summary>
  2326. Broadcast address of this PcapAddress, null if none is present
  2327. </summary>
  2328. </member>
  2329. <member name="P:SharpPcap.LibPcap.PcapAddress.Dstaddr">
  2330. <summary>
  2331. Destination address, null if the interface isn't a point-to-point interface
  2332. </summary>
  2333. </member>
  2334. <member name="M:SharpPcap.LibPcap.PcapAddress.ToString">
  2335. <summary>
  2336. ToString override
  2337. </summary>
  2338. <returns>
  2339. A <see cref="T:System.String" /></returns>
  2340. </member>
  2341. <member name="T:SharpPcap.LibPcap.Sockaddr">
  2342. <summary>
  2343. Container class that represents either an ip address or a mac address
  2344. An analog to the 'sockaddr_' series of structures
  2345. </summary>
  2346. </member>
  2347. <member name="M:SharpPcap.LibPcap.Sockaddr.#ctor(System.Net.NetworkInformation.PhysicalAddress)">
  2348. <summary>
  2349. Create a Sockaddr from a PhysicalAddress which is presumed to
  2350. be a hardware address
  2351. </summary>
  2352. <param name="hardwareAddress">
  2353. A <see cref="T:System.Net.NetworkInformation.PhysicalAddress" /></param>
  2354. </member>
  2355. <member name="T:SharpPcap.LibPcap.Sockaddr.AddressTypes">
  2356. <summary>
  2357. Types of addresses a Sockaddr can represent
  2358. </summary>
  2359. </member>
  2360. <member name="F:SharpPcap.LibPcap.Sockaddr.AddressTypes.AF_INET_AF_INET6">
  2361. <summary>
  2362. Address represents an ipv4 or ipv6 address
  2363. </summary>
  2364. </member>
  2365. <member name="F:SharpPcap.LibPcap.Sockaddr.AddressTypes.HARDWARE">
  2366. <summary>
  2367. Address represents a physical hardware address eg. a ethernet mac address
  2368. </summary>
  2369. </member>
  2370. <member name="F:SharpPcap.LibPcap.Sockaddr.AddressTypes.UNKNOWN">
  2371. <summary>
  2372. Unknown address type
  2373. </summary>
  2374. </member>
  2375. <member name="F:SharpPcap.LibPcap.Sockaddr.type">
  2376. <summary>
  2377. Address type represented by this Sockaddr
  2378. </summary>
  2379. </member>
  2380. <member name="F:SharpPcap.LibPcap.Sockaddr.ipAddress">
  2381. <summary>
  2382. If type == AF_INET_AF_INET6
  2383. </summary>
  2384. </member>
  2385. <member name="F:SharpPcap.LibPcap.Sockaddr.hardwareAddress">
  2386. <summary>
  2387. If type == HARDWARE
  2388. </summary>
  2389. </member>
  2390. <member name="P:SharpPcap.LibPcap.Sockaddr.sa_family">
  2391. <summary>
  2392. Address family
  2393. </summary>
  2394. </member>
  2395. <member name="M:SharpPcap.LibPcap.Sockaddr.ToString">
  2396. <summary>
  2397. ToString override
  2398. </summary>
  2399. <returns>
  2400. A <see cref="T:System.String" /></returns>
  2401. </member>
  2402. <member name="T:SharpPcap.LibPcap.PcapInterface">
  2403. <summary>
  2404. managed version of struct pcap_if
  2405. NOTE: we can't use pcap_if directly because the class contains
  2406. a pointer to pcap_if that will be freed when the
  2407. device memory is freed, so instead convert the unmanaged structure
  2408. to a managed one to avoid this issue
  2409. </summary>
  2410. </member>
  2411. <member name="P:SharpPcap.LibPcap.PcapInterface.Name">
  2412. <value>
  2413. Name of the interface. Used internally when passed to pcap_open_live()
  2414. </value>
  2415. </member>
  2416. <member name="P:SharpPcap.LibPcap.PcapInterface.FriendlyName">
  2417. <value>
  2418. Human readable interface name derived from System.Net.NetworkInformation.NetworkInterface.Name
  2419. </value>
  2420. </member>
  2421. <member name="P:SharpPcap.LibPcap.PcapInterface.Description">
  2422. <value>
  2423. Text description of the interface as given by pcap/winpcap
  2424. </value>
  2425. </member>
  2426. <member name="P:SharpPcap.LibPcap.PcapInterface.GatewayAddress">
  2427. <value>
  2428. Gateway address of this device
  2429. NOTE: May only be available on Windows
  2430. </value>
  2431. </member>
  2432. <member name="P:SharpPcap.LibPcap.PcapInterface.Addresses">
  2433. <value>
  2434. Addresses associated with this device
  2435. </value>
  2436. </member>
  2437. <member name="P:SharpPcap.LibPcap.PcapInterface.Flags">
  2438. <value>
  2439. Pcap interface flags
  2440. </value>
  2441. </member>
  2442. <member name="P:SharpPcap.LibPcap.PcapInterface.MacAddress">
  2443. <summary>
  2444. MacAddress of the interface
  2445. </summary>
  2446. </member>
  2447. <member name="M:SharpPcap.LibPcap.PcapInterface.ToString">
  2448. <summary>
  2449. ToString override
  2450. </summary>
  2451. <returns>
  2452. A <see cref="T:System.String" /></returns>
  2453. </member>
  2454. <member name="T:SharpPcap.DeviceNotReadyException">
  2455. <summary>
  2456. A PcapDevice or dumpfile is not ready for capture operations.
  2457. </summary>
  2458. </member>
  2459. <member name="T:SharpPcap.LibPcap.PcapStatistics">
  2460. <summary>
  2461. Adapter statistics, received, dropped packet counts etc
  2462. </summary>
  2463. </member>
  2464. <member name="M:SharpPcap.LibPcap.PcapStatistics.#ctor(System.IntPtr)">
  2465. <summary>
  2466. Retrieve pcap statistics from the adapter
  2467. </summary>
  2468. <param name="pcap_t">
  2469. pcap_t* for the adapter
  2470. A <see cref="T:System.IntPtr" /></param>
  2471. </member>
  2472. <member name="P:SharpPcap.LibPcap.PcapStatistics.ReceivedPackets">
  2473. <value>
  2474. Number of packets received
  2475. </value>
  2476. </member>
  2477. <member name="P:SharpPcap.LibPcap.PcapStatistics.DroppedPackets">
  2478. <value>
  2479. Number of packets dropped
  2480. </value>
  2481. </member>
  2482. <member name="P:SharpPcap.LibPcap.PcapStatistics.InterfaceDroppedPackets">
  2483. <value>
  2484. Number of interface dropped packets
  2485. </value>
  2486. </member>
  2487. <member name="M:SharpPcap.LibPcap.PcapStatistics.ToString">
  2488. <summary>
  2489. ToString override
  2490. </summary>
  2491. <returns>
  2492. A <see cref="T:System.String" /></returns>
  2493. </member>
  2494. <member name="T:SharpPcap.WinPcapRequiredException">
  2495. <summary>
  2496. Exception thrown when a WinPcap extension method is called from
  2497. a non-Windows platform
  2498. </summary>
  2499. </member>
  2500. <member name="M:SharpPcap.WinPcapRequiredException.#ctor(System.String)">
  2501. <summary>
  2502. string constructor
  2503. </summary>
  2504. <param name="msg">
  2505. A <see cref="T:System.String" /></param>
  2506. </member>
  2507. <member name="T:SharpPcap.PacketArrivalEventHandler">
  2508. <summary>A delegate for Packet Arrival events</summary>
  2509. </member>
  2510. <member name="T:SharpPcap.CaptureStoppedEventHandler">
  2511. <summary>
  2512. A delegate for notifying of a capture stopped event
  2513. </summary>
  2514. </member>
  2515. <member name="T:SharpPcap.DeviceMode">
  2516. <summary>
  2517. The mode used when opening a device
  2518. </summary>
  2519. </member>
  2520. <member name="F:SharpPcap.DeviceMode.Promiscuous">
  2521. <summary>
  2522. Promiscuous mode.
  2523. Instructs the OS that we want to receive all packets, even those not
  2524. intended for the adapter. On non-switched networks this can result in
  2525. a large amount of addtional traffic.
  2526. NOTE: Devices in this mode CAN be detected via the network
  2527. </summary>
  2528. </member>
  2529. <member name="F:SharpPcap.DeviceMode.Normal">
  2530. <summary>
  2531. Not promiscuous mode
  2532. </summary>
  2533. </member>
  2534. <member name="T:SharpPcap.CaptureEventArgs">
  2535. <summary>
  2536. Capture event arguments
  2537. </summary>
  2538. </member>
  2539. <member name="M:SharpPcap.CaptureEventArgs.#ctor(SharpPcap.RawCapture,SharpPcap.ICaptureDevice)">
  2540. <summary>
  2541. Constructor
  2542. </summary>
  2543. <param name="packet">
  2544. A <see cref="T:SharpPcap.RawCapture" /></param>
  2545. <param name="device">
  2546. A <see cref="T:SharpPcap.ICaptureDevice" /></param>
  2547. </member>
  2548. <member name="P:SharpPcap.CaptureEventArgs.Packet">
  2549. <summary>
  2550. Packet that was captured
  2551. </summary>
  2552. </member>
  2553. <member name="P:SharpPcap.CaptureEventArgs.Device">
  2554. <summary>
  2555. Device this EventArgs was generated for
  2556. </summary>
  2557. </member>
  2558. <member name="T:SharpPcap.ARP">
  2559. <summary>
  2560. Resolves MAC addresses from IP addresses using the Address Resolution Protocol (ARP)
  2561. </summary>
  2562. </member>
  2563. <member name="M:SharpPcap.ARP.#ctor(SharpPcap.LibPcap.LibPcapLiveDevice)">
  2564. <summary>
  2565. Constructs a new ARP Resolver
  2566. </summary>
  2567. <param name="device">The network device on which this resolver sends its ARP packets</param>
  2568. </member>
  2569. <member name="P:SharpPcap.ARP.Timeout">
  2570. <summary>
  2571. Timeout for a given call to Resolve()
  2572. </summary>
  2573. </member>
  2574. <member name="M:SharpPcap.ARP.Resolve(System.Net.IPAddress)">
  2575. <summary>
  2576. Resolves the MAC address of the specified IP address. The 'DeviceName' propery must be set
  2577. prior to using this method.
  2578. </summary>
  2579. <param name="destIP">The IP address to resolve</param>
  2580. <returns>The MAC address that matches to the given IP address</returns>
  2581. </member>
  2582. <member name="M:SharpPcap.ARP.Resolve(System.Net.IPAddress,System.Net.IPAddress,System.Net.NetworkInformation.PhysicalAddress)">
  2583. <summary>
  2584. Resolves the MAC address of the specified IP address
  2585. </summary>
  2586. <param name="destIP">The IP address to resolve</param>
  2587. <param name="localIP">The local IP address from which to send the ARP request, if null the local address will be discovered</param>
  2588. <param name="localMAC">The localMAC address to use, if null the local mac will be discovered</param>
  2589. <returns>The MAC address that matches to the given IP address or
  2590. null if there was a timeout</returns>
  2591. </member>
  2592. <member name="T:SharpPcap.CaptureStoppedEventStatus">
  2593. <summary>
  2594. Status types when capture is stopped
  2595. </summary>
  2596. </member>
  2597. <member name="F:SharpPcap.CaptureStoppedEventStatus.CompletedWithoutError">
  2598. <summary>
  2599. Capture completed without errors
  2600. </summary>
  2601. </member>
  2602. <member name="F:SharpPcap.CaptureStoppedEventStatus.ErrorWhileCapturing">
  2603. <summary>
  2604. Error while capturing
  2605. </summary>
  2606. </member>
  2607. <member name="T:SharpPcap.InvalidOperationDuringBackgroundCaptureException">
  2608. <summary>
  2609. Thrown when an operation can't be performed because
  2610. a background capture has been started via PcapDevice.StartCapture()
  2611. </summary>
  2612. </member>
  2613. <member name="M:SharpPcap.InvalidOperationDuringBackgroundCaptureException.#ctor(System.String)">
  2614. <summary>
  2615. string constructor
  2616. </summary>
  2617. <param name="msg">
  2618. A <see cref="T:System.String" /></param>
  2619. </member>
  2620. <member name="T:SharpPcap.WinPcap.SafeNativeMethods">
  2621. <summary>
  2622. Per http://msdn.microsoft.com/en-us/ms182161.aspx
  2623. </summary>
  2624. </member>
  2625. <member name="M:SharpPcap.WinPcap.SafeNativeMethods.pcap_open(System.String,System.Int32,System.Int32,System.Int32,System.IntPtr,System.Text.StringBuilder)">
  2626. <summary>
  2627. Extended pcap_open() method that is WinPcap specific that
  2628. provides extra flags and functionality
  2629. See http://www.winpcap.org/docs/docs_40_2/html/group__wpcapfunc.html#g2b64c7b6490090d1d37088794f1f1791
  2630. </summary>
  2631. <param name="dev">
  2632. A <see cref="T:System.String" /></param>
  2633. <param name="packetLen">
  2634. A <see cref="T:System.Int32" /></param>
  2635. <param name="flags">
  2636. A <see cref="T:System.Int32" /></param>
  2637. <param name="read_timeout">
  2638. A <see cref="T:System.Int32" /></param>
  2639. <param name="rmtauth">
  2640. A <see cref="T:System.IntPtr" /></param>
  2641. <param name="errbuf">
  2642. A <see cref="T:System.Text.StringBuilder" /></param>
  2643. <returns>
  2644. A <see cref="T:System.IntPtr" /></returns>
  2645. </member>
  2646. <member name="M:SharpPcap.WinPcap.SafeNativeMethods.pcap_findalldevs_ex(System.String,System.IntPtr,System.IntPtr@,System.Text.StringBuilder)">
  2647. <summary>Create a list of network devices that can be opened with pcap_open().</summary>
  2648. </member>
  2649. <member name="M:SharpPcap.WinPcap.SafeNativeMethods.pcap_setmode(System.IntPtr,System.Int32)">
  2650. <summary>
  2651. Set the working mode of the interface p to mode.
  2652. Valid values for mode are MODE_CAPT (default capture mode)
  2653. and MODE_STAT (statistical mode). See the tutorial
  2654. "\ref wpcap_tut9" for details about statistical mode.
  2655. WinPcap specific method
  2656. </summary>
  2657. </member>
  2658. <member name="M:SharpPcap.WinPcap.SafeNativeMethods.pcap_setbuff(System.IntPtr,System.Int32)">
  2659. <summary>
  2660. WinPcap specific method for setting the kernel buffer size
  2661. associated with this adapter. The old buffer is discarded
  2662. when the buffer size is changed.
  2663. See http://www.winpcap.org/docs/docs_40_2/html/group__wpcapfunc.html
  2664. </summary>
  2665. <param name="adapter">
  2666. A <see cref="T:System.IntPtr" /></param>
  2667. <param name="bufferSizeInBytes">
  2668. A <see cref="T:System.Int32" /></param>
  2669. <returns>
  2670. A <see cref="T:System.Int32" /></returns>
  2671. </member>
  2672. <member name="M:SharpPcap.WinPcap.SafeNativeMethods.pcap_setmintocopy(System.IntPtr,System.Int32)">
  2673. <summary>
  2674. changes the minimum amount of data in the kernel buffer that causes
  2675. a read from the application to return (unless the timeout expires)
  2676. See http://www.winpcap.org/docs/docs_412/html/group__wpcapfunc.html#gab14ceacbf1c2f63026416dd73f80dc0d
  2677. </summary>
  2678. <param name="adapter">
  2679. A <see cref="T:System.IntPtr" /></param>
  2680. <param name="sizeInBytes">
  2681. A <see cref="T:System.Int32" /></param>
  2682. <returns>
  2683. A <see cref="T:System.Int32" /></returns>
  2684. </member>
  2685. <member name="M:SharpPcap.WinPcap.SafeNativeMethods.pcap_get_airpcap_handle(System.IntPtr)">
  2686. <summary>
  2687. Returns the AirPcap handler associated with an adapter. This handler can be used to change the
  2688. wireless-related settings of the CACE Technologies AirPcap wireless capture adapters.
  2689. Note: THIS FUNCTION SHOULD BE CONSIDERED PROVISIONAL, AND MAY BE REPLACED IN THE FUTURE BY A
  2690. MORE COMPLETE SET OF FUNCTIONS FOR WIRELESS SUPPORT.
  2691. pcap_get_airpcap_handle() allows to obtain the airpcap handle of an open adapter. This handle
  2692. can be used with the AirPcap API functions to perform wireless-releated operations, e.g. changing
  2693. the channel or enabling WEP decryption. For more details about the AirPcap wireless capture adapters,
  2694. see http://www.cacetech.com/products/airpcap.html
  2695. Parameters:
  2696. p,: handle to an open libpcap adapter
  2697. Returns:
  2698. a PAirpcapHandle pointer to an open AirPcap handle, used internally by the libpcap open adapter.
  2699. NULL if the libpcap adapter doesn't have wireless support through AirPcap.
  2700. </summary>
  2701. <param name="p">
  2702. </param>
  2703. <returns>
  2704. </returns>
  2705. </member>
  2706. <member name="M:SharpPcap.WinPcap.SafeNativeMethods.pcap_sendqueue_alloc(System.Int32)">
  2707. <summary>
  2708. Allocate a send queue.
  2709. </summary>
  2710. <param name="memsize">The size of the queue</param>
  2711. <returns>A pointer to the allocated buffer</returns>
  2712. </member>
  2713. <member name="M:SharpPcap.WinPcap.SafeNativeMethods.pcap_sendqueue_destroy(System.IntPtr)">
  2714. <summary>
  2715. Destroy a send queue.
  2716. </summary>
  2717. <param name="queue">A pointer to the queue start address</param>
  2718. </member>
  2719. <member name="M:SharpPcap.WinPcap.SafeNativeMethods.pcap_sendqueue_queue(System.IntPtr,System.IntPtr,System.IntPtr)">
  2720. <summary>
  2721. Add a packet to a send queue.
  2722. </summary>
  2723. <param name="queue">A pointer to a queue</param>
  2724. <param name="header">The pcap header of the packet to send</param>
  2725. <param name="data">The packet data</param>
  2726. </member>
  2727. <member name="M:SharpPcap.WinPcap.SafeNativeMethods.pcap_sendqueue_transmit(System.IntPtr,System.IntPtr,System.Int32)">
  2728. <summary>
  2729. Send a queue of raw packets to the network.
  2730. </summary>
  2731. <param name="p">
  2732. </param>
  2733. <param name="queue">
  2734. </param>
  2735. <param name="sync">determines if the send operation must be synchronized:
  2736. if it is non-zero, the packets are sent respecting the timestamps,
  2737. otherwise they are sent as fast as possible</param>
  2738. <returns>The amount of bytes actually sent.
  2739. If it is smaller than the size parameter, an error occurred
  2740. during the send. The error can be caused by a driver/adapter
  2741. problem or by an inconsistent/bogus send queue.</returns>
  2742. </member>
  2743. <member name="T:SharpPcap.WinPcap.SendQueue">
  2744. <summary>
  2745. Interface to the WinPcap send queue extension methods
  2746. </summary>
  2747. </member>
  2748. <member name="M:SharpPcap.WinPcap.SendQueue.#ctor(System.Int32)">
  2749. <summary>
  2750. Creates and allocates a new SendQueue
  2751. </summary>
  2752. <param name="memSize">
  2753. The maximun amount of memory (in bytes)
  2754. to allocate for the queue</param>
  2755. </member>
  2756. <member name="P:SharpPcap.WinPcap.SendQueue.CurrentLength">
  2757. <summary>
  2758. The current length in bytes of this queue
  2759. </summary>
  2760. </member>
  2761. <member name="M:SharpPcap.WinPcap.SendQueue.AddInternal(System.Byte[],SharpPcap.LibPcap.PcapHeader)">
  2762. <summary>
  2763. Add a packet to this send queue. The PcapHeader defines the packet length.
  2764. </summary>
  2765. <param name="packet">The packet bytes to add</param>
  2766. <param name="pcapHdr">The pcap header of the packet</param>
  2767. <returns>True if success, else false</returns>
  2768. </member>
  2769. <member name="M:SharpPcap.WinPcap.SendQueue.Add(System.Byte[],SharpPcap.LibPcap.PcapHeader)">
  2770. <summary>
  2771. Add a packet to this send queue.
  2772. </summary>
  2773. <param name="packet">The packet bytes to add</param>
  2774. <param name="pcapHdr">The pcap header of the packet</param>
  2775. <returns>True if success, else false</returns>
  2776. </member>
  2777. <member name="M:SharpPcap.WinPcap.SendQueue.Add(System.Byte[])">
  2778. <summary>
  2779. Add a packet to this send queue.
  2780. </summary>
  2781. <param name="packet">The packet bytes to add</param>
  2782. <returns>True if success, else false</returns>
  2783. </member>
  2784. <member name="M:SharpPcap.WinPcap.SendQueue.Add(SharpPcap.RawCapture)">
  2785. <summary>
  2786. Add a packet to this send queue.
  2787. </summary>
  2788. <param name="packet">The packet to add</param>
  2789. <returns>True if success, else false</returns>
  2790. </member>
  2791. <member name="M:SharpPcap.WinPcap.SendQueue.Add(System.Byte[],System.Int32,System.Int32)">
  2792. <summary>
  2793. Add a packet to this send queue.
  2794. </summary>
  2795. <param name="packet">The packet to add</param>
  2796. <param name="seconds">The 'seconds' part of the packet's timestamp</param>
  2797. <param name="microseconds">The 'microseconds' part of the packet's timestamp</param>
  2798. <returns>True if success, else false</returns>
  2799. </member>
  2800. <member name="M:SharpPcap.WinPcap.SendQueue.Transmit(SharpPcap.WinPcap.WinPcapDevice,SharpPcap.WinPcap.SendQueueTransmitModes)">
  2801. <summary>
  2802. Send a queue of raw packets to the network.
  2803. </summary>
  2804. <param name="device">
  2805. The device on which to send the queue
  2806. A <see cref="T:SharpPcap.LibPcap.PcapDevice" /></param>
  2807. <param name="transmitMode">
  2808. A <see cref="T:SharpPcap.WinPcap.SendQueueTransmitModes" /></param>
  2809. <returns>
  2810. A <see cref="T:System.Int32" /></returns>
  2811. </member>
  2812. <member name="M:SharpPcap.WinPcap.SendQueue.Dispose">
  2813. <summary>
  2814. Destroy the send queue.
  2815. </summary>
  2816. </member>
  2817. <member name="T:SharpPcap.WinPcap.SendQueueTransmitModes">
  2818. <summary>
  2819. The types of transmit modes allowed by the WinPcap specific send queue
  2820. implementation
  2821. </summary>
  2822. </member>
  2823. <member name="F:SharpPcap.WinPcap.SendQueueTransmitModes.Normal">
  2824. <summary>
  2825. Packets are sent as fast as possible
  2826. </summary>
  2827. </member>
  2828. <member name="F:SharpPcap.WinPcap.SendQueueTransmitModes.Synchronized">
  2829. <summary>
  2830. Packets are synchronized in the kernel with a high precision timestamp
  2831. </summary>
  2832. </member>
  2833. <member name="T:SharpPcap.WinPcap.StatisticsModeEventArgs">
  2834. <summary>
  2835. Event that contains statistics mode data
  2836. NOTE: WinPcap only
  2837. </summary>
  2838. </member>
  2839. <member name="M:SharpPcap.WinPcap.StatisticsModeEventArgs.#ctor(SharpPcap.RawCapture,SharpPcap.LibPcap.PcapDevice)">
  2840. <summary>
  2841. Constructor for a statistics mode event
  2842. </summary>
  2843. <param name="packet">
  2844. A <see cref="T:SharpPcap.RawCapture" /></param>
  2845. <param name="device">
  2846. A <see cref="T:SharpPcap.LibPcap.PcapDevice" /></param>
  2847. </member>
  2848. <member name="P:SharpPcap.WinPcap.StatisticsModeEventArgs.Statistics">
  2849. <summary>
  2850. Statistics data for this event
  2851. </summary>
  2852. </member>
  2853. <member name="T:SharpPcap.WinPcap.StatisticsModeEventHandler">
  2854. <summary>
  2855. A delegate for delivering network statistics when using winpcap in
  2856. statistics mode
  2857. </summary>
  2858. </member>
  2859. <member name="T:SharpPcap.WinPcap.StatisticsModePacket">
  2860. <summary>
  2861. Holds network statistics entry from winpcap when in statistics mode
  2862. See http://www.winpcap.org/docs/docs_41b5/html/group__wpcap__tut9.html
  2863. </summary>
  2864. </member>
  2865. <member name="F:SharpPcap.WinPcap.StatisticsModePacket.m_pktData">
  2866. <summary>
  2867. This holds byte received and packets received
  2868. </summary>
  2869. </member>
  2870. <member name="P:SharpPcap.WinPcap.StatisticsModePacket.Timeval">
  2871. <summary>
  2872. This holds time value
  2873. </summary>
  2874. </member>
  2875. <member name="P:SharpPcap.WinPcap.StatisticsModePacket.RecievedPackets">
  2876. <summary>
  2877. Number of packets received since last sample
  2878. </summary>
  2879. </member>
  2880. <member name="P:SharpPcap.WinPcap.StatisticsModePacket.RecievedBytes">
  2881. <summary>
  2882. Number of bytes received since last sample
  2883. </summary>
  2884. </member>
  2885. <member name="T:SharpPcap.WinPcap.OpenFlags">
  2886. <summary>
  2887. The mode used when opening a device
  2888. </summary>
  2889. </member>
  2890. <member name="F:SharpPcap.WinPcap.OpenFlags.Promiscuous">
  2891. <summary>
  2892. Defines if the adapter has to go in promiscuous mode.
  2893. </summary>
  2894. </member>
  2895. <member name="F:SharpPcap.WinPcap.OpenFlags.DataTransferUdp">
  2896. <summary>
  2897. Defines if the data trasfer (in case of a remote capture)
  2898. has to be done with UDP protocol.
  2899. </summary>
  2900. </member>
  2901. <member name="F:SharpPcap.WinPcap.OpenFlags.NoCaptureRemote">
  2902. <summary>
  2903. Defines if the remote probe will capture its own generated traffic.
  2904. </summary>
  2905. </member>
  2906. <member name="F:SharpPcap.WinPcap.OpenFlags.NoCaptureLocal">
  2907. <summary>
  2908. Defines if the local adapter will capture its own generated traffic.
  2909. </summary>
  2910. </member>
  2911. <member name="F:SharpPcap.WinPcap.OpenFlags.MaxResponsiveness">
  2912. <summary>
  2913. This flag configures the adapter for maximum responsiveness.
  2914. </summary>
  2915. </member>
  2916. <member name="T:SharpPcap.ICaptureDevice">
  2917. <summary>
  2918. Interfaces for capture devices
  2919. </summary>
  2920. </member>
  2921. <member name="E:SharpPcap.ICaptureDevice.OnPacketArrival">
  2922. <summary>
  2923. Fires whenever a new packet is processed, either when the packet arrives
  2924. from the network device or when the packet is read from the on-disk file.<br />
  2925. For network captured packets this event is invoked only when working in "PcapMode.Capture" mode.
  2926. </summary>
  2927. </member>
  2928. <member name="E:SharpPcap.ICaptureDevice.OnCaptureStopped">
  2929. <summary>
  2930. Fired when the capture process of this pcap device is stopped
  2931. </summary>
  2932. </member>
  2933. <member name="P:SharpPcap.ICaptureDevice.Name">
  2934. <summary>
  2935. Gets the name of the device
  2936. </summary>
  2937. </member>
  2938. <member name="P:SharpPcap.ICaptureDevice.Description">
  2939. <value>
  2940. Description of the device
  2941. </value>
  2942. </member>
  2943. <member name="P:SharpPcap.ICaptureDevice.LastError">
  2944. <summary>
  2945. The last pcap error associated with this pcap device
  2946. </summary>
  2947. </member>
  2948. <member name="P:SharpPcap.ICaptureDevice.Filter">
  2949. <summary>
  2950. Kernel level filtering expression associated with this device.
  2951. For more info on filter expression syntax, see:
  2952. http://www.winpcap.org/docs/docs31/html/group__language.html
  2953. </summary>
  2954. </member>
  2955. <member name="P:SharpPcap.ICaptureDevice.Statistics">
  2956. <summary>
  2957. Retrieves pcap statistics
  2958. </summary>
  2959. </member>
  2960. <member name="P:SharpPcap.ICaptureDevice.MacAddress">
  2961. <summary>
  2962. Mac address of the physical device
  2963. </summary>
  2964. </member>
  2965. <member name="P:SharpPcap.ICaptureDevice.Started">
  2966. <summary>
  2967. Return a value indicating if the capturing process of this adapter is started
  2968. </summary>
  2969. </member>
  2970. <member name="P:SharpPcap.ICaptureDevice.StopCaptureTimeout">
  2971. <summary>
  2972. Maximum time within which the capture thread must join the main thread (on
  2973. <see cref="M:SharpPcap.ICaptureDevice.StopCapture" />) or else the thread is aborted and an exception thrown.
  2974. </summary>
  2975. </member>
  2976. <member name="P:SharpPcap.ICaptureDevice.LinkType">
  2977. <summary>
  2978. Return the pcap link layer value of an adapter.
  2979. </summary>
  2980. </member>
  2981. <member name="M:SharpPcap.ICaptureDevice.Open">
  2982. <summary>
  2983. Opens the adapter
  2984. </summary>
  2985. </member>
  2986. <member name="M:SharpPcap.ICaptureDevice.Open(SharpPcap.DeviceMode)">
  2987. <summary>
  2988. Open the device. To start capturing call the 'StartCapture' function
  2989. </summary>
  2990. <param name="mode">
  2991. A <see cref="T:SharpPcap.DeviceMode" /></param>
  2992. </member>
  2993. <member name="M:SharpPcap.ICaptureDevice.Open(SharpPcap.DeviceMode,System.Int32)">
  2994. <summary>
  2995. Open the device. To start capturing call the 'StartCapture' function
  2996. </summary>
  2997. <param name="mode">
  2998. A <see cref="T:SharpPcap.DeviceMode" /></param>
  2999. <param name="read_timeout">
  3000. A <see cref="T:System.Int32" /></param>
  3001. </member>
  3002. <member name="M:SharpPcap.ICaptureDevice.Close">
  3003. <summary>
  3004. Closes this adapter
  3005. </summary>
  3006. </member>
  3007. <member name="M:SharpPcap.ICaptureDevice.StartCapture">
  3008. <summary>
  3009. Start the capture
  3010. </summary>
  3011. </member>
  3012. <member name="M:SharpPcap.ICaptureDevice.StopCapture">
  3013. <summary>
  3014. Stop the capture
  3015. </summary>
  3016. </member>
  3017. <member name="M:SharpPcap.ICaptureDevice.Capture">
  3018. <summary>
  3019. Synchronously capture packets on this device. Method blocks forever.
  3020. </summary>
  3021. </member>
  3022. <member name="M:SharpPcap.ICaptureDevice.GetNextPacket">
  3023. <summary>
  3024. Retrieves the next packet from a device
  3025. </summary>
  3026. <returns>
  3027. </returns>
  3028. </member>
  3029. <member name="M:SharpPcap.ICaptureDevice.GetNextPacketPointers(System.IntPtr@,System.IntPtr@)">
  3030. <summary>
  3031. Gets pointers to the next PCAP header and packet data.
  3032. Data is only valid until next call to GetNextPacketNative.
  3033. Advanced use only. Intended to allow unmanaged code to avoid the overhead of
  3034. marshalling PcapHeader and packet contents to allocated memory.
  3035. </summary>
  3036. </member>
  3037. <member name="M:SharpPcap.ICaptureDevice.SendPacket(PacketDotNet.Packet)">
  3038. <summary>
  3039. Sends a raw packet throgh this device
  3040. </summary>
  3041. <param name="p">The packet to send</param>
  3042. </member>
  3043. <member name="M:SharpPcap.ICaptureDevice.SendPacket(PacketDotNet.Packet,System.Int32)">
  3044. <summary>
  3045. Sends a raw packet throgh this device
  3046. </summary>
  3047. <param name="p">The packet to send</param>
  3048. <param name="size">The number of bytes to send</param>
  3049. </member>
  3050. <member name="M:SharpPcap.ICaptureDevice.SendPacket(System.Byte[])">
  3051. <summary>
  3052. Sends a raw packet throgh this device
  3053. </summary>
  3054. <param name="p">The packet bytes to send</param>
  3055. </member>
  3056. <member name="M:SharpPcap.ICaptureDevice.SendPacket(System.Byte[],System.Int32)">
  3057. <summary>
  3058. Sends a raw packet throgh this device
  3059. </summary>
  3060. <param name="p">The packet bytes to send</param>
  3061. <param name="size">The number of bytes to send</param>
  3062. </member>
  3063. <member name="T:SharpPcap.WinPcap.WinPcapDevice">
  3064. <summary>
  3065. WinPcap device
  3066. </summary>
  3067. </member>
  3068. <member name="M:SharpPcap.WinPcap.WinPcapDevice.#ctor(SharpPcap.LibPcap.PcapInterface)">
  3069. <summary>
  3070. Constructs a new PcapDevice based on a 'pcapIf' struct
  3071. </summary>
  3072. <param name="pcapIf">A 'pcapIf' struct representing
  3073. the pcap device</param>
  3074. </member>
  3075. <member name="E:SharpPcap.WinPcap.WinPcapDevice.OnPcapStatistics">
  3076. <summary>
  3077. Fires whenever a new pcap statistics is available for this Pcap Device.<br />
  3078. For network captured packets this event is invoked only when working in "PcapMode.Statistics" mode.
  3079. </summary>
  3080. </member>
  3081. <member name="P:SharpPcap.WinPcap.WinPcapDevice.Mode">
  3082. <value>
  3083. WinPcap specific property
  3084. </value>
  3085. </member>
  3086. <member name="P:SharpPcap.WinPcap.WinPcapDevice.KernelBufferSize">
  3087. <value>
  3088. Set the kernel value buffer size in bytes
  3089. WinPcap extension
  3090. </value>
  3091. </member>
  3092. <member name="P:SharpPcap.WinPcap.WinPcapDevice.MinToCopy">
  3093. <value>
  3094. Set the minumum amount of data (in bytes) received by the kernel in a single call.
  3095. WinPcap extension
  3096. </value>
  3097. </member>
  3098. <member name="M:SharpPcap.WinPcap.WinPcapDevice.StartCapture">
  3099. <summary>
  3100. Starts the capturing process via a background thread
  3101. OnPacketArrival() will be called for each captured packet
  3102. NOTE: Winpcap devices can capture packets or statistics updates
  3103. so only if both a packet handler AND a statistics handler
  3104. are defined will an exception be thrown
  3105. </summary>
  3106. </member>
  3107. <member name="M:SharpPcap.WinPcap.WinPcapDevice.Open">
  3108. <summary>
  3109. Open the device
  3110. </summary>
  3111. </member>
  3112. <member name="M:SharpPcap.WinPcap.WinPcapDevice.Open(SharpPcap.WinPcap.OpenFlags,System.Int32,SharpPcap.WinPcap.RemoteAuthentication)">
  3113. <summary>
  3114. Open
  3115. </summary>
  3116. <param name="flags">
  3117. A <see cref="T:SharpPcap.WinPcap.OpenFlags" /></param>
  3118. <param name="readTimeoutMilliseconds">
  3119. A <see cref="T:System.Int32" /></param>
  3120. <param name="remoteAuthentication">
  3121. A <see cref="T:SharpPcap.WinPcap.RemoteAuthentication" /></param>
  3122. </member>
  3123. <member name="M:SharpPcap.WinPcap.WinPcapDevice.Open(SharpPcap.WinPcap.OpenFlags,System.Int32)">
  3124. <summary>
  3125. Open a device with specific flags
  3126. WinPcap extension - Use of this method will exclude your application
  3127. from working on Linux or Mac
  3128. </summary>
  3129. </member>
  3130. <member name="M:SharpPcap.WinPcap.WinPcapDevice.Close">
  3131. <summary>
  3132. Close the device
  3133. </summary>
  3134. </member>
  3135. <member name="M:SharpPcap.WinPcap.WinPcapDevice.SendPacketArrivalEvent(SharpPcap.RawCapture)">
  3136. <summary>
  3137. Notify the OnPacketArrival delegates about a newly captured packet
  3138. </summary>
  3139. <param name="p">
  3140. A <see cref="T:SharpPcap.RawCapture" /></param>
  3141. </member>
  3142. <member name="M:SharpPcap.WinPcap.WinPcapDevice.SendQueue(SharpPcap.WinPcap.SendQueue,SharpPcap.WinPcap.SendQueueTransmitModes)">
  3143. <summary>
  3144. Sends all packets in a 'PcapSendQueue' out this pcap device
  3145. </summary>
  3146. <param name="q">
  3147. A <see cref="T:SharpPcap.WinPcap.SendQueue" /></param>
  3148. <param name="transmitMode">
  3149. A <see cref="T:SharpPcap.WinPcap.SendQueueTransmitModes" /></param>
  3150. <returns>
  3151. A <see cref="T:System.Int32" /></returns>
  3152. </member>
  3153. <member name="M:SharpPcap.WinPcap.WinPcapDevice.ThrowIfNotWinPcap">
  3154. <summary>
  3155. Helper method for ensuring we are running in winpcap. Throws
  3156. a PcapWinPcapRequiredException() if not on a windows platform
  3157. </summary>
  3158. </member>
  3159. <member name="T:SharpPcap.StatisticsException">
  3160. <summary>
  3161. thrown when pcap_stats() reports an error
  3162. </summary>
  3163. </member>
  3164. <member name="M:SharpPcap.StatisticsException.#ctor(System.String)">
  3165. <summary>
  3166. string constructor
  3167. </summary>
  3168. <param name="msg">
  3169. A <see cref="T:System.String" /></param>
  3170. </member>
  3171. <member name="T:SharpPcap.WinPcap.CaptureMode">
  3172. <summary>
  3173. The working mode of a Pcap device
  3174. </summary>
  3175. </member>
  3176. <member name="F:SharpPcap.WinPcap.CaptureMode.Packets">
  3177. <summary>
  3178. Set a Pcap device to capture packets, Capture mode
  3179. </summary>
  3180. </member>
  3181. <member name="F:SharpPcap.WinPcap.CaptureMode.Statistics">
  3182. <summary>
  3183. Set a Pcap device to report statistics.
  3184. <br />
  3185. Statistics mode is only supported in WinPcap
  3186. </summary>
  3187. </member>
  3188. <member name="T:SharpPcap.WinPcap.UnmanagedStructures">
  3189. <summary>
  3190. WinPcap specific unmanaged structures
  3191. </summary>
  3192. </member>
  3193. <member name="T:SharpPcap.WinPcap.UnmanagedStructures.pcap_rmtauth">
  3194. <summary>
  3195. Struct to specifiy Remote Address using rpcapd.exe, Winpcaps Remote Packet Capture Daemon
  3196. </summary>
  3197. </member>
  3198. <member name="F:SharpPcap.WinPcap.UnmanagedStructures.pcap_rmtauth.type">
  3199. <summary>
  3200. NOTE: IntPtr used to ensure that the correct data size is used depending on
  3201. the platform being used, 32bits on a 32bit machine, 64bits on a 64bit machine
  3202. Auth Type, 0=Null, 1= Password
  3203. </summary>
  3204. </member>
  3205. <member name="F:SharpPcap.WinPcap.UnmanagedStructures.pcap_rmtauth.username">
  3206. <summary>
  3207. Username
  3208. </summary>
  3209. </member>
  3210. <member name="F:SharpPcap.WinPcap.UnmanagedStructures.pcap_rmtauth.password">
  3211. <summary>
  3212. Password
  3213. </summary>
  3214. </member>
  3215. <member name="T:SharpPcap.WinPcap.RemoteAuthentication">
  3216. <summary>
  3217. Remote authentication type and parameters
  3218. </summary>
  3219. </member>
  3220. <member name="M:SharpPcap.WinPcap.RemoteAuthentication.#ctor(SharpPcap.WinPcap.AuthenticationTypes,System.String,System.String)">
  3221. <summary>
  3222. Constructor
  3223. </summary>
  3224. <param name="Type">
  3225. A <see cref="T:SharpPcap.WinPcap.AuthenticationTypes" /></param>
  3226. <param name="Username">
  3227. A <see cref="T:System.String" /></param>
  3228. <param name="Password">
  3229. A <see cref="T:System.String" /></param>
  3230. </member>
  3231. <member name="P:SharpPcap.WinPcap.RemoteAuthentication.Type">
  3232. <summary>
  3233. Type of authentication
  3234. </summary>
  3235. </member>
  3236. <member name="P:SharpPcap.WinPcap.RemoteAuthentication.Username">
  3237. <summary>
  3238. Username
  3239. </summary>
  3240. </member>
  3241. <member name="P:SharpPcap.WinPcap.RemoteAuthentication.Password">
  3242. <summary>
  3243. Password
  3244. </summary>
  3245. </member>
  3246. <member name="M:SharpPcap.WinPcap.RemoteAuthentication.GetUnmanaged">
  3247. <summary>
  3248. Converts this structure to an unmanaged IntPtr. Should be
  3249. freed with Marshal.FreeHGlobal(IntPtr);
  3250. </summary>
  3251. <returns>
  3252. A <see cref="T:System.IntPtr" /></returns>
  3253. </member>
  3254. <member name="T:SharpPcap.WinPcap.AuthenticationTypes">
  3255. <summary>
  3256. Types of authentication
  3257. </summary>
  3258. </member>
  3259. <member name="F:SharpPcap.WinPcap.AuthenticationTypes.Null">
  3260. <summary>
  3261. Null authentication
  3262. </summary>
  3263. </member>
  3264. <member name="F:SharpPcap.WinPcap.AuthenticationTypes.Password">
  3265. <summary>
  3266. Username/password authentication
  3267. </summary>
  3268. </member>
  3269. <member name="T:SharpPcap.AirPcap.AirPcapLinkTypes">
  3270. <summary>
  3271. Link type
  3272. </summary>
  3273. </member>
  3274. <member name="F:SharpPcap.AirPcap.AirPcapLinkTypes._802_11">
  3275. <summary>
  3276. plain 802.11 link type. Every packet in the buffer contains the raw 802.11 frame, including MAC FCS.
  3277. </summary>
  3278. </member>
  3279. <member name="F:SharpPcap.AirPcap.AirPcapLinkTypes._802_11_PLUS_RADIO">
  3280. <summary>
  3281. 802.11 plus radiotap link type. Every packet in the buffer contains a radiotap header followed by the 802.11 frame. MAC FCS is included.
  3282. </summary>
  3283. </member>
  3284. <member name="F:SharpPcap.AirPcap.AirPcapLinkTypes.UNKNOWN">
  3285. <summary>
  3286. Unknown link type, should be seen only in error
  3287. </summary>
  3288. </member>
  3289. <member name="F:SharpPcap.AirPcap.AirPcapLinkTypes._802_11_PLUS_PPI">
  3290. <summary>
  3291. 802.11 plus PPI header link type. Every packet in the buffer contains a PPI header followed by the 802.11 frame. MAC FCS is included.
  3292. </summary>
  3293. </member>
  3294. <member name="T:SharpPcap.ICaptureStatistics">
  3295. <summary>
  3296. Adapter statistics, received, dropped packet counts etc
  3297. </summary>
  3298. </member>
  3299. <member name="P:SharpPcap.ICaptureStatistics.ReceivedPackets">
  3300. <value>
  3301. Number of packets received
  3302. </value>
  3303. </member>
  3304. <member name="P:SharpPcap.ICaptureStatistics.DroppedPackets">
  3305. <value>
  3306. Number of packets dropped
  3307. </value>
  3308. </member>
  3309. <member name="P:SharpPcap.ICaptureStatistics.InterfaceDroppedPackets">
  3310. <value>
  3311. Number of interface dropped packets
  3312. </value>
  3313. </member>
  3314. <member name="T:SharpPcap.WinPcap.WinPcapDeviceList">
  3315. <summary>
  3316. Remote adapter list
  3317. </summary>
  3318. </member>
  3319. <member name="M:SharpPcap.WinPcap.WinPcapDeviceList.#ctor">
  3320. <summary>
  3321. Represents a strongly typed, read-only list of PcapDevices.
  3322. </summary>
  3323. </member>
  3324. <member name="F:SharpPcap.WinPcap.WinPcapDeviceList.RpcapdDefaultPort">
  3325. <summary>
  3326. Port used by rpcapd by default
  3327. </summary>
  3328. </member>
  3329. <member name="P:SharpPcap.WinPcap.WinPcapDeviceList.Item(System.String)">
  3330. <param name="Name">The name or description of the pcap interface to get.</param>
  3331. </member>
  3332. <member name="P:SharpPcap.WinPcap.WinPcapDeviceList.Instance">
  3333. <summary>
  3334. Method to retrieve this classes singleton instance
  3335. </summary>
  3336. </member>
  3337. <member name="M:SharpPcap.WinPcap.WinPcapDeviceList.New">
  3338. <summary>
  3339. Caution: Use the singlton instance unless you know why you need to call this.
  3340. One use is for multiple filters on the same physical device. To apply multiple
  3341. filters open the same physical device multiple times, one for each
  3342. filter by calling this routine and picking the same device out of each list.
  3343. </summary>
  3344. <returns>
  3345. A <see cref="T:SharpPcap.CaptureDeviceList" /></returns>
  3346. </member>
  3347. <!--FIXME: Invalid documentation markup was found for member M:SharpPcap.WinPcap.WinPcapDeviceList.Devices(System.Net.IPAddress,System.Int32,SharpPcap.WinPcap.RemoteAuthentication)-->
  3348. <member name="M:SharpPcap.WinPcap.WinPcapDeviceList.GetDevices">
  3349. <summary>
  3350. Retrieve the local devices
  3351. </summary>
  3352. <returns>
  3353. </returns>
  3354. </member>
  3355. <member name="M:SharpPcap.WinPcap.WinPcapDeviceList.Refresh">
  3356. <summary>
  3357. Refresh the device list
  3358. </summary>
  3359. </member>
  3360. <member name="T:SharpPcap.LibPcap.LibPcapLiveDevice">
  3361. <summary>
  3362. Capture live packets from a network device
  3363. </summary>
  3364. </member>
  3365. <member name="M:SharpPcap.LibPcap.LibPcapLiveDevice.#ctor(SharpPcap.LibPcap.PcapInterface)">
  3366. <summary>
  3367. Constructs a new PcapDevice based on a 'pcapIf' struct
  3368. </summary>
  3369. <param name="pcapIf">A 'pcapIf' struct representing
  3370. the pcap device</param>
  3371. </member>
  3372. <member name="M:SharpPcap.LibPcap.LibPcapLiveDevice.#ctor">
  3373. <summary>
  3374. Default contructor for subclasses
  3375. </summary>
  3376. </member>
  3377. <member name="P:SharpPcap.LibPcap.LibPcapLiveDevice.Name">
  3378. <summary>
  3379. Gets the pcap name of this network device
  3380. </summary>
  3381. </member>
  3382. <member name="P:SharpPcap.LibPcap.LibPcapLiveDevice.Addresses">
  3383. <summary>
  3384. Addresses that represent this device
  3385. </summary>
  3386. </member>
  3387. <member name="P:SharpPcap.LibPcap.LibPcapLiveDevice.Description">
  3388. <summary>
  3389. Gets the pcap description of this device
  3390. </summary>
  3391. </member>
  3392. <member name="P:SharpPcap.LibPcap.LibPcapLiveDevice.Flags">
  3393. <summary>
  3394. Interface flags, see pcap_findalldevs() man page for more info
  3395. </summary>
  3396. </member>
  3397. <member name="P:SharpPcap.LibPcap.LibPcapLiveDevice.Loopback">
  3398. <summary>
  3399. True if device is a loopback interface, false if not
  3400. </summary>
  3401. </member>
  3402. <member name="P:SharpPcap.LibPcap.LibPcapLiveDevice.NonBlockingMode">
  3403. <summary>
  3404. Set/Get Non-Blocking Mode. returns allways false for savefiles.
  3405. </summary>
  3406. </member>
  3407. <member name="P:SharpPcap.LibPcap.LibPcapLiveDevice.Statistics">
  3408. <summary>
  3409. Retrieves pcap statistics
  3410. </summary>
  3411. <returns>
  3412. A <see cref="T:SharpPcap.LibPcap.PcapStatistics" /></returns>
  3413. </member>
  3414. <member name="M:SharpPcap.LibPcap.LibPcapLiveDevice.Finalize">
  3415. <summary>
  3416. PcapDevice finalizer. Ensure PcapDevices are stopped and closed before exit.
  3417. </summary>
  3418. </member>
  3419. <member name="M:SharpPcap.LibPcap.LibPcapLiveDevice.Open">
  3420. <summary>
  3421. Open the device with default values of: promiscuous_mode = false, read_timeout = 1000
  3422. To start capturing call the 'StartCapture' function
  3423. </summary>
  3424. </member>
  3425. <member name="M:SharpPcap.LibPcap.LibPcapLiveDevice.Open(SharpPcap.DeviceMode)">
  3426. <summary>
  3427. Open the device. To start capturing call the 'StartCapture' function
  3428. </summary>
  3429. <param name="mode">
  3430. A <see cref="T:SharpPcap.DeviceMode" /></param>
  3431. </member>
  3432. <member name="M:SharpPcap.LibPcap.LibPcapLiveDevice.Open(SharpPcap.DeviceMode,System.Int32)">
  3433. <summary>
  3434. Open the device. To start capturing call the 'StartCapture' function
  3435. </summary>
  3436. <param name="mode">
  3437. A <see cref="T:SharpPcap.DeviceMode" /></param>
  3438. <param name="read_timeout">
  3439. A <see cref="T:System.Int32" /></param>
  3440. </member>
  3441. <member name="M:SharpPcap.LibPcap.LibPcapLiveDevice.SendPacket(System.Byte[],System.Int32)">
  3442. <summary>
  3443. Sends a raw packet throgh this device
  3444. </summary>
  3445. <param name="p">The packet bytes to send</param>
  3446. <param name="size">The number of bytes to send</param>
  3447. </member>
  3448. <member name="T:SharpPcap.LibPcap.LibPcapLiveDeviceList">
  3449. <summary>
  3450. List of available Pcap Interfaces.
  3451. </summary>
  3452. </member>
  3453. <member name="M:SharpPcap.LibPcap.LibPcapLiveDeviceList.#ctor">
  3454. <summary>
  3455. Represents a strongly typed, read-only list of PcapDevices.
  3456. </summary>
  3457. </member>
  3458. <member name="P:SharpPcap.LibPcap.LibPcapLiveDeviceList.Item(System.String)">
  3459. <param name="Name">The name or description of the pcap interface to get.</param>
  3460. </member>
  3461. <member name="P:SharpPcap.LibPcap.LibPcapLiveDeviceList.Instance">
  3462. <summary>
  3463. Method to retrieve this classes singleton instance
  3464. </summary>
  3465. </member>
  3466. <member name="M:SharpPcap.LibPcap.LibPcapLiveDeviceList.New">
  3467. <summary>
  3468. Caution: Use the singlton instance unless you know why you need to call this.
  3469. One use is for multiple filters on the same physical device. To apply multiple
  3470. filters open the same physical device multiple times, one for each
  3471. filter by calling this routine and picking the same device out of each list.
  3472. </summary>
  3473. <returns>
  3474. A <see cref="T:SharpPcap.LibPcap.LibPcapLiveDeviceList" /></returns>
  3475. </member>
  3476. <member name="M:SharpPcap.LibPcap.LibPcapLiveDeviceList.GetDevices">
  3477. <summary>
  3478. Retrieve a list of the current PcapDevices
  3479. </summary>
  3480. <returns>
  3481. A <see cref="!:List&lt;LibPcapLiveDevice&gt;" /></returns>
  3482. </member>
  3483. <member name="M:SharpPcap.LibPcap.LibPcapLiveDeviceList.Refresh">
  3484. <summary>
  3485. Refresh the device list
  3486. </summary>
  3487. </member>
  3488. <member name="T:SharpPcap.RawCapture">
  3489. <summary>
  3490. Represents a raw captured packet
  3491. </summary>
  3492. </member>
  3493. <member name="M:SharpPcap.RawCapture.#ctor(PacketDotNet.LinkLayers,SharpPcap.PosixTimeval,System.Byte[])">
  3494. <summary>
  3495. Constructor
  3496. </summary>
  3497. <param name="LinkLayerType">
  3498. A <see cref="T:PacketDotNet.LinkLayers" /></param>
  3499. <param name="Timeval">
  3500. A <see cref="T:SharpPcap.PosixTimeval" /></param>
  3501. <param name="Data">
  3502. A <see cref="T:System.Byte" /></param>
  3503. </member>
  3504. <member name="F:SharpPcap.RawCapture.Data">
  3505. <summary> Fetch data portion of the packet.</summary>
  3506. Data as a class field vs. a virtual property improves performance
  3507. significantly. ~2.5% when parsing the packet with Packet.Net and
  3508. ~20% when reading each byte of the packet</member>
  3509. <member name="P:SharpPcap.RawCapture.LinkLayerType">
  3510. <value>
  3511. Link layer from which this packet was captured
  3512. </value>
  3513. </member>
  3514. <member name="P:SharpPcap.RawCapture.Timeval">
  3515. <value>
  3516. The unix timeval when the packet was created
  3517. </value>
  3518. </member>
  3519. <member name="M:SharpPcap.RawCapture.ToString">
  3520. <summary>Output this packet as a readable string</summary>
  3521. </member>
  3522. <member name="T:SharpPcap.PosixTimeval">
  3523. <summary> POSIX.4 timeval</summary>
  3524. </member>
  3525. <member name="M:SharpPcap.PosixTimeval.#ctor(System.UInt64,System.UInt64)">
  3526. <summary>
  3527. Constructor with Seconds and MicroSeconds fields
  3528. </summary>
  3529. <param name="Seconds">
  3530. A <see cref="T:System.UInt64" /></param>
  3531. <param name="MicroSeconds">
  3532. A <see cref="T:System.UInt64" /></param>
  3533. </member>
  3534. <member name="M:SharpPcap.PosixTimeval.#ctor">
  3535. <summary>
  3536. Construct a PosixTimeval using the current UTC time
  3537. </summary>
  3538. </member>
  3539. <member name="P:SharpPcap.PosixTimeval.Seconds">
  3540. <value>
  3541. Number of seconds in the timeval
  3542. </value>
  3543. </member>
  3544. <member name="P:SharpPcap.PosixTimeval.MicroSeconds">
  3545. <value>
  3546. Number of microseconds in the timeval
  3547. </value>
  3548. </member>
  3549. <member name="P:SharpPcap.PosixTimeval.Date">
  3550. <summary> The timeval as a DateTime in Utc </summary>
  3551. </member>
  3552. <member name="M:SharpPcap.PosixTimeval.Equals(System.Object)">
  3553. <summary>
  3554. Equals override
  3555. </summary>
  3556. <param name="obj">
  3557. A <see cref="T:System.Object" /></param>
  3558. <returns>
  3559. A <see cref="T:System.Boolean" /></returns>
  3560. </member>
  3561. <member name="M:SharpPcap.PosixTimeval.GetHashCode">
  3562. <summary>
  3563. GetHashCode override
  3564. </summary>
  3565. <returns>
  3566. A <see cref="T:System.Int32" /></returns>
  3567. </member>
  3568. <member name="M:SharpPcap.PosixTimeval.ToString">
  3569. <summary>
  3570. Convert the timeval to a string like 'SECONDS.MICROSECONDSs'
  3571. </summary>
  3572. <returns>
  3573. A <see cref="T:System.String" /></returns>
  3574. </member>
  3575. <member name="M:SharpPcap.PosixTimeval.CompareTo(SharpPcap.PosixTimeval)">
  3576. <summary>
  3577. Compare this to another
  3578. </summary>
  3579. <param name="that">
  3580. A <see cref="T:SharpPcap.PosixTimeval" /></param>
  3581. <returns>
  3582. A <see cref="T:System.Int32" /></returns>
  3583. </member>
  3584. <member name="M:SharpPcap.PosixTimeval.op_LessThan(SharpPcap.PosixTimeval,SharpPcap.PosixTimeval)">
  3585. <summary>
  3586. Operator &lt; overload
  3587. </summary>
  3588. <param name="a">
  3589. A <see cref="T:SharpPcap.PosixTimeval" /></param>
  3590. <param name="b">
  3591. A <see cref="T:SharpPcap.PosixTimeval" /></param>
  3592. <returns>
  3593. A <see cref="T:System.Boolean" /></returns>
  3594. </member>
  3595. <member name="M:SharpPcap.PosixTimeval.op_GreaterThan(SharpPcap.PosixTimeval,SharpPcap.PosixTimeval)">
  3596. <summary>
  3597. Operator &gt; overload
  3598. </summary>
  3599. <param name="a">
  3600. A <see cref="T:SharpPcap.PosixTimeval" /></param>
  3601. <param name="b">
  3602. A <see cref="T:SharpPcap.PosixTimeval" /></param>
  3603. <returns>
  3604. A <see cref="T:System.Boolean" /></returns>
  3605. </member>
  3606. <member name="M:SharpPcap.PosixTimeval.op_LessThanOrEqual(SharpPcap.PosixTimeval,SharpPcap.PosixTimeval)">
  3607. <summary>
  3608. Operator &lt;=
  3609. </summary>
  3610. <param name="a">
  3611. A <see cref="T:SharpPcap.PosixTimeval" /></param>
  3612. <param name="b">
  3613. A <see cref="T:SharpPcap.PosixTimeval" /></param>
  3614. <returns>
  3615. A <see cref="T:System.Boolean" /></returns>
  3616. </member>
  3617. <member name="M:SharpPcap.PosixTimeval.op_GreaterThanOrEqual(SharpPcap.PosixTimeval,SharpPcap.PosixTimeval)">
  3618. <summary>
  3619. Operator &gt;=
  3620. </summary>
  3621. <param name="a">
  3622. A <see cref="T:SharpPcap.PosixTimeval" /></param>
  3623. <param name="b">
  3624. A <see cref="T:SharpPcap.PosixTimeval" /></param>
  3625. <returns>
  3626. A <see cref="T:System.Boolean" /></returns>
  3627. </member>
  3628. <member name="M:SharpPcap.PosixTimeval.op_Equality(SharpPcap.PosixTimeval,SharpPcap.PosixTimeval)">
  3629. <summary>
  3630. Operator ==
  3631. </summary>
  3632. <param name="a">
  3633. A <see cref="T:SharpPcap.PosixTimeval" /></param>
  3634. <param name="b">
  3635. A <see cref="T:SharpPcap.PosixTimeval" /></param>
  3636. <returns>
  3637. A <see cref="T:System.Boolean" /></returns>
  3638. </member>
  3639. <member name="M:SharpPcap.PosixTimeval.op_Inequality(SharpPcap.PosixTimeval,SharpPcap.PosixTimeval)">
  3640. <summary>
  3641. Operator !=
  3642. </summary>
  3643. <param name="a">
  3644. A <see cref="T:SharpPcap.PosixTimeval" /></param>
  3645. <param name="b">
  3646. A <see cref="T:SharpPcap.PosixTimeval" /></param>
  3647. <returns>
  3648. A <see cref="T:System.Boolean" /></returns>
  3649. </member>
  3650. <member name="T:SharpPcap.LibPcap.CaptureFileReaderDevice">
  3651. <summary>
  3652. Read a pcap capture file
  3653. </summary>
  3654. </member>
  3655. <member name="M:SharpPcap.LibPcap.CaptureFileReaderDevice.#ctor(System.String)">
  3656. <summary>
  3657. </summary>
  3658. <param name="captureFilename">
  3659. A <see cref="T:System.String" /></param>
  3660. </member>
  3661. <member name="P:SharpPcap.LibPcap.CaptureFileReaderDevice.Name">
  3662. <value>
  3663. The name of the capture file
  3664. </value>
  3665. </member>
  3666. <member name="P:SharpPcap.LibPcap.CaptureFileReaderDevice.Description">
  3667. <value>
  3668. Description of the device
  3669. </value>
  3670. </member>
  3671. <member name="P:SharpPcap.LibPcap.CaptureFileReaderDevice.FileSize">
  3672. <value>
  3673. Number of bytes in the capture file
  3674. </value>
  3675. </member>
  3676. <member name="P:SharpPcap.LibPcap.CaptureFileReaderDevice.FileName">
  3677. <summary>
  3678. The underlying pcap file name
  3679. </summary>
  3680. </member>
  3681. <member name="P:SharpPcap.LibPcap.CaptureFileReaderDevice.Statistics">
  3682. <summary>
  3683. Retrieves pcap statistics
  3684. </summary>
  3685. <returns>
  3686. A <see cref="T:SharpPcap.LibPcap.PcapStatistics" /></returns>
  3687. </member>
  3688. <member name="M:SharpPcap.LibPcap.CaptureFileReaderDevice.Open">
  3689. <summary>
  3690. Open the device
  3691. </summary>
  3692. </member>
  3693. <member name="T:SharpPcap.LibPcap.CaptureFileWriterDevice">
  3694. <summary>
  3695. Create or write to a pcap capture file
  3696. NOTE: Appending to a capture file is not currently supported
  3697. </summary>
  3698. </member>
  3699. <member name="M:SharpPcap.LibPcap.CaptureFileWriterDevice.#ctor(System.String)">
  3700. <summary>
  3701. Constructor
  3702. </summary>
  3703. <param name="captureFilename">
  3704. A <see cref="T:System.String" /></param>
  3705. </member>
  3706. <member name="M:SharpPcap.LibPcap.CaptureFileWriterDevice.#ctor(System.String,System.IO.FileMode)">
  3707. <summary>
  3708. Constructor
  3709. </summary>
  3710. <param name="captureFilename">
  3711. A <see cref="T:System.String" /></param>
  3712. <param name="mode">
  3713. A <see cref="T:System.IO.FileMode" /></param>
  3714. </member>
  3715. <member name="M:SharpPcap.LibPcap.CaptureFileWriterDevice.#ctor(SharpPcap.LibPcap.LibPcapLiveDevice,System.String)">
  3716. <summary>
  3717. Constructor
  3718. </summary>
  3719. <param name="device">
  3720. A <see cref="T:SharpPcap.LibPcap.LibPcapLiveDevice" /></param>
  3721. <param name="captureFilename">
  3722. A <see cref="T:System.String" /></param>
  3723. </member>
  3724. <member name="M:SharpPcap.LibPcap.CaptureFileWriterDevice.#ctor(SharpPcap.LibPcap.LibPcapLiveDevice,System.String,System.IO.FileMode)">
  3725. <summary>
  3726. Constructor
  3727. </summary>
  3728. <param name="device">
  3729. A <see cref="T:SharpPcap.LibPcap.LibPcapLiveDevice" /></param>
  3730. <param name="captureFilename">
  3731. A <see cref="T:System.String" /></param>
  3732. <param name="mode">
  3733. A <see cref="T:System.IO.FileMode" /></param>
  3734. </member>
  3735. <member name="M:SharpPcap.LibPcap.CaptureFileWriterDevice.#ctor(PacketDotNet.LinkLayers,System.Nullable{System.Int32},System.String,System.IO.FileMode)">
  3736. <summary>
  3737. Constructor
  3738. </summary>
  3739. <param name="linkLayerType">
  3740. A <see cref="T:PacketDotNet.LinkLayers" /></param>
  3741. <param name="snapshotLength">
  3742. A <see cref="!:System.Nullable&lt;System.Int32&gt;" /></param>
  3743. <param name="captureFilename">
  3744. A <see cref="T:System.String" /></param>
  3745. <param name="mode">
  3746. A <see cref="T:System.IO.FileMode" /></param>
  3747. </member>
  3748. <member name="F:SharpPcap.LibPcap.CaptureFileWriterDevice.m_pcapDumpHandle">
  3749. <summary>
  3750. Handle to an open dump file, not equal to IntPtr.Zero if a dump file is open
  3751. </summary>
  3752. </member>
  3753. <member name="P:SharpPcap.LibPcap.CaptureFileWriterDevice.DumpOpened">
  3754. <summary>
  3755. Whether dump file is open or not
  3756. </summary>
  3757. <returns>
  3758. A <see cref="T:System.Boolean" /></returns>
  3759. </member>
  3760. <member name="P:SharpPcap.LibPcap.CaptureFileWriterDevice.Name">
  3761. <value>
  3762. The name of the capture file
  3763. </value>
  3764. </member>
  3765. <member name="P:SharpPcap.LibPcap.CaptureFileWriterDevice.Description">
  3766. <value>
  3767. Description of the device
  3768. </value>
  3769. </member>
  3770. <member name="P:SharpPcap.LibPcap.CaptureFileWriterDevice.Statistics">
  3771. <summary>
  3772. Retrieves pcap statistics
  3773. </summary>
  3774. <returns>
  3775. A <see cref="T:SharpPcap.LibPcap.PcapStatistics" /></returns>
  3776. </member>
  3777. <member name="M:SharpPcap.LibPcap.CaptureFileWriterDevice.Close">
  3778. <summary>
  3779. Close the capture file
  3780. </summary>
  3781. </member>
  3782. <member name="M:SharpPcap.LibPcap.CaptureFileWriterDevice.Open">
  3783. <summary>
  3784. Open the device
  3785. </summary>
  3786. </member>
  3787. <member name="M:SharpPcap.LibPcap.CaptureFileWriterDevice.Write(System.Byte[],SharpPcap.LibPcap.PcapHeader)">
  3788. <summary>
  3789. Writes a packet to the pcap dump file associated with this device.
  3790. </summary>
  3791. </member>
  3792. <member name="M:SharpPcap.LibPcap.CaptureFileWriterDevice.Write(System.Byte[])">
  3793. <summary>
  3794. Writes a packet to the pcap dump file associated with this device.
  3795. </summary>
  3796. <param name="p">The packet to write</param>
  3797. </member>
  3798. <member name="M:SharpPcap.LibPcap.CaptureFileWriterDevice.Write(SharpPcap.RawCapture)">
  3799. <summary>
  3800. Writes a packet to the pcap dump file associated with this device.
  3801. </summary>
  3802. <param name="p">The packet to write</param>
  3803. </member>
  3804. <member name="T:SharpPcap.NotSupportedOnCaptureFileException">
  3805. <summary>
  3806. Thrown when a method not supported on a capture file
  3807. </summary>
  3808. </member>
  3809. <member name="M:SharpPcap.NotSupportedOnCaptureFileException.#ctor(System.String)">
  3810. <summary>
  3811. string constructor
  3812. </summary>
  3813. <param name="msg">
  3814. A <see cref="T:System.String" /></param>
  3815. </member>
  3816. </members>
  3817. </doc>