Geen omschrijving

PacketDotNet.xml 285KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>/home/cmorgan/packetnet_git/PacketDotNet/bin/Release/PacketDotNet</name>
  5. </assembly>
  6. <members>
  7. <member name="T:PacketDotNet.ApplicationPacket">
  8. <summary>
  9. Represents an application layer packet as described at http://en.wikipedia.org/wiki/Application_Layer
  10. </summary>
  11. </member>
  12. <member name="M:PacketDotNet.ApplicationPacket.#ctor">
  13. <summary>
  14. ApplicationPacket constructor
  15. </summary>
  16. </member>
  17. <member name="T:PacketDotNet.DataLinkPacket">
  18. <summary>
  19. Represents a Layer 2 protocol.
  20. </summary>
  21. </member>
  22. <member name="M:PacketDotNet.DataLinkPacket.#ctor">
  23. <summary>
  24. DataLinkPacket constructor
  25. </summary>
  26. </member>
  27. <member name="T:PacketDotNet.EthernetPacket">
  28. <summary>
  29. See http://en.wikipedia.org/wiki/Ethernet#Ethernet_frame_types_and_the_EtherType_field
  30. </summary>
  31. </member>
  32. <member name="M:PacketDotNet.EthernetPacket.#ctor(System.Net.NetworkInformation.PhysicalAddress,System.Net.NetworkInformation.PhysicalAddress,PacketDotNet.EthernetPacketType)">
  33. <summary>
  34. Construct a new ethernet packet from source and destination mac addresses
  35. </summary>
  36. </member>
  37. <member name="M:PacketDotNet.EthernetPacket.#ctor(PacketDotNet.Utils.ByteArraySegment)">
  38. <summary>
  39. Constructor
  40. </summary>
  41. <param name="bas">
  42. A <see cref="T:PacketDotNet.Utils.ByteArraySegment" /></param>
  43. </member>
  44. <member name="P:PacketDotNet.EthernetPacket.PayloadPacket">
  45. <value>
  46. Payload packet, overridden to set the 'Type' field based on
  47. the type of packet being used here if the PayloadPacket is being set
  48. </value>
  49. </member>
  50. <member name="P:PacketDotNet.EthernetPacket.SourceHwAddress">
  51. <summary> MAC address of the host where the packet originated from.</summary>
  52. </member>
  53. <member name="P:PacketDotNet.EthernetPacket.DestinationHwAddress">
  54. <summary> MAC address of the host where the packet originated from.</summary>
  55. </member>
  56. <member name="P:PacketDotNet.EthernetPacket.Type">
  57. <value>
  58. Type of packet that this ethernet packet encapsulates
  59. </value>
  60. </member>
  61. <member name="P:PacketDotNet.EthernetPacket.Color">
  62. <summary> Fetch ascii escape sequence of the color associated with this packet type.</summary>
  63. </member>
  64. <member name="M:PacketDotNet.EthernetPacket.ParseEncapsulatedBytes(PacketDotNet.Utils.ByteArraySegment,PacketDotNet.EthernetPacketType)">
  65. <summary>
  66. Used by the EthernetPacket constructor. Located here because the LinuxSLL constructor
  67. also needs to perform the same operations as it contains an ethernet type
  68. </summary>
  69. <param name="Header">
  70. A <see cref="T:PacketDotNet.Utils.ByteArraySegment" /></param>
  71. <param name="Type">
  72. A <see cref="T:PacketDotNet.EthernetPacketType" /></param>
  73. <returns>
  74. A <see cref="T:PacketDotNet.PacketOrByteArraySegment" /></returns>
  75. </member>
  76. <member name="M:PacketDotNet.EthernetPacket.GetEncapsulated(PacketDotNet.Packet)">
  77. <summary>
  78. Returns the EthernetPacket inside of the Packet p or null if
  79. there is no encapsulated packet
  80. </summary>
  81. <param name="p">
  82. A <see cref="T:PacketDotNet.Packet" /></param>
  83. <returns>
  84. A <see cref="T:PacketDotNet.EthernetPacket" /></returns>
  85. </member>
  86. <member name="M:PacketDotNet.EthernetPacket.ToString(PacketDotNet.StringOutputType)">
  87. <summary cref="Packet.ToString(StringOutputType)" />
  88. </member>
  89. <member name="M:PacketDotNet.EthernetPacket.RandomPacket">
  90. <summary>
  91. Generate a random EthernetPacket
  92. TODO: could improve this routine to set a random payload as well
  93. </summary>
  94. <returns>
  95. A <see cref="T:PacketDotNet.EthernetPacket" /></returns>
  96. </member>
  97. <member name="T:PacketDotNet.EthernetPacketType">
  98. Copied from Pcap.Net @ 20091117
  99. <summary>
  100. Code constants for well-defined ethernet protocols.
  101. EtherType is a two-octet field in an Ethernet frame, as defined by the Ethernet II framing networking standard.
  102. It is used to indicate which protocol is encapsulated in the payload.
  103. Also contains entries taken from linux/if_ether.h and tcpdump/ethertype.h
  104. </summary></member>
  105. <member name="F:PacketDotNet.EthernetPacketType.None">
  106. <summary>
  107. No Ethernet type
  108. </summary>
  109. </member>
  110. <member name="F:PacketDotNet.EthernetPacketType.IpV4">
  111. <summary>
  112. Internet Protocol, Version 4 (IPv4)
  113. </summary>
  114. </member>
  115. <member name="F:PacketDotNet.EthernetPacketType.Arp">
  116. <summary>
  117. Address Resolution Protocol (ARP)
  118. </summary>
  119. </member>
  120. <member name="F:PacketDotNet.EthernetPacketType.ReverseArp">
  121. <summary>
  122. Reverse Address Resolution Protocol (RARP)
  123. </summary>
  124. </member>
  125. <member name="F:PacketDotNet.EthernetPacketType.WakeOnLan">
  126. <summary>
  127. Wake-On-Lan (WOL)
  128. </summary>
  129. </member>
  130. <member name="F:PacketDotNet.EthernetPacketType.AppleTalk">
  131. <summary>
  132. AppleTalk (Ethertalk)
  133. </summary>
  134. </member>
  135. <member name="F:PacketDotNet.EthernetPacketType.AppleTalkArp">
  136. <summary>
  137. AppleTalk Address Resolution Protocol (AARP)
  138. </summary>
  139. </member>
  140. <member name="F:PacketDotNet.EthernetPacketType.VLanTaggedFrame">
  141. <summary>
  142. VLAN-tagged frame (IEEE 802.1Q)
  143. </summary>
  144. </member>
  145. <member name="F:PacketDotNet.EthernetPacketType.NovellInternetworkPacketExchange">
  146. <summary>
  147. Novell IPX (alt)
  148. </summary>
  149. </member>
  150. <member name="F:PacketDotNet.EthernetPacketType.Novell">
  151. <summary>
  152. Novell
  153. </summary>
  154. </member>
  155. <member name="F:PacketDotNet.EthernetPacketType.IpV6">
  156. <summary>
  157. Internet Protocol, Version 6 (IPv6)
  158. </summary>
  159. </member>
  160. <member name="F:PacketDotNet.EthernetPacketType.MacControl">
  161. <summary>
  162. MAC Control
  163. </summary>
  164. </member>
  165. <member name="F:PacketDotNet.EthernetPacketType.CobraNet">
  166. <summary>
  167. CobraNet
  168. </summary>
  169. </member>
  170. <member name="F:PacketDotNet.EthernetPacketType.MultiprotocolLabelSwitchingUnicast">
  171. <summary>
  172. MPLS unicast
  173. </summary>
  174. </member>
  175. <member name="F:PacketDotNet.EthernetPacketType.MultiprotocolLabelSwitchingMulticast">
  176. <summary>
  177. MPLS multicast
  178. </summary>
  179. </member>
  180. <member name="F:PacketDotNet.EthernetPacketType.PointToPointProtocolOverEthernetDiscoveryStage">
  181. <summary>
  182. PPPoE Discovery Stage
  183. </summary>
  184. </member>
  185. <member name="F:PacketDotNet.EthernetPacketType.PointToPointProtocolOverEthernetSessionStage">
  186. <summary>
  187. PPPoE Session Stage
  188. </summary>
  189. </member>
  190. <member name="F:PacketDotNet.EthernetPacketType.ExtensibleAuthenticationProtocolOverLan">
  191. <summary>
  192. EAP over LAN (IEEE 802.1X)
  193. </summary>
  194. </member>
  195. <member name="F:PacketDotNet.EthernetPacketType.HyperScsi">
  196. <summary>
  197. HyperSCSI (SCSI over Ethernet)
  198. </summary>
  199. </member>
  200. <member name="F:PacketDotNet.EthernetPacketType.AtaOverEthernet">
  201. <summary>
  202. ATA over Ethernet
  203. </summary>
  204. </member>
  205. <member name="F:PacketDotNet.EthernetPacketType.EtherCatProtocol">
  206. <summary>
  207. EtherCAT Protocol
  208. </summary>
  209. </member>
  210. <member name="F:PacketDotNet.EthernetPacketType.ProviderBridging">
  211. <summary>
  212. Provider Bridging (IEEE 802.1ad)
  213. </summary>
  214. </member>
  215. <member name="F:PacketDotNet.EthernetPacketType.AvbTransportProtocol">
  216. <summary>
  217. AVB Transport Protocol (AVBTP)
  218. </summary>
  219. </member>
  220. <member name="F:PacketDotNet.EthernetPacketType.LLDP">
  221. <summary>
  222. Link Layer Discovery Protocol (LLDP)
  223. </summary>
  224. </member>
  225. <member name="F:PacketDotNet.EthernetPacketType.SerialRealTimeCommunicationSystemIii">
  226. <summary>
  227. SERCOS III
  228. </summary>
  229. </member>
  230. <member name="F:PacketDotNet.EthernetPacketType.CircuitEmulationServicesOverEthernet">
  231. <summary>
  232. Circuit Emulation Services over Ethernet (MEF-8)
  233. </summary>
  234. </member>
  235. <member name="F:PacketDotNet.EthernetPacketType.HomePlug">
  236. <summary>
  237. HomePlug
  238. </summary>
  239. </member>
  240. <member name="F:PacketDotNet.EthernetPacketType.MacSecurity">
  241. <summary>
  242. MAC security (IEEE 802.1AE)
  243. </summary>
  244. </member>
  245. <member name="F:PacketDotNet.EthernetPacketType.PrecisionTimeProtocol">
  246. <summary>
  247. Precision Time Protocol (IEEE 1588)
  248. </summary>
  249. </member>
  250. <member name="F:PacketDotNet.EthernetPacketType.ConnectivityFaultManagementOrOperationsAdministrationManagement">
  251. <summary>
  252. IEEE 802.1ag Connectivity Fault Management (CFM) Protocol / ITU-T Recommendation Y.1731 (OAM)
  253. </summary>
  254. </member>
  255. <member name="F:PacketDotNet.EthernetPacketType.FibreChannelOverEthernet">
  256. <summary>
  257. Fibre Channel over Ethernet
  258. </summary>
  259. </member>
  260. <member name="F:PacketDotNet.EthernetPacketType.FibreChannelOverEthernetInitializationProtocol">
  261. <summary>
  262. FCoE Initialization Protocol
  263. </summary>
  264. </member>
  265. <member name="F:PacketDotNet.EthernetPacketType.QInQ">
  266. <summary>
  267. Q-in-Q
  268. </summary>
  269. </member>
  270. <member name="F:PacketDotNet.EthernetPacketType.VeritasLowLatencyTransport">
  271. <summary>
  272. Veritas Low Latency Transport (LLT)
  273. </summary>
  274. </member>
  275. <member name="F:PacketDotNet.EthernetPacketType.Loop">
  276. <summary>
  277. Ethernet loopback packet
  278. </summary>
  279. </member>
  280. <member name="F:PacketDotNet.EthernetPacketType.Echo">
  281. <summary>
  282. Ethernet echo packet
  283. </summary>
  284. </member>
  285. <member name="T:PacketDotNet.Ieee80211FrameControlField">
  286. <summary>
  287. See http://www.ucertify.com/article/ieee-802-11-frame-format.html
  288. </summary>
  289. </member>
  290. <member name="M:PacketDotNet.Ieee80211FrameControlField.#ctor(System.UInt16)">
  291. <summary>
  292. Constructor
  293. </summary>
  294. <param name="field">
  295. A <see cref="T:System.UInt16" /></param>
  296. </member>
  297. <member name="T:PacketDotNet.Ieee80211FrameControlField.FrameTypes">
  298. <summary>
  299. Types of frames
  300. </summary>
  301. </member>
  302. <member name="F:PacketDotNet.Ieee80211FrameControlField.FrameTypes.ManagementAssociationRequest">
  303. <summary>
  304. Association request
  305. </summary>
  306. </member>
  307. <member name="F:PacketDotNet.Ieee80211FrameControlField.FrameTypes.ManagementAssociationResponse">
  308. <summary>
  309. Association response
  310. </summary>
  311. </member>
  312. <member name="F:PacketDotNet.Ieee80211FrameControlField.FrameTypes.ManagementReassociationRequest">
  313. <summary>
  314. Reassociation request
  315. </summary>
  316. </member>
  317. <member name="F:PacketDotNet.Ieee80211FrameControlField.FrameTypes.ManagementReassociationResponse">
  318. <summary>
  319. Reassociation response
  320. </summary>
  321. </member>
  322. <member name="F:PacketDotNet.Ieee80211FrameControlField.FrameTypes.ManagementProbeRequest">
  323. <summary>
  324. Probe request
  325. </summary>
  326. </member>
  327. <member name="F:PacketDotNet.Ieee80211FrameControlField.FrameTypes.ManagementProbeResponse">
  328. <summary>
  329. Probe response
  330. </summary>
  331. </member>
  332. <member name="F:PacketDotNet.Ieee80211FrameControlField.FrameTypes.ManagementReserved0">
  333. <summary>
  334. Reserved 0
  335. </summary>
  336. </member>
  337. <member name="F:PacketDotNet.Ieee80211FrameControlField.FrameTypes.ManagementReserved1">
  338. <summary>
  339. Reserved 1
  340. </summary>
  341. </member>
  342. <member name="F:PacketDotNet.Ieee80211FrameControlField.FrameTypes.ManagementBecon">
  343. <summary>
  344. Becon
  345. </summary>
  346. </member>
  347. <member name="F:PacketDotNet.Ieee80211FrameControlField.FrameTypes.ManagementATIM">
  348. <summary>
  349. ATIM
  350. </summary>
  351. </member>
  352. <member name="F:PacketDotNet.Ieee80211FrameControlField.FrameTypes.ManagementDisassociation">
  353. <summary>
  354. Disassociation
  355. </summary>
  356. </member>
  357. <member name="F:PacketDotNet.Ieee80211FrameControlField.FrameTypes.ManagementAuthentication">
  358. <summary>
  359. Authentication
  360. </summary>
  361. </member>
  362. <member name="F:PacketDotNet.Ieee80211FrameControlField.FrameTypes.ManagementDeauthentication">
  363. <summary>
  364. Deauthentication
  365. </summary>
  366. </member>
  367. <member name="F:PacketDotNet.Ieee80211FrameControlField.FrameTypes.ManagementReserved2">
  368. <summary>
  369. Reserved 2
  370. </summary>
  371. </member>
  372. <member name="F:PacketDotNet.Ieee80211FrameControlField.FrameTypes.ManagementReserved3">
  373. <summary>
  374. Reserved 3
  375. </summary>
  376. </member>
  377. <member name="F:PacketDotNet.Ieee80211FrameControlField.FrameTypes.ControlPSPoll">
  378. <summary>
  379. PS poll
  380. </summary>
  381. </member>
  382. <member name="F:PacketDotNet.Ieee80211FrameControlField.FrameTypes.ControlRTS">
  383. <summary>
  384. RTS
  385. </summary>
  386. </member>
  387. <member name="F:PacketDotNet.Ieee80211FrameControlField.FrameTypes.ControlCTS">
  388. <summary>
  389. CTS
  390. </summary>
  391. </member>
  392. <member name="F:PacketDotNet.Ieee80211FrameControlField.FrameTypes.ControlACK">
  393. <summary>
  394. ACK
  395. </summary>
  396. </member>
  397. <member name="F:PacketDotNet.Ieee80211FrameControlField.FrameTypes.ControlCFEnd">
  398. <summary>
  399. CF-End
  400. </summary>
  401. </member>
  402. <member name="F:PacketDotNet.Ieee80211FrameControlField.FrameTypes.ControlCFEndCFACK">
  403. <summary>
  404. CF-End CF-Ack
  405. </summary>
  406. </member>
  407. <member name="F:PacketDotNet.Ieee80211FrameControlField.FrameTypes.Data">
  408. <summary>
  409. Data
  410. </summary>
  411. </member>
  412. <member name="F:PacketDotNet.Ieee80211FrameControlField.FrameTypes.DataCFACK">
  413. <summary>
  414. CF-ACK
  415. </summary>
  416. </member>
  417. <member name="F:PacketDotNet.Ieee80211FrameControlField.FrameTypes.DataCFPoll">
  418. <summary>
  419. CF-Poll
  420. </summary>
  421. </member>
  422. <member name="F:PacketDotNet.Ieee80211FrameControlField.FrameTypes.DataCFAckCFPoll">
  423. <summary>
  424. CF-Ack CF-Poll
  425. </summary>
  426. </member>
  427. <member name="F:PacketDotNet.Ieee80211FrameControlField.FrameTypes.DataNullFunctionNoData">
  428. <summary>
  429. Null function no data
  430. </summary>
  431. </member>
  432. <member name="F:PacketDotNet.Ieee80211FrameControlField.FrameTypes.DataCFAckNoData">
  433. <summary>
  434. CF-Ack No data
  435. </summary>
  436. </member>
  437. <member name="F:PacketDotNet.Ieee80211FrameControlField.FrameTypes.DataCFPollNoData">
  438. <summary>
  439. CF-Poll no data
  440. </summary>
  441. </member>
  442. <member name="F:PacketDotNet.Ieee80211FrameControlField.FrameTypes.DataCFAckCFPollNoData">
  443. <summary>
  444. CF-Ack CF-Poll no data
  445. </summary>
  446. </member>
  447. <member name="P:PacketDotNet.Ieee80211FrameControlField.ProtocolVersion">
  448. <summary>
  449. Protocol version
  450. </summary>
  451. </member>
  452. <member name="P:PacketDotNet.Ieee80211FrameControlField.Types">
  453. <summary>
  454. Helps to identify the type of WLAN frame, control data and management are
  455. the various frame types defined in IEEE 802.11
  456. </summary>
  457. </member>
  458. <member name="P:PacketDotNet.Ieee80211FrameControlField.ToDS">
  459. <summary>
  460. Is set to 1 when the frame is sent to Distribution System (DS)
  461. </summary>
  462. </member>
  463. <member name="P:PacketDotNet.Ieee80211FrameControlField.FromDS">
  464. <summary>
  465. Is set to 1 when the frame is received from the Distribution System (DS)
  466. </summary>
  467. </member>
  468. <member name="P:PacketDotNet.Ieee80211FrameControlField.MoreFragments">
  469. <summary>
  470. More Fragment is set to 1 when there are more fragments belonging to the same
  471. frame following the current fragment
  472. </summary>
  473. </member>
  474. <member name="P:PacketDotNet.Ieee80211FrameControlField.Retry">
  475. <summary>
  476. Indicates that this fragment is a retransmission of a previously transmitted fragment.
  477. (For receiver to recognize duplicate transmissions of frames)
  478. </summary>
  479. </member>
  480. <member name="P:PacketDotNet.Ieee80211FrameControlField.PowerManagement">
  481. <summary>
  482. Indicates the power management mode that the station will be in after the transmission of the frame
  483. </summary>
  484. </member>
  485. <member name="P:PacketDotNet.Ieee80211FrameControlField.MoreData">
  486. <summary>
  487. Indicates that there are more frames buffered for this station
  488. </summary>
  489. </member>
  490. <member name="P:PacketDotNet.Ieee80211FrameControlField.Wep">
  491. <summary>
  492. Indicates that the frame body is encrypted according to the WEP (wired equivalent privacy) algorithm
  493. </summary>
  494. </member>
  495. <member name="P:PacketDotNet.Ieee80211FrameControlField.Order">
  496. <summary>
  497. Bit is set when the "strict ordering" delivery method is employed. Frames and
  498. fragments are not always sent in order as it causes a transmission performance penalty.
  499. </summary>
  500. </member>
  501. <member name="T:PacketDotNet.Ieee80211MacFields">
  502. <summary>
  503. See http://www.ucertify.com/article/ieee-802-11-frame-format.html
  504. NOTE: All positions are not defined here because the frame type changes
  505. whether some address fields are present or not, causing the sequence control
  506. field to move. In addition the payload size determines where the frame control
  507. sequence value is as it is after the payload bytes, if any payload is present
  508. </summary>
  509. </member>
  510. <member name="T:PacketDotNet.Ieee80211MacFrame">
  511. <summary>
  512. Packet class has common fields, FrameControl and Duration and
  513. a specific object class that is set based on the type of
  514. the frame
  515. See http://www.ucertify.com/article/ieee-802-11-frame-format.html
  516. </summary>
  517. </member>
  518. <member name="M:PacketDotNet.Ieee80211MacFrame.#ctor(PacketDotNet.Utils.ByteArraySegment)">
  519. <summary>
  520. Constructor
  521. </summary>
  522. <param name="bas">
  523. A <see cref="T:PacketDotNet.Utils.ByteArraySegment" /></param>
  524. </member>
  525. <member name="T:PacketDotNet.Ieee80211MacFrame.InnerFramePacket">
  526. <summary>
  527. Interfaces for all inner frames
  528. </summary>
  529. </member>
  530. <member name="P:PacketDotNet.Ieee80211MacFrame.InnerFramePacket.FrameSize">
  531. <summary>
  532. Length of the frame
  533. </summary>
  534. </member>
  535. <member name="T:PacketDotNet.Ieee80211MacFrame.RTSFrame">
  536. <summary>
  537. RTS Frame has a ReceiverAddress[6], TransmitterAddress[6] and a FrameCheckSequence[4],
  538. these fields follow the common FrameControl[2] and DurationId[2] fields
  539. </summary>
  540. </member>
  541. <member name="M:PacketDotNet.Ieee80211MacFrame.RTSFrame.#ctor(PacketDotNet.Ieee80211MacFrame,PacketDotNet.Utils.ByteArraySegment)">
  542. <summary>
  543. Constructor
  544. </summary>
  545. <param name="parent">
  546. A <see cref="T:PacketDotNet.Ieee80211MacFrame" /></param>
  547. <param name="bas">
  548. A <see cref="T:PacketDotNet.Utils.ByteArraySegment" /></param>
  549. </member>
  550. <member name="P:PacketDotNet.Ieee80211MacFrame.RTSFrame.ReceiverAddress">
  551. <summary>
  552. ReceiverAddress
  553. </summary>
  554. </member>
  555. <member name="P:PacketDotNet.Ieee80211MacFrame.RTSFrame.TransmitterAddress">
  556. <summary>
  557. TransmitterAddress
  558. </summary>
  559. </member>
  560. <member name="P:PacketDotNet.Ieee80211MacFrame.RTSFrame.FrameSize">
  561. <summary>
  562. Length of the frame
  563. </summary>
  564. </member>
  565. <member name="M:PacketDotNet.Ieee80211MacFrame.RTSFrame.ToString">
  566. <summary>
  567. ToString() override
  568. </summary>
  569. <returns>
  570. A <see cref="T:System.String" /></returns>
  571. </member>
  572. <member name="T:PacketDotNet.Ieee80211MacFrame.CTSOrACKFrame">
  573. <summary>
  574. Format of a CTS or an ACK frame
  575. </summary>
  576. </member>
  577. <member name="M:PacketDotNet.Ieee80211MacFrame.CTSOrACKFrame.#ctor(PacketDotNet.Ieee80211MacFrame,PacketDotNet.Utils.ByteArraySegment)">
  578. <summary>
  579. Constructor
  580. </summary>
  581. <param name="parent">
  582. A <see cref="T:PacketDotNet.Ieee80211MacFrame" /></param>
  583. <param name="bas">
  584. A <see cref="T:PacketDotNet.Utils.ByteArraySegment" /></param>
  585. </member>
  586. <member name="P:PacketDotNet.Ieee80211MacFrame.CTSOrACKFrame.ReceiverAddress">
  587. <summary>
  588. Receiver address
  589. </summary>
  590. </member>
  591. <member name="P:PacketDotNet.Ieee80211MacFrame.CTSOrACKFrame.FrameSize">
  592. <summary>
  593. Length of the frame
  594. </summary>
  595. </member>
  596. <member name="M:PacketDotNet.Ieee80211MacFrame.CTSOrACKFrame.ToString">
  597. <summary>
  598. ToString() override
  599. </summary>
  600. <returns>
  601. A <see cref="T:System.String" /></returns>
  602. </member>
  603. <member name="P:PacketDotNet.Ieee80211MacFrame.FrameControlBytes">
  604. <summary>
  605. Frame control bytes are the first two bytes of the frame
  606. </summary>
  607. </member>
  608. <member name="P:PacketDotNet.Ieee80211MacFrame.FrameControl">
  609. <summary>
  610. Frame control field
  611. </summary>
  612. </member>
  613. <member name="P:PacketDotNet.Ieee80211MacFrame.FrameCheckSequence">
  614. <summary>
  615. Frame check sequence, the last thing in the 802.11 mac packet
  616. </summary>
  617. </member>
  618. <member name="P:PacketDotNet.Ieee80211MacFrame.InnerFrame">
  619. <summary>
  620. One of RTS, CTS etc frames
  621. </summary>
  622. </member>
  623. <member name="M:PacketDotNet.Ieee80211MacFrame.SetAddress(System.Int32,System.Net.NetworkInformation.PhysicalAddress)">
  624. <summary>
  625. </summary>
  626. <param name="addressIndex">Zero based address to look up</param>
  627. <param name="address">
  628. </param>
  629. </member>
  630. <member name="M:PacketDotNet.Ieee80211MacFrame.ToString">
  631. <summary>
  632. ToString() override
  633. </summary>
  634. <returns>
  635. A <see cref="T:System.String" /></returns>
  636. </member>
  637. <member name="T:PacketDotNet.Ieee80211RadioPacket">
  638. <summary>
  639. .Net analog of a ieee80211_radiotap_header from airpcap.h
  640. </summary>
  641. </member>
  642. <member name="P:PacketDotNet.Ieee80211RadioPacket.Version">
  643. <summary>
  644. Version 0. Only increases for drastic changes, introduction of compatible
  645. new fields does not count.
  646. </summary>
  647. </member>
  648. <member name="P:PacketDotNet.Ieee80211RadioPacket.Length">
  649. <summary>
  650. Length of the whole header in bytes, including it_version, it_pad, it_len
  651. and data fields
  652. </summary>
  653. </member>
  654. <member name="P:PacketDotNet.Ieee80211RadioPacket.Present">
  655. <summary>
  656. Returns an array of UInt32 bitmap entries. Each bit in the bitmap indicates
  657. which fields are present. Set bit 31 (0x8000000)
  658. to extend the bitmap by another 32 bits. Additional extensions are made
  659. by setting bit 31.
  660. </summary>
  661. </member>
  662. <member name="P:PacketDotNet.Ieee80211RadioPacket.RadioTapFields">
  663. <summary>
  664. Array of radio tap fields
  665. </summary>
  666. </member>
  667. <member name="M:PacketDotNet.Ieee80211RadioPacket.ToString(PacketDotNet.StringOutputType)">
  668. <summary cref="Packet.ToString(StringOutputType)" />
  669. </member>
  670. <member name="T:PacketDotNet.Ieee80211RadioFields">
  671. <summary>
  672. As defined by Airpcap.h
  673. NOTE: PresentPosition may not be the only position present
  674. as this the field can be extended if the high bit is set
  675. </summary>
  676. </member>
  677. <member name="F:PacketDotNet.Ieee80211RadioFields.VersionLength">
  678. <summary>Length of the version field</summary>
  679. </member>
  680. <member name="F:PacketDotNet.Ieee80211RadioFields.PadLength">
  681. <summary>Length of the pad field</summary>
  682. </member>
  683. <member name="F:PacketDotNet.Ieee80211RadioFields.LengthLength">
  684. <summary>Length of the length field</summary>
  685. </member>
  686. <member name="F:PacketDotNet.Ieee80211RadioFields.PresentLength">
  687. <summary>Length of the first present field (others may follow)</summary>
  688. </member>
  689. <member name="F:PacketDotNet.Ieee80211RadioFields.VersionPosition">
  690. <summary>Position of the version field</summary>
  691. </member>
  692. <member name="F:PacketDotNet.Ieee80211RadioFields.PadPosition">
  693. <summary>Position of the padding field</summary>
  694. </member>
  695. <member name="F:PacketDotNet.Ieee80211RadioFields.LengthPosition">
  696. <summary>Position of the length field</summary>
  697. </member>
  698. <member name="F:PacketDotNet.Ieee80211RadioFields.PresentPosition">
  699. <summary>Position of the first present field</summary>
  700. </member>
  701. <member name="F:PacketDotNet.Ieee80211RadioFields.DefaultHeaderLength">
  702. <summary>Default header length, assuming one present field entry</summary>
  703. </member>
  704. <member name="T:PacketDotNet.Ieee80211RadioTapChannelFlags">
  705. <summary>
  706. Channel flags
  707. </summary>
  708. </member>
  709. <member name="F:PacketDotNet.Ieee80211RadioTapChannelFlags.IEEE80211_CHAN_TURBO">
  710. <summary>Turbo channel</summary>
  711. </member>
  712. <member name="F:PacketDotNet.Ieee80211RadioTapChannelFlags.IEEE80211_CHAN_CCK">
  713. <summary>CCK channel</summary>
  714. </member>
  715. <member name="F:PacketDotNet.Ieee80211RadioTapChannelFlags.IEEE80211_CHAN_OFDM">
  716. <summary>OFDM channel</summary>
  717. </member>
  718. <member name="F:PacketDotNet.Ieee80211RadioTapChannelFlags.IEEE80211_CHAN_2GHZ">
  719. <summary>2 GHz spectrum channel</summary>
  720. </member>
  721. <member name="F:PacketDotNet.Ieee80211RadioTapChannelFlags.IEEE80211_CHAN_5GHZ">
  722. <summary>5 GHz spectrum channel</summary>
  723. </member>
  724. <member name="F:PacketDotNet.Ieee80211RadioTapChannelFlags.IEEE80211_CHAN_PASSIVE">
  725. <summary>Only passive scan allowed</summary>
  726. </member>
  727. <member name="F:PacketDotNet.Ieee80211RadioTapChannelFlags.IEEE80211_CHAN_DYN">
  728. <summary>Dynamic CCK-OFDM channel</summary>
  729. </member>
  730. <member name="F:PacketDotNet.Ieee80211RadioTapChannelFlags.IEEE80211_CHAN_GFSK">
  731. <summary>GFSK channel (FHSS PHY)</summary>
  732. </member>
  733. <member name="F:PacketDotNet.Ieee80211RadioTapChannelFlags.IEEE80211_CHAN_STURBO">
  734. <summary>11a static turbo channel only</summary>
  735. </member>
  736. <member name="T:PacketDotNet.ChannelRadioTapField">
  737. <summary>
  738. Channel field
  739. </summary>
  740. </member>
  741. <member name="M:PacketDotNet.ChannelRadioTapField.#ctor(System.IO.BinaryReader)">
  742. <summary>
  743. Constructor
  744. </summary>
  745. <param name="br">
  746. A <see cref="T:System.IO.BinaryReader" /></param>
  747. </member>
  748. <member name="F:PacketDotNet.ChannelRadioTapField.Flags">
  749. <summary>
  750. Channel flags
  751. </summary>
  752. </member>
  753. <member name="P:PacketDotNet.ChannelRadioTapField.FieldType">
  754. <summary>Type of the field</summary>
  755. </member>
  756. <member name="P:PacketDotNet.ChannelRadioTapField.FrequencyMHz">
  757. <summary>
  758. Frequency in MHz
  759. </summary>
  760. </member>
  761. <member name="P:PacketDotNet.ChannelRadioTapField.Channel">
  762. <summary>
  763. Channel number derived from frequency
  764. </summary>
  765. </member>
  766. <member name="M:PacketDotNet.ChannelRadioTapField.ChannelFromFrequencyMHz(System.Int32)">
  767. <summary>
  768. Convert a frequency to a channel
  769. </summary>
  770. <param name="frequencyMHz">
  771. A <see cref="T:System.Int32" /></param>
  772. <returns>
  773. A <see cref="T:System.Int32" /></returns>
  774. </member>
  775. <member name="M:PacketDotNet.ChannelRadioTapField.ToString">
  776. <summary>
  777. ToString() override
  778. </summary>
  779. <returns>
  780. A <see cref="T:System.String" /></returns>
  781. </member>
  782. <member name="T:PacketDotNet.FhssRadioTapField">
  783. <summary>
  784. Fhss radio tap field
  785. </summary>
  786. </member>
  787. <member name="M:PacketDotNet.FhssRadioTapField.#ctor(System.IO.BinaryReader)">
  788. <summary>
  789. Constructor
  790. </summary>
  791. <param name="br">
  792. A <see cref="T:System.IO.BinaryReader" /></param>
  793. </member>
  794. <member name="P:PacketDotNet.FhssRadioTapField.FieldType">
  795. <summary>Type of the field</summary>
  796. </member>
  797. <member name="P:PacketDotNet.FhssRadioTapField.ChannelHoppingSet">
  798. <summary>
  799. Hop set
  800. </summary>
  801. </member>
  802. <member name="P:PacketDotNet.FhssRadioTapField.Pattern">
  803. <summary>
  804. Hop pattern
  805. </summary>
  806. </member>
  807. <member name="M:PacketDotNet.FhssRadioTapField.ToString">
  808. <summary>
  809. ToString() override
  810. </summary>
  811. <returns>
  812. A <see cref="T:System.String" /></returns>
  813. </member>
  814. <member name="T:PacketDotNet.FlagsRadioTapField">
  815. <summary>
  816. Radio tap flags
  817. </summary>
  818. </member>
  819. <member name="M:PacketDotNet.FlagsRadioTapField.#ctor(System.IO.BinaryReader)">
  820. <summary>
  821. Constructor
  822. </summary>
  823. <param name="br">
  824. A <see cref="T:System.IO.BinaryReader" /></param>
  825. </member>
  826. <member name="F:PacketDotNet.FlagsRadioTapField.Flags">
  827. <summary>
  828. Flags set
  829. </summary>
  830. </member>
  831. <member name="P:PacketDotNet.FlagsRadioTapField.FieldType">
  832. <summary>Type of the field</summary>
  833. </member>
  834. <member name="M:PacketDotNet.FlagsRadioTapField.ToString">
  835. <summary>
  836. ToString() override
  837. </summary>
  838. <returns>
  839. A <see cref="T:System.String" /></returns>
  840. </member>
  841. <member name="T:PacketDotNet.RateRadioTapField">
  842. <summary>
  843. Rate field
  844. </summary>
  845. </member>
  846. <member name="M:PacketDotNet.RateRadioTapField.#ctor(System.IO.BinaryReader)">
  847. <summary>
  848. Constructor
  849. </summary>
  850. <param name="br">
  851. A <see cref="T:System.IO.BinaryReader" /></param>
  852. </member>
  853. <member name="P:PacketDotNet.RateRadioTapField.FieldType">
  854. <summary>Type of the field</summary>
  855. </member>
  856. <member name="P:PacketDotNet.RateRadioTapField.RateMbps">
  857. <summary>
  858. Rate in Mbps
  859. </summary>
  860. </member>
  861. <member name="M:PacketDotNet.RateRadioTapField.ToString">
  862. <summary>
  863. ToString() override
  864. </summary>
  865. <returns>
  866. A <see cref="T:System.String" /></returns>
  867. </member>
  868. <member name="T:PacketDotNet.DbAntennaSignalRadioTapField">
  869. <summary>
  870. Db antenna signal
  871. </summary>
  872. </member>
  873. <member name="M:PacketDotNet.DbAntennaSignalRadioTapField.#ctor(System.IO.BinaryReader)">
  874. <summary>
  875. Constructor
  876. </summary>
  877. <param name="br">
  878. A <see cref="T:System.IO.BinaryReader" /></param>
  879. </member>
  880. <member name="P:PacketDotNet.DbAntennaSignalRadioTapField.FieldType">
  881. <summary>Type of the field</summary>
  882. </member>
  883. <member name="P:PacketDotNet.DbAntennaSignalRadioTapField.SignalStrengthdB">
  884. <summary>
  885. Signal strength in dB
  886. </summary>
  887. </member>
  888. <member name="M:PacketDotNet.DbAntennaSignalRadioTapField.ToString">
  889. <summary>
  890. ToString() override
  891. </summary>
  892. <returns>
  893. A <see cref="T:System.String" /></returns>
  894. </member>
  895. <member name="T:PacketDotNet.DbAntennaNoiseRadioTapField">
  896. <summary>
  897. Antenna noise in dB
  898. </summary>
  899. </member>
  900. <member name="M:PacketDotNet.DbAntennaNoiseRadioTapField.#ctor(System.IO.BinaryReader)">
  901. <summary>
  902. Constructor
  903. </summary>
  904. <param name="br">
  905. A <see cref="T:System.IO.BinaryReader" /></param>
  906. </member>
  907. <member name="P:PacketDotNet.DbAntennaNoiseRadioTapField.FieldType">
  908. <summary>Type of the field</summary>
  909. </member>
  910. <member name="P:PacketDotNet.DbAntennaNoiseRadioTapField.AntennaNoisedB">
  911. <summary>
  912. Antenna noise in dB
  913. </summary>
  914. </member>
  915. <member name="M:PacketDotNet.DbAntennaNoiseRadioTapField.ToString">
  916. <summary>
  917. ToString() override
  918. </summary>
  919. <returns>
  920. A <see cref="T:System.String" /></returns>
  921. </member>
  922. <member name="T:PacketDotNet.AntennaRadioTapField">
  923. <summary>
  924. Antenna field
  925. </summary>
  926. </member>
  927. <member name="M:PacketDotNet.AntennaRadioTapField.#ctor(System.IO.BinaryReader)">
  928. <summary>
  929. Constructor
  930. </summary>
  931. <param name="br">
  932. A <see cref="T:System.IO.BinaryReader" /></param>
  933. </member>
  934. <member name="P:PacketDotNet.AntennaRadioTapField.FieldType">
  935. <summary>Type of the field</summary>
  936. </member>
  937. <member name="P:PacketDotNet.AntennaRadioTapField.Antenna">
  938. <summary>
  939. Antenna number
  940. </summary>
  941. </member>
  942. <member name="M:PacketDotNet.AntennaRadioTapField.ToString">
  943. <summary>
  944. ToString() override
  945. </summary>
  946. <returns>
  947. A <see cref="T:System.String" /></returns>
  948. </member>
  949. <member name="T:PacketDotNet.DbmAntennaSignalRadioTapField">
  950. <summary>
  951. Antenna signal in dBm
  952. </summary>
  953. </member>
  954. <member name="M:PacketDotNet.DbmAntennaSignalRadioTapField.#ctor(System.IO.BinaryReader)">
  955. <summary>
  956. Constructor
  957. </summary>
  958. <param name="br">
  959. A <see cref="T:System.IO.BinaryReader" /></param>
  960. </member>
  961. <member name="P:PacketDotNet.DbmAntennaSignalRadioTapField.FieldType">
  962. <summary>Type of the field</summary>
  963. </member>
  964. <member name="P:PacketDotNet.DbmAntennaSignalRadioTapField.AntennaSignalDbm">
  965. <summary>
  966. Antenna signal in dBm
  967. </summary>
  968. </member>
  969. <member name="M:PacketDotNet.DbmAntennaSignalRadioTapField.ToString">
  970. <summary>
  971. ToString() override
  972. </summary>
  973. <returns>
  974. A <see cref="T:System.String" /></returns>
  975. </member>
  976. <member name="T:PacketDotNet.DbmAntennaNoiseRadioTapField">
  977. <summary>
  978. Antenna noise in dBm
  979. </summary>
  980. </member>
  981. <member name="M:PacketDotNet.DbmAntennaNoiseRadioTapField.#ctor(System.IO.BinaryReader)">
  982. <summary>
  983. Constructor
  984. </summary>
  985. <param name="br">
  986. A <see cref="T:System.IO.BinaryReader" /></param>
  987. </member>
  988. <member name="P:PacketDotNet.DbmAntennaNoiseRadioTapField.FieldType">
  989. <summary>Type of the field</summary>
  990. </member>
  991. <member name="P:PacketDotNet.DbmAntennaNoiseRadioTapField.AntennaNoisedBm">
  992. <summary>
  993. Antenna noise in dBm
  994. </summary>
  995. </member>
  996. <member name="M:PacketDotNet.DbmAntennaNoiseRadioTapField.ToString">
  997. <summary>
  998. ToString() override
  999. </summary>
  1000. <returns>
  1001. A <see cref="T:System.String" /></returns>
  1002. </member>
  1003. <member name="T:PacketDotNet.LockQualityRadioTapField">
  1004. <summary>
  1005. Lock quality
  1006. </summary>
  1007. </member>
  1008. <member name="M:PacketDotNet.LockQualityRadioTapField.#ctor(System.IO.BinaryReader)">
  1009. <summary>
  1010. Constructor
  1011. </summary>
  1012. <param name="br">
  1013. A <see cref="T:System.IO.BinaryReader" /></param>
  1014. </member>
  1015. <member name="P:PacketDotNet.LockQualityRadioTapField.FieldType">
  1016. <summary>Type of the field</summary>
  1017. </member>
  1018. <member name="P:PacketDotNet.LockQualityRadioTapField.SignalQuality">
  1019. <summary>
  1020. Signal quality
  1021. </summary>
  1022. </member>
  1023. <member name="M:PacketDotNet.LockQualityRadioTapField.ToString">
  1024. <summary>
  1025. ToString() override
  1026. </summary>
  1027. <returns>
  1028. A <see cref="T:System.String" /></returns>
  1029. </member>
  1030. <member name="T:PacketDotNet.TsftRadioTapField">
  1031. <summary>
  1032. Tsft radio tap field
  1033. </summary>
  1034. </member>
  1035. <member name="M:PacketDotNet.TsftRadioTapField.#ctor(System.IO.BinaryReader)">
  1036. <summary>
  1037. Constructor
  1038. </summary>
  1039. <param name="br">
  1040. A <see cref="T:System.IO.BinaryReader" /></param>
  1041. </member>
  1042. <member name="P:PacketDotNet.TsftRadioTapField.FieldType">
  1043. <summary>Type of the field</summary>
  1044. </member>
  1045. <member name="P:PacketDotNet.TsftRadioTapField.TimestampUsec">
  1046. <summary>
  1047. Timestamp in microseconds
  1048. </summary>
  1049. </member>
  1050. <member name="M:PacketDotNet.TsftRadioTapField.ToString">
  1051. <summary>
  1052. ToString() override
  1053. </summary>
  1054. <returns>
  1055. A <see cref="T:System.String" /></returns>
  1056. </member>
  1057. <member name="T:PacketDotNet.FcsRadioTapField">
  1058. <summary>
  1059. Fcs field
  1060. </summary>
  1061. </member>
  1062. <member name="M:PacketDotNet.FcsRadioTapField.#ctor(System.IO.BinaryReader)">
  1063. <summary>
  1064. Constructor
  1065. </summary>
  1066. <param name="br">
  1067. A <see cref="T:System.IO.BinaryReader" /></param>
  1068. </member>
  1069. <member name="P:PacketDotNet.FcsRadioTapField.FieldType">
  1070. <summary>Type of the field</summary>
  1071. </member>
  1072. <member name="P:PacketDotNet.FcsRadioTapField.FrameCheckSequence">
  1073. <summary>
  1074. Frame check sequence
  1075. </summary>
  1076. </member>
  1077. <member name="M:PacketDotNet.FcsRadioTapField.ToString">
  1078. <summary>
  1079. ToString() override
  1080. </summary>
  1081. <returns>
  1082. A <see cref="T:System.String" /></returns>
  1083. </member>
  1084. <member name="T:PacketDotNet.TxAttenuationRadioTapField">
  1085. <summary>
  1086. Transmit power expressed as unitless distance from max
  1087. power set at factory calibration. 0 is max power.
  1088. Monotonically nondecreasing with lower power levels.
  1089. </summary>
  1090. </member>
  1091. <member name="M:PacketDotNet.TxAttenuationRadioTapField.#ctor(System.IO.BinaryReader)">
  1092. <summary>
  1093. Constructor
  1094. </summary>
  1095. <param name="br">
  1096. A <see cref="T:System.IO.BinaryReader" /></param>
  1097. </member>
  1098. <member name="P:PacketDotNet.TxAttenuationRadioTapField.FieldType">
  1099. <summary>Type of the field</summary>
  1100. </member>
  1101. <member name="P:PacketDotNet.TxAttenuationRadioTapField.TxPower">
  1102. <summary>
  1103. Transmit power
  1104. </summary>
  1105. </member>
  1106. <member name="M:PacketDotNet.TxAttenuationRadioTapField.ToString">
  1107. <summary>
  1108. ToString() override
  1109. </summary>
  1110. <returns>
  1111. A <see cref="T:System.String" /></returns>
  1112. </member>
  1113. <member name="T:PacketDotNet.DbTxAttenuationRadioTapField">
  1114. <summary>
  1115. Transmit power expressed as decibel distance from max power
  1116. set at factory calibration. 0 is max power. Monotonically
  1117. nondecreasing with lower power levels.
  1118. </summary>
  1119. </member>
  1120. <member name="M:PacketDotNet.DbTxAttenuationRadioTapField.#ctor(System.IO.BinaryReader)">
  1121. <summary>
  1122. Constructor
  1123. </summary>
  1124. <param name="br">
  1125. A <see cref="T:System.IO.BinaryReader" /></param>
  1126. </member>
  1127. <member name="P:PacketDotNet.DbTxAttenuationRadioTapField.FieldType">
  1128. <summary>Type of the field</summary>
  1129. </member>
  1130. <member name="P:PacketDotNet.DbTxAttenuationRadioTapField.TxPowerdB">
  1131. <summary>
  1132. Transmit power
  1133. </summary>
  1134. </member>
  1135. <member name="M:PacketDotNet.DbTxAttenuationRadioTapField.ToString">
  1136. <summary>
  1137. ToString() override
  1138. </summary>
  1139. <returns>
  1140. A <see cref="T:System.String" /></returns>
  1141. </member>
  1142. <member name="T:PacketDotNet.DbmTxPowerRadioTapField">
  1143. <summary>
  1144. Transmit power expressed as dBm (decibels from a 1 milliwatt
  1145. reference). This is the absolute power level measured at
  1146. the antenna port.
  1147. </summary>
  1148. </member>
  1149. <member name="M:PacketDotNet.DbmTxPowerRadioTapField.#ctor(System.IO.BinaryReader)">
  1150. <summary>
  1151. Constructor
  1152. </summary>
  1153. <param name="br">
  1154. A <see cref="T:System.IO.BinaryReader" /></param>
  1155. </member>
  1156. <member name="P:PacketDotNet.DbmTxPowerRadioTapField.FieldType">
  1157. <summary>Type of the field</summary>
  1158. </member>
  1159. <member name="P:PacketDotNet.DbmTxPowerRadioTapField.TxPowerdBm">
  1160. <summary>
  1161. Tx power in dBm
  1162. </summary>
  1163. </member>
  1164. <member name="M:PacketDotNet.DbmTxPowerRadioTapField.ToString">
  1165. <summary>
  1166. ToString() override
  1167. </summary>
  1168. <returns>
  1169. A <see cref="T:System.String" /></returns>
  1170. </member>
  1171. <member name="T:PacketDotNet.RadioTapField">
  1172. <summary>
  1173. Abstract class for all radio tap fields
  1174. </summary>
  1175. </member>
  1176. <member name="P:PacketDotNet.RadioTapField.FieldType">
  1177. <summary>Type of the field</summary>
  1178. </member>
  1179. <member name="M:PacketDotNet.RadioTapField.Parse(System.Int32,System.IO.BinaryReader)">
  1180. <summary>
  1181. Parse a radio tap field, indicated by bitIndex, from a given BinaryReader
  1182. </summary>
  1183. <param name="bitIndex">
  1184. A <see cref="T:System.Int32" /></param>
  1185. <param name="br">
  1186. A <see cref="T:System.IO.BinaryReader" /></param>
  1187. <returns>
  1188. A <see cref="T:PacketDotNet.RadioTapField" /></returns>
  1189. </member>
  1190. <member name="T:PacketDotNet.Ieee80211RadioTapFlags">
  1191. <summary>
  1192. Radio tap flags
  1193. </summary>
  1194. </member>
  1195. <member name="F:PacketDotNet.Ieee80211RadioTapFlags.CFP">
  1196. <summary>
  1197. sent/received during cfp
  1198. </summary>
  1199. </member>
  1200. <member name="F:PacketDotNet.Ieee80211RadioTapFlags.ShortPreamble">
  1201. <summary>
  1202. sent/received with short preamble
  1203. </summary>
  1204. </member>
  1205. <member name="F:PacketDotNet.Ieee80211RadioTapFlags.WepEncrypted">
  1206. <summary>
  1207. sent/received with WEP encryption
  1208. </summary>
  1209. </member>
  1210. <member name="F:PacketDotNet.Ieee80211RadioTapFlags.Fragmentation">
  1211. <summary>
  1212. sent/received with fragmentation
  1213. </summary>
  1214. </member>
  1215. <member name="F:PacketDotNet.Ieee80211RadioTapFlags.FcsIncludedInFrame">
  1216. <summary>
  1217. frame includes FCS
  1218. </summary>
  1219. </member>
  1220. <member name="T:PacketDotNet.Ieee80211RadioTapType">
  1221. <summary>
  1222. NOTE: Might be out-of-date information since it mentions Ethereal
  1223. NOTE: ethereal does NOT handle the following:
  1224. IEEE80211_RADIOTAP_FHSS:
  1225. IEEE80211_RADIOTAP_LOCK_QUALITY:
  1226. IEEE80211_RADIOTAP_TX_ATTENUATION:
  1227. IEEE80211_RADIOTAP_DB_TX_ATTENUATION:
  1228. </summary>
  1229. </member>
  1230. <member name="F:PacketDotNet.Ieee80211RadioTapType.IEEE80211_RADIOTAP_TSFT">
  1231. <summary>
  1232. IEEE80211_RADIOTAP_TSFT u_int64_t microseconds
  1233. Value in microseconds of the MAC's 64-bit 802.11 Time
  1234. Synchronization Function timer when the first bit of the
  1235. MPDU arrived at the MAC. For received frames, only.
  1236. </summary>
  1237. </member>
  1238. <member name="F:PacketDotNet.Ieee80211RadioTapType.IEEE80211_RADIOTAP_FLAGS">
  1239. <summary>
  1240. IEEE80211_RADIOTAP_FLAGS u_int8_t bitmap
  1241. Properties of transmitted and received frames. See flags
  1242. defined below.
  1243. </summary>
  1244. </member>
  1245. <member name="F:PacketDotNet.Ieee80211RadioTapType.IEEE80211_RADIOTAP_RATE">
  1246. <summary>
  1247. IEEE80211_RADIOTAP_RATE u_int8_t 500kb/s
  1248. Tx/Rx data rate
  1249. </summary>
  1250. </member>
  1251. <member name="F:PacketDotNet.Ieee80211RadioTapType.IEEE80211_RADIOTAP_CHANNEL">
  1252. <summary>
  1253. IEEE80211_RADIOTAP_CHANNEL 2 x u_int16_t MHz, bitmap
  1254. Tx/Rx frequency in MHz, followed by flags (see below).
  1255. </summary>
  1256. </member>
  1257. <member name="F:PacketDotNet.Ieee80211RadioTapType.IEEE80211_RADIOTAP_FHSS">
  1258. <summary>
  1259. IEEE80211_RADIOTAP_FHSS u_int16_t see below
  1260. For frequency-hopping radios, the hop set (first byte)
  1261. and pattern (second byte).
  1262. </summary>
  1263. </member>
  1264. <member name="F:PacketDotNet.Ieee80211RadioTapType.IEEE80211_RADIOTAP_DBM_ANTSIGNAL">
  1265. <summary>
  1266. IEEE80211_RADIOTAP_DBM_ANTSIGNAL int8_t decibels from
  1267. one milliwatt (dBm)
  1268. RF signal power at the antenna, decibel difference from
  1269. one milliwatt.
  1270. </summary>
  1271. </member>
  1272. <member name="F:PacketDotNet.Ieee80211RadioTapType.IEEE80211_RADIOTAP_DBM_ANTNOISE">
  1273. <summary>
  1274. IEEE80211_RADIOTAP_DBM_ANTNOISE int8_t decibels from
  1275. one milliwatt (dBm)
  1276. RF noise power at the antenna, decibel difference from one
  1277. milliwatt.
  1278. </summary>
  1279. </member>
  1280. <member name="F:PacketDotNet.Ieee80211RadioTapType.IEEE80211_RADIOTAP_LOCK_QUALITY">
  1281. <summary>
  1282. IEEE80211_RADIOTAP_LOCK_QUALITY u_int16_t unitless
  1283. Quality of Barker code lock. Unitless. Monotonically
  1284. nondecreasing with "better" lock strength. Called "Signal
  1285. Quality" in datasheets. (Is there a standard way to measure
  1286. this?)
  1287. </summary>
  1288. </member>
  1289. <member name="F:PacketDotNet.Ieee80211RadioTapType.IEEE80211_RADIOTAP_TX_ATTENUATION">
  1290. <summary>
  1291. IEEE80211_RADIOTAP_TX_ATTENUATION u_int16_t unitless
  1292. Transmit power expressed as unitless distance from max
  1293. power set at factory calibration. 0 is max power.
  1294. Monotonically nondecreasing with lower power levels.
  1295. </summary>
  1296. </member>
  1297. <member name="F:PacketDotNet.Ieee80211RadioTapType.IEEE80211_RADIOTAP_DB_TX_ATTENUATION">
  1298. <summary>
  1299. IEEE80211_RADIOTAP_DB_TX_ATTENUATION u_int16_t decibels (dB)
  1300. Transmit power expressed as decibel distance from max power
  1301. set at factory calibration. 0 is max power. Monotonically
  1302. nondecreasing with lower power levels.
  1303. </summary>
  1304. </member>
  1305. <member name="F:PacketDotNet.Ieee80211RadioTapType.IEEE80211_RADIOTAP_DBM_TX_POWER">
  1306. <summary>
  1307. IEEE80211_RADIOTAP_DBM_TX_POWER int8_t decibels from
  1308. one milliwatt (dBm)
  1309. Transmit power expressed as dBm (decibels from a 1 milliwatt
  1310. reference). This is the absolute power level measured at
  1311. the antenna port.
  1312. </summary>
  1313. </member>
  1314. <member name="F:PacketDotNet.Ieee80211RadioTapType.IEEE80211_RADIOTAP_ANTENNA">
  1315. <summary>
  1316. IEEE80211_RADIOTAP_ANTENNA u_int8_t antenna index
  1317. Unitless indication of the Rx/Tx antenna for this packet.
  1318. The first antenna is antenna 0.
  1319. </summary>
  1320. </member>
  1321. <member name="F:PacketDotNet.Ieee80211RadioTapType.IEEE80211_RADIOTAP_DB_ANTSIGNAL">
  1322. <summary>
  1323. IEEE80211_RADIOTAP_DB_ANTSIGNAL u_int8_t decibel (dB)
  1324. RF signal power at the antenna, decibel difference from an
  1325. arbitrary, fixed reference.
  1326. </summary>
  1327. </member>
  1328. <member name="F:PacketDotNet.Ieee80211RadioTapType.IEEE80211_RADIOTAP_DB_ANTNOISE">
  1329. <summary>
  1330. IEEE80211_RADIOTAP_DB_ANTNOISE u_int8_t decibel (dB)
  1331. RF noise power at the antenna, decibel difference from an
  1332. arbitrary, fixed reference point.
  1333. </summary>
  1334. </member>
  1335. <member name="F:PacketDotNet.Ieee80211RadioTapType.IEEE80211_RADIOTAP_FCS">
  1336. <summary>
  1337. IEEE80211_RADIOTAP_FCS u_int32_t data
  1338. FCS from frame in network byte order.
  1339. </summary>
  1340. </member>
  1341. <member name="F:PacketDotNet.Ieee80211RadioTapType.IEEE80211_RADIOTAP_EXT">
  1342. <summary>
  1343. Indicates that the flags bitmaps have been extended
  1344. </summary>
  1345. </member>
  1346. <member name="T:PacketDotNet.IpPacket">
  1347. <summary>
  1348. Base class for IPv4 and IPv6 packets that exports the common
  1349. functionality that both of these classes has in common
  1350. </summary>
  1351. </member>
  1352. <member name="M:PacketDotNet.IpPacket.#ctor">
  1353. <summary>
  1354. IpPacket constructor
  1355. </summary>
  1356. </member>
  1357. <member name="F:PacketDotNet.IpPacket.DefaultTimeToLive">
  1358. <summary>
  1359. The default time to live value for Ip packets being constructed
  1360. </summary>
  1361. </member>
  1362. <member name="P:PacketDotNet.IpPacket.PayloadPacket">
  1363. <value>
  1364. Payload packet, overridden to set the NextHeader/Protocol based
  1365. on the type of payload packet when the payload packet is set
  1366. </value>
  1367. </member>
  1368. <member name="P:PacketDotNet.IpPacket.DestinationAddress">
  1369. <value>
  1370. The destination address
  1371. </value>
  1372. </member>
  1373. <member name="P:PacketDotNet.IpPacket.SourceAddress">
  1374. <value>
  1375. The source address
  1376. </value>
  1377. </member>
  1378. <member name="P:PacketDotNet.IpPacket.Version">
  1379. <value>
  1380. The IP version
  1381. </value>
  1382. </member>
  1383. <member name="P:PacketDotNet.IpPacket.Protocol">
  1384. <value>
  1385. The protocol of the ip packet's payload
  1386. Named 'Protocol' in IPv4
  1387. Named 'NextHeader' in IPv6'
  1388. </value>
  1389. </member>
  1390. <member name="P:PacketDotNet.IpPacket.NextHeader">
  1391. <value>
  1392. The protocol of the ip packet's payload
  1393. Included along side Protocol for user convienence
  1394. </value>
  1395. </member>
  1396. <member name="P:PacketDotNet.IpPacket.TimeToLive">
  1397. <value>
  1398. The number of hops remaining before this packet is discarded
  1399. Named 'TimeToLive' in IPv4
  1400. Named 'HopLimit' in IPv6
  1401. </value>
  1402. </member>
  1403. <member name="P:PacketDotNet.IpPacket.HopLimit">
  1404. <value>
  1405. The number of hops remaining for this packet
  1406. Included along side of TimeToLive for user convienence
  1407. </value>
  1408. </member>
  1409. <member name="P:PacketDotNet.IpPacket.HeaderLength">
  1410. <summary>
  1411. ipv4 header length field, calculated for ipv6 packets
  1412. NOTE: This field is the number of 32bit words in the ip header,
  1413. ie. the number of bytes is 4x this value
  1414. </summary>
  1415. </member>
  1416. <member name="P:PacketDotNet.IpPacket.TotalLength">
  1417. <summary>
  1418. ipv4 total number of bytes in the ipv4 header + payload,
  1419. ipv6 PayloadLength + IPv6Fields.HeaderLength
  1420. </summary>
  1421. </member>
  1422. <member name="P:PacketDotNet.IpPacket.PayloadLength">
  1423. <summary>
  1424. ipv6 payload length in bytes,
  1425. calculate from ipv4.TotalLength - (ipv4.HeaderLength * 4)
  1426. </summary>
  1427. </member>
  1428. <member name="M:PacketDotNet.IpPacket.AttachPseudoIPHeader(System.Byte[])">
  1429. <summary>
  1430. Adds a pseudo ip header to a given packet. Used to generate the full
  1431. byte array required to generate a udp or tcp checksum.
  1432. </summary>
  1433. <param name="origHeader">
  1434. A <see cref="T:System.Byte" /></param>
  1435. <returns>
  1436. A <see cref="T:System.Byte" /></returns>
  1437. </member>
  1438. <member name="M:PacketDotNet.IpPacket.GetIPAddress(System.Net.Sockets.AddressFamily,System.Int32,System.Byte[])">
  1439. <summary>
  1440. Convert an ip address from a byte[]
  1441. </summary>
  1442. <param name="ipType">
  1443. A <see cref="T:System.Net.Sockets.AddressFamily" /></param>
  1444. <param name="fieldOffset">
  1445. A <see cref="T:System.Int32" /></param>
  1446. <param name="bytes">
  1447. A <see cref="T:System.Byte" /></param>
  1448. <returns>
  1449. A <see cref="T:System.Net.IPAddress" /></returns>
  1450. </member>
  1451. <member name="M:PacketDotNet.IpPacket.ParseEncapsulatedBytes(PacketDotNet.Utils.ByteArraySegment,PacketDotNet.IPProtocolType,PacketDotNet.Packet)">
  1452. <summary>
  1453. Called by IPv4 and IPv6 packets to parse their packet payload
  1454. </summary>
  1455. <param name="payload">
  1456. A <see cref="T:PacketDotNet.Utils.ByteArraySegment" /></param>
  1457. <param name="ProtocolType">
  1458. A <see cref="T:PacketDotNet.IPProtocolType" /></param>
  1459. <param name="ParentPacket">
  1460. A <see cref="T:PacketDotNet.Packet" /></param>
  1461. <returns>
  1462. A <see cref="T:PacketDotNet.PacketOrByteArraySegment" /></returns>
  1463. </member>
  1464. <member name="M:PacketDotNet.IpPacket.GetEncapsulated(PacketDotNet.Packet)">
  1465. <summary>
  1466. Returns the IpPacket inside of the Packet p or null if
  1467. there is no encapsulated packet
  1468. </summary>
  1469. <param name="p">
  1470. A <see cref="T:PacketDotNet.Packet" /></param>
  1471. <returns>
  1472. A <see cref="T:PacketDotNet.IpPacket" /></returns>
  1473. </member>
  1474. <member name="M:PacketDotNet.IpPacket.RandomPacket(PacketDotNet.IpVersion)">
  1475. <summary>
  1476. Generate a random packet of a specific ip version
  1477. </summary>
  1478. <param name="version">
  1479. A <see cref="T:PacketDotNet.IpVersion" /></param>
  1480. <returns>
  1481. A <see cref="T:PacketDotNet.IpPacket" /></returns>
  1482. </member>
  1483. <member name="T:PacketDotNet.Packet">
  1484. <summary>
  1485. Base class for all packet types.
  1486. Defines helper methods and accessors for the architecture that underlies how
  1487. packets interact and store their data.
  1488. </summary>
  1489. </member>
  1490. <member name="M:PacketDotNet.Packet.#ctor">
  1491. <summary>
  1492. Constructor
  1493. </summary>
  1494. </member>
  1495. <member name="P:PacketDotNet.Packet.SharesMemoryWithSubPackets">
  1496. <value>
  1497. Returns true if we already have a contiguous byte[] in either
  1498. of these conditions:
  1499. - This packet's header byte[] and payload byte[] are the same instance
  1500. or
  1501. - This packet's header byte[] and this packet's payload packet
  1502. are the same instance and the offsets indicate that the bytes
  1503. are contiguous
  1504. </value>
  1505. </member>
  1506. <member name="P:PacketDotNet.Packet.ParentPacket">
  1507. <summary>
  1508. The packet that is carrying this one
  1509. </summary>
  1510. </member>
  1511. <member name="P:PacketDotNet.Packet.Header">
  1512. <value>
  1513. Returns a
  1514. </value>
  1515. </member>
  1516. <member name="P:PacketDotNet.Packet.PayloadPacket">
  1517. <summary>
  1518. Packet that this packet carries if one is present.
  1519. Note that the packet MAY have a null PayloadPacket but
  1520. a non-null PayloadData
  1521. </summary>
  1522. </member>
  1523. <member name="P:PacketDotNet.Packet.PayloadData">
  1524. <summary>
  1525. Payload byte[] if one is present.
  1526. Note that the packet MAY have a null PayloadData but a
  1527. non-null PayloadPacket
  1528. </summary>
  1529. </member>
  1530. <member name="P:PacketDotNet.Packet.Bytes">
  1531. <summary>
  1532. byte[] containing this packet and its payload
  1533. NOTE: Use 'public virtual ByteArraySegment BytesHighPerformance' for highest performance
  1534. </summary>
  1535. </member>
  1536. <member name="P:PacketDotNet.Packet.BytesHighPerformance">
  1537. <value>
  1538. The option to return a ByteArraySegment means that this method
  1539. is higher performance as the data can start at an offset other than
  1540. the first byte.
  1541. </value>
  1542. </member>
  1543. <member name="P:PacketDotNet.Packet.Color">
  1544. <value>
  1545. Color used when generating the text description of a packet
  1546. </value>
  1547. </member>
  1548. <member name="M:PacketDotNet.Packet.ParsePacket(PacketDotNet.LinkLayers,System.Byte[])">
  1549. <summary>
  1550. Parse bytes into a packet
  1551. </summary>
  1552. <param name="LinkLayer">
  1553. A <see cref="T:PacketDotNet.LinkLayers" /></param>
  1554. <param name="PacketData">
  1555. A <see cref="T:System.Byte" /></param>
  1556. <returns>
  1557. A <see cref="T:PacketDotNet.Packet" /></returns>
  1558. </member>
  1559. <member name="M:PacketDotNet.Packet.RecursivelyUpdateCalculatedValues">
  1560. <summary>
  1561. Used to ensure that values like checksums and lengths are
  1562. properly updated
  1563. </summary>
  1564. </member>
  1565. <member name="M:PacketDotNet.Packet.UpdateCalculatedValues">
  1566. <summary>
  1567. Called to ensure that calculated values are updated before
  1568. the packet bytes are retrieved
  1569. Classes should override this method to update things like
  1570. checksums and lengths that take too much time or are too complex
  1571. to update for each packet parameter change
  1572. </summary>
  1573. </member>
  1574. <member name="M:PacketDotNet.Packet.ToString">
  1575. <summary>Output this packet as a readable string</summary>
  1576. </member>
  1577. <member name="M:PacketDotNet.Packet.ToString(PacketDotNet.StringOutputType)">
  1578. <summary cref="Packet.ToString()">
  1579. Output the packet information in the specified format
  1580. Normal - outputs the packet info to a single line
  1581. Colored - outputs the packet info to a single line with coloring
  1582. Verbose - outputs detailed info about the packet
  1583. VerboseColored - outputs detailed info about the packet with coloring
  1584. </summary>
  1585. <param name="outputFormat">
  1586. <see cref="T:PacketDotNet.StringOutputType" />
  1587. </param>
  1588. </member>
  1589. <member name="M:PacketDotNet.Packet.PrintHex">
  1590. <summary>
  1591. Prints the Packet PayloadData in Hex format
  1592. With the 16-byte segment number, raw bytes, and parsed ascii output
  1593. Ex:
  1594. 0010 00 18 82 6c 7c 7f 00 c0 9f 77 a3 b0 88 64 11 00 ...1|... .w...d..
  1595. </summary>
  1596. <returns>
  1597. A <see cref="T:System.String" /></returns>
  1598. </member>
  1599. <member name="T:PacketDotNet.SessionPacket">
  1600. <summary>
  1601. Session layer packet
  1602. </summary>
  1603. </member>
  1604. <member name="M:PacketDotNet.SessionPacket.#ctor">
  1605. <summary>
  1606. Constructor
  1607. </summary>
  1608. </member>
  1609. <member name="T:PacketDotNet.TcpPacket">
  1610. <summary>
  1611. TcpPacket
  1612. See: http://en.wikipedia.org/wiki/Transmission_Control_Protocol
  1613. </summary>
  1614. </member>
  1615. <member name="M:PacketDotNet.TcpPacket.#ctor(System.UInt16,System.UInt16)">
  1616. <summary>
  1617. Create a new TCP packet from values
  1618. </summary>
  1619. </member>
  1620. <member name="M:PacketDotNet.TcpPacket.#ctor(PacketDotNet.Utils.ByteArraySegment)">
  1621. <summary>
  1622. Constructor
  1623. </summary>
  1624. <param name="bas">
  1625. A <see cref="T:PacketDotNet.Utils.ByteArraySegment" /></param>
  1626. </member>
  1627. <member name="M:PacketDotNet.TcpPacket.#ctor(PacketDotNet.Utils.ByteArraySegment,PacketDotNet.Packet)">
  1628. <summary>
  1629. Constructor
  1630. </summary>
  1631. <param name="bas">
  1632. A <see cref="T:PacketDotNet.Utils.ByteArraySegment" /></param>
  1633. <param name="ParentPacket">
  1634. A <see cref="T:PacketDotNet.Packet" /></param>
  1635. </member>
  1636. <member name="F:PacketDotNet.TcpPacket.HeaderMinimumLength">
  1637. <value>
  1638. 20 bytes is the smallest tcp header
  1639. </value>
  1640. </member>
  1641. <member name="P:PacketDotNet.TcpPacket.SourcePort">
  1642. <summary> Fetch the port number on the source host.</summary>
  1643. </member>
  1644. <member name="P:PacketDotNet.TcpPacket.DestinationPort">
  1645. <summary> Fetches the port number on the destination host.</summary>
  1646. </member>
  1647. <member name="P:PacketDotNet.TcpPacket.SequenceNumber">
  1648. <summary> Fetch the packet sequence number.</summary>
  1649. </member>
  1650. <member name="P:PacketDotNet.TcpPacket.AcknowledgmentNumber">
  1651. <summary> Fetch the packet acknowledgment number.</summary>
  1652. </member>
  1653. <member name="P:PacketDotNet.TcpPacket.DataOffset">
  1654. <summary> The size of the tcp header in 32bit words </summary>
  1655. </member>
  1656. <member name="P:PacketDotNet.TcpPacket.WindowSize">
  1657. <summary>
  1658. The size of the receive window, which specifies the number of
  1659. bytes (beyond the sequence number in the acknowledgment field) that
  1660. the receiver is currently willing to receive.
  1661. </summary>
  1662. </member>
  1663. <member name="P:PacketDotNet.TcpPacket.Checksum">
  1664. <value>
  1665. Tcp checksum field value of type UInt16
  1666. </value>
  1667. </member>
  1668. <member name="P:PacketDotNet.TcpPacket.ValidChecksum">
  1669. <summary> Check if the TCP packet is valid, checksum-wise.</summary>
  1670. </member>
  1671. <member name="P:PacketDotNet.TcpPacket.ValidTCPChecksum">
  1672. <value>
  1673. True if the tcp checksum is valid
  1674. </value>
  1675. </member>
  1676. <member name="P:PacketDotNet.TcpPacket.AllFlags">
  1677. <summary>
  1678. Flags, 9 bits
  1679. TODO: Handle the NS bit
  1680. </summary>
  1681. </member>
  1682. <member name="P:PacketDotNet.TcpPacket.Urg">
  1683. <summary> Check the URG flag, flag indicates if the urgent pointer is valid.</summary>
  1684. </member>
  1685. <member name="P:PacketDotNet.TcpPacket.Ack">
  1686. <summary> Check the ACK flag, flag indicates if the ack number is valid.</summary>
  1687. </member>
  1688. <member name="P:PacketDotNet.TcpPacket.Psh">
  1689. <summary> Check the PSH flag, flag indicates the receiver should pass the
  1690. data to the application as soon as possible.
  1691. </summary>
  1692. </member>
  1693. <member name="P:PacketDotNet.TcpPacket.Rst">
  1694. <summary> Check the RST flag, flag indicates the session should be reset between
  1695. the sender and the receiver.
  1696. </summary>
  1697. </member>
  1698. <member name="P:PacketDotNet.TcpPacket.Syn">
  1699. <summary> Check the SYN flag, flag indicates the sequence numbers should
  1700. be synchronized between the sender and receiver to initiate
  1701. a connection.
  1702. </summary>
  1703. </member>
  1704. <member name="P:PacketDotNet.TcpPacket.Fin">
  1705. <summary> Check the FIN flag, flag indicates the sender is finished sending.</summary>
  1706. </member>
  1707. <member name="P:PacketDotNet.TcpPacket.ECN">
  1708. <value>
  1709. ECN flag
  1710. </value>
  1711. </member>
  1712. <member name="P:PacketDotNet.TcpPacket.CWR">
  1713. <value>
  1714. CWR flag
  1715. </value>
  1716. </member>
  1717. <member name="P:PacketDotNet.TcpPacket.Color">
  1718. <summary> Fetch ascii escape sequence of the color associated with this packet type.</summary>
  1719. </member>
  1720. <member name="P:PacketDotNet.TcpPacket.UrgentPointer">
  1721. <summary> Fetch the urgent pointer.</summary>
  1722. </member>
  1723. <member name="P:PacketDotNet.TcpPacket.Options">
  1724. <summary>
  1725. Bytes that represent the tcp options
  1726. </summary>
  1727. <returns>
  1728. A <see cref="T:System.String" /></returns>
  1729. </member>
  1730. <member name="P:PacketDotNet.TcpPacket.OptionsCollection">
  1731. <summary>
  1732. Contains the Options list attached to the TCP header
  1733. </summary>
  1734. </member>
  1735. <member name="M:PacketDotNet.TcpPacket.CalculateTCPChecksum">
  1736. <summary>
  1737. Computes the TCP checksum. Does not update the current checksum value
  1738. </summary>
  1739. <returns> The calculated TCP checksum.</returns>
  1740. </member>
  1741. <member name="M:PacketDotNet.TcpPacket.UpdateTCPChecksum">
  1742. <summary>
  1743. Update the checksum value.
  1744. </summary>
  1745. </member>
  1746. <!--FIXME: Invalid documentation markup was found for member M:PacketDotNet.TcpPacket.ParseOptions(System.Byte[])-->
  1747. <member name="M:PacketDotNet.TcpPacket.ToString(PacketDotNet.StringOutputType)">
  1748. <summary cref="Packet.ToString(StringOutputType)" />
  1749. </member>
  1750. <member name="M:PacketDotNet.TcpPacket.GetEncapsulated(PacketDotNet.Packet)">
  1751. <summary>
  1752. Returns the TcpPacket embedded in Packet p or null if
  1753. there is no embedded TcpPacket
  1754. </summary>
  1755. </member>
  1756. <member name="M:PacketDotNet.TcpPacket.RandomPacket">
  1757. <summary>
  1758. Create a randomized tcp packet with the given ip version
  1759. </summary>
  1760. <returns>
  1761. A <see cref="T:PacketDotNet.Packet" /></returns>
  1762. </member>
  1763. <member name="T:PacketDotNet.UdpPacket">
  1764. <summary>
  1765. User datagram protocol
  1766. See http://en.wikipedia.org/wiki/Udp
  1767. </summary>
  1768. </member>
  1769. <member name="M:PacketDotNet.UdpPacket.#ctor(System.UInt16,System.UInt16)">
  1770. <summary>
  1771. Create from values
  1772. </summary>
  1773. <param name="SourcePort">
  1774. A <see cref="T:System.UInt16" /></param>
  1775. <param name="DestinationPort">
  1776. A <see cref="T:System.UInt16" /></param>
  1777. </member>
  1778. <member name="M:PacketDotNet.UdpPacket.#ctor(PacketDotNet.Utils.ByteArraySegment)">
  1779. <summary>
  1780. Constructor
  1781. </summary>
  1782. <param name="bas">
  1783. A <see cref="T:PacketDotNet.Utils.ByteArraySegment" /></param>
  1784. </member>
  1785. <member name="M:PacketDotNet.UdpPacket.#ctor(PacketDotNet.Utils.ByteArraySegment,PacketDotNet.Packet)">
  1786. <summary>
  1787. Constructor
  1788. </summary>
  1789. <param name="bas">
  1790. A <see cref="T:PacketDotNet.Utils.ByteArraySegment" /></param>
  1791. <param name="ParentPacket">
  1792. A <see cref="T:PacketDotNet.Packet" /></param>
  1793. </member>
  1794. <member name="P:PacketDotNet.UdpPacket.SourcePort">
  1795. <summary> Fetch the port number on the source host.</summary>
  1796. </member>
  1797. <member name="P:PacketDotNet.UdpPacket.DestinationPort">
  1798. <summary> Fetch the port number on the target host.</summary>
  1799. </member>
  1800. <member name="P:PacketDotNet.UdpPacket.Length">
  1801. <value>
  1802. Length in bytes of the header and payload, minimum size of 8,
  1803. the size of the Udp header
  1804. </value>
  1805. </member>
  1806. <member name="P:PacketDotNet.UdpPacket.Checksum">
  1807. <summary> Fetch the header checksum.</summary>
  1808. </member>
  1809. <member name="P:PacketDotNet.UdpPacket.ValidChecksum">
  1810. <summary> Check if the UDP packet is valid, checksum-wise.</summary>
  1811. </member>
  1812. <member name="P:PacketDotNet.UdpPacket.ValidUDPChecksum">
  1813. <value>
  1814. True if the udp checksum is valid
  1815. </value>
  1816. </member>
  1817. <member name="P:PacketDotNet.UdpPacket.Color">
  1818. <summary> Fetch ascii escape sequence of the color associated with this packet type.</summary>
  1819. </member>
  1820. <member name="M:PacketDotNet.UdpPacket.UpdateCalculatedValues">
  1821. <summary>
  1822. Update the Udp length
  1823. </summary>
  1824. </member>
  1825. <member name="M:PacketDotNet.UdpPacket.CalculateUDPChecksum">
  1826. <summary>
  1827. Calculates the UDP checksum, optionally updating the UDP checksum header.
  1828. </summary>
  1829. <returns>The calculated UDP checksum.</returns>
  1830. </member>
  1831. <member name="M:PacketDotNet.UdpPacket.UpdateUDPChecksum">
  1832. <summary>
  1833. Update the checksum value.
  1834. </summary>
  1835. </member>
  1836. <member name="M:PacketDotNet.UdpPacket.ToString(PacketDotNet.StringOutputType)">
  1837. <summary cref="Packet.ToString(StringOutputType)" />
  1838. </member>
  1839. <member name="M:PacketDotNet.UdpPacket.GetEncapsulated(PacketDotNet.Packet)">
  1840. <summary>
  1841. Returns the UdpPacket inside of the Packet p or null if
  1842. there is no encapsulated packet
  1843. </summary>
  1844. <param name="p">
  1845. A <see cref="T:PacketDotNet.Packet" /></param>
  1846. <returns>
  1847. A <see cref="T:PacketDotNet.UdpPacket" /></returns>
  1848. </member>
  1849. <member name="M:PacketDotNet.UdpPacket.RandomPacket">
  1850. <summary>
  1851. Generate a random packet
  1852. </summary>
  1853. <returns>
  1854. A <see cref="T:PacketDotNet.UdpPacket" /></returns>
  1855. </member>
  1856. <member name="T:PacketDotNet.EthernetFields">
  1857. <summary>
  1858. Ethernet protocol field encoding information.
  1859. </summary>
  1860. </member>
  1861. <member name="F:PacketDotNet.EthernetFields.TypeLength">
  1862. <summary> Width of the ethernet type code in bytes.</summary>
  1863. </member>
  1864. <member name="F:PacketDotNet.EthernetFields.DestinationMacPosition">
  1865. <summary> Position of the destination MAC address within the ethernet header.</summary>
  1866. </member>
  1867. <member name="F:PacketDotNet.EthernetFields.SourceMacPosition">
  1868. <summary> Position of the source MAC address within the ethernet header.</summary>
  1869. </member>
  1870. <member name="F:PacketDotNet.EthernetFields.TypePosition">
  1871. <summary> Position of the ethernet type field within the ethernet header.</summary>
  1872. </member>
  1873. <member name="F:PacketDotNet.EthernetFields.HeaderLength">
  1874. <summary> Total length of an ethernet header in bytes.</summary>
  1875. </member>
  1876. <member name="F:PacketDotNet.EthernetFields.MacAddressLength">
  1877. <summary>
  1878. size of an ethernet mac address in bytes
  1879. </summary>
  1880. </member>
  1881. <member name="T:PacketDotNet.TransportPacket">
  1882. <summary>
  1883. Transport layer packet
  1884. </summary>
  1885. </member>
  1886. <member name="M:PacketDotNet.TransportPacket.#ctor">
  1887. <summary>
  1888. Constructor
  1889. </summary>
  1890. </member>
  1891. <member name="T:PacketDotNet.TransportPacket.TransportChecksumOption">
  1892. <summary>
  1893. Options for use when creating a transport layer checksum
  1894. </summary>
  1895. </member>
  1896. <member name="F:PacketDotNet.TransportPacket.TransportChecksumOption.None">
  1897. <summary>
  1898. No extra options
  1899. </summary>
  1900. </member>
  1901. <member name="F:PacketDotNet.TransportPacket.TransportChecksumOption.AttachPseudoIPHeader">
  1902. <summary>
  1903. Attach a pseudo IP header to the transport data being checksummed
  1904. </summary>
  1905. </member>
  1906. <member name="P:PacketDotNet.TransportPacket.Checksum">
  1907. <value>
  1908. The Checksum version
  1909. </value>
  1910. </member>
  1911. <member name="M:PacketDotNet.TransportPacket.CalculateChecksum(PacketDotNet.TransportPacket.TransportChecksumOption)">
  1912. <summary>
  1913. Calculates the transport layer checksum, either for the
  1914. tcp or udp packet
  1915. </summary>
  1916. <param name="option">
  1917. <see cref="T:PacketDotNet.TransportPacket.TransportChecksumOption" />
  1918. </param>
  1919. <returns>
  1920. A <see cref="T:System.Int32" /></returns>
  1921. </member>
  1922. <member name="M:PacketDotNet.TransportPacket.IsValidChecksum(PacketDotNet.TransportPacket.TransportChecksumOption)">
  1923. <summary>
  1924. Determine if the transport layer checksum is valid
  1925. </summary>
  1926. <param name="option">
  1927. A <see cref="T:PacketDotNet.TransportPacket.TransportChecksumOption" /></param>
  1928. <returns>
  1929. A <see cref="T:System.Boolean" /></returns>
  1930. </member>
  1931. <member name="T:PacketDotNet.Utils.AnsiEscapeSequences">
  1932. <summary> String constants for color console output.
  1933. <p>
  1934. This file contains control sequences to print color text on a text
  1935. console capable of interpreting and displaying control sequences.
  1936. </p><p>
  1937. A capable console would be
  1938. unix bash, os/2 shell, or command.com w/ ansi.sys loaded
  1939. </p></summary>
  1940. <author> Chris Cheetham
  1941. </author>
  1942. </member>
  1943. <member name="F:PacketDotNet.Utils.AnsiEscapeSequences.EscapeBegin">
  1944. <summary>
  1945. Delimits the start of an ansi color sequence, the color code goes after this
  1946. </summary>
  1947. </member>
  1948. <member name="F:PacketDotNet.Utils.AnsiEscapeSequences.EscapeEnd">
  1949. <summary>
  1950. Delimits the stop of the ansi color sequence, the color code comes before this
  1951. </summary>
  1952. </member>
  1953. <member name="T:PacketDotNet.UdpFields">
  1954. <summary>
  1955. Defines the lengths and positions of the udp fields within
  1956. a udp packet
  1957. </summary>
  1958. </member>
  1959. <member name="F:PacketDotNet.UdpFields.PortLength">
  1960. <summary> Length of a UDP port in bytes.</summary>
  1961. </member>
  1962. <member name="F:PacketDotNet.UdpFields.HeaderLengthLength">
  1963. <summary> Length of the header length field in bytes.</summary>
  1964. </member>
  1965. <member name="F:PacketDotNet.UdpFields.ChecksumLength">
  1966. <summary> Length of the checksum field in bytes.</summary>
  1967. </member>
  1968. <member name="F:PacketDotNet.UdpFields.SourcePortPosition">
  1969. <summary> Position of the source port.</summary>
  1970. </member>
  1971. <member name="F:PacketDotNet.UdpFields.DestinationPortPosition">
  1972. <summary> Position of the destination port.</summary>
  1973. </member>
  1974. <member name="F:PacketDotNet.UdpFields.HeaderLengthPosition">
  1975. <summary> Position of the header length.</summary>
  1976. </member>
  1977. <member name="F:PacketDotNet.UdpFields.ChecksumPosition">
  1978. <summary> Position of the header checksum length.</summary>
  1979. </member>
  1980. <member name="F:PacketDotNet.UdpFields.HeaderLength">
  1981. <summary> Length of a UDP header in bytes.</summary>
  1982. </member>
  1983. <member name="T:MiscUtil.IO.EndianBinaryReader">
  1984. <summary>
  1985. Equivalent of System.IO.BinaryReader, but with either endianness, depending on
  1986. the EndianBitConverter it is constructed with. No data is buffered in the
  1987. reader; the client may seek within the stream at will.
  1988. </summary>
  1989. </member>
  1990. <member name="M:MiscUtil.IO.EndianBinaryReader.#ctor(MiscUtil.Conversion.EndianBitConverter,System.IO.Stream)">
  1991. <summary>
  1992. Equivalent of System.IO.BinaryWriter, but with either endianness, depending on
  1993. the EndianBitConverter it is constructed with.
  1994. </summary>
  1995. <param name="bitConverter">Converter to use when reading data</param>
  1996. <param name="stream">Stream to read data from</param>
  1997. </member>
  1998. <member name="M:MiscUtil.IO.EndianBinaryReader.#ctor(MiscUtil.Conversion.EndianBitConverter,System.IO.Stream,System.Text.Encoding)">
  1999. <summary>
  2000. Constructs a new binary reader with the given bit converter, reading
  2001. to the given stream, using the given encoding.
  2002. </summary>
  2003. <param name="bitConverter">Converter to use when reading data</param>
  2004. <param name="stream">Stream to read data from</param>
  2005. <param name="encoding">Encoding to use when reading character data</param>
  2006. </member>
  2007. <member name="F:MiscUtil.IO.EndianBinaryReader.disposed">
  2008. <summary>
  2009. Whether or not this reader has been disposed yet.
  2010. </summary>
  2011. </member>
  2012. <member name="F:MiscUtil.IO.EndianBinaryReader.decoder">
  2013. <summary>
  2014. Decoder to use for string conversions.
  2015. </summary>
  2016. </member>
  2017. <member name="F:MiscUtil.IO.EndianBinaryReader.buffer">
  2018. <summary>
  2019. Buffer used for temporary storage before conversion into primitives
  2020. </summary>
  2021. </member>
  2022. <member name="F:MiscUtil.IO.EndianBinaryReader.charBuffer">
  2023. <summary>
  2024. Buffer used for temporary storage when reading a single character
  2025. </summary>
  2026. </member>
  2027. <member name="F:MiscUtil.IO.EndianBinaryReader.minBytesPerChar">
  2028. <summary>
  2029. Minimum number of bytes used to encode a character
  2030. </summary>
  2031. </member>
  2032. <member name="P:MiscUtil.IO.EndianBinaryReader.BitConverter">
  2033. <summary>
  2034. The bit converter used to read values from the stream
  2035. </summary>
  2036. </member>
  2037. <member name="P:MiscUtil.IO.EndianBinaryReader.Encoding">
  2038. <summary>
  2039. The encoding used to read strings
  2040. </summary>
  2041. </member>
  2042. <member name="P:MiscUtil.IO.EndianBinaryReader.BaseStream">
  2043. <summary>
  2044. Gets the underlying stream of the EndianBinaryReader.
  2045. </summary>
  2046. </member>
  2047. <member name="M:MiscUtil.IO.EndianBinaryReader.Close">
  2048. <summary>
  2049. Closes the reader, including the underlying stream..
  2050. </summary>
  2051. </member>
  2052. <member name="M:MiscUtil.IO.EndianBinaryReader.Seek(System.Int32,System.IO.SeekOrigin)">
  2053. <summary>
  2054. Seeks within the stream.
  2055. </summary>
  2056. <param name="offset">Offset to seek to.</param>
  2057. <param name="origin">Origin of seek operation.</param>
  2058. </member>
  2059. <member name="M:MiscUtil.IO.EndianBinaryReader.ReadByte">
  2060. <summary>
  2061. Reads a single byte from the stream.
  2062. </summary>
  2063. <returns>The byte read</returns>
  2064. </member>
  2065. <member name="M:MiscUtil.IO.EndianBinaryReader.ReadSByte">
  2066. <summary>
  2067. Reads a single signed byte from the stream.
  2068. </summary>
  2069. <returns>The byte read</returns>
  2070. </member>
  2071. <member name="M:MiscUtil.IO.EndianBinaryReader.ReadBoolean">
  2072. <summary>
  2073. Reads a boolean from the stream. 1 byte is read.
  2074. </summary>
  2075. <returns>The boolean read</returns>
  2076. </member>
  2077. <member name="M:MiscUtil.IO.EndianBinaryReader.ReadInt16">
  2078. <summary>
  2079. Reads a 16-bit signed integer from the stream, using the bit converter
  2080. for this reader. 2 bytes are read.
  2081. </summary>
  2082. <returns>The 16-bit integer read</returns>
  2083. </member>
  2084. <member name="M:MiscUtil.IO.EndianBinaryReader.ReadInt32">
  2085. <summary>
  2086. Reads a 32-bit signed integer from the stream, using the bit converter
  2087. for this reader. 4 bytes are read.
  2088. </summary>
  2089. <returns>The 32-bit integer read</returns>
  2090. </member>
  2091. <member name="M:MiscUtil.IO.EndianBinaryReader.ReadInt64">
  2092. <summary>
  2093. Reads a 64-bit signed integer from the stream, using the bit converter
  2094. for this reader. 8 bytes are read.
  2095. </summary>
  2096. <returns>The 64-bit integer read</returns>
  2097. </member>
  2098. <member name="M:MiscUtil.IO.EndianBinaryReader.ReadUInt16">
  2099. <summary>
  2100. Reads a 16-bit unsigned integer from the stream, using the bit converter
  2101. for this reader. 2 bytes are read.
  2102. </summary>
  2103. <returns>The 16-bit unsigned integer read</returns>
  2104. </member>
  2105. <member name="M:MiscUtil.IO.EndianBinaryReader.ReadUInt32">
  2106. <summary>
  2107. Reads a 32-bit unsigned integer from the stream, using the bit converter
  2108. for this reader. 4 bytes are read.
  2109. </summary>
  2110. <returns>The 32-bit unsigned integer read</returns>
  2111. </member>
  2112. <member name="M:MiscUtil.IO.EndianBinaryReader.ReadUInt64">
  2113. <summary>
  2114. Reads a 64-bit unsigned integer from the stream, using the bit converter
  2115. for this reader. 8 bytes are read.
  2116. </summary>
  2117. <returns>The 64-bit unsigned integer read</returns>
  2118. </member>
  2119. <member name="M:MiscUtil.IO.EndianBinaryReader.ReadSingle">
  2120. <summary>
  2121. Reads a single-precision floating-point value from the stream, using the bit converter
  2122. for this reader. 4 bytes are read.
  2123. </summary>
  2124. <returns>The floating point value read</returns>
  2125. </member>
  2126. <member name="M:MiscUtil.IO.EndianBinaryReader.ReadDouble">
  2127. <summary>
  2128. Reads a double-precision floating-point value from the stream, using the bit converter
  2129. for this reader. 8 bytes are read.
  2130. </summary>
  2131. <returns>The floating point value read</returns>
  2132. </member>
  2133. <member name="M:MiscUtil.IO.EndianBinaryReader.ReadDecimal">
  2134. <summary>
  2135. Reads a decimal value from the stream, using the bit converter
  2136. for this reader. 16 bytes are read.
  2137. </summary>
  2138. <returns>The decimal value read</returns>
  2139. </member>
  2140. <member name="M:MiscUtil.IO.EndianBinaryReader.Read">
  2141. <summary>
  2142. Reads a single character from the stream, using the character encoding for
  2143. this reader. If no characters have been fully read by the time the stream ends,
  2144. -1 is returned.
  2145. </summary>
  2146. <returns>The character read, or -1 for end of stream.</returns>
  2147. </member>
  2148. <member name="M:MiscUtil.IO.EndianBinaryReader.Read(System.Char[],System.Int32,System.Int32)">
  2149. <summary>
  2150. Reads the specified number of characters into the given buffer, starting at
  2151. the given index.
  2152. </summary>
  2153. <param name="data">The buffer to copy data into</param>
  2154. <param name="index">The first index to copy data into</param>
  2155. <param name="count">The number of characters to read</param>
  2156. <returns>The number of characters actually read. This will only be less than
  2157. the requested number of characters if the end of the stream is reached.
  2158. </returns>
  2159. </member>
  2160. <member name="M:MiscUtil.IO.EndianBinaryReader.Read(System.Byte[],System.Int32,System.Int32)">
  2161. <summary>
  2162. Reads the specified number of bytes into the given buffer, starting at
  2163. the given index.
  2164. </summary>
  2165. <param name="buffer">The buffer to copy data into</param>
  2166. <param name="index">The first index to copy data into</param>
  2167. <param name="count">The number of bytes to read</param>
  2168. <returns>The number of bytes actually read. This will only be less than
  2169. the requested number of bytes if the end of the stream is reached.
  2170. </returns>
  2171. </member>
  2172. <member name="M:MiscUtil.IO.EndianBinaryReader.ReadBytes(System.Int32)">
  2173. <summary>
  2174. Reads the specified number of bytes, returning them in a new byte array.
  2175. If not enough bytes are available before the end of the stream, this
  2176. method will return what is available.
  2177. </summary>
  2178. <param name="count">The number of bytes to read</param>
  2179. <returns>The bytes read</returns>
  2180. </member>
  2181. <member name="M:MiscUtil.IO.EndianBinaryReader.ReadBytesOrThrow(System.Int32)">
  2182. <summary>
  2183. Reads the specified number of bytes, returning them in a new byte array.
  2184. If not enough bytes are available before the end of the stream, this
  2185. method will throw an IOException.
  2186. </summary>
  2187. <param name="count">The number of bytes to read</param>
  2188. <returns>The bytes read</returns>
  2189. </member>
  2190. <member name="M:MiscUtil.IO.EndianBinaryReader.Read7BitEncodedInt">
  2191. <summary>
  2192. Reads a 7-bit encoded integer from the stream. This is stored with the least significant
  2193. information first, with 7 bits of information per byte of value, and the top
  2194. bit as a continuation flag. This method is not affected by the endianness
  2195. of the bit converter.
  2196. </summary>
  2197. <returns>The 7-bit encoded integer read from the stream.</returns>
  2198. </member>
  2199. <member name="M:MiscUtil.IO.EndianBinaryReader.ReadBigEndian7BitEncodedInt">
  2200. <summary>
  2201. Reads a 7-bit encoded integer from the stream. This is stored with the most significant
  2202. information first, with 7 bits of information per byte of value, and the top
  2203. bit as a continuation flag. This method is not affected by the endianness
  2204. of the bit converter.
  2205. </summary>
  2206. <returns>The 7-bit encoded integer read from the stream.</returns>
  2207. </member>
  2208. <member name="M:MiscUtil.IO.EndianBinaryReader.ReadString">
  2209. <summary>
  2210. Reads a length-prefixed string from the stream, using the encoding for this reader.
  2211. A 7-bit encoded integer is first read, which specifies the number of bytes
  2212. to read from the stream. These bytes are then converted into a string with
  2213. the encoding for this reader.
  2214. </summary>
  2215. <returns>The string read from the stream.</returns>
  2216. </member>
  2217. <member name="M:MiscUtil.IO.EndianBinaryReader.CheckDisposed">
  2218. <summary>
  2219. Checks whether or not the reader has been disposed, throwing an exception if so.
  2220. </summary>
  2221. </member>
  2222. <member name="M:MiscUtil.IO.EndianBinaryReader.ReadInternal(System.Byte[],System.Int32)">
  2223. <summary>
  2224. Reads the given number of bytes from the stream, throwing an exception
  2225. if they can't all be read.
  2226. </summary>
  2227. <param name="data">Buffer to read into</param>
  2228. <param name="size">Number of bytes to read</param>
  2229. </member>
  2230. <member name="M:MiscUtil.IO.EndianBinaryReader.TryReadInternal(System.Byte[],System.Int32)">
  2231. <summary>
  2232. Reads the given number of bytes from the stream if possible, returning
  2233. the number of bytes actually read, which may be less than requested if
  2234. (and only if) the end of the stream is reached.
  2235. </summary>
  2236. <param name="data">Buffer to read into</param>
  2237. <param name="size">Number of bytes to read</param>
  2238. <returns>Number of bytes actually read</returns>
  2239. </member>
  2240. <member name="M:MiscUtil.IO.EndianBinaryReader.Dispose">
  2241. <summary>
  2242. Disposes of the underlying stream.
  2243. </summary>
  2244. </member>
  2245. <member name="T:MiscUtil.IO.EndianBinaryWriter">
  2246. <summary>
  2247. Equivalent of System.IO.BinaryWriter, but with either endianness, depending on
  2248. the EndianBitConverter it is constructed with.
  2249. </summary>
  2250. </member>
  2251. <member name="M:MiscUtil.IO.EndianBinaryWriter.#ctor(MiscUtil.Conversion.EndianBitConverter,System.IO.Stream)">
  2252. <summary>
  2253. Constructs a new binary writer with the given bit converter, writing
  2254. to the given stream, using UTF-8 encoding.
  2255. </summary>
  2256. <param name="bitConverter">Converter to use when writing data</param>
  2257. <param name="stream">Stream to write data to</param>
  2258. </member>
  2259. <member name="M:MiscUtil.IO.EndianBinaryWriter.#ctor(MiscUtil.Conversion.EndianBitConverter,System.IO.Stream,System.Text.Encoding)">
  2260. <summary>
  2261. Constructs a new binary writer with the given bit converter, writing
  2262. to the given stream, using the given encoding.
  2263. </summary>
  2264. <param name="bitConverter">Converter to use when writing data</param>
  2265. <param name="stream">Stream to write data to</param>
  2266. <param name="encoding">Encoding to use when writing character data</param>
  2267. </member>
  2268. <member name="F:MiscUtil.IO.EndianBinaryWriter.disposed">
  2269. <summary>
  2270. Whether or not this writer has been disposed yet.
  2271. </summary>
  2272. </member>
  2273. <member name="F:MiscUtil.IO.EndianBinaryWriter.buffer">
  2274. <summary>
  2275. Buffer used for temporary storage during conversion from primitives
  2276. </summary>
  2277. </member>
  2278. <member name="F:MiscUtil.IO.EndianBinaryWriter.charBuffer">
  2279. <summary>
  2280. Buffer used for Write(char)
  2281. </summary>
  2282. </member>
  2283. <member name="P:MiscUtil.IO.EndianBinaryWriter.BitConverter">
  2284. <summary>
  2285. The bit converter used to write values to the stream
  2286. </summary>
  2287. </member>
  2288. <member name="P:MiscUtil.IO.EndianBinaryWriter.Encoding">
  2289. <summary>
  2290. The encoding used to write strings
  2291. </summary>
  2292. </member>
  2293. <member name="P:MiscUtil.IO.EndianBinaryWriter.BaseStream">
  2294. <summary>
  2295. Gets the underlying stream of the EndianBinaryWriter.
  2296. </summary>
  2297. </member>
  2298. <member name="M:MiscUtil.IO.EndianBinaryWriter.Close">
  2299. <summary>
  2300. Closes the writer, including the underlying stream.
  2301. </summary>
  2302. </member>
  2303. <member name="M:MiscUtil.IO.EndianBinaryWriter.Flush">
  2304. <summary>
  2305. Flushes the underlying stream.
  2306. </summary>
  2307. </member>
  2308. <member name="M:MiscUtil.IO.EndianBinaryWriter.Seek(System.Int32,System.IO.SeekOrigin)">
  2309. <summary>
  2310. Seeks within the stream.
  2311. </summary>
  2312. <param name="offset">Offset to seek to.</param>
  2313. <param name="origin">Origin of seek operation.</param>
  2314. </member>
  2315. <member name="M:MiscUtil.IO.EndianBinaryWriter.Write(System.Boolean)">
  2316. <summary>
  2317. Writes a boolean value to the stream. 1 byte is written.
  2318. </summary>
  2319. <param name="value">The value to write</param>
  2320. </member>
  2321. <member name="M:MiscUtil.IO.EndianBinaryWriter.Write(System.Int16)">
  2322. <summary>
  2323. Writes a 16-bit signed integer to the stream, using the bit converter
  2324. for this writer. 2 bytes are written.
  2325. </summary>
  2326. <param name="value">The value to write</param>
  2327. </member>
  2328. <member name="M:MiscUtil.IO.EndianBinaryWriter.Write(System.Int32)">
  2329. <summary>
  2330. Writes a 32-bit signed integer to the stream, using the bit converter
  2331. for this writer. 4 bytes are written.
  2332. </summary>
  2333. <param name="value">The value to write</param>
  2334. </member>
  2335. <member name="M:MiscUtil.IO.EndianBinaryWriter.Write(System.Int64)">
  2336. <summary>
  2337. Writes a 64-bit signed integer to the stream, using the bit converter
  2338. for this writer. 8 bytes are written.
  2339. </summary>
  2340. <param name="value">The value to write</param>
  2341. </member>
  2342. <member name="M:MiscUtil.IO.EndianBinaryWriter.Write(System.UInt16)">
  2343. <summary>
  2344. Writes a 16-bit unsigned integer to the stream, using the bit converter
  2345. for this writer. 2 bytes are written.
  2346. </summary>
  2347. <param name="value">The value to write</param>
  2348. </member>
  2349. <member name="M:MiscUtil.IO.EndianBinaryWriter.Write(System.UInt32)">
  2350. <summary>
  2351. Writes a 32-bit unsigned integer to the stream, using the bit converter
  2352. for this writer. 4 bytes are written.
  2353. </summary>
  2354. <param name="value">The value to write</param>
  2355. </member>
  2356. <member name="M:MiscUtil.IO.EndianBinaryWriter.Write(System.UInt64)">
  2357. <summary>
  2358. Writes a 64-bit unsigned integer to the stream, using the bit converter
  2359. for this writer. 8 bytes are written.
  2360. </summary>
  2361. <param name="value">The value to write</param>
  2362. </member>
  2363. <member name="M:MiscUtil.IO.EndianBinaryWriter.Write(System.Single)">
  2364. <summary>
  2365. Writes a single-precision floating-point value to the stream, using the bit converter
  2366. for this writer. 4 bytes are written.
  2367. </summary>
  2368. <param name="value">The value to write</param>
  2369. </member>
  2370. <member name="M:MiscUtil.IO.EndianBinaryWriter.Write(System.Double)">
  2371. <summary>
  2372. Writes a double-precision floating-point value to the stream, using the bit converter
  2373. for this writer. 8 bytes are written.
  2374. </summary>
  2375. <param name="value">The value to write</param>
  2376. </member>
  2377. <member name="M:MiscUtil.IO.EndianBinaryWriter.Write(System.Decimal)">
  2378. <summary>
  2379. Writes a decimal value to the stream, using the bit converter for this writer.
  2380. 16 bytes are written.
  2381. </summary>
  2382. <param name="value">The value to write</param>
  2383. </member>
  2384. <member name="M:MiscUtil.IO.EndianBinaryWriter.Write(System.Byte)">
  2385. <summary>
  2386. Writes a signed byte to the stream.
  2387. </summary>
  2388. <param name="value">The value to write</param>
  2389. </member>
  2390. <member name="M:MiscUtil.IO.EndianBinaryWriter.Write(System.SByte)">
  2391. <summary>
  2392. Writes an unsigned byte to the stream.
  2393. </summary>
  2394. <param name="value">The value to write</param>
  2395. </member>
  2396. <member name="M:MiscUtil.IO.EndianBinaryWriter.Write(System.Byte[])">
  2397. <summary>
  2398. Writes an array of bytes to the stream.
  2399. </summary>
  2400. <param name="value">The values to write</param>
  2401. </member>
  2402. <member name="M:MiscUtil.IO.EndianBinaryWriter.Write(System.Byte[],System.Int32,System.Int32)">
  2403. <summary>
  2404. Writes a portion of an array of bytes to the stream.
  2405. </summary>
  2406. <param name="value">An array containing the bytes to write</param>
  2407. <param name="offset">The index of the first byte to write within the array</param>
  2408. <param name="count">The number of bytes to write</param>
  2409. </member>
  2410. <member name="M:MiscUtil.IO.EndianBinaryWriter.Write(System.Char)">
  2411. <summary>
  2412. Writes a single character to the stream, using the encoding for this writer.
  2413. </summary>
  2414. <param name="value">The value to write</param>
  2415. </member>
  2416. <member name="M:MiscUtil.IO.EndianBinaryWriter.Write(System.Char[])">
  2417. <summary>
  2418. Writes an array of characters to the stream, using the encoding for this writer.
  2419. </summary>
  2420. <param name="value">An array containing the characters to write</param>
  2421. </member>
  2422. <member name="M:MiscUtil.IO.EndianBinaryWriter.Write(System.String)">
  2423. <summary>
  2424. Writes a string to the stream, using the encoding for this writer.
  2425. </summary>
  2426. <param name="value">The value to write. Must not be null.</param>
  2427. <exception cref="T:System.ArgumentNullException">value is null</exception>
  2428. </member>
  2429. <member name="M:MiscUtil.IO.EndianBinaryWriter.Write7BitEncodedInt(System.Int32)">
  2430. <summary>
  2431. Writes a 7-bit encoded integer from the stream. This is stored with the least significant
  2432. information first, with 7 bits of information per byte of value, and the top
  2433. bit as a continuation flag.
  2434. </summary>
  2435. <param name="value">The 7-bit encoded integer to write to the stream</param>
  2436. </member>
  2437. <member name="M:MiscUtil.IO.EndianBinaryWriter.CheckDisposed">
  2438. <summary>
  2439. Checks whether or not the writer has been disposed, throwing an exception if so.
  2440. </summary>
  2441. </member>
  2442. <member name="M:MiscUtil.IO.EndianBinaryWriter.WriteInternal(System.Byte[],System.Int32)">
  2443. <summary>
  2444. Writes the specified number of bytes from the start of the given byte array,
  2445. after checking whether or not the writer has been disposed.
  2446. </summary>
  2447. <param name="bytes">The array of bytes to write from</param>
  2448. <param name="length">The number of bytes to write</param>
  2449. </member>
  2450. <member name="M:MiscUtil.IO.EndianBinaryWriter.Dispose">
  2451. <summary>
  2452. Disposes of the underlying stream.
  2453. </summary>
  2454. </member>
  2455. <member name="T:MiscUtil.Conversion.BigEndianBitConverter">
  2456. <summary>
  2457. Implementation of EndianBitConverter which converts to/from big-endian
  2458. byte arrays.
  2459. </summary>
  2460. </member>
  2461. <member name="P:MiscUtil.Conversion.BigEndianBitConverter.Endianness">
  2462. <summary>
  2463. Indicates the byte order ("endianess") in which data is converted using this class.
  2464. </summary>
  2465. </member>
  2466. <member name="M:MiscUtil.Conversion.BigEndianBitConverter.IsLittleEndian">
  2467. <summary>
  2468. Indicates the byte order ("endianess") in which data is converted using this class.
  2469. </summary>
  2470. <remarks>
  2471. Different computer architectures store data using different byte orders. "Big-endian"
  2472. means the most significant byte is on the left end of a word. "Little-endian" means the
  2473. most significant byte is on the right end of a word.
  2474. </remarks>
  2475. <returns>true if this converter is little-endian, false otherwise.</returns>
  2476. </member>
  2477. <member name="M:MiscUtil.Conversion.BigEndianBitConverter.CopyBytesImpl(System.Int64,System.Int32,System.Byte[],System.Int32)">
  2478. <summary>
  2479. Copies the specified number of bytes from value to buffer, starting at index.
  2480. </summary>
  2481. <param name="value">The value to copy</param>
  2482. <param name="bytes">The number of bytes to copy</param>
  2483. <param name="buffer">The buffer to copy the bytes into</param>
  2484. <param name="index">The index to start at</param>
  2485. </member>
  2486. <member name="M:MiscUtil.Conversion.BigEndianBitConverter.FromBytes(System.Byte[],System.Int32,System.Int32)">
  2487. <summary>
  2488. Returns a value built from the specified number of bytes from the given buffer,
  2489. starting at index.
  2490. </summary>
  2491. <param name="buffer">The data in byte array format</param>
  2492. <param name="startIndex">The first index to use</param>
  2493. <param name="bytesToConvert">The number of bytes to use</param>
  2494. <returns>The value built from the given bytes</returns>
  2495. </member>
  2496. <member name="T:MiscUtil.Conversion.DoubleConverter">
  2497. <summary>
  2498. A class to allow the conversion of doubles to string representations of
  2499. their exact decimal values. The implementation aims for readability over
  2500. efficiency.
  2501. </summary>
  2502. </member>
  2503. <member name="T:MiscUtil.Conversion.DoubleConverter.ArbitraryDecimal">
  2504. <summary>
  2505. Private class used for manipulating sequences of decimal digits.
  2506. </summary>
  2507. </member>
  2508. <member name="M:MiscUtil.Conversion.DoubleConverter.ArbitraryDecimal.#ctor(System.Int64)">
  2509. <summary>
  2510. Constructs an arbitrary decimal expansion from the given long.
  2511. The long must not be negative.
  2512. </summary>
  2513. </member>
  2514. <member name="F:MiscUtil.Conversion.DoubleConverter.ArbitraryDecimal.digits">
  2515. <summary>Digits in the decimal expansion, one byte per digit</summary>
  2516. </member>
  2517. <member name="F:MiscUtil.Conversion.DoubleConverter.ArbitraryDecimal.decimalPoint">
  2518. <summary>
  2519. How many digits are *after* the decimal point
  2520. </summary>
  2521. </member>
  2522. <member name="M:MiscUtil.Conversion.DoubleConverter.ArbitraryDecimal.MultiplyBy(System.Int32)">
  2523. <summary>
  2524. Multiplies the current expansion by the given amount, which should
  2525. only be 2 or 5.
  2526. </summary>
  2527. </member>
  2528. <member name="M:MiscUtil.Conversion.DoubleConverter.ArbitraryDecimal.Shift(System.Int32)">
  2529. <summary>
  2530. Shifts the decimal point; a negative value makes
  2531. the decimal expansion bigger (as fewer digits come after the
  2532. decimal place) and a positive value makes the decimal
  2533. expansion smaller.
  2534. </summary>
  2535. </member>
  2536. <member name="M:MiscUtil.Conversion.DoubleConverter.ArbitraryDecimal.Normalize">
  2537. <summary>
  2538. Removes leading/trailing zeroes from the expansion.
  2539. </summary>
  2540. </member>
  2541. <member name="M:MiscUtil.Conversion.DoubleConverter.ArbitraryDecimal.ToString">
  2542. <summary>
  2543. Converts the value to a proper decimal string representation.
  2544. </summary>
  2545. </member>
  2546. <member name="M:MiscUtil.Conversion.DoubleConverter.ToExactString(System.Double)">
  2547. <summary>
  2548. Converts the given double to a string representation of its
  2549. exact decimal value.
  2550. </summary>
  2551. <param name="d">The double to convert.</param>
  2552. <returns>A string representation of the double's exact decimal value.</returns>
  2553. </member>
  2554. <member name="T:MiscUtil.Conversion.EndianBitConverter">
  2555. <summary>
  2556. Equivalent of System.BitConverter, but with either endianness.
  2557. </summary>
  2558. </member>
  2559. <member name="T:MiscUtil.Conversion.EndianBitConverter.Int32SingleUnion">
  2560. <summary>
  2561. Union used solely for the equivalent of DoubleToInt64Bits and vice versa.
  2562. </summary>
  2563. </member>
  2564. <member name="M:MiscUtil.Conversion.EndianBitConverter.Int32SingleUnion.#ctor(System.Int32)">
  2565. <summary>
  2566. Creates an instance representing the given integer.
  2567. </summary>
  2568. <param name="i">The integer value of the new instance.</param>
  2569. </member>
  2570. <member name="M:MiscUtil.Conversion.EndianBitConverter.Int32SingleUnion.#ctor(System.Single)">
  2571. <summary>
  2572. Creates an instance representing the given floating point number.
  2573. </summary>
  2574. <param name="f">The floating point value of the new instance.</param>
  2575. </member>
  2576. <member name="F:MiscUtil.Conversion.EndianBitConverter.Int32SingleUnion.i">
  2577. <summary>
  2578. Int32 version of the value.
  2579. </summary>
  2580. </member>
  2581. <member name="F:MiscUtil.Conversion.EndianBitConverter.Int32SingleUnion.f">
  2582. <summary>
  2583. Single version of the value.
  2584. </summary>
  2585. </member>
  2586. <member name="P:MiscUtil.Conversion.EndianBitConverter.Int32SingleUnion.AsInt32">
  2587. <summary>
  2588. Returns the value of the instance as an integer.
  2589. </summary>
  2590. </member>
  2591. <member name="P:MiscUtil.Conversion.EndianBitConverter.Int32SingleUnion.AsSingle">
  2592. <summary>
  2593. Returns the value of the instance as a floating point number.
  2594. </summary>
  2595. </member>
  2596. <member name="P:MiscUtil.Conversion.EndianBitConverter.Endianness">
  2597. <summary>
  2598. Indicates the byte order ("endianess") in which data is converted using this class.
  2599. </summary>
  2600. </member>
  2601. <member name="P:MiscUtil.Conversion.EndianBitConverter.Little">
  2602. <summary>
  2603. Returns a little-endian bit converter instance. The same instance is
  2604. always returned.
  2605. </summary>
  2606. </member>
  2607. <member name="P:MiscUtil.Conversion.EndianBitConverter.Big">
  2608. <summary>
  2609. Returns a big-endian bit converter instance. The same instance is
  2610. always returned.
  2611. </summary>
  2612. </member>
  2613. <member name="M:MiscUtil.Conversion.EndianBitConverter.IsLittleEndian">
  2614. <summary>
  2615. Indicates the byte order ("endianess") in which data is converted using this class.
  2616. </summary>
  2617. <remarks>
  2618. Different computer architectures store data using different byte orders. "Big-endian"
  2619. means the most significant byte is on the left end of a word. "Little-endian" means the
  2620. most significant byte is on the right end of a word.
  2621. </remarks>
  2622. <returns>true if this converter is little-endian, false otherwise.</returns>
  2623. </member>
  2624. <member name="M:MiscUtil.Conversion.EndianBitConverter.DoubleToInt64Bits(System.Double)">
  2625. <summary>
  2626. Converts the specified double-precision floating point number to a
  2627. 64-bit signed integer. Note: the endianness of this converter does not
  2628. affect the returned value.
  2629. </summary>
  2630. <param name="value">The number to convert. </param>
  2631. <returns>A 64-bit signed integer whose value is equivalent to value.</returns>
  2632. </member>
  2633. <member name="M:MiscUtil.Conversion.EndianBitConverter.Int64BitsToDouble(System.Int64)">
  2634. <summary>
  2635. Converts the specified 64-bit signed integer to a double-precision
  2636. floating point number. Note: the endianness of this converter does not
  2637. affect the returned value.
  2638. </summary>
  2639. <param name="value">The number to convert. </param>
  2640. <returns>A double-precision floating point number whose value is equivalent to value.</returns>
  2641. </member>
  2642. <member name="M:MiscUtil.Conversion.EndianBitConverter.SingleToInt32Bits(System.Single)">
  2643. <summary>
  2644. Converts the specified single-precision floating point number to a
  2645. 32-bit signed integer. Note: the endianness of this converter does not
  2646. affect the returned value.
  2647. </summary>
  2648. <param name="value">The number to convert. </param>
  2649. <returns>A 32-bit signed integer whose value is equivalent to value.</returns>
  2650. </member>
  2651. <member name="M:MiscUtil.Conversion.EndianBitConverter.Int32BitsToSingle(System.Int32)">
  2652. <summary>
  2653. Converts the specified 32-bit signed integer to a single-precision floating point
  2654. number. Note: the endianness of this converter does not
  2655. affect the returned value.
  2656. </summary>
  2657. <param name="value">The number to convert. </param>
  2658. <returns>A single-precision floating point number whose value is equivalent to value.</returns>
  2659. </member>
  2660. <member name="M:MiscUtil.Conversion.EndianBitConverter.ToBoolean(System.Byte[],System.Int32)">
  2661. <summary>
  2662. Returns a Boolean value converted from one byte at a specified position in a byte array.
  2663. </summary>
  2664. <param name="value">An array of bytes.</param>
  2665. <param name="startIndex">The starting position within value.</param>
  2666. <returns>true if the byte at startIndex in value is nonzero; otherwise, false.</returns>
  2667. </member>
  2668. <member name="M:MiscUtil.Conversion.EndianBitConverter.ToChar(System.Byte[],System.Int32)">
  2669. <summary>
  2670. Returns a Unicode character converted from two bytes at a specified position in a byte array.
  2671. </summary>
  2672. <param name="value">An array of bytes.</param>
  2673. <param name="startIndex">The starting position within value.</param>
  2674. <returns>A character formed by two bytes beginning at startIndex.</returns>
  2675. </member>
  2676. <member name="M:MiscUtil.Conversion.EndianBitConverter.ToDouble(System.Byte[],System.Int32)">
  2677. <summary>
  2678. Returns a double-precision floating point number converted from eight bytes
  2679. at a specified position in a byte array.
  2680. </summary>
  2681. <param name="value">An array of bytes.</param>
  2682. <param name="startIndex">The starting position within value.</param>
  2683. <returns>A double precision floating point number formed by eight bytes beginning at startIndex.</returns>
  2684. </member>
  2685. <member name="M:MiscUtil.Conversion.EndianBitConverter.ToSingle(System.Byte[],System.Int32)">
  2686. <summary>
  2687. Returns a single-precision floating point number converted from four bytes
  2688. at a specified position in a byte array.
  2689. </summary>
  2690. <param name="value">An array of bytes.</param>
  2691. <param name="startIndex">The starting position within value.</param>
  2692. <returns>A single precision floating point number formed by four bytes beginning at startIndex.</returns>
  2693. </member>
  2694. <member name="M:MiscUtil.Conversion.EndianBitConverter.ToInt16(System.Byte[],System.Int32)">
  2695. <summary>
  2696. Returns a 16-bit signed integer converted from two bytes at a specified position in a byte array.
  2697. </summary>
  2698. <param name="value">An array of bytes.</param>
  2699. <param name="startIndex">The starting position within value.</param>
  2700. <returns>A 16-bit signed integer formed by two bytes beginning at startIndex.</returns>
  2701. </member>
  2702. <member name="M:MiscUtil.Conversion.EndianBitConverter.ToInt32(System.Byte[],System.Int32)">
  2703. <summary>
  2704. Returns a 32-bit signed integer converted from four bytes at a specified position in a byte array.
  2705. </summary>
  2706. <param name="value">An array of bytes.</param>
  2707. <param name="startIndex">The starting position within value.</param>
  2708. <returns>A 32-bit signed integer formed by four bytes beginning at startIndex.</returns>
  2709. </member>
  2710. <member name="M:MiscUtil.Conversion.EndianBitConverter.ToInt64(System.Byte[],System.Int32)">
  2711. <summary>
  2712. Returns a 64-bit signed integer converted from eight bytes at a specified position in a byte array.
  2713. </summary>
  2714. <param name="value">An array of bytes.</param>
  2715. <param name="startIndex">The starting position within value.</param>
  2716. <returns>A 64-bit signed integer formed by eight bytes beginning at startIndex.</returns>
  2717. </member>
  2718. <member name="M:MiscUtil.Conversion.EndianBitConverter.ToUInt16(System.Byte[],System.Int32)">
  2719. <summary>
  2720. Returns a 16-bit unsigned integer converted from two bytes at a specified position in a byte array.
  2721. </summary>
  2722. <param name="value">An array of bytes.</param>
  2723. <param name="startIndex">The starting position within value.</param>
  2724. <returns>A 16-bit unsigned integer formed by two bytes beginning at startIndex.</returns>
  2725. </member>
  2726. <member name="M:MiscUtil.Conversion.EndianBitConverter.ToUInt32(System.Byte[],System.Int32)">
  2727. <summary>
  2728. Returns a 32-bit unsigned integer converted from four bytes at a specified position in a byte array.
  2729. </summary>
  2730. <param name="value">An array of bytes.</param>
  2731. <param name="startIndex">The starting position within value.</param>
  2732. <returns>A 32-bit unsigned integer formed by four bytes beginning at startIndex.</returns>
  2733. </member>
  2734. <member name="M:MiscUtil.Conversion.EndianBitConverter.ToUInt64(System.Byte[],System.Int32)">
  2735. <summary>
  2736. Returns a 64-bit unsigned integer converted from eight bytes at a specified position in a byte array.
  2737. </summary>
  2738. <param name="value">An array of bytes.</param>
  2739. <param name="startIndex">The starting position within value.</param>
  2740. <returns>A 64-bit unsigned integer formed by eight bytes beginning at startIndex.</returns>
  2741. </member>
  2742. <member name="M:MiscUtil.Conversion.EndianBitConverter.CheckByteArgument(System.Byte[],System.Int32,System.Int32)">
  2743. <summary>
  2744. Checks the given argument for validity.
  2745. </summary>
  2746. <param name="value">The byte array passed in</param>
  2747. <param name="startIndex">The start index passed in</param>
  2748. <param name="bytesRequired">The number of bytes required</param>
  2749. <exception cref="T:System.ArgumentNullException">value is a null reference</exception>
  2750. <exception cref="T:System.ArgumentOutOfRangeException">
  2751. startIndex is less than zero or greater than the length of value minus bytesRequired.
  2752. </exception>
  2753. </member>
  2754. <member name="M:MiscUtil.Conversion.EndianBitConverter.CheckedFromBytes(System.Byte[],System.Int32,System.Int32)">
  2755. <summary>
  2756. Checks the arguments for validity before calling FromBytes
  2757. (which can therefore assume the arguments are valid).
  2758. </summary>
  2759. <param name="value">The bytes to convert after checking</param>
  2760. <param name="startIndex">The index of the first byte to convert</param>
  2761. <param name="bytesToConvert">The number of bytes to convert</param>
  2762. <returns>
  2763. </returns>
  2764. </member>
  2765. <member name="M:MiscUtil.Conversion.EndianBitConverter.FromBytes(System.Byte[],System.Int32,System.Int32)">
  2766. <summary>
  2767. Convert the given number of bytes from the given array, from the given start
  2768. position, into a long, using the bytes as the least significant part of the long.
  2769. By the time this is called, the arguments have been checked for validity.
  2770. </summary>
  2771. <param name="value">The bytes to convert</param>
  2772. <param name="startIndex">The index of the first byte to convert</param>
  2773. <param name="bytesToConvert">The number of bytes to use in the conversion</param>
  2774. <returns>The converted number</returns>
  2775. </member>
  2776. <member name="M:MiscUtil.Conversion.EndianBitConverter.ToString(System.Byte[])">
  2777. <summary>
  2778. Returns a String converted from the elements of a byte array.
  2779. </summary>
  2780. <param name="value">An array of bytes.</param>
  2781. <remarks>All the elements of value are converted.</remarks>
  2782. <returns>
  2783. A String of hexadecimal pairs separated by hyphens, where each pair
  2784. represents the corresponding element in value; for example, "7F-2C-4A".
  2785. </returns>
  2786. </member>
  2787. <member name="M:MiscUtil.Conversion.EndianBitConverter.ToString(System.Byte[],System.Int32)">
  2788. <summary>
  2789. Returns a String converted from the elements of a byte array starting at a specified array position.
  2790. </summary>
  2791. <param name="value">An array of bytes.</param>
  2792. <param name="startIndex">The starting position within value.</param>
  2793. <remarks>The elements from array position startIndex to the end of the array are converted.</remarks>
  2794. <returns>
  2795. A String of hexadecimal pairs separated by hyphens, where each pair
  2796. represents the corresponding element in value; for example, "7F-2C-4A".
  2797. </returns>
  2798. </member>
  2799. <member name="M:MiscUtil.Conversion.EndianBitConverter.ToString(System.Byte[],System.Int32,System.Int32)">
  2800. <summary>
  2801. Returns a String converted from a specified number of bytes at a specified position in a byte array.
  2802. </summary>
  2803. <param name="value">An array of bytes.</param>
  2804. <param name="startIndex">The starting position within value.</param>
  2805. <param name="length">The number of bytes to convert.</param>
  2806. <remarks>The length elements from array position startIndex are converted.</remarks>
  2807. <returns>
  2808. A String of hexadecimal pairs separated by hyphens, where each pair
  2809. represents the corresponding element in value; for example, "7F-2C-4A".
  2810. </returns>
  2811. </member>
  2812. <member name="M:MiscUtil.Conversion.EndianBitConverter.ToDecimal(System.Byte[],System.Int32)">
  2813. <summary>
  2814. Returns a decimal value converted from sixteen bytes
  2815. at a specified position in a byte array.
  2816. </summary>
  2817. <param name="value">An array of bytes.</param>
  2818. <param name="startIndex">The starting position within value.</param>
  2819. <returns>A decimal formed by sixteen bytes beginning at startIndex.</returns>
  2820. </member>
  2821. <member name="M:MiscUtil.Conversion.EndianBitConverter.GetBytes(System.Decimal)">
  2822. <summary>
  2823. Returns the specified decimal value as an array of bytes.
  2824. </summary>
  2825. <param name="value">The number to convert.</param>
  2826. <returns>An array of bytes with length 16.</returns>
  2827. </member>
  2828. <member name="M:MiscUtil.Conversion.EndianBitConverter.CopyBytes(System.Decimal,System.Byte[],System.Int32)">
  2829. <summary>
  2830. Copies the specified decimal value into the specified byte array,
  2831. beginning at the specified index.
  2832. </summary>
  2833. <param name="value">A character to convert.</param>
  2834. <param name="buffer">The byte array to copy the bytes into</param>
  2835. <param name="index">The first index into the array to copy the bytes into</param>
  2836. </member>
  2837. <member name="M:MiscUtil.Conversion.EndianBitConverter.GetBytes(System.Int64,System.Int32)">
  2838. <summary>
  2839. Returns an array with the given number of bytes formed
  2840. from the least significant bytes of the specified value.
  2841. This is used to implement the other GetBytes methods.
  2842. </summary>
  2843. <param name="value">The value to get bytes for</param>
  2844. <param name="bytes">The number of significant bytes to return</param>
  2845. </member>
  2846. <member name="M:MiscUtil.Conversion.EndianBitConverter.GetBytes(System.Boolean)">
  2847. <summary>
  2848. Returns the specified Boolean value as an array of bytes.
  2849. </summary>
  2850. <param name="value">A Boolean value.</param>
  2851. <returns>An array of bytes with length 1.</returns>
  2852. </member>
  2853. <member name="M:MiscUtil.Conversion.EndianBitConverter.GetBytes(System.Char)">
  2854. <summary>
  2855. Returns the specified Unicode character value as an array of bytes.
  2856. </summary>
  2857. <param name="value">A character to convert.</param>
  2858. <returns>An array of bytes with length 2.</returns>
  2859. </member>
  2860. <member name="M:MiscUtil.Conversion.EndianBitConverter.GetBytes(System.Double)">
  2861. <summary>
  2862. Returns the specified double-precision floating point value as an array of bytes.
  2863. </summary>
  2864. <param name="value">The number to convert.</param>
  2865. <returns>An array of bytes with length 8.</returns>
  2866. </member>
  2867. <member name="M:MiscUtil.Conversion.EndianBitConverter.GetBytes(System.Int16)">
  2868. <summary>
  2869. Returns the specified 16-bit signed integer value as an array of bytes.
  2870. </summary>
  2871. <param name="value">The number to convert.</param>
  2872. <returns>An array of bytes with length 2.</returns>
  2873. </member>
  2874. <member name="M:MiscUtil.Conversion.EndianBitConverter.GetBytes(System.Int32)">
  2875. <summary>
  2876. Returns the specified 32-bit signed integer value as an array of bytes.
  2877. </summary>
  2878. <param name="value">The number to convert.</param>
  2879. <returns>An array of bytes with length 4.</returns>
  2880. </member>
  2881. <member name="M:MiscUtil.Conversion.EndianBitConverter.GetBytes(System.Int64)">
  2882. <summary>
  2883. Returns the specified 64-bit signed integer value as an array of bytes.
  2884. </summary>
  2885. <param name="value">The number to convert.</param>
  2886. <returns>An array of bytes with length 8.</returns>
  2887. </member>
  2888. <member name="M:MiscUtil.Conversion.EndianBitConverter.GetBytes(System.Single)">
  2889. <summary>
  2890. Returns the specified single-precision floating point value as an array of bytes.
  2891. </summary>
  2892. <param name="value">The number to convert.</param>
  2893. <returns>An array of bytes with length 4.</returns>
  2894. </member>
  2895. <member name="M:MiscUtil.Conversion.EndianBitConverter.GetBytes(System.UInt16)">
  2896. <summary>
  2897. Returns the specified 16-bit unsigned integer value as an array of bytes.
  2898. </summary>
  2899. <param name="value">The number to convert.</param>
  2900. <returns>An array of bytes with length 2.</returns>
  2901. </member>
  2902. <member name="M:MiscUtil.Conversion.EndianBitConverter.GetBytes(System.UInt32)">
  2903. <summary>
  2904. Returns the specified 32-bit unsigned integer value as an array of bytes.
  2905. </summary>
  2906. <param name="value">The number to convert.</param>
  2907. <returns>An array of bytes with length 4.</returns>
  2908. </member>
  2909. <member name="M:MiscUtil.Conversion.EndianBitConverter.GetBytes(System.UInt64)">
  2910. <summary>
  2911. Returns the specified 64-bit unsigned integer value as an array of bytes.
  2912. </summary>
  2913. <param name="value">The number to convert.</param>
  2914. <returns>An array of bytes with length 8.</returns>
  2915. </member>
  2916. <member name="M:MiscUtil.Conversion.EndianBitConverter.CopyBytes(System.Int64,System.Int32,System.Byte[],System.Int32)">
  2917. <summary>
  2918. Copies the given number of bytes from the least-specific
  2919. end of the specified value into the specified byte array, beginning
  2920. at the specified index.
  2921. This is used to implement the other CopyBytes methods.
  2922. </summary>
  2923. <param name="value">The value to copy bytes for</param>
  2924. <param name="bytes">The number of significant bytes to copy</param>
  2925. <param name="buffer">The byte array to copy the bytes into</param>
  2926. <param name="index">The first index into the array to copy the bytes into</param>
  2927. </member>
  2928. <member name="M:MiscUtil.Conversion.EndianBitConverter.CopyBytesImpl(System.Int64,System.Int32,System.Byte[],System.Int32)">
  2929. <summary>
  2930. Copies the given number of bytes from the least-specific
  2931. end of the specified value into the specified byte array, beginning
  2932. at the specified index.
  2933. This must be implemented in concrete derived classes, but the implementation
  2934. may assume that the value will fit into the buffer.
  2935. </summary>
  2936. <param name="value">The value to copy bytes for</param>
  2937. <param name="bytes">The number of significant bytes to copy</param>
  2938. <param name="buffer">The byte array to copy the bytes into</param>
  2939. <param name="index">The first index into the array to copy the bytes into</param>
  2940. </member>
  2941. <member name="M:MiscUtil.Conversion.EndianBitConverter.CopyBytes(System.Boolean,System.Byte[],System.Int32)">
  2942. <summary>
  2943. Copies the specified Boolean value into the specified byte array,
  2944. beginning at the specified index.
  2945. </summary>
  2946. <param name="value">A Boolean value.</param>
  2947. <param name="buffer">The byte array to copy the bytes into</param>
  2948. <param name="index">The first index into the array to copy the bytes into</param>
  2949. </member>
  2950. <member name="M:MiscUtil.Conversion.EndianBitConverter.CopyBytes(System.Char,System.Byte[],System.Int32)">
  2951. <summary>
  2952. Copies the specified Unicode character value into the specified byte array,
  2953. beginning at the specified index.
  2954. </summary>
  2955. <param name="value">A character to convert.</param>
  2956. <param name="buffer">The byte array to copy the bytes into</param>
  2957. <param name="index">The first index into the array to copy the bytes into</param>
  2958. </member>
  2959. <member name="M:MiscUtil.Conversion.EndianBitConverter.CopyBytes(System.Double,System.Byte[],System.Int32)">
  2960. <summary>
  2961. Copies the specified double-precision floating point value into the specified byte array,
  2962. beginning at the specified index.
  2963. </summary>
  2964. <param name="value">The number to convert.</param>
  2965. <param name="buffer">The byte array to copy the bytes into</param>
  2966. <param name="index">The first index into the array to copy the bytes into</param>
  2967. </member>
  2968. <member name="M:MiscUtil.Conversion.EndianBitConverter.CopyBytes(System.Int16,System.Byte[],System.Int32)">
  2969. <summary>
  2970. Copies the specified 16-bit signed integer value into the specified byte array,
  2971. beginning at the specified index.
  2972. </summary>
  2973. <param name="value">The number to convert.</param>
  2974. <param name="buffer">The byte array to copy the bytes into</param>
  2975. <param name="index">The first index into the array to copy the bytes into</param>
  2976. </member>
  2977. <member name="M:MiscUtil.Conversion.EndianBitConverter.CopyBytes(System.Int32,System.Byte[],System.Int32)">
  2978. <summary>
  2979. Copies the specified 32-bit signed integer value into the specified byte array,
  2980. beginning at the specified index.
  2981. </summary>
  2982. <param name="value">The number to convert.</param>
  2983. <param name="buffer">The byte array to copy the bytes into</param>
  2984. <param name="index">The first index into the array to copy the bytes into</param>
  2985. </member>
  2986. <member name="M:MiscUtil.Conversion.EndianBitConverter.CopyBytes(System.Int64,System.Byte[],System.Int32)">
  2987. <summary>
  2988. Copies the specified 64-bit signed integer value into the specified byte array,
  2989. beginning at the specified index.
  2990. </summary>
  2991. <param name="value">The number to convert.</param>
  2992. <param name="buffer">The byte array to copy the bytes into</param>
  2993. <param name="index">The first index into the array to copy the bytes into</param>
  2994. </member>
  2995. <member name="M:MiscUtil.Conversion.EndianBitConverter.CopyBytes(System.Single,System.Byte[],System.Int32)">
  2996. <summary>
  2997. Copies the specified single-precision floating point value into the specified byte array,
  2998. beginning at the specified index.
  2999. </summary>
  3000. <param name="value">The number to convert.</param>
  3001. <param name="buffer">The byte array to copy the bytes into</param>
  3002. <param name="index">The first index into the array to copy the bytes into</param>
  3003. </member>
  3004. <member name="M:MiscUtil.Conversion.EndianBitConverter.CopyBytes(System.UInt16,System.Byte[],System.Int32)">
  3005. <summary>
  3006. Copies the specified 16-bit unsigned integer value into the specified byte array,
  3007. beginning at the specified index.
  3008. </summary>
  3009. <param name="value">The number to convert.</param>
  3010. <param name="buffer">The byte array to copy the bytes into</param>
  3011. <param name="index">The first index into the array to copy the bytes into</param>
  3012. </member>
  3013. <member name="M:MiscUtil.Conversion.EndianBitConverter.CopyBytes(System.UInt32,System.Byte[],System.Int32)">
  3014. <summary>
  3015. Copies the specified 32-bit unsigned integer value into the specified byte array,
  3016. beginning at the specified index.
  3017. </summary>
  3018. <param name="value">The number to convert.</param>
  3019. <param name="buffer">The byte array to copy the bytes into</param>
  3020. <param name="index">The first index into the array to copy the bytes into</param>
  3021. </member>
  3022. <member name="M:MiscUtil.Conversion.EndianBitConverter.CopyBytes(System.UInt64,System.Byte[],System.Int32)">
  3023. <summary>
  3024. Copies the specified 64-bit unsigned integer value into the specified byte array,
  3025. beginning at the specified index.
  3026. </summary>
  3027. <param name="value">The number to convert.</param>
  3028. <param name="buffer">The byte array to copy the bytes into</param>
  3029. <param name="index">The first index into the array to copy the bytes into</param>
  3030. </member>
  3031. <member name="T:MiscUtil.Conversion.Endianness">
  3032. <summary>
  3033. Endianness of a converter
  3034. </summary>
  3035. </member>
  3036. <member name="F:MiscUtil.Conversion.Endianness.LittleEndian">
  3037. <summary>
  3038. Little endian - least significant byte first
  3039. </summary>
  3040. </member>
  3041. <member name="F:MiscUtil.Conversion.Endianness.BigEndian">
  3042. <summary>
  3043. Big endian - most significant byte first
  3044. </summary>
  3045. </member>
  3046. <member name="T:MiscUtil.Conversion.LittleEndianBitConverter">
  3047. <summary>
  3048. Implementation of EndianBitConverter which converts to/from little-endian
  3049. byte arrays.
  3050. </summary>
  3051. </member>
  3052. <member name="P:MiscUtil.Conversion.LittleEndianBitConverter.Endianness">
  3053. <summary>
  3054. Indicates the byte order ("endianess") in which data is converted using this class.
  3055. </summary>
  3056. </member>
  3057. <member name="M:MiscUtil.Conversion.LittleEndianBitConverter.IsLittleEndian">
  3058. <summary>
  3059. Indicates the byte order ("endianess") in which data is converted using this class.
  3060. </summary>
  3061. <remarks>
  3062. Different computer architectures store data using different byte orders. "Big-endian"
  3063. means the most significant byte is on the left end of a word. "Little-endian" means the
  3064. most significant byte is on the right end of a word.
  3065. </remarks>
  3066. <returns>true if this converter is little-endian, false otherwise.</returns>
  3067. </member>
  3068. <member name="M:MiscUtil.Conversion.LittleEndianBitConverter.CopyBytesImpl(System.Int64,System.Int32,System.Byte[],System.Int32)">
  3069. <summary>
  3070. Copies the specified number of bytes from value to buffer, starting at index.
  3071. </summary>
  3072. <param name="value">The value to copy</param>
  3073. <param name="bytes">The number of bytes to copy</param>
  3074. <param name="buffer">The buffer to copy the bytes into</param>
  3075. <param name="index">The index to start at</param>
  3076. </member>
  3077. <member name="M:MiscUtil.Conversion.LittleEndianBitConverter.FromBytes(System.Byte[],System.Int32,System.Int32)">
  3078. <summary>
  3079. Returns a value built from the specified number of bytes from the given buffer,
  3080. starting at index.
  3081. </summary>
  3082. <param name="buffer">The data in byte array format</param>
  3083. <param name="startIndex">The first index to use</param>
  3084. <param name="bytesToConvert">The number of bytes to use</param>
  3085. <returns>The value built from the given bytes</returns>
  3086. </member>
  3087. <member name="T:PacketDotNet.InternetPacket">
  3088. <summary>
  3089. Internet packets include IPv4, IPv6, IGMP etc, see
  3090. http://en.wikipedia.org/wiki/Internet_Layer
  3091. </summary>
  3092. </member>
  3093. <member name="M:PacketDotNet.InternetPacket.#ctor">
  3094. <summary>
  3095. Constructor
  3096. </summary>
  3097. </member>
  3098. <member name="T:PacketDotNet.IPv4Fields">
  3099. <summary>
  3100. IP protocol field encoding information.
  3101. </summary>
  3102. </member>
  3103. <member name="F:PacketDotNet.IPv4Fields.VersionAndHeaderLengthLength">
  3104. <summary> Width of the IP version and header length field in bytes.</summary>
  3105. </member>
  3106. <member name="F:PacketDotNet.IPv4Fields.DifferentiatedServicesLength">
  3107. <summary> Width of the Differentiated Services / Type of service field in bytes.</summary>
  3108. </member>
  3109. <member name="F:PacketDotNet.IPv4Fields.TotalLengthLength">
  3110. <summary> Width of the total length field in bytes.</summary>
  3111. </member>
  3112. <member name="F:PacketDotNet.IPv4Fields.IdLength">
  3113. <summary> Width of the ID field in bytes.</summary>
  3114. </member>
  3115. <member name="F:PacketDotNet.IPv4Fields.FragmentOffsetAndFlagsLength">
  3116. <summary> Width of the fragment offset bits and offset field in bytes.</summary>
  3117. </member>
  3118. <member name="F:PacketDotNet.IPv4Fields.TtlLength">
  3119. <summary> Width of the TTL field in bytes.</summary>
  3120. </member>
  3121. <member name="F:PacketDotNet.IPv4Fields.ProtocolLength">
  3122. <summary> Width of the IP protocol code in bytes.</summary>
  3123. </member>
  3124. <member name="F:PacketDotNet.IPv4Fields.ChecksumLength">
  3125. <summary> Width of the IP checksum in bytes.</summary>
  3126. </member>
  3127. <member name="F:PacketDotNet.IPv4Fields.VersionAndHeaderLengthPosition">
  3128. <summary> Position of the version code and header length within the IP header.</summary>
  3129. </member>
  3130. <member name="F:PacketDotNet.IPv4Fields.DifferentiatedServicesPosition">
  3131. <summary> Position of the differentiated services value within the IP header.</summary>
  3132. </member>
  3133. <member name="F:PacketDotNet.IPv4Fields.TotalLengthPosition">
  3134. <summary> Position of the header length within the IP header.</summary>
  3135. </member>
  3136. <member name="F:PacketDotNet.IPv4Fields.IdPosition">
  3137. <summary> Position of the packet ID within the IP header.</summary>
  3138. </member>
  3139. <member name="F:PacketDotNet.IPv4Fields.FragmentOffsetAndFlagsPosition">
  3140. <summary> Position of the flag bits and fragment offset within the IP header.</summary>
  3141. </member>
  3142. <member name="F:PacketDotNet.IPv4Fields.TtlPosition">
  3143. <summary> Position of the ttl within the IP header.</summary>
  3144. </member>
  3145. <member name="F:PacketDotNet.IPv4Fields.ProtocolPosition">
  3146. <summary>
  3147. Position of the protocol used within the IP data
  3148. </summary>
  3149. </member>
  3150. <member name="F:PacketDotNet.IPv4Fields.ChecksumPosition">
  3151. <summary> Position of the checksum within the IP header.</summary>
  3152. </member>
  3153. <member name="F:PacketDotNet.IPv4Fields.SourcePosition">
  3154. <summary> Position of the source IP address within the IP header.</summary>
  3155. </member>
  3156. <member name="F:PacketDotNet.IPv4Fields.DestinationPosition">
  3157. <summary> Position of the destination IP address within a packet.</summary>
  3158. </member>
  3159. <member name="F:PacketDotNet.IPv4Fields.HeaderLength">
  3160. <summary> Length in bytes of an IP header, excluding options.</summary>
  3161. </member>
  3162. <member name="F:PacketDotNet.IPv4Fields.AddressLength">
  3163. <summary>
  3164. Number of bytes in an IPv4 address
  3165. </summary>
  3166. </member>
  3167. <member name="T:PacketDotNet.IPv4Packet">
  3168. <summary>
  3169. IPv4 packet
  3170. See http://en.wikipedia.org/wiki/IPv4 for into
  3171. </summary>
  3172. </member>
  3173. <member name="M:PacketDotNet.IPv4Packet.#ctor(System.Net.IPAddress,System.Net.IPAddress)">
  3174. <summary>
  3175. Construct an instance by values
  3176. </summary>
  3177. </member>
  3178. <member name="M:PacketDotNet.IPv4Packet.#ctor(PacketDotNet.Utils.ByteArraySegment)">
  3179. <summary>
  3180. Constructor
  3181. </summary>
  3182. <param name="bas">
  3183. A <see cref="T:PacketDotNet.Utils.ByteArraySegment" /></param>
  3184. </member>
  3185. <member name="T:PacketDotNet.IPv4Packet.TypesOfService_Fields">
  3186. <summary> Type of service code constants for IP. Type of service describes
  3187. how a packet should be handled.
  3188. <p>
  3189. TOS is an 8-bit record in an IP header which contains a 3-bit
  3190. precendence field, 4 TOS bit fields and a 0 bit.
  3191. </p><p>
  3192. The following constants are bit masks which can be logically and'ed
  3193. with the 8-bit IP TOS field to determine what type of service is set.
  3194. </p><p>
  3195. Taken from TCP/IP Illustrated V1 by Richard Stevens, p34.
  3196. </p></summary>
  3197. </member>
  3198. <member name="F:PacketDotNet.IPv4Packet.HeaderMinimumLength">
  3199. <value>
  3200. Number of bytes in the smallest valid ipv4 packet
  3201. </value>
  3202. </member>
  3203. <member name="F:PacketDotNet.IPv4Packet.ipVersion">
  3204. <value>
  3205. Version number of the IP protocol being used
  3206. </value>
  3207. </member>
  3208. <member name="P:PacketDotNet.IPv4Packet.Version">
  3209. <summary> Get the IP version code.</summary>
  3210. </member>
  3211. <member name="P:PacketDotNet.IPv4Packet.PayloadLength">
  3212. <value>
  3213. Forwards compatibility IPv6.PayloadLength property
  3214. </value>
  3215. </member>
  3216. <member name="P:PacketDotNet.IPv4Packet.HeaderLength">
  3217. <summary>
  3218. The IP header length field. At most, this can be a
  3219. four-bit value. The high order bits beyond the fourth bit
  3220. will be ignored.
  3221. </summary>
  3222. <param name="length">The length of the IP header in 32-bit words.
  3223. </param>
  3224. </member>
  3225. <member name="P:PacketDotNet.IPv4Packet.Id">
  3226. <summary>
  3227. The unique ID of this IP datagram. The ID normally
  3228. increments by one each time a datagram is sent by a host.
  3229. A 16-bit unsigned integer.
  3230. </summary>
  3231. </member>
  3232. <member name="P:PacketDotNet.IPv4Packet.FragmentOffset">
  3233. <summary>
  3234. Fragmentation offset
  3235. The offset specifies a number of octets (i.e., bytes).
  3236. A 13-bit unsigned integer.
  3237. </summary>
  3238. </member>
  3239. <member name="P:PacketDotNet.IPv4Packet.SourceAddress">
  3240. <summary> Fetch the IP address of the host where the packet originated from.</summary>
  3241. </member>
  3242. <member name="P:PacketDotNet.IPv4Packet.DestinationAddress">
  3243. <summary> Fetch the IP address of the host where the packet is destined.</summary>
  3244. </member>
  3245. <member name="P:PacketDotNet.IPv4Packet.Checksum">
  3246. <summary> Fetch the header checksum.</summary>
  3247. </member>
  3248. <member name="P:PacketDotNet.IPv4Packet.ValidChecksum">
  3249. <summary> Check if the IP packet is valid, checksum-wise.</summary>
  3250. </member>
  3251. <member name="P:PacketDotNet.IPv4Packet.ValidIPChecksum">
  3252. <summary>
  3253. Check if the IP packet header is valid, checksum-wise.
  3254. </summary>
  3255. </member>
  3256. <member name="P:PacketDotNet.IPv4Packet.Color">
  3257. <summary> Fetch ascii escape sequence of the color associated with this packet type.</summary>
  3258. </member>
  3259. <member name="P:PacketDotNet.IPv4Packet.DifferentiatedServices">
  3260. <summary> Fetch the type of service. </summary>
  3261. </member>
  3262. <member name="P:PacketDotNet.IPv4Packet.TypeOfService">
  3263. <value>
  3264. Renamed to DifferentiatedServices in IPv6 but present here
  3265. for backwards compatibility
  3266. </value>
  3267. </member>
  3268. <member name="P:PacketDotNet.IPv4Packet.TotalLength">
  3269. <value>
  3270. The entire datagram size including header and data
  3271. </value>
  3272. </member>
  3273. <member name="P:PacketDotNet.IPv4Packet.FragmentFlags">
  3274. <summary> Fetch fragment flags.</summary>
  3275. <param name="flags">A 3-bit unsigned integer.</param>
  3276. </member>
  3277. <member name="P:PacketDotNet.IPv4Packet.TimeToLive">
  3278. <summary> Fetch the time to live. TTL sets the upper limit on the number of
  3279. routers through which this IP datagram is allowed to pass.
  3280. Originally intended to be the number of seconds the packet lives it is now decremented
  3281. by one each time a router passes the packet on
  3282. 8-bit value
  3283. </summary>
  3284. </member>
  3285. <member name="P:PacketDotNet.IPv4Packet.Protocol">
  3286. <summary> Fetch the code indicating the type of protocol embedded in the IP</summary>
  3287. <seealso cref="T:PacketDotNet.IPProtocolType">
  3288. </seealso>
  3289. </member>
  3290. <member name="M:PacketDotNet.IPv4Packet.CalculateIPChecksum">
  3291. <summary>
  3292. Calculates the IP checksum, optionally updating the IP checksum header.
  3293. </summary>
  3294. <returns> The calculated IP checksum.
  3295. </returns>
  3296. </member>
  3297. <member name="M:PacketDotNet.IPv4Packet.UpdateIPChecksum">
  3298. <summary>
  3299. Update the checksum value
  3300. </summary>
  3301. </member>
  3302. <member name="M:PacketDotNet.IPv4Packet.AttachPseudoIPHeader(System.Byte[])">
  3303. <summary>
  3304. Prepend to the given byte[] origHeader the portion of the IPv6 header used for
  3305. generating an tcp checksum
  3306. http://en.wikipedia.org/wiki/Transmission_Control_Protocol#TCP_checksum_using_IPv4
  3307. http://tools.ietf.org/html/rfc793
  3308. </summary>
  3309. <param name="origHeader">
  3310. A <see cref="T:System.Byte" /></param>
  3311. <returns>
  3312. A <see cref="T:System.Byte" /></returns>
  3313. </member>
  3314. <member name="M:PacketDotNet.IPv4Packet.ToString(PacketDotNet.StringOutputType)">
  3315. <summary cref="Packet.ToString(StringOutputType)" />
  3316. </member>
  3317. <member name="M:PacketDotNet.IPv4Packet.RandomPacket">
  3318. <summary>
  3319. Generate a random packet
  3320. </summary>
  3321. <returns>
  3322. A <see cref="T:PacketDotNet.Packet" /></returns>
  3323. </member>
  3324. <member name="M:PacketDotNet.IPv4Packet.UpdateCalculatedValues">
  3325. <summary>
  3326. Update the length fields
  3327. </summary>
  3328. </member>
  3329. <member name="T:PacketDotNet.IPv6Fields">
  3330. <summary>
  3331. A struct containing length and position information about IPv6 Fields.
  3332. </summary>
  3333. </member>
  3334. <member name="M:PacketDotNet.IPv6Fields.#ctor">
  3335. <summary>
  3336. Commutes the field positions.
  3337. </summary>
  3338. </member>
  3339. <member name="F:PacketDotNet.IPv6Fields.VersionTrafficClassFlowLabelLength">
  3340. <summary>
  3341. The IP Version, Traffic Class, and Flow Label field length. These must be in one
  3342. field due to boundary crossings.
  3343. </summary>
  3344. </member>
  3345. <member name="F:PacketDotNet.IPv6Fields.PayloadLengthLength">
  3346. <summary>
  3347. The payload length field length.
  3348. </summary>
  3349. </member>
  3350. <member name="F:PacketDotNet.IPv6Fields.NextHeaderLength">
  3351. <summary>
  3352. The next header field length, identifies protocol encapsulated by the packet
  3353. </summary>
  3354. </member>
  3355. <member name="F:PacketDotNet.IPv6Fields.HopLimitLength">
  3356. <summary>
  3357. The hop limit field length.
  3358. </summary>
  3359. </member>
  3360. <member name="F:PacketDotNet.IPv6Fields.AddressLength">
  3361. <summary>
  3362. Address field length
  3363. </summary>
  3364. </member>
  3365. <member name="F:PacketDotNet.IPv6Fields.VersionTrafficClassFlowLabelPosition">
  3366. <summary>
  3367. The byte position of the field line in the IPv6 header.
  3368. This is where the IP version, Traffic Class, and Flow Label fields are.
  3369. </summary>
  3370. </member>
  3371. <member name="F:PacketDotNet.IPv6Fields.PayloadLengthPosition">
  3372. <summary>
  3373. The byte position of the payload length field.
  3374. </summary>
  3375. </member>
  3376. <member name="F:PacketDotNet.IPv6Fields.NextHeaderPosition">
  3377. <summary>
  3378. The byte position of the next header field. (Replaces the ipv4 protocol field)
  3379. </summary>
  3380. </member>
  3381. <member name="F:PacketDotNet.IPv6Fields.HopLimitPosition">
  3382. <summary>
  3383. The byte position of the hop limit field.
  3384. </summary>
  3385. </member>
  3386. <member name="F:PacketDotNet.IPv6Fields.SourceAddressPosition">
  3387. <summary>
  3388. The byte position of the source address field.
  3389. </summary>
  3390. </member>
  3391. <member name="F:PacketDotNet.IPv6Fields.DestinationAddressPosition">
  3392. <summary>
  3393. The byte position of the destination address field.
  3394. </summary>
  3395. </member>
  3396. <member name="F:PacketDotNet.IPv6Fields.HeaderLength">
  3397. <summary>
  3398. The byte length of the IPv6 Header
  3399. </summary>
  3400. </member>
  3401. <member name="T:PacketDotNet.IPv6Packet">
  3402. <summary>
  3403. IPv6 packet
  3404. References
  3405. ----------
  3406. http://tools.ietf.org/html/rfc2460
  3407. http://en.wikipedia.org/wiki/IPv6
  3408. </summary>
  3409. </member>
  3410. <member name="M:PacketDotNet.IPv6Packet.#ctor(System.Net.IPAddress,System.Net.IPAddress)">
  3411. <summary>
  3412. Create an IPv6 packet from values
  3413. </summary>
  3414. <param name="SourceAddress">
  3415. A <see cref="T:System.Net.IPAddress" /></param>
  3416. <param name="DestinationAddress">
  3417. A <see cref="T:System.Net.IPAddress" /></param>
  3418. </member>
  3419. <member name="M:PacketDotNet.IPv6Packet.#ctor(PacketDotNet.Utils.ByteArraySegment)">
  3420. <summary>
  3421. Constructor
  3422. </summary>
  3423. <param name="bas">
  3424. A <see cref="T:PacketDotNet.Utils.ByteArraySegment" /></param>
  3425. </member>
  3426. <member name="F:PacketDotNet.IPv6Packet.HeaderMinimumLength">
  3427. <value>
  3428. Minimum number of bytes in an IPv6 header
  3429. </value>
  3430. </member>
  3431. <member name="F:PacketDotNet.IPv6Packet.ipVersion">
  3432. <value>
  3433. The version of the IP protocol. The '6' in IPv6 indicates the version of the protocol
  3434. </value>
  3435. </member>
  3436. <member name="P:PacketDotNet.IPv6Packet.Version">
  3437. <summary>
  3438. The version field of the IPv6 Packet.
  3439. </summary>
  3440. </member>
  3441. <member name="P:PacketDotNet.IPv6Packet.TrafficClass">
  3442. <summary>
  3443. The traffic class field of the IPv6 Packet.
  3444. </summary>
  3445. </member>
  3446. <member name="P:PacketDotNet.IPv6Packet.FlowLabel">
  3447. <summary>
  3448. The flow label field of the IPv6 Packet.
  3449. </summary>
  3450. </member>
  3451. <member name="P:PacketDotNet.IPv6Packet.PayloadLength">
  3452. <summary>
  3453. The payload lengeth field of the IPv6 Packet
  3454. NOTE: Differs from the IPv4 'Total length' field that includes the length of the header as
  3455. payload length is ONLY the size of the payload.
  3456. </summary>
  3457. </member>
  3458. <member name="P:PacketDotNet.IPv6Packet.HeaderLength">
  3459. <value>
  3460. Backwards compatibility property for IPv4.HeaderLength
  3461. NOTE: This field is the number of 32bit words
  3462. </value>
  3463. </member>
  3464. <member name="P:PacketDotNet.IPv6Packet.TotalLength">
  3465. <value>
  3466. Backwards compatibility property for IPv4.TotalLength
  3467. </value>
  3468. </member>
  3469. <member name="P:PacketDotNet.IPv6Packet.NextHeader">
  3470. <summary>
  3471. Identifies the protocol encapsulated by this packet
  3472. Replaces IPv4's 'protocol' field, has compatible values
  3473. </summary>
  3474. </member>
  3475. <member name="P:PacketDotNet.IPv6Packet.Protocol">
  3476. <value>
  3477. The protocol of the packet encapsulated in this ip packet
  3478. </value>
  3479. </member>
  3480. <member name="P:PacketDotNet.IPv6Packet.HopLimit">
  3481. <summary>
  3482. The hop limit field of the IPv6 Packet.
  3483. NOTE: Replaces the 'time to live' field of IPv4
  3484. 8-bit value
  3485. </summary>
  3486. </member>
  3487. <member name="P:PacketDotNet.IPv6Packet.TimeToLive">
  3488. <value>
  3489. Helper alias for 'HopLimit'
  3490. </value>
  3491. </member>
  3492. <member name="P:PacketDotNet.IPv6Packet.SourceAddress">
  3493. <summary>
  3494. The source address field of the IPv6 Packet.
  3495. </summary>
  3496. </member>
  3497. <member name="P:PacketDotNet.IPv6Packet.DestinationAddress">
  3498. <summary>
  3499. The destination address field of the IPv6 Packet.
  3500. </summary>
  3501. </member>
  3502. <member name="P:PacketDotNet.IPv6Packet.Color">
  3503. <summary> Fetch ascii escape sequence of the color associated with this packet type.</summary>
  3504. </member>
  3505. <member name="M:PacketDotNet.IPv6Packet.AttachPseudoIPHeader(System.Byte[])">
  3506. <summary>
  3507. Prepend to the given byte[] origHeader the portion of the IPv6 header used for
  3508. generating an tcp checksum
  3509. http://en.wikipedia.org/wiki/Transmission_Control_Protocol#TCP_checksum_using_IPv6
  3510. http://tools.ietf.org/html/rfc2460#page-27
  3511. </summary>
  3512. <param name="origHeader">
  3513. A <see cref="T:System.Byte" /></param>
  3514. <returns>
  3515. A <see cref="T:System.Byte" /></returns>
  3516. </member>
  3517. <member name="M:PacketDotNet.IPv6Packet.ToString(PacketDotNet.StringOutputType)">
  3518. <summary cref="Packet.ToString(StringOutputType)" />
  3519. </member>
  3520. <member name="M:PacketDotNet.IPv6Packet.RandomPacket">
  3521. <summary>
  3522. Generate a random packet
  3523. </summary>
  3524. <returns>
  3525. A <see cref="T:PacketDotNet.Packet" /></returns>
  3526. </member>
  3527. <member name="T:PacketDotNet.IpPort">
  3528. <summary> Code constants for ip ports. </summary>
  3529. </member>
  3530. <member name="F:PacketDotNet.IpPort.Ssh">
  3531. <summary>
  3532. Secure shell
  3533. </summary>
  3534. </member>
  3535. <member name="F:PacketDotNet.IpPort.Telnet">
  3536. <summary>
  3537. Terminal protocol
  3538. </summary>
  3539. </member>
  3540. <member name="F:PacketDotNet.IpPort.Smtp">
  3541. <summary>
  3542. Simple mail transport protocol
  3543. </summary>
  3544. </member>
  3545. <member name="F:PacketDotNet.IpPort.Http">
  3546. <summary>
  3547. Hyper text transfer protocol
  3548. </summary>
  3549. </member>
  3550. <member name="F:PacketDotNet.IpPort.Www">
  3551. <summary>
  3552. Same as Http
  3553. </summary>
  3554. </member>
  3555. <member name="F:PacketDotNet.IpPort.Sftp">
  3556. <summary>
  3557. Secure ftp
  3558. </summary>
  3559. </member>
  3560. <member name="F:PacketDotNet.IpPort.Ntp">
  3561. <summary>
  3562. Network time protocol
  3563. </summary>
  3564. </member>
  3565. <member name="F:PacketDotNet.IpPort.Snmp">
  3566. <summary>
  3567. Simple network management protocol
  3568. </summary>
  3569. </member>
  3570. <member name="T:PacketDotNet.Utils.ChecksumUtils">
  3571. <summary>
  3572. Computes the one's sum on a byte array.
  3573. Based TCP/IP Illustrated Vol. 2(1995) by Gary R. Wright and W. Richard
  3574. Stevens. Page 236. And on http://www.cs.utk.edu/~cs594np/unp/checksum.html
  3575. </summary>
  3576. </member>
  3577. <member name="M:PacketDotNet.Utils.ChecksumUtils.OnesComplementSum(System.Byte[])">
  3578. <summary>
  3579. Computes the one's complement sum on a byte array
  3580. </summary>
  3581. </member>
  3582. <member name="M:PacketDotNet.Utils.ChecksumUtils.OnesComplementSum(System.Byte[],System.Int32,System.Int32)">
  3583. <summary>
  3584. Computes the one's complement sum on a byte array
  3585. </summary>
  3586. </member>
  3587. <member name="M:PacketDotNet.Utils.ChecksumUtils.OnesSum(System.Byte[])">
  3588. <summary>
  3589. Compute a ones sum of a byte array
  3590. </summary>
  3591. <param name="bytes">
  3592. A <see cref="T:System.Byte" /></param>
  3593. <returns>
  3594. A <see cref="T:System.Int32" /></returns>
  3595. </member>
  3596. <member name="M:PacketDotNet.Utils.ChecksumUtils.OnesSum(System.Byte[],System.Int32,System.Int32)">
  3597. <summary>
  3598. 16 bit sum of all values
  3599. http://en.wikipedia.org/wiki/Signed_number_representations#Ones.27_complement
  3600. </summary>
  3601. <param name="bytes">
  3602. A <see cref="T:System.Byte" /></param>
  3603. <param name="start">
  3604. A <see cref="T:System.Int32" /></param>
  3605. <param name="len">
  3606. A <see cref="T:System.Int32" /></param>
  3607. <returns>
  3608. A <see cref="T:System.Int32" /></returns>
  3609. </member>
  3610. <member name="T:PacketDotNet.TcpFields">
  3611. <summary> IP protocol field encoding information.
  3612. </summary>
  3613. </member>
  3614. <member name="F:PacketDotNet.TcpFields.PortLength">
  3615. <summary> Length of a TCP port in bytes.</summary>
  3616. </member>
  3617. <member name="F:PacketDotNet.TcpFields.SequenceNumberLength">
  3618. <summary> Length of the sequence number in bytes.</summary>
  3619. </member>
  3620. <member name="F:PacketDotNet.TcpFields.AckNumberLength">
  3621. <summary> Length of the acknowledgment number in bytes.</summary>
  3622. </member>
  3623. <member name="F:PacketDotNet.TcpFields.DataOffsetLength">
  3624. <summary> Length of the data offset and flags field in bytes.</summary>
  3625. </member>
  3626. <member name="F:PacketDotNet.TcpFields.FlagsLength">
  3627. <summary> The length of the flags field </summary>
  3628. </member>
  3629. <member name="F:PacketDotNet.TcpFields.WindowSizeLength">
  3630. <summary> Length of the window size field in bytes.</summary>
  3631. </member>
  3632. <member name="F:PacketDotNet.TcpFields.ChecksumLength">
  3633. <summary> Length of the checksum field in bytes.</summary>
  3634. </member>
  3635. <member name="F:PacketDotNet.TcpFields.UrgentPointerLength">
  3636. <summary> Length of the urgent field in bytes.</summary>
  3637. </member>
  3638. <member name="F:PacketDotNet.TcpFields.SourcePortPosition">
  3639. <summary> Position of the source port field.</summary>
  3640. </member>
  3641. <member name="F:PacketDotNet.TcpFields.DestinationPortPosition">
  3642. <summary> Position of the destination port field.</summary>
  3643. </member>
  3644. <member name="F:PacketDotNet.TcpFields.SequenceNumberPosition">
  3645. <summary> Position of the sequence number field.</summary>
  3646. </member>
  3647. <member name="F:PacketDotNet.TcpFields.AckNumberPosition">
  3648. <summary> Position of the acknowledgment number field.</summary>
  3649. </member>
  3650. <member name="F:PacketDotNet.TcpFields.DataOffsetPosition">
  3651. <summary> Position of the data offset </summary>
  3652. </member>
  3653. <member name="F:PacketDotNet.TcpFields.FlagsPosition">
  3654. <summary> Position of the flags field </summary>
  3655. </member>
  3656. <member name="F:PacketDotNet.TcpFields.WindowSizePosition">
  3657. <summary> Position of the window size field.</summary>
  3658. </member>
  3659. <member name="F:PacketDotNet.TcpFields.ChecksumPosition">
  3660. <summary> Position of the checksum field.</summary>
  3661. </member>
  3662. <member name="F:PacketDotNet.TcpFields.UrgentPointerPosition">
  3663. <summary> Position of the urgent pointer field.</summary>
  3664. </member>
  3665. <member name="F:PacketDotNet.TcpFields.HeaderLength">
  3666. <summary> Length in bytes of a TCP header.</summary>
  3667. </member>
  3668. <member name="T:PacketDotNet.ARPFields">
  3669. <summary> IP protocol field encoding information.
  3670. </summary>
  3671. FIXME: These fields are partially broken because they assume the offset for
  3672. several fields and the offset is actually based on the accumulated offset
  3673. into the structure determined by the fields that indicate sizes</member>
  3674. <member name="F:PacketDotNet.ARPFields.EthernetProtocolType">
  3675. <summary> Type code for ethernet addresses.</summary>
  3676. </member>
  3677. <member name="F:PacketDotNet.ARPFields.IPv4ProtocolType">
  3678. <summary> Type code for MAC addresses.</summary>
  3679. </member>
  3680. <member name="F:PacketDotNet.ARPFields.OperationLength">
  3681. <summary> Operation type length in bytes.</summary>
  3682. </member>
  3683. <member name="F:PacketDotNet.ARPFields.AddressTypeLength">
  3684. <summary>
  3685. The length of the address type fields in bytes,
  3686. eg. the length of hardware type or protocol type
  3687. </summary>
  3688. </member>
  3689. <member name="F:PacketDotNet.ARPFields.AddressLengthLength">
  3690. <summary>
  3691. The length of the address length fields in bytes.
  3692. </summary>
  3693. </member>
  3694. <member name="F:PacketDotNet.ARPFields.HardwareAddressTypePosition">
  3695. <summary> Position of the hardware address type.</summary>
  3696. </member>
  3697. <member name="F:PacketDotNet.ARPFields.ProtocolAddressTypePosition">
  3698. <summary> Position of the protocol address type.</summary>
  3699. </member>
  3700. <member name="F:PacketDotNet.ARPFields.HardwareAddressLengthPosition">
  3701. <summary> Position of the hardware address length.</summary>
  3702. </member>
  3703. <member name="F:PacketDotNet.ARPFields.ProtocolAddressLengthPosition">
  3704. <summary> Position of the protocol address length.</summary>
  3705. </member>
  3706. <member name="F:PacketDotNet.ARPFields.OperationPosition">
  3707. <summary> Position of the operation type.</summary>
  3708. </member>
  3709. <member name="F:PacketDotNet.ARPFields.SenderHardwareAddressPosition">
  3710. <summary> Position of the sender hardware address.</summary>
  3711. </member>
  3712. <member name="F:PacketDotNet.ARPFields.SenderProtocolAddressPosition">
  3713. <summary> Position of the sender protocol address.</summary>
  3714. </member>
  3715. <member name="F:PacketDotNet.ARPFields.TargetHardwareAddressPosition">
  3716. <summary> Position of the target hardware address.</summary>
  3717. </member>
  3718. <member name="F:PacketDotNet.ARPFields.TargetProtocolAddressPosition">
  3719. <summary> Position of the target protocol address.</summary>
  3720. </member>
  3721. <member name="F:PacketDotNet.ARPFields.HeaderLength">
  3722. <summary> Total length in bytes of an ARP header.</summary>
  3723. </member>
  3724. <member name="T:PacketDotNet.ARPPacket">
  3725. <summary>
  3726. An ARP protocol packet.
  3727. </summary>
  3728. </member>
  3729. <member name="M:PacketDotNet.ARPPacket.#ctor(PacketDotNet.ARPOperation,System.Net.NetworkInformation.PhysicalAddress,System.Net.IPAddress,System.Net.NetworkInformation.PhysicalAddress,System.Net.IPAddress)">
  3730. <summary>
  3731. Create an ARPPacket from values
  3732. </summary>
  3733. <param name="Operation">
  3734. A <see cref="T:PacketDotNet.ARPOperation" /></param>
  3735. <param name="TargetHardwareAddress">
  3736. A <see cref="T:System.Net.NetworkInformation.PhysicalAddress" /></param>
  3737. <param name="TargetProtocolAddress">
  3738. A <see cref="T:System.Net.IPAddress" /></param>
  3739. <param name="SenderHardwareAddress">
  3740. A <see cref="T:System.Net.NetworkInformation.PhysicalAddress" /></param>
  3741. <param name="SenderProtocolAddress">
  3742. A <see cref="T:System.Net.IPAddress" /></param>
  3743. </member>
  3744. <member name="M:PacketDotNet.ARPPacket.#ctor(PacketDotNet.Utils.ByteArraySegment)">
  3745. <summary>
  3746. Constructor
  3747. </summary>
  3748. <param name="bas">
  3749. A <see cref="T:PacketDotNet.Utils.ByteArraySegment" /></param>
  3750. </member>
  3751. <member name="P:PacketDotNet.ARPPacket.HardwareAddressType">
  3752. <value>
  3753. Also known as HardwareType
  3754. </value>
  3755. </member>
  3756. <member name="P:PacketDotNet.ARPPacket.ProtocolAddressType">
  3757. <value>
  3758. Also known as ProtocolType
  3759. </value>
  3760. </member>
  3761. <member name="P:PacketDotNet.ARPPacket.HardwareAddressLength">
  3762. <value>
  3763. Hardware address length field
  3764. </value>
  3765. </member>
  3766. <member name="P:PacketDotNet.ARPPacket.ProtocolAddressLength">
  3767. <value>
  3768. Protocol address length field
  3769. </value>
  3770. </member>
  3771. <member name="P:PacketDotNet.ARPPacket.Operation">
  3772. <summary> Fetch the operation code.
  3773. Usually one of ARPFields.{ARP_OP_REQ_CODE, ARP_OP_REP_CODE}.
  3774. </summary>
  3775. <summary> Sets the operation code.
  3776. Usually one of ARPFields.{ARP_OP_REQ_CODE, ARP_OP_REP_CODE}.
  3777. </summary>
  3778. </member>
  3779. <member name="P:PacketDotNet.ARPPacket.SenderProtocolAddress">
  3780. <value>
  3781. Upper layer protocol address of the sender, arp is used for IPv4, IPv6 uses NDP
  3782. </value>
  3783. </member>
  3784. <member name="P:PacketDotNet.ARPPacket.TargetProtocolAddress">
  3785. <value>
  3786. Upper layer protocol address of the target, arp is used for IPv4, IPv6 uses NDP
  3787. </value>
  3788. </member>
  3789. <member name="P:PacketDotNet.ARPPacket.SenderHardwareAddress">
  3790. <value>
  3791. Sender hardware address, usually an ethernet mac address
  3792. </value>
  3793. </member>
  3794. <member name="P:PacketDotNet.ARPPacket.TargetHardwareAddress">
  3795. <value>
  3796. Target hardware address, usually an ethernet mac address
  3797. </value>
  3798. </member>
  3799. <member name="P:PacketDotNet.ARPPacket.Color">
  3800. <summary> Fetch ascii escape sequence of the color associated with this packet type.</summary>
  3801. </member>
  3802. <member name="M:PacketDotNet.ARPPacket.ToString(PacketDotNet.StringOutputType)">
  3803. <summary cref="Packet.ToString(StringOutputType)" />
  3804. </member>
  3805. <member name="M:PacketDotNet.ARPPacket.GetEncapsulated(PacketDotNet.Packet)">
  3806. <summary>
  3807. Returns the encapsulated ARPPacket of the Packet p or null if
  3808. there is no encapsulated packet
  3809. </summary>
  3810. <param name="p">
  3811. A <see cref="T:PacketDotNet.Packet" /></param>
  3812. <returns>
  3813. A <see cref="T:PacketDotNet.ARPPacket" /></returns>
  3814. </member>
  3815. <member name="T:PacketDotNet.ICMPv6Fields">
  3816. <summary>
  3817. ICMP protocol field encoding information.
  3818. See http://en.wikipedia.org/wiki/ICMPv6
  3819. </summary>
  3820. </member>
  3821. <member name="F:PacketDotNet.ICMPv6Fields.TypeLength">
  3822. <summary> Length of the ICMP message type code in bytes.</summary>
  3823. </member>
  3824. <member name="F:PacketDotNet.ICMPv6Fields.CodeLength">
  3825. <summary> Length of the ICMP subcode in bytes.</summary>
  3826. </member>
  3827. <member name="F:PacketDotNet.ICMPv6Fields.ChecksumLength">
  3828. <summary> Length of the ICMP header checksum in bytes.</summary>
  3829. </member>
  3830. <member name="F:PacketDotNet.ICMPv6Fields.TypePosition">
  3831. <summary> Position of the ICMP message type.</summary>
  3832. </member>
  3833. <member name="F:PacketDotNet.ICMPv6Fields.CodePosition">
  3834. <summary> Position of the ICMP message subcode.</summary>
  3835. </member>
  3836. <member name="F:PacketDotNet.ICMPv6Fields.ChecksumPosition">
  3837. <summary> Position of the ICMP header checksum.</summary>
  3838. </member>
  3839. <member name="F:PacketDotNet.ICMPv6Fields.HeaderLength">
  3840. <summary> Length in bytes of an ICMP header.</summary>
  3841. </member>
  3842. <member name="T:PacketDotNet.ICMPv6Packet">
  3843. <summary>
  3844. An ICMP packet.
  3845. See http://en.wikipedia.org/wiki/ICMPv6
  3846. </summary>
  3847. </member>
  3848. <member name="M:PacketDotNet.ICMPv6Packet.#ctor(PacketDotNet.Utils.ByteArraySegment)">
  3849. <summary>
  3850. Constructor
  3851. </summary>
  3852. <param name="bas">
  3853. A <see cref="T:PacketDotNet.Utils.ByteArraySegment" /></param>
  3854. </member>
  3855. <member name="M:PacketDotNet.ICMPv6Packet.#ctor(PacketDotNet.Utils.ByteArraySegment,PacketDotNet.Packet)">
  3856. <summary>
  3857. Constructor with parent packet
  3858. </summary>
  3859. <param name="bas">
  3860. A <see cref="T:PacketDotNet.Utils.ByteArraySegment" /></param>
  3861. <param name="ParentPacket">
  3862. A <see cref="T:PacketDotNet.Packet" /></param>
  3863. </member>
  3864. <member name="F:PacketDotNet.ICMPv6Packet.skipUpdating">
  3865. <summary>
  3866. Used to prevent a recursive stack overflow
  3867. when recalculating in UpdateCalculatedValues()
  3868. </summary>
  3869. </member>
  3870. <member name="P:PacketDotNet.ICMPv6Packet.Type">
  3871. <value>
  3872. The Type value
  3873. </value>
  3874. </member>
  3875. <member name="P:PacketDotNet.ICMPv6Packet.Code">
  3876. <summary> Fetch the ICMP code </summary>
  3877. </member>
  3878. <member name="P:PacketDotNet.ICMPv6Packet.Checksum">
  3879. <value>
  3880. Checksum value
  3881. </value>
  3882. </member>
  3883. <member name="P:PacketDotNet.ICMPv6Packet.Color">
  3884. <summary> Fetch ascii escape sequence of the color associated with this packet type.</summary>
  3885. </member>
  3886. <member name="M:PacketDotNet.ICMPv6Packet.UpdateCalculatedValues">
  3887. <summary>
  3888. Recalculate the checksum
  3889. </summary>
  3890. </member>
  3891. <member name="M:PacketDotNet.ICMPv6Packet.ToString(PacketDotNet.StringOutputType)">
  3892. <summary cref="Packet.ToString(StringOutputType)" />
  3893. </member>
  3894. <member name="M:PacketDotNet.ICMPv6Packet.GetEncapsulated(PacketDotNet.Packet)">
  3895. <summary>
  3896. Returns the ICMPv6Packet inside of Packet p or null if
  3897. there is no encapsulated ICMPv6Packet
  3898. </summary>
  3899. <param name="p">
  3900. A <see cref="T:PacketDotNet.Packet" /></param>
  3901. <returns>
  3902. A <see cref="T:PacketDotNet.ICMPv6Packet" /></returns>
  3903. </member>
  3904. <member name="T:PacketDotNet.IGMPMessageType">
  3905. <summary> Code constants for IGMP message types.
  3906. From RFC #2236.
  3907. </summary>
  3908. </member>
  3909. <member name="T:PacketDotNet.IGMPv2Packet">
  3910. <summary>
  3911. An IGMP packet.
  3912. </summary>
  3913. </member>
  3914. <member name="M:PacketDotNet.IGMPv2Packet.#ctor(PacketDotNet.Utils.ByteArraySegment)">
  3915. <summary>
  3916. Constructor
  3917. </summary>
  3918. <param name="bas">
  3919. A <see cref="T:PacketDotNet.Utils.ByteArraySegment" /></param>
  3920. </member>
  3921. <member name="M:PacketDotNet.IGMPv2Packet.#ctor(PacketDotNet.Utils.ByteArraySegment,PacketDotNet.Packet)">
  3922. <summary>
  3923. Constructor with parent
  3924. </summary>
  3925. <param name="bas">
  3926. A <see cref="T:PacketDotNet.Utils.ByteArraySegment" /></param>
  3927. <param name="ParentPacket">
  3928. A <see cref="T:PacketDotNet.Packet" /></param>
  3929. </member>
  3930. <member name="P:PacketDotNet.IGMPv2Packet.Type">
  3931. <value>
  3932. The type of IGMP message
  3933. </value>
  3934. </member>
  3935. <member name="P:PacketDotNet.IGMPv2Packet.MaxResponseTime">
  3936. <summary> Fetch the IGMP max response time.</summary>
  3937. </member>
  3938. <member name="P:PacketDotNet.IGMPv2Packet.Checksum">
  3939. <summary> Fetch the IGMP header checksum.</summary>
  3940. </member>
  3941. <member name="P:PacketDotNet.IGMPv2Packet.GroupAddress">
  3942. <summary> Fetch the IGMP group address.</summary>
  3943. </member>
  3944. <member name="P:PacketDotNet.IGMPv2Packet.Color">
  3945. <summary> Fetch ascii escape sequence of the color associated with this packet type.</summary>
  3946. </member>
  3947. <member name="M:PacketDotNet.IGMPv2Packet.GetEncapsulated(PacketDotNet.Packet)">
  3948. <summary>
  3949. Returns the encapsulated IGMPv2Packet of the Packet p or null if
  3950. there is no encapsulated packet
  3951. </summary>
  3952. <param name="p">
  3953. A <see cref="T:PacketDotNet.Packet" /></param>
  3954. <returns>
  3955. A <see cref="T:PacketDotNet.IGMPv2Packet" /></returns>
  3956. </member>
  3957. <member name="M:PacketDotNet.IGMPv2Packet.ToString(PacketDotNet.StringOutputType)">
  3958. <summary cref="Packet.ToString(StringOutputType)" />
  3959. </member>
  3960. <member name="T:PacketDotNet.InternetLinkLayerPacket">
  3961. <summary>
  3962. Internet Link layer packet
  3963. See http://en.wikipedia.org/wiki/Link_Layer
  3964. </summary>
  3965. </member>
  3966. <member name="M:PacketDotNet.InternetLinkLayerPacket.#ctor">
  3967. <summary>
  3968. Constructor
  3969. </summary>
  3970. </member>
  3971. <member name="M:PacketDotNet.InternetLinkLayerPacket.GetInnerPayload(PacketDotNet.InternetLinkLayerPacket)">
  3972. <summary>
  3973. Look for the innermost payload. This method is useful because
  3974. while some packets are LinuxSSL-&gt;IpPacket or
  3975. EthernetPacket-&gt;IpPacket, there are some packets that are
  3976. EthernetPacket-&gt;PPPoEPacket-&gt;PPPPacket-&gt;IpPacket, and for these cases
  3977. we really want to get to the IpPacket
  3978. </summary>
  3979. <returns>
  3980. A <see cref="T:PacketDotNet.Packet" /></returns>
  3981. </member>
  3982. <member name="T:PacketDotNet.IGMPv2Fields">
  3983. <summary> IGMP protocol field encoding information. </summary>
  3984. </member>
  3985. <member name="F:PacketDotNet.IGMPv2Fields.TypeLength">
  3986. <summary> Length of the IGMP message type code in bytes.</summary>
  3987. </member>
  3988. <member name="F:PacketDotNet.IGMPv2Fields.MaxResponseTimeLength">
  3989. <summary> Length of the IGMP max response code in bytes.</summary>
  3990. </member>
  3991. <member name="F:PacketDotNet.IGMPv2Fields.ChecksumLength">
  3992. <summary> Length of the IGMP header checksum in bytes.</summary>
  3993. </member>
  3994. <member name="F:PacketDotNet.IGMPv2Fields.GroupAddressLength">
  3995. <summary> Length of group address in bytes.</summary>
  3996. </member>
  3997. <member name="F:PacketDotNet.IGMPv2Fields.TypePosition">
  3998. <summary> Position of the IGMP message type.</summary>
  3999. </member>
  4000. <member name="F:PacketDotNet.IGMPv2Fields.MaxResponseTimePosition">
  4001. <summary> Position of the IGMP max response code.</summary>
  4002. </member>
  4003. <member name="F:PacketDotNet.IGMPv2Fields.ChecksumPosition">
  4004. <summary> Position of the IGMP header checksum.</summary>
  4005. </member>
  4006. <member name="F:PacketDotNet.IGMPv2Fields.GroupAddressPosition">
  4007. <summary> Position of the IGMP group address.</summary>
  4008. </member>
  4009. <member name="F:PacketDotNet.IGMPv2Fields.HeaderLength">
  4010. <summary> Length in bytes of an IGMP header.</summary>
  4011. </member>
  4012. <member name="T:PacketDotNet.LinuxSLLPacket">
  4013. <summary>
  4014. Represents a Linux cooked capture packet, the kinds of packets
  4015. received when capturing on an 'any' device
  4016. See http://github.com/mcr/libpcap/blob/master/pcap/sll.h
  4017. </summary>
  4018. </member>
  4019. <member name="M:PacketDotNet.LinuxSLLPacket.#ctor(PacketDotNet.Utils.ByteArraySegment)">
  4020. <summary>
  4021. Constructor
  4022. </summary>
  4023. <param name="bas">
  4024. A <see cref="T:PacketDotNet.Utils.ByteArraySegment" /></param>
  4025. </member>
  4026. <member name="P:PacketDotNet.LinuxSLLPacket.Type">
  4027. <value>
  4028. Information about the packet direction
  4029. </value>
  4030. </member>
  4031. <member name="P:PacketDotNet.LinuxSLLPacket.LinkLayerAddressType">
  4032. <value>
  4033. The
  4034. </value>
  4035. </member>
  4036. <member name="P:PacketDotNet.LinuxSLLPacket.LinkLayerAddressLength">
  4037. <value>
  4038. Number of bytes in the link layer address of the sender of the packet
  4039. </value>
  4040. </member>
  4041. <member name="P:PacketDotNet.LinuxSLLPacket.LinkLayerAddress">
  4042. <value>
  4043. Link layer header bytes, maximum of 8 bytes
  4044. </value>
  4045. </member>
  4046. <member name="P:PacketDotNet.LinuxSLLPacket.EthernetProtocolType">
  4047. <value>
  4048. The encapsulated protocol type
  4049. </value>
  4050. </member>
  4051. <member name="M:PacketDotNet.LinuxSLLPacket.ToString(PacketDotNet.StringOutputType)">
  4052. <summary cref="Packet.ToString(StringOutputType)" />
  4053. </member>
  4054. <member name="T:PacketDotNet.LinuxSLLFields">
  4055. <summary>
  4056. Lengths and offsets to the fields in the LinuxSLL packet
  4057. See http://github.com/mcr/libpcap/blob/master/pcap/sll.h
  4058. </summary>
  4059. </member>
  4060. <member name="F:PacketDotNet.LinuxSLLFields.PacketTypeLength">
  4061. <summary>
  4062. Length of the packet type field
  4063. </summary>
  4064. </member>
  4065. <member name="F:PacketDotNet.LinuxSLLFields.LinkLayerAddressTypeLength">
  4066. <summary>
  4067. Link layer address type
  4068. </summary>
  4069. </member>
  4070. <member name="F:PacketDotNet.LinuxSLLFields.LinkLayerAddressLengthLength">
  4071. <summary>
  4072. Link layer address length
  4073. </summary>
  4074. </member>
  4075. <member name="F:PacketDotNet.LinuxSLLFields.LinkLayerAddressMaximumLength">
  4076. <summary>
  4077. The link layer address field length
  4078. NOTE: the actual link layer address MAY be shorter than this
  4079. </summary>
  4080. </member>
  4081. <member name="F:PacketDotNet.LinuxSLLFields.SLLHeaderLength">
  4082. <summary>
  4083. Number of bytes in a SLL header
  4084. </summary>
  4085. </member>
  4086. <member name="F:PacketDotNet.LinuxSLLFields.EthernetProtocolTypeLength">
  4087. <summary>
  4088. Length of the ethernet protocol field
  4089. </summary>
  4090. </member>
  4091. <member name="F:PacketDotNet.LinuxSLLFields.PacketTypePosition">
  4092. <summary>
  4093. Position of the packet type field
  4094. </summary>
  4095. </member>
  4096. <member name="F:PacketDotNet.LinuxSLLFields.LinkLayerAddressTypePosition">
  4097. <summary>
  4098. Position of the link layer address type field
  4099. </summary>
  4100. </member>
  4101. <member name="F:PacketDotNet.LinuxSLLFields.LinkLayerAddressLengthPosition">
  4102. <summary>
  4103. Positino of the link layer address length field
  4104. </summary>
  4105. </member>
  4106. <member name="F:PacketDotNet.LinuxSLLFields.LinkLayerAddressPosition">
  4107. <summary>
  4108. Position of the link layer address field
  4109. </summary>
  4110. </member>
  4111. <member name="F:PacketDotNet.LinuxSLLFields.EthernetProtocolTypePosition">
  4112. <summary>
  4113. Position of the ethernet protocol type field
  4114. </summary>
  4115. </member>
  4116. <member name="T:PacketDotNet.LinuxSLLType">
  4117. <summary>
  4118. The types of cooked packets
  4119. See http://github.com/mcr/libpcap/blob/master/pcap/sll.h
  4120. </summary>
  4121. </member>
  4122. <member name="F:PacketDotNet.LinuxSLLType.PacketSentToUs">
  4123. <summary>
  4124. Packet was sent to us by somebody else
  4125. </summary>
  4126. </member>
  4127. <member name="F:PacketDotNet.LinuxSLLType.PacketBroadCast">
  4128. <summary>
  4129. Packet was broadcast by somebody else
  4130. </summary>
  4131. </member>
  4132. <member name="F:PacketDotNet.LinuxSLLType.PacketMulticast">
  4133. <summary>
  4134. Packet was multicast, but not broadcast
  4135. </summary>
  4136. </member>
  4137. <member name="F:PacketDotNet.LinuxSLLType.PacketSentToSomeoneElse">
  4138. <summary>
  4139. Packet was sent by somebody else to somebody else
  4140. </summary>
  4141. </member>
  4142. <member name="F:PacketDotNet.LinuxSLLType.PacketSentByUs">
  4143. <summary>
  4144. Packet was sent by us
  4145. </summary>
  4146. </member>
  4147. <member name="T:PacketDotNet.IPProtocolType">
  4148. <summary>
  4149. The protocol encapsulated inside of the IP packet
  4150. </summary>
  4151. </member>
  4152. <member name="F:PacketDotNet.IPProtocolType.IP">
  4153. <summary> Dummy protocol for TCP. </summary>
  4154. </member>
  4155. <member name="F:PacketDotNet.IPProtocolType.HOPOPTS">
  4156. <summary> IPv6 Hop-by-Hop options. </summary>
  4157. </member>
  4158. <member name="F:PacketDotNet.IPProtocolType.ICMP">
  4159. <summary> Internet Control Message Protocol. </summary>
  4160. </member>
  4161. <member name="F:PacketDotNet.IPProtocolType.IGMP">
  4162. <summary> Internet Group Management Protocol.</summary>
  4163. </member>
  4164. <member name="F:PacketDotNet.IPProtocolType.IPIP">
  4165. <summary> IPIP tunnels (older KA9Q tunnels use 94). </summary>
  4166. </member>
  4167. <member name="F:PacketDotNet.IPProtocolType.TCP">
  4168. <summary> Transmission Control Protocol. </summary>
  4169. </member>
  4170. <member name="F:PacketDotNet.IPProtocolType.EGP">
  4171. <summary> Exterior Gateway Protocol. </summary>
  4172. </member>
  4173. <member name="F:PacketDotNet.IPProtocolType.PUP">
  4174. <summary> PUP protocol. </summary>
  4175. </member>
  4176. <member name="F:PacketDotNet.IPProtocolType.UDP">
  4177. <summary> User Datagram Protocol. </summary>
  4178. </member>
  4179. <member name="F:PacketDotNet.IPProtocolType.IDP">
  4180. <summary> XNS IDP protocol. </summary>
  4181. </member>
  4182. <member name="F:PacketDotNet.IPProtocolType.TP">
  4183. <summary> SO Transport Protocol Class 4. </summary>
  4184. </member>
  4185. <member name="F:PacketDotNet.IPProtocolType.IPV6">
  4186. <summary> IPv6 header. </summary>
  4187. </member>
  4188. <member name="F:PacketDotNet.IPProtocolType.ROUTING">
  4189. <summary> IPv6 routing header. </summary>
  4190. </member>
  4191. <member name="F:PacketDotNet.IPProtocolType.FRAGMENT">
  4192. <summary> IPv6 fragmentation header. </summary>
  4193. </member>
  4194. <member name="F:PacketDotNet.IPProtocolType.RSVP">
  4195. <summary> Reservation Protocol. </summary>
  4196. </member>
  4197. <member name="F:PacketDotNet.IPProtocolType.GRE">
  4198. <summary> General Routing Encapsulation. </summary>
  4199. </member>
  4200. <member name="F:PacketDotNet.IPProtocolType.ESP">
  4201. <summary> encapsulating security payload. </summary>
  4202. </member>
  4203. <member name="F:PacketDotNet.IPProtocolType.AH">
  4204. <summary> authentication header. </summary>
  4205. </member>
  4206. <member name="F:PacketDotNet.IPProtocolType.ICMPV6">
  4207. <summary> ICMPv6. </summary>
  4208. </member>
  4209. <member name="F:PacketDotNet.IPProtocolType.NONE">
  4210. <summary> IPv6 no next header. </summary>
  4211. </member>
  4212. <member name="F:PacketDotNet.IPProtocolType.DSTOPTS">
  4213. <summary> IPv6 destination options. </summary>
  4214. </member>
  4215. <member name="F:PacketDotNet.IPProtocolType.MTP">
  4216. <summary> Multicast Transport Protocol. </summary>
  4217. </member>
  4218. <member name="F:PacketDotNet.IPProtocolType.ENCAP">
  4219. <summary> Encapsulation Header. </summary>
  4220. </member>
  4221. <member name="F:PacketDotNet.IPProtocolType.PIM">
  4222. <summary> Protocol Independent Multicast. </summary>
  4223. </member>
  4224. <member name="F:PacketDotNet.IPProtocolType.COMP">
  4225. <summary> Compression Header Protocol. </summary>
  4226. </member>
  4227. <member name="F:PacketDotNet.IPProtocolType.RAW">
  4228. <summary> Raw IP packets. </summary>
  4229. </member>
  4230. <member name="F:PacketDotNet.IPProtocolType.MASK">
  4231. <summary> IP protocol mask.</summary>
  4232. </member>
  4233. <member name="T:PacketDotNet.IpVersion">
  4234. <summary> Code constants for internet protocol versions.
  4235. </summary>
  4236. </member>
  4237. <member name="F:PacketDotNet.IpVersion.IPv4">
  4238. <summary> Internet protocol version 4.</summary>
  4239. </member>
  4240. <member name="F:PacketDotNet.IpVersion.IPv6">
  4241. <summary> Internet protocol version 6.</summary>
  4242. </member>
  4243. <member name="T:PacketDotNet.LinkLayers">
  4244. <summary> Link-layer type codes.
  4245. <p>
  4246. Taken from libpcap/bpf/net/bpf.h and pcap/net/bpf.h.
  4247. </p><p>
  4248. The link-layer type is used to determine what data-structure the
  4249. IP protocol bits will be encapsulated inside of.
  4250. </p><p>
  4251. On a 10/100mbps network, packets are encapsulated inside of ethernet.
  4252. 14-byte ethernet headers which contain MAC addresses and an ethernet type
  4253. field.
  4254. </p><p>
  4255. On ethernet over ppp, the link-layer type is raw, and packets
  4256. are not encapsulated in any ethernet header.
  4257. </p></summary>
  4258. </member>
  4259. <member name="F:PacketDotNet.LinkLayers.Null">
  4260. <summary> no link-layer encapsulation </summary>
  4261. </member>
  4262. <member name="F:PacketDotNet.LinkLayers.Ethernet">
  4263. <summary> Ethernet (10Mb) </summary>
  4264. </member>
  4265. <member name="F:PacketDotNet.LinkLayers.ExperimentalEthernet3MB">
  4266. <summary> Experimental Ethernet (3Mb) </summary>
  4267. </member>
  4268. <member name="F:PacketDotNet.LinkLayers.AmateurRadioAX25">
  4269. <summary> Amateur Radio AX.25 </summary>
  4270. </member>
  4271. <member name="F:PacketDotNet.LinkLayers.ProteonProNetTokenRing">
  4272. <summary> Proteon ProNET Token Ring </summary>
  4273. </member>
  4274. <member name="F:PacketDotNet.LinkLayers.Chaos">
  4275. <summary> Chaos </summary>
  4276. </member>
  4277. <member name="F:PacketDotNet.LinkLayers.Ieee802">
  4278. <summary> IEEE 802 Networks </summary>
  4279. </member>
  4280. <member name="F:PacketDotNet.LinkLayers.ArcNet">
  4281. <summary> ARCNET </summary>
  4282. </member>
  4283. <member name="F:PacketDotNet.LinkLayers.Slip">
  4284. <summary> Serial Line IP </summary>
  4285. </member>
  4286. <member name="F:PacketDotNet.LinkLayers.Ppp">
  4287. <summary> Point-to-point Protocol </summary>
  4288. </member>
  4289. <member name="F:PacketDotNet.LinkLayers.Fddi">
  4290. <summary> FDDI </summary>
  4291. </member>
  4292. <member name="F:PacketDotNet.LinkLayers.AtmRfc1483">
  4293. <summary> LLC/SNAP encapsulated atm </summary>
  4294. </member>
  4295. <member name="F:PacketDotNet.LinkLayers.Raw">
  4296. <summary> raw IP </summary>
  4297. </member>
  4298. <member name="F:PacketDotNet.LinkLayers.SlipBSD">
  4299. <summary> BSD Slip.</summary>
  4300. </member>
  4301. <member name="F:PacketDotNet.LinkLayers.PppBSD">
  4302. <summary> BSD PPP.</summary>
  4303. </member>
  4304. <member name="F:PacketDotNet.LinkLayers.AtmClip">
  4305. <summary> IP over ATM.</summary>
  4306. </member>
  4307. <member name="F:PacketDotNet.LinkLayers.PppSerial">
  4308. <summary> PPP over HDLC.</summary>
  4309. </member>
  4310. <member name="F:PacketDotNet.LinkLayers.CiscoHDLC">
  4311. <summary> Cisco HDLC.</summary>
  4312. </member>
  4313. <member name="F:PacketDotNet.LinkLayers.Ieee80211">
  4314. <summary> IEEE 802.11 wireless.</summary>
  4315. </member>
  4316. <member name="F:PacketDotNet.LinkLayers.Loop">
  4317. <summary> OpenBSD loopback.</summary>
  4318. </member>
  4319. <member name="F:PacketDotNet.LinkLayers.LinuxSLL">
  4320. <summary> Linux cooked sockets.</summary>
  4321. </member>
  4322. <member name="F:PacketDotNet.LinkLayers.Ieee80211_Radio">
  4323. <summary>
  4324. Header for 802.11 plus a number of bits of link-layer information
  4325. including radio information, used by some recent BSD drivers as
  4326. well as the madwifi Atheros driver for Linux.
  4327. </summary>
  4328. </member>
  4329. <member name="F:PacketDotNet.LinkLayers.PerPacketInformation">
  4330. <summary>
  4331. Per Packet Information encapsulated packets.
  4332. DLT_ requested by Gianluca Varenni &lt;gianluca.varenni@cacetech.com&gt;.
  4333. See http://www.cacetech.com/documents/PPI%20Header%20format%201.0.7.pdf
  4334. </summary>
  4335. </member>
  4336. <member name="T:PacketDotNet.Utils.HexPrinter">
  4337. <summary>
  4338. Helper class that prints out an array of hex values
  4339. </summary>
  4340. </member>
  4341. <member name="M:PacketDotNet.Utils.HexPrinter.GetString(System.Byte[],System.Int32,System.Int32)">
  4342. <summary>
  4343. Create a string that contains the hex values of byte[] Byte in
  4344. text form
  4345. </summary>
  4346. <param name="Byte">
  4347. A <see cref="T:System.Byte" /></param>
  4348. <param name="Offset">
  4349. A <see cref="T:System.Int32" /></param>
  4350. <param name="Length">
  4351. A <see cref="T:System.Int32" /></param>
  4352. <returns>
  4353. A <see cref="T:System.String" /></returns>
  4354. </member>
  4355. <member name="M:PacketDotNet.Utils.HexPrinter.PrintMACAddress(System.Net.NetworkInformation.PhysicalAddress)">
  4356. <summary>
  4357. Creates a string from a Physical address in the format "xx:xx:xx:xx:xx:xx"
  4358. </summary>
  4359. <param name="address">
  4360. A <see cref="T:System.Net.NetworkInformation.PhysicalAddress" /></param>
  4361. <returns>
  4362. A <see cref="T:System.String" /></returns>
  4363. </member>
  4364. <member name="T:PacketDotNet.Utils.RandomUtils">
  4365. <summary>
  4366. Random utility methods
  4367. </summary>
  4368. </member>
  4369. <member name="M:PacketDotNet.Utils.RandomUtils.GetIPAddress(PacketDotNet.IpVersion)">
  4370. <summary>
  4371. Generate a random ip address
  4372. </summary>
  4373. <param name="version">
  4374. A <see cref="T:PacketDotNet.IpVersion" /></param>
  4375. <returns>
  4376. A <see cref="T:System.Net.IPAddress" /></returns>
  4377. </member>
  4378. <!--FIXME: Invalid documentation markup was found for member M:PacketDotNet.Utils.RandomUtils.LongestStringLength(System.Collections.Generic.List{System.String})-->
  4379. <member name="T:PacketDotNet.PayloadType">
  4380. <summary>
  4381. Differentiates between a packet class payload, a byte[] payload
  4382. or no payload
  4383. </summary>
  4384. </member>
  4385. <member name="T:PacketDotNet.ICMPv6Types">
  4386. <summary>
  4387. ICMPv6 types, see http://en.wikipedia.org/wiki/ICMPv6 and
  4388. http://www.iana.org/assignments/icmpv6-parameters
  4389. </summary>
  4390. </member>
  4391. <member name="T:PacketDotNet.ARPOperation">
  4392. <summary>
  4393. The possible ARP operation values
  4394. </summary>
  4395. <remarks>
  4396. References:
  4397. - http://www.networksorcery.com/enp/default1101.htm
  4398. </remarks>
  4399. </member>
  4400. <member name="F:PacketDotNet.ARPOperation.Request">
  4401. <summary>Request</summary>
  4402. <remarks>See RFC 826, RFC 5227</remarks>
  4403. </member>
  4404. <member name="F:PacketDotNet.ARPOperation.Response">
  4405. <summary>Response</summary>
  4406. <remarks>See RFC 826, RFC 1868, RFC 5227</remarks>
  4407. </member>
  4408. <member name="F:PacketDotNet.ARPOperation.RequestReverse">
  4409. <summary>Request Reverse</summary>
  4410. <remarks>See RFC 903</remarks>
  4411. </member>
  4412. <member name="F:PacketDotNet.ARPOperation.ReplyReverse">
  4413. <summary>Reply Reverse</summary>
  4414. <remarks>See RFC 903</remarks>
  4415. </member>
  4416. <member name="F:PacketDotNet.ARPOperation.DRARPRequest">
  4417. <summary>DRARP Request</summary>
  4418. <remarks>See RFC 1931</remarks>
  4419. </member>
  4420. <member name="F:PacketDotNet.ARPOperation.DRARPReply">
  4421. <summary>DRARP Reply</summary>
  4422. <remarks>See RFC 1931</remarks>
  4423. </member>
  4424. <member name="F:PacketDotNet.ARPOperation.DRARPError">
  4425. <summary>DRARP Error</summary>
  4426. <remarks>See RFC 1931</remarks>
  4427. </member>
  4428. <member name="F:PacketDotNet.ARPOperation.InARPRequest">
  4429. <summary>InARP Request</summary>
  4430. <remarks>See RFC 1293</remarks>
  4431. </member>
  4432. <member name="F:PacketDotNet.ARPOperation.InARPReply">
  4433. <summary>InARP Reply</summary>
  4434. <remarks>See RFC 1293</remarks>
  4435. </member>
  4436. <member name="F:PacketDotNet.ARPOperation.ARPNAK">
  4437. <summary>ARP NAK</summary>
  4438. <remarks>See RFC 1577</remarks>
  4439. </member>
  4440. <member name="F:PacketDotNet.ARPOperation.MARSRequest">
  4441. <summary>MARS Request</summary>
  4442. </member>
  4443. <member name="F:PacketDotNet.ARPOperation.MARSMulti">
  4444. <summary>MARS Multi</summary>
  4445. </member>
  4446. <member name="F:PacketDotNet.ARPOperation.MARSMServ">
  4447. <summary>MARS MServ</summary>
  4448. </member>
  4449. <member name="F:PacketDotNet.ARPOperation.MARSJoin">
  4450. <summary>MARS Join</summary>
  4451. </member>
  4452. <member name="F:PacketDotNet.ARPOperation.MARSLeave">
  4453. <summary>MARS Leave</summary>
  4454. </member>
  4455. <member name="F:PacketDotNet.ARPOperation.MARSNAK">
  4456. <summary>MARS NAK</summary>
  4457. </member>
  4458. <member name="F:PacketDotNet.ARPOperation.MARSUnserv">
  4459. <summary>MARS Unserv</summary>
  4460. </member>
  4461. <member name="F:PacketDotNet.ARPOperation.MARSSJoin">
  4462. <summary>MARS SJoin</summary>
  4463. </member>
  4464. <member name="F:PacketDotNet.ARPOperation.MARSSLeave">
  4465. <summary>MARS SLeave</summary>
  4466. </member>
  4467. <member name="F:PacketDotNet.ARPOperation.MARSGrouplistRequest">
  4468. <summary>MARS Grouplist Request</summary>
  4469. </member>
  4470. <member name="F:PacketDotNet.ARPOperation.MARSGrouplistReply">
  4471. <summary>MARS Grouplist Reply</summary>
  4472. </member>
  4473. <member name="F:PacketDotNet.ARPOperation.MARSRedirectMap">
  4474. <summary>MARS Redirect Map</summary>
  4475. </member>
  4476. <member name="F:PacketDotNet.ARPOperation.MaposUnarp">
  4477. <summary>MARS UNARP</summary>
  4478. <remarks>See RFC 2176</remarks>
  4479. </member>
  4480. <member name="F:PacketDotNet.ARPOperation.OP_EXP1">
  4481. <summary>OP_EXP1</summary>
  4482. <remarks>See RFC 5494</remarks>
  4483. </member>
  4484. <member name="F:PacketDotNet.ARPOperation.OP_EXP2">
  4485. <summary>OP_EXP2</summary>
  4486. </member>
  4487. <member name="T:PacketDotNet.PPPoEPacket">
  4488. <summary>
  4489. Point to Point Protocol
  4490. See http://tools.ietf.org/html/rfc2516
  4491. </summary>
  4492. </member>
  4493. <member name="M:PacketDotNet.PPPoEPacket.#ctor(PacketDotNet.PPPoECode,System.UInt16)">
  4494. <summary>
  4495. Construct a new PPPoEPacket from source and destination mac addresses
  4496. </summary>
  4497. </member>
  4498. <member name="M:PacketDotNet.PPPoEPacket.#ctor(PacketDotNet.Utils.ByteArraySegment)">
  4499. <summary>
  4500. Constructor
  4501. </summary>
  4502. <param name="bas">
  4503. A <see cref="T:PacketDotNet.Utils.ByteArraySegment" /></param>
  4504. </member>
  4505. <member name="P:PacketDotNet.PPPoEPacket.Version">
  4506. <summary>
  4507. PPPoe version, must be 0x1 according to RFC
  4508. </summary>
  4509. FIXME: This currently outputs the wrong version number</member>
  4510. <member name="P:PacketDotNet.PPPoEPacket.Type">
  4511. <summary>
  4512. Type, must be 0x1 according to RFC
  4513. </summary>
  4514. </member>
  4515. <member name="P:PacketDotNet.PPPoEPacket.Code">
  4516. <summary>
  4517. </summary>
  4518. FIXME: This currently outputs the wrong code</member>
  4519. <member name="P:PacketDotNet.PPPoEPacket.SessionId">
  4520. <summary>
  4521. Session identifier for this PPPoe packet
  4522. </summary>
  4523. </member>
  4524. <member name="P:PacketDotNet.PPPoEPacket.Length">
  4525. <summary>
  4526. Length of the PPPoe payload, not including the PPPoe header
  4527. </summary>
  4528. </member>
  4529. <member name="P:PacketDotNet.PPPoEPacket.Color">
  4530. <summary> Fetch ascii escape sequence of the color associated with this packet type.</summary>
  4531. </member>
  4532. <member name="M:PacketDotNet.PPPoEPacket.ToString(PacketDotNet.StringOutputType)">
  4533. <summary cref="Packet.ToString(StringOutputType)" />
  4534. </member>
  4535. <member name="M:PacketDotNet.PPPoEPacket.GetEncapsulated(PacketDotNet.Packet)">
  4536. <summary>
  4537. Returns the encapsulated PPPoE of the Packet p or null if
  4538. there is no encapsulated packet
  4539. </summary>
  4540. <param name="p">
  4541. A <see cref="T:PacketDotNet.Packet" /></param>
  4542. <returns>
  4543. A <see cref="T:PacketDotNet.ARPPacket" /></returns>
  4544. </member>
  4545. <member name="M:PacketDotNet.PPPoEPacket.RandomPacket">
  4546. <summary>
  4547. Generate a random PPPoEPacket
  4548. </summary>
  4549. <returns>
  4550. A <see cref="T:PacketDotNet.PPPoEPacket" /></returns>
  4551. </member>
  4552. <member name="T:PacketDotNet.PPPoEFields">
  4553. <summary>
  4554. Point to Point Protocol
  4555. See http://tools.ietf.org/html/rfc2516
  4556. </summary>
  4557. </member>
  4558. <member name="F:PacketDotNet.PPPoEFields.VersionTypeLength">
  4559. <summary> Size in bytes of the version/type field </summary>
  4560. </member>
  4561. <member name="F:PacketDotNet.PPPoEFields.CodeLength">
  4562. <summary> Size in bytes of the code field </summary>
  4563. </member>
  4564. <member name="F:PacketDotNet.PPPoEFields.SessionIdLength">
  4565. <summary> Size in bytes of the SessionId field </summary>
  4566. </member>
  4567. <member name="F:PacketDotNet.PPPoEFields.LengthLength">
  4568. <summary> Size in bytes of the Length field </summary>
  4569. </member>
  4570. <member name="F:PacketDotNet.PPPoEFields.VersionTypePosition">
  4571. <summary> Offset from the start of the header to the version/type field </summary>
  4572. </member>
  4573. <member name="F:PacketDotNet.PPPoEFields.CodePosition">
  4574. <summary> Offset from the start of the header to the Code field </summary>
  4575. </member>
  4576. <member name="F:PacketDotNet.PPPoEFields.SessionIdPosition">
  4577. <summary> Offset from the start of the header to the SessionId field </summary>
  4578. </member>
  4579. <member name="F:PacketDotNet.PPPoEFields.LengthPosition">
  4580. <summary> Offset from the start of the header to the Length field </summary>
  4581. </member>
  4582. <member name="F:PacketDotNet.PPPoEFields.HeaderLength">
  4583. <summary>
  4584. Length of the overall PPPoe header
  4585. </summary>
  4586. </member>
  4587. <member name="T:PacketDotNet.PPPoECode">
  4588. <summary>
  4589. Values for the Code field of a PPPoE packet
  4590. See http://tools.ietf.org/html/rfc2516
  4591. </summary>
  4592. </member>
  4593. <member name="F:PacketDotNet.PPPoECode.SessionStage">
  4594. <summary>
  4595. The PPPoe payload must contain a PPP packet
  4596. </summary>
  4597. </member>
  4598. <member name="F:PacketDotNet.PPPoECode.ActiveDiscoveryOffer">
  4599. <summary>
  4600. Active Discovery Offer (PADO) packet
  4601. </summary>
  4602. </member>
  4603. <member name="F:PacketDotNet.PPPoECode.ActiveDiscoveryInitiation">
  4604. <summary>
  4605. From RFC2516:
  4606. The Host sends the PADI packet with the DESTINATION_ADDR set to the
  4607. broadcast address. The CODE field is set to 0x09 and the SESSION_ID
  4608. MUST be set to 0x0000.
  4609. The PADI packet MUST contain exactly one TAG of TAG_TYPE Service-
  4610. Name, indicating the service the Host is requesting, and any number
  4611. of other TAG types. An entire PADI packet (including the PPPoE
  4612. header) MUST NOT exceed 1484 octets so as to leave sufficient room
  4613. for a relay agent to add a Relay-Session-Id TAG.
  4614. </summary>
  4615. </member>
  4616. <member name="F:PacketDotNet.PPPoECode.ActiveDiscoveryTerminate">
  4617. <summary>
  4618. Indicate that the PPPoe session specified by the SessionId field of
  4619. the PPPoe packet has been terminated
  4620. </summary>
  4621. </member>
  4622. <member name="T:PacketDotNet.PPPPacket">
  4623. <summary>
  4624. PPP packet
  4625. See http://en.wikipedia.org/wiki/Point-to-Point_Protocol
  4626. </summary>
  4627. </member>
  4628. <member name="M:PacketDotNet.PPPPacket.#ctor(PacketDotNet.PPPoECode,System.UInt16)">
  4629. <summary>
  4630. Construct a new PPPPacket from source and destination mac addresses
  4631. </summary>
  4632. </member>
  4633. <member name="M:PacketDotNet.PPPPacket.#ctor(PacketDotNet.Utils.ByteArraySegment)">
  4634. <summary>
  4635. Constructor
  4636. </summary>
  4637. <param name="bas">
  4638. A <see cref="T:PacketDotNet.Utils.ByteArraySegment" /></param>
  4639. </member>
  4640. <member name="P:PacketDotNet.PPPPacket.Protocol">
  4641. <summary>
  4642. See http://www.iana.org/assignments/ppp-numbers
  4643. </summary>
  4644. </member>
  4645. <member name="P:PacketDotNet.PPPPacket.Color">
  4646. <summary> Fetch ascii escape sequence of the color associated with this packet type.</summary>
  4647. </member>
  4648. <member name="M:PacketDotNet.PPPPacket.ToString(PacketDotNet.StringOutputType)">
  4649. <summary cref="Packet.ToString(StringOutputType)" />
  4650. </member>
  4651. <member name="M:PacketDotNet.PPPPacket.GetEncapsulated(PacketDotNet.Packet)">
  4652. <summary>
  4653. Returns the encapsulated PPPPacket of the Packet p or null if
  4654. there is no encapsulated packet
  4655. </summary>
  4656. <param name="p">
  4657. A <see cref="T:PacketDotNet.Packet" /></param>
  4658. <returns>
  4659. A <see cref="T:PacketDotNet.PPPPacket" /></returns>
  4660. </member>
  4661. <member name="M:PacketDotNet.PPPPacket.RandomPacket">
  4662. <summary>
  4663. Generate a random PPPoEPacket
  4664. </summary>
  4665. <returns>
  4666. A <see cref="T:PacketDotNet.PPPoEPacket" /></returns>
  4667. </member>
  4668. <member name="T:PacketDotNet.PPPFields">
  4669. <summary>
  4670. The fields in a PPP packet
  4671. See http://en.wikipedia.org/wiki/Point-to-Point_Protocol
  4672. </summary>
  4673. </member>
  4674. <member name="F:PacketDotNet.PPPFields.ProtocolLength">
  4675. <summary>
  4676. Length of the Protocol field in bytes, the field is of type
  4677. PPPProtocol
  4678. </summary>
  4679. </member>
  4680. <member name="F:PacketDotNet.PPPFields.ProtocolPosition">
  4681. <summary>
  4682. Offset from the start of the PPP packet where the Protocol field is located
  4683. </summary>
  4684. </member>
  4685. <member name="F:PacketDotNet.PPPFields.HeaderLength">
  4686. <summary>
  4687. The length of the header
  4688. </summary>
  4689. </member>
  4690. <member name="T:PacketDotNet.PPPProtocol">
  4691. <summary>
  4692. Indicates the protocol encapsulated by the PPP packet
  4693. See http://www.iana.org/assignments/ppp-numbers
  4694. </summary>
  4695. </member>
  4696. <member name="F:PacketDotNet.PPPProtocol.Padding">
  4697. <summary> Padding </summary>
  4698. </member>
  4699. <member name="F:PacketDotNet.PPPProtocol.IPv4">
  4700. <summary> IPv4 </summary>
  4701. </member>
  4702. <member name="F:PacketDotNet.PPPProtocol.IPv6">
  4703. <summary> IPv6 </summary>
  4704. </member>
  4705. <member name="T:PacketDotNet.ICMPv4TypeCodes">
  4706. <summary>
  4707. Code constants for ICMP message types.
  4708. From http://en.wikipedia.org/wiki/Internet_Control_Message_Protocol#List_of_permitted_control_messages_.28incomplete_list.29
  4709. Note that these values represent the combined
  4710. type and code fields, where the type field is the upper byte
  4711. </summary>
  4712. </member>
  4713. <member name="T:PacketDotNet.ICMPv4Fields">
  4714. <summary>
  4715. ICMP protocol field encoding information.
  4716. See http://en.wikipedia.org/wiki/ICMPv6
  4717. </summary>
  4718. </member>
  4719. <member name="F:PacketDotNet.ICMPv4Fields.TypeCodeLength">
  4720. <summary> Length of the ICMP message type code in bytes.</summary>
  4721. </member>
  4722. <member name="F:PacketDotNet.ICMPv4Fields.ChecksumLength">
  4723. <summary> Length of the ICMP header checksum in bytes.</summary>
  4724. </member>
  4725. <member name="F:PacketDotNet.ICMPv4Fields.IDLength">
  4726. <summary> Length of the ICMP ID field in bytes.</summary>
  4727. </member>
  4728. <member name="F:PacketDotNet.ICMPv4Fields.SequenceLength">
  4729. <summary> Length of the ICMP Sequence field in bytes </summary>
  4730. </member>
  4731. <member name="F:PacketDotNet.ICMPv4Fields.TypeCodePosition">
  4732. <summary> Position of the ICMP message type/code.</summary>
  4733. </member>
  4734. <member name="F:PacketDotNet.ICMPv4Fields.ChecksumPosition">
  4735. <summary> Position of the ICMP header checksum.</summary>
  4736. </member>
  4737. <member name="F:PacketDotNet.ICMPv4Fields.IDPosition">
  4738. <summary> Position of the ICMP ID field </summary>
  4739. </member>
  4740. <member name="F:PacketDotNet.ICMPv4Fields.SequencePosition">
  4741. <summary> Position of the Sequence field </summary>
  4742. </member>
  4743. <member name="F:PacketDotNet.ICMPv4Fields.HeaderLength">
  4744. <summary> Length in bytes of an ICMP header.</summary>
  4745. </member>
  4746. <member name="T:PacketDotNet.ICMPv4Packet">
  4747. <summary>
  4748. An ICMP packet
  4749. See http://en.wikipedia.org/wiki/Internet_Control_Message_Protocol
  4750. </summary>
  4751. </member>
  4752. <member name="M:PacketDotNet.ICMPv4Packet.#ctor(PacketDotNet.Utils.ByteArraySegment)">
  4753. <summary>
  4754. Constructor
  4755. </summary>
  4756. <param name="bas">
  4757. A <see cref="T:PacketDotNet.Utils.ByteArraySegment" /></param>
  4758. </member>
  4759. <member name="M:PacketDotNet.ICMPv4Packet.#ctor(PacketDotNet.Utils.ByteArraySegment,PacketDotNet.Packet)">
  4760. <summary>
  4761. Construct with parent packet
  4762. </summary>
  4763. <param name="bas">
  4764. A <see cref="T:PacketDotNet.Utils.ByteArraySegment" /></param>
  4765. <param name="ParentPacket">
  4766. A <see cref="T:PacketDotNet.Packet" /></param>
  4767. </member>
  4768. <member name="P:PacketDotNet.ICMPv4Packet.TypeCode">
  4769. <value>
  4770. The Type/Code enum value
  4771. </value>
  4772. </member>
  4773. <member name="P:PacketDotNet.ICMPv4Packet.Checksum">
  4774. <value>
  4775. Checksum value
  4776. </value>
  4777. </member>
  4778. <member name="P:PacketDotNet.ICMPv4Packet.ID">
  4779. <summary>
  4780. ID field
  4781. </summary>
  4782. </member>
  4783. <member name="P:PacketDotNet.ICMPv4Packet.Sequence">
  4784. <summary>
  4785. Sequence field
  4786. </summary>
  4787. </member>
  4788. <member name="P:PacketDotNet.ICMPv4Packet.Data">
  4789. <summary>
  4790. Contents of the ICMP packet
  4791. </summary>
  4792. </member>
  4793. <member name="P:PacketDotNet.ICMPv4Packet.Color">
  4794. <summary> Fetch ascii escape sequence of the color associated with this packet type.</summary>
  4795. </member>
  4796. <member name="M:PacketDotNet.ICMPv4Packet.ToString(PacketDotNet.StringOutputType)">
  4797. <summary cref="Packet.ToString(StringOutputType)" />
  4798. </member>
  4799. <member name="M:PacketDotNet.ICMPv4Packet.GetEncapsulated(PacketDotNet.Packet)">
  4800. <summary>
  4801. Returns the ICMPv4Packet inside of Packet p or null if
  4802. there is no encapsulated ICMPv4Packet
  4803. </summary>
  4804. <param name="p">
  4805. A <see cref="T:PacketDotNet.Packet" /></param>
  4806. <returns>
  4807. A <see cref="T:PacketDotNet.ICMPv4Packet" /></returns>
  4808. </member>
  4809. <member name="T:PacketDotNet.Utils.ByteArraySegment">
  4810. <summary>
  4811. Container class that refers to a segment of bytes in a byte[]
  4812. Used to ensure high performance by allowing memory copies to
  4813. be avoided
  4814. </summary>
  4815. </member>
  4816. <member name="M:PacketDotNet.Utils.ByteArraySegment.#ctor(System.Byte[])">
  4817. <summary>
  4818. Constructor
  4819. </summary>
  4820. <param name="Bytes">
  4821. A <see cref="T:System.Byte[]" /></param>
  4822. </member>
  4823. <member name="M:PacketDotNet.Utils.ByteArraySegment.#ctor(System.Byte[],System.Int32,System.Int32)">
  4824. <summary>
  4825. Constructor from a byte array, offset into the byte array and
  4826. a length beyond that offset of the bytes this class is referencing
  4827. </summary>
  4828. <param name="Bytes">
  4829. A <see cref="T:System.Byte" /></param>
  4830. <param name="Offset">
  4831. A <see cref="T:System.Int32" /></param>
  4832. <param name="Length">
  4833. A <see cref="T:System.Int32" /></param>
  4834. </member>
  4835. <member name="M:PacketDotNet.Utils.ByteArraySegment.#ctor(System.Byte[],System.Int32,System.Int32,System.Int32)">
  4836. <summary>
  4837. Constructor
  4838. </summary>
  4839. <param name="Bytes">
  4840. A <see cref="T:System.Byte[]" /></param>
  4841. <param name="Offset">
  4842. A <see cref="T:System.Int32" /></param>
  4843. <param name="Length">
  4844. A <see cref="T:System.Int32" /></param>
  4845. <param name="BytesLength">
  4846. A <see cref="T:System.Int32" /></param>
  4847. </member>
  4848. <member name="M:PacketDotNet.Utils.ByteArraySegment.#ctor(PacketDotNet.Utils.ByteArraySegment)">
  4849. <summary>
  4850. Copy constructor
  4851. </summary>
  4852. <param name="original">
  4853. A <see cref="T:PacketDotNet.Utils.ByteArraySegment" /></param>
  4854. </member>
  4855. <member name="P:PacketDotNet.Utils.ByteArraySegment.Bytes">
  4856. <value>
  4857. The byte[] array
  4858. </value>
  4859. </member>
  4860. <member name="P:PacketDotNet.Utils.ByteArraySegment.BytesLength">
  4861. <value>
  4862. The maximum number of bytes we should treat Bytes as having, allows
  4863. for controling the number of bytes produced by EncapsulatedBytes()
  4864. </value>
  4865. </member>
  4866. <member name="P:PacketDotNet.Utils.ByteArraySegment.Length">
  4867. <value>
  4868. Number of bytes beyond the offset into Bytes
  4869. </value>
  4870. </member>
  4871. <member name="P:PacketDotNet.Utils.ByteArraySegment.Offset">
  4872. <value>
  4873. Offset into Bytes
  4874. </value>
  4875. </member>
  4876. <member name="P:PacketDotNet.Utils.ByteArraySegment.NeedsCopyForActualBytes">
  4877. <summary>
  4878. Return true if we need to perform a copy to get
  4879. the bytes represented by this class
  4880. </summary>
  4881. <returns>
  4882. A <see cref="T:System.Boolean" /></returns>
  4883. </member>
  4884. <member name="M:PacketDotNet.Utils.ByteArraySegment.ActualBytes">
  4885. <summary>
  4886. Returns a contiguous byte[] from this container, if necessary, by copying
  4887. the bytes from the current offset into a newly allocated byte[].
  4888. NeedsCopyForActualBytes can be used to determine if the copy is necessary
  4889. </summary>
  4890. <returns>
  4891. A <see cref="T:System.Byte" /></returns>
  4892. </member>
  4893. <member name="M:PacketDotNet.Utils.ByteArraySegment.EncapsulatedBytes">
  4894. <summary>
  4895. Helper method that returns the segment immediately following
  4896. this instance, useful for processing where the parent
  4897. wants to pass the next segment to a sub class for processing
  4898. </summary>
  4899. <returns>
  4900. A <see cref="T:PacketDotNet.Utils.ByteArraySegment" /></returns>
  4901. </member>
  4902. <member name="M:PacketDotNet.Utils.ByteArraySegment.EncapsulatedBytes(System.Int32)">
  4903. <summary>
  4904. Create the segment after the current one
  4905. </summary>
  4906. <param name="NewSegmentLength">
  4907. A <see cref="T:System.Int32" /> that can be used to limit the segment length
  4908. of the ByteArraySegment that is to be returned. Often used to exclude trailing bytes.
  4909. </param>
  4910. <returns>
  4911. A <see cref="T:PacketDotNet.Utils.ByteArraySegment" /></returns>
  4912. </member>
  4913. <member name="M:PacketDotNet.Utils.ByteArraySegment.ToString">
  4914. <summary>
  4915. Format the class information as a string
  4916. </summary>
  4917. <returns>
  4918. A <see cref="T:System.String" /></returns>
  4919. </member>
  4920. <member name="T:PacketDotNet.PacketOrByteArraySegment">
  4921. <summary>
  4922. Encapsulates and ensures that we have either a Packet OR
  4923. a ByteArraySegment but not both
  4924. </summary>
  4925. </member>
  4926. <member name="P:PacketDotNet.PacketOrByteArraySegment.Type">
  4927. <value>
  4928. Whether or not this container contains a packet, a byte[] or neither
  4929. </value>
  4930. </member>
  4931. <member name="M:PacketDotNet.PacketOrByteArraySegment.AppendToMemoryStream(System.IO.MemoryStream)">
  4932. <summary>
  4933. Appends to the MemoryStream either the byte[] represented by TheByteArray, or
  4934. if ThePacket is non-null, the Packet.Bytes will be appended to the memory stream
  4935. which will append ThePacket's header and any encapsulated packets it contains
  4936. </summary>
  4937. <param name="ms">
  4938. A <see cref="T:System.IO.MemoryStream" /></param>
  4939. </member>
  4940. <member name="T:PacketDotNet.LLDPPacket">
  4941. <summary>
  4942. A LLDP packet.
  4943. As specified in IEEE Std 802.1AB
  4944. </summary>
  4945. <remarks>
  4946. See http://en.wikipedia.org/wiki/Link_Layer_Discovery_Protocol for general info
  4947. See IETF 802.1AB for the full specification
  4948. </remarks>
  4949. </member>
  4950. <member name="M:PacketDotNet.LLDPPacket.#ctor">
  4951. <summary>
  4952. Create an empty LLDPPacket
  4953. </summary>
  4954. </member>
  4955. <member name="M:PacketDotNet.LLDPPacket.#ctor(PacketDotNet.Utils.ByteArraySegment)">
  4956. <summary>
  4957. Constructor
  4958. </summary>
  4959. <param name="bas">
  4960. A <see cref="T:PacketDotNet.Utils.ByteArraySegment" /></param>
  4961. </member>
  4962. <member name="F:PacketDotNet.LLDPPacket.TlvCollection">
  4963. <summary>
  4964. Contains the TLV's in the LLDPDU
  4965. </summary>
  4966. </member>
  4967. <member name="P:PacketDotNet.LLDPPacket.Item(System.Int32)">
  4968. <summary>
  4969. Allows access of the TlvCollection by index
  4970. </summary>
  4971. <param name="index">The index of the item being set/retrieved in the collection</param>
  4972. <returns>The requested TLV</returns>
  4973. </member>
  4974. <member name="P:PacketDotNet.LLDPPacket.Length">
  4975. <value>
  4976. The current length of the LLDPDU
  4977. </value>
  4978. </member>
  4979. <member name="P:PacketDotNet.LLDPPacket.BytesHighPerformance">
  4980. <summary>
  4981. LLDPPacket specific implementation of BytesHighPerformance
  4982. Necessary because each TLV in the collection may have a
  4983. byte[] that is not shared by other TLVs
  4984. NOTE: There is potential for the same performance improvement that
  4985. the Packet class uses where we check to see if each TLVs uses the
  4986. same byte[] and that there are no gaps.
  4987. </summary>
  4988. </member>
  4989. <member name="M:PacketDotNet.LLDPPacket.GetEnumerator">
  4990. <summary>
  4991. Enables foreach functionality for this class
  4992. </summary>
  4993. <returns>The next item in the list</returns>
  4994. </member>
  4995. <member name="M:PacketDotNet.LLDPPacket.ParseByteArrayIntoTlvs(System.Byte[],System.Int32)">
  4996. <summary>
  4997. Parse byte[] into TLVs
  4998. </summary>
  4999. </member>
  5000. <member name="M:PacketDotNet.LLDPPacket.TLVFactory(System.Byte[],System.Int32,PacketDotNet.LLDP.TLVTypes)">
  5001. <summary>
  5002. </summary>
  5003. <param name="Bytes">
  5004. A <see cref="T:System.Byte[]" /></param>
  5005. <param name="offset">
  5006. A <see cref="T:System.Int32" /></param>
  5007. <param name="type">
  5008. A <see cref="T:PacketDotNet.LLDP.TLVTypes" /></param>
  5009. <returns>
  5010. A <see cref="T:PacketDotNet.LLDP.TLV" /></returns>
  5011. </member>
  5012. <member name="M:PacketDotNet.LLDPPacket.GetEncapsulated(PacketDotNet.Packet)">
  5013. <summary>
  5014. Returns the LLDP inside of the Packet p or null if
  5015. there is no encapsulated packet
  5016. </summary>
  5017. <param name="p">
  5018. A <see cref="T:PacketDotNet.Packet" /></param>
  5019. <returns>
  5020. A <see cref="T:PacketDotNet.IpPacket" /></returns>
  5021. </member>
  5022. <member name="M:PacketDotNet.LLDPPacket.RandomPacket">
  5023. <summary>
  5024. Create a randomized LLDP packet with some basic TLVs
  5025. </summary>
  5026. <returns>
  5027. A <see cref="T:PacketDotNet.Packet" /></returns>
  5028. </member>
  5029. <member name="M:PacketDotNet.LLDPPacket.ToString(PacketDotNet.StringOutputType)">
  5030. <summary cref="Packet.ToString(StringOutputType)" />
  5031. </member>
  5032. <member name="T:PacketDotNet.LLDP.TLVTypes">
  5033. <summary>
  5034. The TLV Types
  5035. </summary>
  5036. <remarks>
  5037. See IETF RFC 802.1AB for more info
  5038. </remarks>
  5039. </member>
  5040. <member name="F:PacketDotNet.LLDP.TLVTypes.EndOfLLDPU">
  5041. <summary>Signifies the end of a LLDPU</summary>
  5042. <description>
  5043. The End Of LLDPDU TLV is a 2-octet, all-zero
  5044. TLV that is used to mark the end of the TLV
  5045. sequence in LLDPDUs
  5046. </description>
  5047. <remarks>Source: IETF RFC 802.1AB</remarks>
  5048. </member>
  5049. <member name="F:PacketDotNet.LLDP.TLVTypes.ChassisID">
  5050. <summary>A Chassis Identifier</summary>
  5051. <description>
  5052. A mandatory TLV that identifies the chassis
  5053. containing the IEEE 802 LAN station
  5054. associated with the transmitting LLDP agent
  5055. </description>
  5056. <remarks>Source: IETF RFC 802.1AB</remarks>
  5057. </member>
  5058. <member name="F:PacketDotNet.LLDP.TLVTypes.PortID">
  5059. <summary>A Port Identifier</summary>
  5060. <description>
  5061. A mandatory TLV that identifies the
  5062. port component of the MSAP identifier associated
  5063. with the transmitting LLDP agent.
  5064. </description>
  5065. <remarks>Source: IETF RFC 802.1AB</remarks>
  5066. </member>
  5067. <member name="F:PacketDotNet.LLDP.TLVTypes.TimeToLive">
  5068. <summary>Specifies the Time to Live</summary>
  5069. <description>
  5070. Indicates the number of seconds that the
  5071. recipient LLDP agent is to regard the information
  5072. associated with this MSAP identifier to be valid
  5073. A value of 0 signals that this source is no longer
  5074. available and all information associated with it
  5075. should be deleted.
  5076. </description>
  5077. <remarks>Source: IETF RFC 802.1AB</remarks>
  5078. </member>
  5079. <member name="F:PacketDotNet.LLDP.TLVTypes.PortDescription">
  5080. <summary>A Description of the Port</summary>
  5081. <description>
  5082. The port description field shall contain an
  5083. alpha-numeric string that indicates the port’s
  5084. description.
  5085. </description>
  5086. <remarks>Source: IETF RFC 802.1AB</remarks>
  5087. </member>
  5088. <member name="F:PacketDotNet.LLDP.TLVTypes.SystemName">
  5089. <summary>The System's Assigned Name</summary>
  5090. <description>
  5091. The System Name TLV allows network management
  5092. to advertise the system’s assigned name.
  5093. </description>
  5094. <remarks>Source: IETF RFC 802.1AB</remarks>
  5095. </member>
  5096. <member name="F:PacketDotNet.LLDP.TLVTypes.SystemDescription">
  5097. <summary>A Description of the System</summary>
  5098. <description>
  5099. The System Description TLV allows network
  5100. management to advertise the system’s description
  5101. </description>
  5102. <remarks>Source: IETF RFC 802.1AB</remarks>
  5103. </member>
  5104. <member name="F:PacketDotNet.LLDP.TLVTypes.SystemCapabilities">
  5105. <summary>A bitmap containing the System's capabilities</summary>
  5106. <description>
  5107. The System Capabilities TLV is an optional TLV
  5108. that identifies the primary function(s) of the
  5109. system and whether or not these primary functions
  5110. are enabled.
  5111. </description>
  5112. <remarks>Source: IETF RFC 802.1AB</remarks>
  5113. </member>
  5114. <member name="F:PacketDotNet.LLDP.TLVTypes.ManagementAddress">
  5115. <summary>The Management Address</summary>
  5116. <description>
  5117. The Management Address TLV identifies an address
  5118. associated with the local LLDP agent that may be
  5119. used to reach higher layer entities to assist
  5120. discovery by network management.
  5121. </description>
  5122. <remarks>Source: IETF RFC 802.1AB</remarks>
  5123. </member>
  5124. <member name="F:PacketDotNet.LLDP.TLVTypes.OrganizationSpecific">
  5125. <summary>A vendor-specifid TLV</summary>
  5126. <description>
  5127. This TLV category is provided to allow different
  5128. organizations, such as IEEE 802.1, IEEE 802.3, IETF,
  5129. as well as individual software and equipment vendors,
  5130. to define TLVs that advertise information to remote
  5131. entities attached to the same media.
  5132. </description>
  5133. <remarks>Source: IETF RFC 802.1AB</remarks>
  5134. </member>
  5135. <member name="T:PacketDotNet.LLDP.ChassisSubTypes">
  5136. <summary>
  5137. The Chassis ID TLV subtypes
  5138. </summary>
  5139. </member>
  5140. <member name="F:PacketDotNet.LLDP.ChassisSubTypes.ChassisComponent">
  5141. <summary>A Chassis Component identifier</summary>
  5142. <remarks>See IETF RFC 2737</remarks>
  5143. </member>
  5144. <member name="F:PacketDotNet.LLDP.ChassisSubTypes.InterfaceAlias">
  5145. <summary>An Interface Alias identifier</summary>
  5146. <remarks>See IETF RFC 2863</remarks>
  5147. </member>
  5148. <member name="F:PacketDotNet.LLDP.ChassisSubTypes.PortComponent">
  5149. <summary>A Port Component identifier</summary>
  5150. <remarks>See IETF RFC 2737</remarks>
  5151. </member>
  5152. <member name="F:PacketDotNet.LLDP.ChassisSubTypes.MACAddress">
  5153. <summary>A MAC (Media Access Control) Address identifier</summary>
  5154. <remarks>See IEEE Std 802</remarks>
  5155. </member>
  5156. <member name="F:PacketDotNet.LLDP.ChassisSubTypes.NetworkAddress">
  5157. <summary>A Network Address (IP Address) Identifier</summary>
  5158. <remarks>See IEEE Std 802</remarks>
  5159. </member>
  5160. <member name="F:PacketDotNet.LLDP.ChassisSubTypes.InterfaceName">
  5161. <summary>An Interface Name identifier</summary>
  5162. <remarks>See IEEE Std 802</remarks>
  5163. </member>
  5164. <member name="F:PacketDotNet.LLDP.ChassisSubTypes.LocallyAssigned">
  5165. <summary>A Locally Assigned identifier</summary>
  5166. </member>
  5167. <member name="T:PacketDotNet.LLDP.PortSubTypes">
  5168. <summary>
  5169. The Port ID TLV subtypes
  5170. </summary>
  5171. </member>
  5172. <member name="F:PacketDotNet.LLDP.PortSubTypes.InterfaceAlias">
  5173. <summary>An Interface Alias identifier</summary>
  5174. <remarks>See IETF RFC 2863</remarks>
  5175. </member>
  5176. <member name="F:PacketDotNet.LLDP.PortSubTypes.PortComponent">
  5177. <summary>A Port Component identifier</summary>
  5178. <remarks>See IETF RFC 2737</remarks>
  5179. </member>
  5180. <member name="F:PacketDotNet.LLDP.PortSubTypes.MACAddress">
  5181. <summary>A MAC (Media Access Control) Address identifier</summary>
  5182. <remarks>See IEEE Std 802</remarks>
  5183. </member>
  5184. <member name="F:PacketDotNet.LLDP.PortSubTypes.NetworkAddress">
  5185. <summary>A Network Address (IP Address) Identifier</summary>
  5186. <remarks>See IEEE Std 802</remarks>
  5187. </member>
  5188. <member name="F:PacketDotNet.LLDP.PortSubTypes.InterfaceName">
  5189. <summary>An Interface Name identifier</summary>
  5190. <remarks>See IEEE Std 802</remarks>
  5191. </member>
  5192. <member name="F:PacketDotNet.LLDP.PortSubTypes.AgentCircuitID">
  5193. <summary>An Agent Circiut ID identifier</summary>
  5194. <remarks>See IETF RFC 3046</remarks>
  5195. </member>
  5196. <member name="F:PacketDotNet.LLDP.PortSubTypes.LocallyAssigned">
  5197. <summary>A Locally Assigned identifier</summary>
  5198. <remarks>See IETF RFC 3046</remarks>
  5199. </member>
  5200. <member name="T:PacketDotNet.LLDP.CapabilityOptions">
  5201. <summary>
  5202. The System Capabilities options
  5203. </summary>
  5204. </member>
  5205. <member name="F:PacketDotNet.LLDP.CapabilityOptions.Other">
  5206. <summary>
  5207. An Other Type of System
  5208. </summary>
  5209. </member>
  5210. <member name="F:PacketDotNet.LLDP.CapabilityOptions.Repeater">
  5211. <summary>A Repeater</summary>
  5212. <remarks>See IETF RFC 2108</remarks>
  5213. </member>
  5214. <member name="F:PacketDotNet.LLDP.CapabilityOptions.Bridge">
  5215. <summary>A Bridge</summary>
  5216. <remarks>IETF RFC 2674</remarks>
  5217. </member>
  5218. <member name="F:PacketDotNet.LLDP.CapabilityOptions.WLanAP">
  5219. <summary>A WLAN Access Point</summary>
  5220. <remarks>IEEE 802.11 MIB</remarks>
  5221. </member>
  5222. <member name="F:PacketDotNet.LLDP.CapabilityOptions.Router">
  5223. <summary>A Router</summary>
  5224. <remarks>IETF RFC 1812</remarks>
  5225. </member>
  5226. <member name="F:PacketDotNet.LLDP.CapabilityOptions.Telephone">
  5227. <summary>A Telephone</summary>
  5228. <remarks>IETF RFC 2011 </remarks>
  5229. </member>
  5230. <member name="F:PacketDotNet.LLDP.CapabilityOptions.DocsisCableDevice">
  5231. <summary>A DOCSIS Cable Device</summary>
  5232. <remarks>
  5233. See IETF RFC 2669
  5234. See IETF RFC 2670
  5235. </remarks>
  5236. </member>
  5237. <member name="F:PacketDotNet.LLDP.CapabilityOptions.StationOnly">
  5238. <summary>A Station with no other capabilities</summary>
  5239. <remarks>IETF RFC 2011</remarks>
  5240. </member>
  5241. <member name="T:PacketDotNet.LLDP.TLV">
  5242. <summary>
  5243. A Type-Length-Value object
  5244. </summary>
  5245. </member>
  5246. <member name="M:PacketDotNet.LLDP.TLV.#ctor">
  5247. <summary>
  5248. Create a tlv
  5249. </summary>
  5250. </member>
  5251. <member name="M:PacketDotNet.LLDP.TLV.#ctor(System.Byte[],System.Int32)">
  5252. <summary>
  5253. Creates a TLV
  5254. </summary>
  5255. <param name="bytes">
  5256. Bytes that comprise the TLV
  5257. </param>
  5258. <param name="offset">
  5259. The TLVs offset from the start of byte[] bytes
  5260. </param>
  5261. </member>
  5262. <member name="F:PacketDotNet.LLDP.TLV._tlvData">
  5263. <summary>
  5264. Points to the TLV data
  5265. </summary>
  5266. </member>
  5267. <member name="F:PacketDotNet.LLDP.TLV.TypeLength">
  5268. <summary>
  5269. Interface to this TLVs type and length
  5270. </summary>
  5271. </member>
  5272. <member name="P:PacketDotNet.LLDP.TLV.Length">
  5273. <summary>
  5274. Length of value portion of the TLV
  5275. NOTE: Does not include the length of the Type and Length fields
  5276. </summary>
  5277. </member>
  5278. <member name="P:PacketDotNet.LLDP.TLV.TotalLength">
  5279. <summary>
  5280. Total length of the TLV, including the length of the Type and Length fields
  5281. </summary>
  5282. </member>
  5283. <member name="P:PacketDotNet.LLDP.TLV.Type">
  5284. <summary>
  5285. Tlv type
  5286. </summary>
  5287. </member>
  5288. <member name="P:PacketDotNet.LLDP.TLV.ValueOffset">
  5289. <summary>
  5290. Offset to the value bytes of the TLV
  5291. </summary>
  5292. </member>
  5293. <member name="P:PacketDotNet.LLDP.TLV.Bytes">
  5294. <summary>
  5295. Return a byte[] that contains the tlv
  5296. </summary>
  5297. </member>
  5298. <member name="P:PacketDotNet.LLDP.TLV.tlvData">
  5299. <summary>
  5300. Points to the TLV data
  5301. </summary>
  5302. </member>
  5303. <member name="T:PacketDotNet.LLDP.NetworkAddress">
  5304. <summary>
  5305. A Network Address
  5306. </summary>
  5307. </member>
  5308. <member name="M:PacketDotNet.LLDP.NetworkAddress.#ctor(System.Net.IPAddress)">
  5309. <summary>
  5310. Creates a Network Address entity
  5311. </summary>
  5312. <param name="address">
  5313. The Network Address
  5314. </param>
  5315. </member>
  5316. <member name="M:PacketDotNet.LLDP.NetworkAddress.#ctor(System.Byte[],System.Int32,System.Int32)">
  5317. <summary>
  5318. Create a network address from byte data
  5319. </summary>
  5320. <param name="bytes">
  5321. A <see cref="T:System.Byte[]" /></param>
  5322. <param name="offset">
  5323. A <see cref="T:System.Int32" /></param>
  5324. <param name="length">
  5325. A <see cref="T:System.Int32" /></param>
  5326. </member>
  5327. <member name="F:PacketDotNet.LLDP.NetworkAddress.AddressFamilyLength">
  5328. <summary>
  5329. Length of AddressFamily field in bytes
  5330. </summary>
  5331. </member>
  5332. <member name="P:PacketDotNet.LLDP.NetworkAddress.Length">
  5333. <summary>
  5334. Number of bytes in the NetworkAddress
  5335. </summary>
  5336. </member>
  5337. <member name="P:PacketDotNet.LLDP.NetworkAddress.AddressFamily">
  5338. <summary>The format of the Network Address</summary>
  5339. </member>
  5340. <member name="P:PacketDotNet.LLDP.NetworkAddress.Address">
  5341. <summary>The Network Address</summary>
  5342. </member>
  5343. <member name="M:PacketDotNet.LLDP.NetworkAddress.Equals(System.Object)">
  5344. <summary>
  5345. Equals override
  5346. </summary>
  5347. <param name="obj">
  5348. A <see cref="T:System.Object" /></param>
  5349. <returns>
  5350. A <see cref="T:System.Boolean" /></returns>
  5351. </member>
  5352. <member name="M:PacketDotNet.LLDP.NetworkAddress.GetHashCode">
  5353. <summary>
  5354. GetHashCode() override
  5355. </summary>
  5356. <returns>
  5357. A <see cref="T:System.Int32" /></returns>
  5358. </member>
  5359. <member name="M:PacketDotNet.LLDP.NetworkAddress.ToString">
  5360. <summary>
  5361. ToString() override
  5362. </summary>
  5363. <returns>
  5364. A <see cref="T:System.String" /></returns>
  5365. </member>
  5366. <member name="T:PacketDotNet.LLDP.InterfaceNumbering">
  5367. <summary>
  5368. Interface Numbering Types
  5369. </summary>
  5370. <remarks>Source IETF RFC 802.1AB</remarks>
  5371. </member>
  5372. <member name="F:PacketDotNet.LLDP.InterfaceNumbering.Unknown">
  5373. <summary>Unknown</summary>
  5374. </member>
  5375. <member name="F:PacketDotNet.LLDP.InterfaceNumbering.ifIndex">
  5376. <summary>Interface Index</summary>
  5377. </member>
  5378. <member name="F:PacketDotNet.LLDP.InterfaceNumbering.SystemPortNumber">
  5379. <summary>System Port Number</summary>
  5380. </member>
  5381. <member name="T:PacketDotNet.LLDP.EndOfLLDPDU">
  5382. <summary>
  5383. An End Of LLDPDU TLV
  5384. </summary>
  5385. </member>
  5386. <member name="M:PacketDotNet.LLDP.EndOfLLDPDU.#ctor(System.Byte[],System.Int32)">
  5387. <summary>
  5388. Parses bytes into an End Of LLDPDU TLV
  5389. </summary>
  5390. <param name="bytes">
  5391. TLV bytes
  5392. </param>
  5393. <param name="offset">
  5394. The End Of LLDPDU TLV's offset from the
  5395. origin of the LLDP
  5396. </param>
  5397. </member>
  5398. <member name="M:PacketDotNet.LLDP.EndOfLLDPDU.#ctor">
  5399. <summary>
  5400. Creates an End Of LLDPDU TLV
  5401. </summary>
  5402. </member>
  5403. <member name="M:PacketDotNet.LLDP.EndOfLLDPDU.ToString">
  5404. <summary>
  5405. Convert this TTL TLV to a string.
  5406. </summary>
  5407. <returns>
  5408. A human readable string
  5409. </returns>
  5410. </member>
  5411. <member name="T:PacketDotNet.LLDP.ChassisID">
  5412. <summary>
  5413. A Chassis ID TLV
  5414. </summary>
  5415. </member>
  5416. <member name="M:PacketDotNet.LLDP.ChassisID.#ctor(System.Byte[],System.Int32)">
  5417. <summary>
  5418. Creates a Chassis ID TLV by parsing a byte[]
  5419. </summary>
  5420. <param name="bytes">
  5421. </param>
  5422. <param name="offset">
  5423. The Chassis ID TLV's offset from the
  5424. origin of the LLDP
  5425. </param>
  5426. </member>
  5427. <member name="M:PacketDotNet.LLDP.ChassisID.#ctor(PacketDotNet.LLDP.ChassisSubTypes,System.Object)">
  5428. <summary>
  5429. Creates a Chassis ID TLV and sets it value
  5430. </summary>
  5431. <param name="subType">
  5432. The ChassisID subtype
  5433. </param>
  5434. <param name="subTypeValue">
  5435. The subtype's value
  5436. </param>
  5437. </member>
  5438. <member name="M:PacketDotNet.LLDP.ChassisID.#ctor(System.Net.NetworkInformation.PhysicalAddress)">
  5439. <summary>
  5440. Create a ChassisID given a mac address
  5441. </summary>
  5442. <param name="MACAddress">
  5443. A <see cref="T:System.Net.NetworkInformation.PhysicalAddress" /></param>
  5444. </member>
  5445. <member name="M:PacketDotNet.LLDP.ChassisID.#ctor(System.String)">
  5446. <summary>
  5447. Create a ChassisID given an interface name
  5448. http://tools.ietf.org/search/rfc2863 page 38
  5449. </summary>
  5450. <param name="InterfaceName">
  5451. A <see cref="T:System.String" /></param>
  5452. </member>
  5453. <member name="F:PacketDotNet.LLDP.ChassisID.SubTypeLength">
  5454. <summary>
  5455. Length of the sub type field in bytes
  5456. </summary>
  5457. </member>
  5458. <member name="P:PacketDotNet.LLDP.ChassisID.SubType">
  5459. <value>
  5460. The type of the TLV subtype
  5461. </value>
  5462. </member>
  5463. <member name="P:PacketDotNet.LLDP.ChassisID.SubTypeValue">
  5464. <value>
  5465. The TLV subtype value
  5466. </value>
  5467. </member>
  5468. <member name="P:PacketDotNet.LLDP.ChassisID.ChassisComponent">
  5469. <summary>
  5470. If SubType is ChassisComponent
  5471. </summary>
  5472. </member>
  5473. <member name="P:PacketDotNet.LLDP.ChassisID.InterfaceName">
  5474. <summary>
  5475. If SubType is InterfaceName the interface name
  5476. </summary>
  5477. </member>
  5478. <member name="P:PacketDotNet.LLDP.ChassisID.MACAddress">
  5479. <summary>
  5480. If SubType is MACAddress the mac address
  5481. </summary>
  5482. </member>
  5483. <member name="P:PacketDotNet.LLDP.ChassisID.NetworkAddress">
  5484. <summary>
  5485. If SubType is NetworkAddress the network address
  5486. </summary>
  5487. </member>
  5488. <member name="P:PacketDotNet.LLDP.ChassisID.PortComponent">
  5489. <summary>
  5490. If SubType is PortComponent
  5491. </summary>
  5492. </member>
  5493. <member name="P:PacketDotNet.LLDP.ChassisID.InterfaceAlias">
  5494. <summary>
  5495. If SubType is InterfaceAlias
  5496. </summary>
  5497. </member>
  5498. <member name="M:PacketDotNet.LLDP.ChassisID.EmptyTLVDataInit">
  5499. <summary>
  5500. Helper method to reduce duplication in type specific constructors
  5501. </summary>
  5502. </member>
  5503. <member name="M:PacketDotNet.LLDP.ChassisID.ToString">
  5504. <summary>
  5505. Convert this Chassis ID TLV to a string.
  5506. </summary>
  5507. <returns>
  5508. A human readable string
  5509. </returns>
  5510. </member>
  5511. <member name="T:PacketDotNet.LLDP.PortID">
  5512. <summary>
  5513. A Port ID TLV
  5514. </summary>
  5515. </member>
  5516. <member name="M:PacketDotNet.LLDP.PortID.#ctor(System.Byte[],System.Int32)">
  5517. <summary>
  5518. Creates a Port ID TLV
  5519. </summary>
  5520. <param name="bytes">
  5521. </param>
  5522. <param name="offset">
  5523. The Port ID TLV's offset from the
  5524. origin of the LLDP
  5525. </param>
  5526. </member>
  5527. <member name="M:PacketDotNet.LLDP.PortID.#ctor(PacketDotNet.LLDP.PortSubTypes,System.Object)">
  5528. <summary>
  5529. Creates a Port ID TLV and sets it value
  5530. </summary>
  5531. <param name="subType">
  5532. The Port ID SubType
  5533. </param>
  5534. <param name="subTypeValue">
  5535. The subtype's value
  5536. </param>
  5537. </member>
  5538. <member name="M:PacketDotNet.LLDP.PortID.#ctor(PacketDotNet.LLDP.NetworkAddress)">
  5539. <summary>
  5540. Construct a PortID from a NetworkAddress
  5541. </summary>
  5542. <param name="networkAddress">
  5543. A <see cref="T:PacketDotNet.LLDP.NetworkAddress" /></param>
  5544. </member>
  5545. <member name="P:PacketDotNet.LLDP.PortID.SubType">
  5546. <value>
  5547. The type of the TLV subtype
  5548. </value>
  5549. </member>
  5550. <member name="P:PacketDotNet.LLDP.PortID.SubTypeValue">
  5551. <value>
  5552. The TLV subtype value
  5553. </value>
  5554. </member>
  5555. <member name="P:PacketDotNet.LLDP.PortID.DataOffset">
  5556. <summary>
  5557. Offset to the value field
  5558. </summary>
  5559. </member>
  5560. <member name="P:PacketDotNet.LLDP.PortID.DataLength">
  5561. <summary>
  5562. Size of the value field
  5563. </summary>
  5564. </member>
  5565. <member name="M:PacketDotNet.LLDP.PortID.EmptyTLVDataInit">
  5566. <summary>
  5567. Helper method to reduce duplication in type specific constructors
  5568. </summary>
  5569. </member>
  5570. <member name="M:PacketDotNet.LLDP.PortID.ToString">
  5571. <summary>
  5572. Convert this Port ID TLV to a string.
  5573. </summary>
  5574. <returns>
  5575. A human readable string
  5576. </returns>
  5577. </member>
  5578. <member name="T:PacketDotNet.LLDP.TimeToLive">
  5579. <summary>
  5580. A Time to Live TLV
  5581. </summary>
  5582. </member>
  5583. <member name="M:PacketDotNet.LLDP.TimeToLive.#ctor(System.Byte[],System.Int32)">
  5584. <summary>
  5585. Creates a TTL TLV
  5586. </summary>
  5587. <param name="bytes">
  5588. </param>
  5589. <param name="offset">
  5590. The TTL TLV's offset from the
  5591. origin of the LLDP
  5592. </param>
  5593. </member>
  5594. <member name="M:PacketDotNet.LLDP.TimeToLive.#ctor(System.UInt16)">
  5595. <summary>
  5596. Creates a TTL TLV and sets it value
  5597. </summary>
  5598. <param name="seconds">
  5599. The length in seconds until the LLDP
  5600. is refreshed
  5601. </param>
  5602. </member>
  5603. <member name="F:PacketDotNet.LLDP.TimeToLive.ValueLength">
  5604. <summary>
  5605. Number of bytes in the value portion of this tlv
  5606. </summary>
  5607. </member>
  5608. <member name="P:PacketDotNet.LLDP.TimeToLive.Seconds">
  5609. <value>
  5610. The number of seconds until the LLDP needs
  5611. to be refreshed
  5612. A value of 0 means that the LLDP source is
  5613. closed and should no longer be refreshed
  5614. </value>
  5615. </member>
  5616. <member name="M:PacketDotNet.LLDP.TimeToLive.ToString">
  5617. <summary>
  5618. Convert this TTL TLV to a string.
  5619. </summary>
  5620. <returns>
  5621. A human readable string
  5622. </returns>
  5623. </member>
  5624. <member name="T:PacketDotNet.LLDP.PortDescription">
  5625. <summary>
  5626. A Port Description TLV
  5627. </summary>
  5628. </member>
  5629. <member name="M:PacketDotNet.LLDP.PortDescription.#ctor(System.Byte[],System.Int32)">
  5630. <summary>
  5631. Creates a Port Description TLV
  5632. </summary>
  5633. <param name="bytes">
  5634. </param>
  5635. <param name="offset">
  5636. The Port Description TLV's offset from the
  5637. origin of the LLDP
  5638. </param>
  5639. </member>
  5640. <member name="M:PacketDotNet.LLDP.PortDescription.#ctor(System.String)">
  5641. <summary>
  5642. Creates a Port Description TLV and sets it value
  5643. </summary>
  5644. <param name="description">
  5645. A textual description of the port
  5646. </param>
  5647. </member>
  5648. <member name="P:PacketDotNet.LLDP.PortDescription.Description">
  5649. <value>
  5650. A textual Description of the port
  5651. </value>
  5652. </member>
  5653. <member name="T:PacketDotNet.LLDP.SystemName">
  5654. <summary>
  5655. A System Name TLV
  5656. </summary>
  5657. </member>
  5658. <member name="M:PacketDotNet.LLDP.SystemName.#ctor(System.Byte[],System.Int32)">
  5659. <summary>
  5660. Creates a System Name TLV
  5661. </summary>
  5662. <param name="bytes">
  5663. </param>
  5664. <param name="offset">
  5665. The System Name TLV's offset from the
  5666. origin of the LLDP
  5667. </param>
  5668. </member>
  5669. <member name="M:PacketDotNet.LLDP.SystemName.#ctor(System.String)">
  5670. <summary>
  5671. Creates a System Name TLV and sets it value
  5672. </summary>
  5673. <param name="name">
  5674. A textual Name of the system
  5675. </param>
  5676. </member>
  5677. <member name="P:PacketDotNet.LLDP.SystemName.Name">
  5678. <value>
  5679. A textual Name of the system
  5680. </value>
  5681. </member>
  5682. <member name="T:PacketDotNet.LLDP.SystemDescription">
  5683. <summary>
  5684. A System Description TLV
  5685. </summary>
  5686. </member>
  5687. <member name="M:PacketDotNet.LLDP.SystemDescription.#ctor(System.Byte[],System.Int32)">
  5688. <summary>
  5689. Creates a System Description TLV
  5690. </summary>
  5691. <param name="bytes">
  5692. </param>
  5693. <param name="offset">
  5694. The System Description TLV's offset from the
  5695. origin of the LLDP
  5696. </param>
  5697. </member>
  5698. <member name="M:PacketDotNet.LLDP.SystemDescription.#ctor(System.String)">
  5699. <summary>
  5700. Creates a System Description TLV and sets it value
  5701. </summary>
  5702. <param name="description">
  5703. A textual Description of the system
  5704. </param>
  5705. </member>
  5706. <member name="P:PacketDotNet.LLDP.SystemDescription.Description">
  5707. <value>
  5708. A textual Description of the system
  5709. </value>
  5710. </member>
  5711. <member name="T:PacketDotNet.LLDP.SystemCapabilities">
  5712. <summary>
  5713. A System Capabilities TLV
  5714. [TLVTypeLength - 2 bytes][System Capabilities - 2 bytes][Enabled Capabilities - 2 bytes]
  5715. </summary>
  5716. </member>
  5717. <member name="M:PacketDotNet.LLDP.SystemCapabilities.#ctor(System.Byte[],System.Int32)">
  5718. <summary>
  5719. Creates a System Capabilities TLV
  5720. </summary>
  5721. <param name="bytes">
  5722. </param>
  5723. <param name="offset">
  5724. The System Capabilities TLV's offset from the
  5725. origin of the LLDP
  5726. </param>
  5727. </member>
  5728. <member name="M:PacketDotNet.LLDP.SystemCapabilities.#ctor(System.UInt16,System.UInt16)">
  5729. <summary>
  5730. Creates a System Capabilities TLV and sets the value
  5731. </summary>
  5732. <param name="capabilities">
  5733. A bitmap containing the available System Capabilities
  5734. </param>
  5735. <param name="enabled">
  5736. A bitmap containing the enabled System Capabilities
  5737. </param>
  5738. </member>
  5739. <member name="P:PacketDotNet.LLDP.SystemCapabilities.Capabilities">
  5740. <value>
  5741. A bitmap containing the available System Capabilities
  5742. </value>
  5743. </member>
  5744. <member name="P:PacketDotNet.LLDP.SystemCapabilities.Enabled">
  5745. <value>
  5746. A bitmap containing the Enabled System Capabilities
  5747. </value>
  5748. </member>
  5749. <member name="M:PacketDotNet.LLDP.SystemCapabilities.IsCapable(PacketDotNet.LLDP.CapabilityOptions)">
  5750. <summary>
  5751. Checks whether the system is capable of a certain function
  5752. </summary>
  5753. <param name="capability">
  5754. The capability being checked
  5755. </param>
  5756. <returns>
  5757. Whether or not the system is capable of the function being tested
  5758. </returns>
  5759. </member>
  5760. <member name="M:PacketDotNet.LLDP.SystemCapabilities.IsEnabled(PacketDotNet.LLDP.CapabilityOptions)">
  5761. <summary>
  5762. Checks whether the specified function has been enabled on the system
  5763. </summary>
  5764. <param name="capability">
  5765. The capability being checked
  5766. </param>
  5767. <returns>
  5768. Whether or not the specified function is enabled
  5769. </returns>
  5770. </member>
  5771. <member name="M:PacketDotNet.LLDP.SystemCapabilities.ToString">
  5772. <summary>
  5773. Convert this System Capabilities TLV to a string.
  5774. </summary>
  5775. <returns>
  5776. A human readable string
  5777. </returns>
  5778. </member>
  5779. <member name="T:PacketDotNet.LLDP.ManagementAddress">
  5780. <summary>
  5781. A Time to Live TLV
  5782. [TLV Type Length : 2][Mgmt Addr length : 1][Mgmt Addr Subtype : 1][Mgmt Addr : 1-31]
  5783. [Interface Subtype : 1][Interface number : 4][OID length : 1][OID : 0-128]
  5784. </summary>
  5785. </member>
  5786. <member name="M:PacketDotNet.LLDP.ManagementAddress.#ctor(System.Byte[],System.Int32)">
  5787. <summary>
  5788. Creates a Management Address TLV
  5789. </summary>
  5790. <param name="bytes">
  5791. The LLDP Data unit being modified
  5792. </param>
  5793. <param name="offset">
  5794. The Management Address TLV's offset from the
  5795. origin of the LLDP
  5796. </param>
  5797. </member>
  5798. <member name="M:PacketDotNet.LLDP.ManagementAddress.#ctor(PacketDotNet.LLDP.NetworkAddress,PacketDotNet.LLDP.InterfaceNumbering,System.UInt32,System.String)">
  5799. <summary>
  5800. Creates a Management Address TLV and sets it value
  5801. </summary>
  5802. <param name="managementAddress">
  5803. The Management Address
  5804. </param>
  5805. <param name="interfaceSubType">
  5806. The Interface Numbering Sub Type
  5807. </param>
  5808. <param name="ifNumber">
  5809. The Interface Number
  5810. </param>
  5811. <param name="oid">
  5812. The Object Identifier
  5813. </param>
  5814. </member>
  5815. <member name="F:PacketDotNet.LLDP.ManagementAddress.MgmtAddressLengthLength">
  5816. <summary>
  5817. Number of bytes in the AddressLength field
  5818. </summary>
  5819. </member>
  5820. <member name="F:PacketDotNet.LLDP.ManagementAddress.InterfaceNumberSubTypeLength">
  5821. <summary>
  5822. Number of bytes in the interface number subtype field
  5823. </summary>
  5824. </member>
  5825. <member name="F:PacketDotNet.LLDP.ManagementAddress.InterfaceNumberLength">
  5826. <summary>
  5827. Number of bytes in the interface number field
  5828. </summary>
  5829. </member>
  5830. <member name="F:PacketDotNet.LLDP.ManagementAddress.ObjectIdentifierLengthLength">
  5831. <summary>
  5832. Number of bytes in the object identifier length field
  5833. </summary>
  5834. </member>
  5835. <member name="F:PacketDotNet.LLDP.ManagementAddress.maxObjectIdentifierLength">
  5836. <summary>
  5837. Maximum number of bytes in the object identifier field
  5838. </summary>
  5839. </member>
  5840. <member name="P:PacketDotNet.LLDP.ManagementAddress.AddressLength">
  5841. <value>
  5842. The Management Address Length
  5843. </value>
  5844. </member>
  5845. <member name="P:PacketDotNet.LLDP.ManagementAddress.AddressSubType">
  5846. <value>
  5847. The Management Address Subtype
  5848. Forward to the MgmtAddress instance
  5849. </value>
  5850. </member>
  5851. <member name="P:PacketDotNet.LLDP.ManagementAddress.MgmtAddress">
  5852. <value>
  5853. The Management Address
  5854. </value>
  5855. </member>
  5856. <member name="P:PacketDotNet.LLDP.ManagementAddress.InterfaceSubType">
  5857. <value>
  5858. Interface Number Sub Type
  5859. </value>
  5860. </member>
  5861. <member name="P:PacketDotNet.LLDP.ManagementAddress.InterfaceNumber">
  5862. <value>
  5863. Interface Number
  5864. </value>
  5865. </member>
  5866. <member name="P:PacketDotNet.LLDP.ManagementAddress.ObjIdLength">
  5867. <value>
  5868. Object ID Length
  5869. </value>
  5870. </member>
  5871. <member name="P:PacketDotNet.LLDP.ManagementAddress.ObjectIdentifier">
  5872. <value>
  5873. Object ID
  5874. </value>
  5875. </member>
  5876. <member name="M:PacketDotNet.LLDP.ManagementAddress.ToString">
  5877. <summary>
  5878. Convert this Management Address TLV to a string.
  5879. </summary>
  5880. <returns>
  5881. A human readable string
  5882. </returns>
  5883. </member>
  5884. <member name="T:PacketDotNet.LLDP.OrganizationSpecific">
  5885. <summary>
  5886. An Organization Specific TLV
  5887. [TLV Type Length : 2][Organizationally Unique Identifier OUI : 3]
  5888. [Organizationally Defined Subtype : 1][Organizationally Defined Information String : 0 - 507]
  5889. </summary>
  5890. </member>
  5891. <member name="M:PacketDotNet.LLDP.OrganizationSpecific.#ctor(System.Byte[],System.Int32)">
  5892. <summary>
  5893. Creates an Organization Specific TLV
  5894. </summary>
  5895. <param name="bytes">
  5896. The LLDP Data unit being modified
  5897. </param>
  5898. <param name="offset">
  5899. The Organization Specific TLV's offset from the
  5900. origin of the LLDP
  5901. </param>
  5902. </member>
  5903. <member name="M:PacketDotNet.LLDP.OrganizationSpecific.#ctor(System.Byte[],System.Int32,System.Byte[])">
  5904. <summary>
  5905. Creates an Organization Specific TLV and sets it value
  5906. </summary>
  5907. <param name="oui">
  5908. An Organizationally Unique Identifier
  5909. </param>
  5910. <param name="subType">
  5911. An Organizationally Defined SubType
  5912. </param>
  5913. <param name="infoString">
  5914. An Organizationally Defined Information String
  5915. </param>
  5916. </member>
  5917. <member name="P:PacketDotNet.LLDP.OrganizationSpecific.OrganizationUniqueID">
  5918. <summary>
  5919. An Organizationally Unique Identifier
  5920. </summary>
  5921. </member>
  5922. <member name="P:PacketDotNet.LLDP.OrganizationSpecific.OrganizationDefinedSubType">
  5923. <summary>
  5924. An Organizationally Defined SubType
  5925. </summary>
  5926. </member>
  5927. <member name="P:PacketDotNet.LLDP.OrganizationSpecific.OrganizationDefinedInfoString">
  5928. <summary>
  5929. An Organizationally Defined Information String
  5930. </summary>
  5931. </member>
  5932. <member name="M:PacketDotNet.LLDP.OrganizationSpecific.ToString">
  5933. <summary>
  5934. Convert this Organization Specific TLV to a string.
  5935. </summary>
  5936. <returns>
  5937. A human readable string
  5938. </returns>
  5939. </member>
  5940. <member name="T:PacketDotNet.LLDP.TLVTypeLength">
  5941. <summary>
  5942. Tlv type and length are 2 bytes
  5943. See http://en.wikipedia.org/wiki/Link_Layer_Discovery_Protocol#Frame_structure
  5944. </summary>
  5945. </member>
  5946. <member name="M:PacketDotNet.LLDP.TLVTypeLength.#ctor(PacketDotNet.Utils.ByteArraySegment)">
  5947. <summary>
  5948. Construct a TLVTypeLength for a TLV
  5949. </summary>
  5950. <param name="byteArraySegment">
  5951. A <see cref="T:PacketDotNet.Utils.ByteArraySegment" /></param>
  5952. </member>
  5953. <member name="F:PacketDotNet.LLDP.TLVTypeLength.TypeLengthLength">
  5954. <summary>
  5955. Length in bytes of the tlv type and length fields
  5956. </summary>
  5957. </member>
  5958. <member name="P:PacketDotNet.LLDP.TLVTypeLength.Type">
  5959. <value>
  5960. The TLV Value's Type
  5961. </value>
  5962. </member>
  5963. <member name="P:PacketDotNet.LLDP.TLVTypeLength.Length">
  5964. <value>
  5965. The TLV Value's Length
  5966. NOTE: Value is the length of the TLV Value only, does not include the length
  5967. of the type and length fields
  5968. </value>
  5969. </member>
  5970. <member name="P:PacketDotNet.LLDP.TLVTypeLength.TypeAndLength">
  5971. <value>
  5972. A unsigned short representing the concatenated Type and Length
  5973. </value>
  5974. </member>
  5975. <member name="T:PacketDotNet.LLDP.AddressFamily">
  5976. <summary>
  5977. The IANA (Internet Assigned Numbers Authority) Address Family
  5978. </summary>
  5979. <remarks>Source http://www.iana.org/assignments/address-family-numbers/</remarks>
  5980. </member>
  5981. <member name="F:PacketDotNet.LLDP.AddressFamily.IPv4">
  5982. <summary>IP version 4</summary>
  5983. </member>
  5984. <member name="F:PacketDotNet.LLDP.AddressFamily.IPv6">
  5985. <summary>IP version 6</summary>
  5986. </member>
  5987. <member name="F:PacketDotNet.LLDP.AddressFamily.NSAP">
  5988. <summary>NSAP</summary>
  5989. </member>
  5990. <member name="F:PacketDotNet.LLDP.AddressFamily.HDLC">
  5991. <summary>HDLC</summary>
  5992. </member>
  5993. <member name="F:PacketDotNet.LLDP.AddressFamily.BBN1822">
  5994. <summary>BBN 1822</summary>
  5995. </member>
  5996. <member name="F:PacketDotNet.LLDP.AddressFamily.Eth802">
  5997. <summary>802 (includes all 802 media plus Ethernet "canonical format")</summary>
  5998. </member>
  5999. <member name="F:PacketDotNet.LLDP.AddressFamily.E163">
  6000. <summary>E.163</summary>
  6001. </member>
  6002. <member name="T:PacketDotNet.LLDP.StringTLV">
  6003. <summary>
  6004. Base class for several TLV types that all contain strings
  6005. </summary>
  6006. </member>
  6007. <member name="M:PacketDotNet.LLDP.StringTLV.#ctor(System.Byte[],System.Int32)">
  6008. <summary>
  6009. Creates a String TLV
  6010. </summary>
  6011. <param name="bytes">
  6012. </param>
  6013. <param name="offset">
  6014. The Port Description TLV's offset from the
  6015. origin of the LLDP
  6016. </param>
  6017. </member>
  6018. <member name="M:PacketDotNet.LLDP.StringTLV.#ctor(PacketDotNet.LLDP.TLVTypes,System.String)">
  6019. <summary>
  6020. Create from a type and string value
  6021. </summary>
  6022. <param name="tlvType">
  6023. A <see cref="T:PacketDotNet.LLDP.TLVTypes" /></param>
  6024. <param name="StringValue">
  6025. A <see cref="T:System.String" /></param>
  6026. </member>
  6027. <member name="P:PacketDotNet.LLDP.StringTLV.StringValue">
  6028. <value>
  6029. A textual Description of the port
  6030. </value>
  6031. </member>
  6032. <member name="M:PacketDotNet.LLDP.StringTLV.ToString">
  6033. <summary>
  6034. Convert this Port Description TLV to a string.
  6035. </summary>
  6036. <returns>
  6037. A human readable string
  6038. </returns>
  6039. </member>
  6040. <member name="T:PacketDotNet.TLVCollection">
  6041. <summary>
  6042. Custom collection for TLV types
  6043. Special behavior includes:
  6044. - Preventing an EndOfLLDPDU tlv from being added out of place
  6045. - Checking and throwing exceptions if one-per-LLDP packet TLVs are added multiple times
  6046. </summary>
  6047. </member>
  6048. <member name="M:PacketDotNet.TLVCollection.InsertItem(System.Int32,PacketDotNet.LLDP.TLV)">
  6049. <summary>
  6050. Override to:
  6051. - Prevent duplicate end tlvs from being added
  6052. - Ensure that an end tlv is present
  6053. - Replace any automatically added end tlvs with the user provided tlv
  6054. </summary>
  6055. <param name="index">
  6056. A <see cref="T:System.Int32" /></param>
  6057. <param name="item">
  6058. A <see cref="T:PacketDotNet.LLDP.TLV" /></param>
  6059. </member>
  6060. <member name="T:PacketDotNet.WakeOnLanPacket">
  6061. <summary>
  6062. Wake-On-Lan
  6063. See: http://en.wikipedia.org/wiki/Wake-on-LAN
  6064. See: http://wiki.wireshark.org/WakeOnLAN
  6065. </summary>
  6066. </member>
  6067. <member name="M:PacketDotNet.WakeOnLanPacket.#ctor(System.Net.NetworkInformation.PhysicalAddress)">
  6068. <summary>
  6069. Create a Wake-On-LAN packet from the destination MAC address
  6070. </summary>
  6071. <param name="destinationMAC">
  6072. A <see cref="T:System.Net.NetworkInformation.PhysicalAddress" /></param>
  6073. </member>
  6074. <member name="M:PacketDotNet.WakeOnLanPacket.#ctor(PacketDotNet.Utils.ByteArraySegment)">
  6075. <summary>
  6076. Constructor
  6077. </summary>
  6078. <param name="bas">
  6079. A <see cref="T:PacketDotNet.Utils.ByteArraySegment" /></param>
  6080. </member>
  6081. <member name="P:PacketDotNet.WakeOnLanPacket.DestinationMAC">
  6082. <summary>
  6083. The Physical Address (MAC) of the host being woken up from sleep
  6084. </summary>
  6085. </member>
  6086. <member name="M:PacketDotNet.WakeOnLanPacket.GetEncapsulated(PacketDotNet.Packet)">
  6087. <summary>
  6088. Returns the embedded Wake-On-LAN packet
  6089. or null if there is none
  6090. </summary>
  6091. <returns>
  6092. A Wake-On-LAN packet
  6093. </returns>
  6094. </member>
  6095. <member name="M:PacketDotNet.WakeOnLanPacket.RandomPacket">
  6096. <summary>
  6097. Generate a random WakeOnLanPacket
  6098. </summary>
  6099. <returns>
  6100. A <see cref="T:PacketDotNet.WakeOnLanPacket" /></returns>
  6101. </member>
  6102. <member name="M:PacketDotNet.WakeOnLanPacket.IsValid">
  6103. <summary>
  6104. Checks the validity of the Wake-On-LAN payload
  6105. - by checking the synchronization sequence
  6106. - by checking to see if there are 16 iterations of the Destination MAC address
  6107. </summary>
  6108. <returns>
  6109. True if the Wake-On-LAN payload is valid
  6110. </returns>
  6111. </member>
  6112. <member name="M:PacketDotNet.WakeOnLanPacket.IsValid(PacketDotNet.Utils.ByteArraySegment)">
  6113. <summary>
  6114. See IsValid
  6115. </summary>
  6116. <param name="bas">
  6117. A <see cref="T:PacketDotNet.Utils.ByteArraySegment" /></param>
  6118. <returns>
  6119. A <see cref="T:System.Boolean" /></returns>
  6120. </member>
  6121. <member name="M:PacketDotNet.WakeOnLanPacket.Equals(System.Object)">
  6122. <summary>
  6123. Compare two instances
  6124. </summary>
  6125. <param name="obj">
  6126. A <see cref="T:System.Object" /></param>
  6127. <returns>
  6128. A <see cref="T:System.Boolean" /></returns>
  6129. </member>
  6130. <member name="M:PacketDotNet.WakeOnLanPacket.GetHashCode">
  6131. <summary>
  6132. GetHashCode override
  6133. </summary>
  6134. <returns>
  6135. A <see cref="T:System.Int32" /></returns>
  6136. </member>
  6137. <member name="M:PacketDotNet.WakeOnLanPacket.ToString(PacketDotNet.StringOutputType)">
  6138. <summary cref="Packet.ToString(StringOutputType)" />
  6139. </member>
  6140. <member name="T:PacketDotNet.StringOutputType">
  6141. <summary>
  6142. The available types of strings that the ToString(StringOutputType) can handle.
  6143. </summary>
  6144. </member>
  6145. <member name="F:PacketDotNet.StringOutputType.Normal">
  6146. <summary>
  6147. Outputs the packet info on a single line
  6148. </summary>
  6149. </member>
  6150. <member name="F:PacketDotNet.StringOutputType.Colored">
  6151. <summary>
  6152. Outputs the packet info on a single line with coloring
  6153. </summary>
  6154. </member>
  6155. <member name="F:PacketDotNet.StringOutputType.Verbose">
  6156. <summary>
  6157. Outputs the detailed packet info
  6158. </summary>
  6159. </member>
  6160. <member name="F:PacketDotNet.StringOutputType.VerboseColored">
  6161. <summary>
  6162. Outputs the detailed packet info with coloring
  6163. </summary>
  6164. </member>
  6165. <member name="T:PacketDotNet.Tcp.NoOperation">
  6166. <summary>
  6167. No Operation Option
  6168. Used in the TCP Options field to pad the length to the next 32 byte boundary
  6169. </summary>
  6170. <remarks>
  6171. References:
  6172. http://datatracker.ietf.org/doc/rfc793/
  6173. </remarks>
  6174. </member>
  6175. <member name="M:PacketDotNet.Tcp.NoOperation.#ctor(System.Byte[],System.Int32,System.Int32)">
  6176. <summary>
  6177. Creates a No Operation Option
  6178. </summary>
  6179. <param name="bytes">
  6180. A <see cref="T:System.Byte[]" /></param>
  6181. <param name="offset">
  6182. A <see cref="T:System.Int32" /></param>
  6183. <param name="length">
  6184. A <see cref="T:System.Int32" /></param>
  6185. </member>
  6186. <member name="F:PacketDotNet.Tcp.NoOperation.OptionLength">
  6187. <summary>
  6188. The length (in bytes) of the NoOperation option
  6189. </summary>
  6190. </member>
  6191. <member name="P:PacketDotNet.Tcp.NoOperation.Length">
  6192. <summary>
  6193. The length of the NoOperation field
  6194. Returns 1 as opposed to returning the length field because
  6195. the NoOperation option is only 1 byte long and doesn't
  6196. contain a length field
  6197. </summary>
  6198. </member>
  6199. <member name="T:PacketDotNet.Tcp.EndOfOptions">
  6200. <summary>
  6201. End-of-Options Option
  6202. Marks the end of the Options list
  6203. </summary>
  6204. <remarks>
  6205. References:
  6206. http://datatracker.ietf.org/doc/rfc793/
  6207. </remarks>
  6208. </member>
  6209. <member name="M:PacketDotNet.Tcp.EndOfOptions.#ctor(System.Byte[],System.Int32,System.Int32)">
  6210. <summary>
  6211. Creates an End Of Options Option
  6212. </summary>
  6213. <param name="bytes">
  6214. A <see cref="T:System.Byte[]" /></param>
  6215. <param name="offset">
  6216. A <see cref="T:System.Int32" /></param>
  6217. <param name="length">
  6218. A <see cref="T:System.Int32" /></param>
  6219. </member>
  6220. <member name="F:PacketDotNet.Tcp.EndOfOptions.OptionLength">
  6221. <summary>
  6222. The length (in bytes) of the EndOfOptions option
  6223. </summary>
  6224. </member>
  6225. <member name="P:PacketDotNet.Tcp.EndOfOptions.Length">
  6226. <summary>
  6227. The length of the EndOfOptions field
  6228. Returns 1 as opposed to returning the length field because
  6229. the EndOfOptions option is only 1 byte long and doesn't
  6230. contain a length field
  6231. </summary>
  6232. </member>
  6233. <member name="T:PacketDotNet.Tcp.MaximumSegmentSize">
  6234. <summary>
  6235. Maximum Segment Size Option
  6236. An extension to the DataOffset/HeaderLength field to
  6237. allow sizes greater than 65,535
  6238. </summary>
  6239. <remarks>
  6240. References:
  6241. http://datatracker.ietf.org/doc/rfc793/
  6242. </remarks>
  6243. </member>
  6244. <member name="M:PacketDotNet.Tcp.MaximumSegmentSize.#ctor(System.Byte[],System.Int32,System.Int32)">
  6245. <summary>
  6246. Creates a Maximum Segment Size Option
  6247. </summary>
  6248. <param name="bytes">
  6249. A <see cref="T:System.Byte[]" /></param>
  6250. <param name="offset">
  6251. A <see cref="T:System.Int32" /></param>
  6252. <param name="length">
  6253. A <see cref="T:System.Int32" /></param>
  6254. </member>
  6255. <member name="P:PacketDotNet.Tcp.MaximumSegmentSize.Value">
  6256. <summary>
  6257. The Maximum Segment Size
  6258. </summary>
  6259. </member>
  6260. <member name="M:PacketDotNet.Tcp.MaximumSegmentSize.ToString">
  6261. <summary>
  6262. Returns the Option info as a string
  6263. </summary>
  6264. <returns>
  6265. A <see cref="T:System.String" /></returns>
  6266. </member>
  6267. <member name="T:PacketDotNet.Tcp.Option">
  6268. <summary>
  6269. A TCP Option
  6270. </summary>
  6271. </member>
  6272. <member name="M:PacketDotNet.Tcp.Option.#ctor(System.Byte[],System.Int32,System.Int32)">
  6273. <summary>
  6274. Creates an Option from a byte[]
  6275. </summary>
  6276. <param name="bytes">
  6277. A <see cref="T:System.Byte[]" /></param>
  6278. <param name="offset">
  6279. A <see cref="T:System.Int32" /></param>
  6280. <param name="length">
  6281. A <see cref="T:System.Int32" /></param>
  6282. </member>
  6283. <member name="F:PacketDotNet.Tcp.Option.KindFieldLength">
  6284. <summary>The length (in bytes) of the Kind field</summary>
  6285. </member>
  6286. <member name="F:PacketDotNet.Tcp.Option.LengthFieldLength">
  6287. <summary>The length (in bytes) of the Length field</summary>
  6288. </member>
  6289. <member name="F:PacketDotNet.Tcp.Option.KindFieldOffset">
  6290. <summary>The offset (in bytes) of the Kind Field</summary>
  6291. </member>
  6292. <member name="F:PacketDotNet.Tcp.Option.LengthFieldOffset">
  6293. <summary>The offset (in bytes) of the Length field</summary>
  6294. </member>
  6295. <member name="P:PacketDotNet.Tcp.Option.Length">
  6296. <summary>
  6297. The Length of the Option type
  6298. </summary>
  6299. </member>
  6300. <member name="P:PacketDotNet.Tcp.Option.Kind">
  6301. <summary>
  6302. The Kind of option
  6303. </summary>
  6304. </member>
  6305. <member name="P:PacketDotNet.Tcp.Option.Bytes">
  6306. <summary>
  6307. Returns a TLV that contains the Option
  6308. </summary>
  6309. </member>
  6310. <member name="M:PacketDotNet.Tcp.Option.ToString">
  6311. <summary>
  6312. Returns the Option info as a string
  6313. </summary>
  6314. <returns>
  6315. A <see cref="T:System.String" /></returns>
  6316. </member>
  6317. <member name="T:PacketDotNet.Tcp.WindowScaleFactor">
  6318. <summary>
  6319. Window Scale Factor Option
  6320. Expands the definition of the TCP window to 32 bits
  6321. </summary>
  6322. <remarks>
  6323. References:
  6324. http://datatracker.ietf.org/doc/rfc1323/
  6325. </remarks>
  6326. </member>
  6327. <member name="M:PacketDotNet.Tcp.WindowScaleFactor.#ctor(System.Byte[],System.Int32,System.Int32)">
  6328. <summary>
  6329. Creates a Window Scale Factor Option
  6330. </summary>
  6331. <param name="bytes">
  6332. A <see cref="T:System.Byte[]" /></param>
  6333. <param name="offset">
  6334. A <see cref="T:System.Int32" /></param>
  6335. <param name="length">
  6336. A <see cref="T:System.Int32" /></param>
  6337. </member>
  6338. <member name="P:PacketDotNet.Tcp.WindowScaleFactor.ScaleFactor">
  6339. <summary>
  6340. The Window Scale Factor
  6341. used as a multiplier to the window value
  6342. The multiplier is equal to 1 left-shifted by the ScaleFactor
  6343. So a scale factor of 7 would equal 1 &lt;&lt; 7 = 128
  6344. </summary>
  6345. </member>
  6346. <member name="M:PacketDotNet.Tcp.WindowScaleFactor.ToString">
  6347. <summary>
  6348. Returns the Option info as a string
  6349. The multiplier is equal to a value of 1 left-shifted by the scale factor
  6350. </summary>
  6351. <returns>
  6352. A <see cref="T:System.String" /></returns>
  6353. </member>
  6354. <member name="T:PacketDotNet.Tcp.OptionTypes">
  6355. <summary>
  6356. The different types fields that could be found in the Options field
  6357. </summary>
  6358. <remarks>
  6359. References:
  6360. http://en.wikipedia.org/wiki/Transmission_Control_Protocol#TCP_Timestamps
  6361. http://www.networksorcery.com/enp/default1101.htm
  6362. </remarks>
  6363. </member>
  6364. <member name="F:PacketDotNet.Tcp.OptionTypes.EndOfOptionList">
  6365. <summary>End Of List</summary>
  6366. <remarks>See RFC 793</remarks>
  6367. </member>
  6368. <member name="F:PacketDotNet.Tcp.OptionTypes.NoOperation">
  6369. <summary>No Operation</summary>
  6370. <remarks>See RFC 793</remarks>
  6371. </member>
  6372. <member name="F:PacketDotNet.Tcp.OptionTypes.MaximumSegmentSize">
  6373. <summary>Maximum Segment Size</summary>
  6374. <remarks>See RFC 793</remarks>
  6375. </member>
  6376. <member name="F:PacketDotNet.Tcp.OptionTypes.WindowScaleFactor">
  6377. <summary>Window Scale Factor</summary>
  6378. <remarks>See RFC 1323</remarks>
  6379. </member>
  6380. <member name="F:PacketDotNet.Tcp.OptionTypes.SACKPermitted">
  6381. <summary>SACK (Selective Ack) Permitted</summary>
  6382. <remarks>See RFC 2018</remarks>
  6383. </member>
  6384. <member name="F:PacketDotNet.Tcp.OptionTypes.SACK">
  6385. <summary>SACK (Selective Ack)</summary>
  6386. <remarks>See RFC 2018 and RFC 2883</remarks>
  6387. </member>
  6388. <member name="F:PacketDotNet.Tcp.OptionTypes.Echo">
  6389. <summary>Echo (obsolete)</summary>
  6390. <remarks>See RFC 1072</remarks>
  6391. </member>
  6392. <member name="F:PacketDotNet.Tcp.OptionTypes.EchoReply">
  6393. <summary>Echo Reply (obsolete)</summary>
  6394. <remarks>See RFC 1072</remarks>
  6395. </member>
  6396. <member name="F:PacketDotNet.Tcp.OptionTypes.Timestamp">
  6397. <summary>Timestamp</summary>
  6398. <remarks>See RFC 1323</remarks>
  6399. </member>
  6400. <member name="F:PacketDotNet.Tcp.OptionTypes.POConnectionPermitted">
  6401. <summary>Partial Order Connection Permitted (experimental)</summary>
  6402. <remarks>See RFC 1693</remarks>
  6403. </member>
  6404. <member name="F:PacketDotNet.Tcp.OptionTypes.POServiceProfile">
  6405. <summary>Partial Order Service Profile (experimental)</summary>
  6406. <remarks>See RFC 1693</remarks>
  6407. </member>
  6408. <member name="F:PacketDotNet.Tcp.OptionTypes.ConnectionCount">
  6409. <summary>Connection Count (experimental)</summary>
  6410. <remarks>See RFC 1644</remarks>
  6411. </member>
  6412. <member name="F:PacketDotNet.Tcp.OptionTypes.ConnectionCountNew">
  6413. <summary>Connection Count New (experimental)</summary>
  6414. <remarks>See RFC 1644</remarks>
  6415. </member>
  6416. <member name="F:PacketDotNet.Tcp.OptionTypes.ConnectionCountEcho">
  6417. <summary>Connection Count Echo (experimental)</summary>
  6418. <remarks>See RFC 1644</remarks>
  6419. </member>
  6420. <member name="F:PacketDotNet.Tcp.OptionTypes.AlternateChecksumRequest">
  6421. <summary>Alternate Checksum Request</summary>
  6422. <remarks>See RFC 1146</remarks>
  6423. </member>
  6424. <member name="F:PacketDotNet.Tcp.OptionTypes.AlternateChecksumData">
  6425. <summary>Alternate Checksum Data</summary>
  6426. <remarks>See RFC 1146</remarks>
  6427. </member>
  6428. <member name="F:PacketDotNet.Tcp.OptionTypes.MD5Signature">
  6429. <summary>MD5 Signature</summary>
  6430. <remarks>See RFC 2385</remarks>
  6431. </member>
  6432. <member name="F:PacketDotNet.Tcp.OptionTypes.QuickStartResponse">
  6433. <summary>Quick-Start Response (experimental)</summary>
  6434. <remarks>See RFC 4782</remarks>
  6435. </member>
  6436. <member name="F:PacketDotNet.Tcp.OptionTypes.UserTimeout">
  6437. <summary>User Timeout</summary>
  6438. <remarks>See RFC 5482</remarks>
  6439. </member>
  6440. <member name="T:PacketDotNet.Tcp.SACKPermitted">
  6441. <summary>
  6442. SACK (Selective Ack) Permitted Option
  6443. Notifies the receiver that SACK is allowed.
  6444. Must only be sent in a SYN segment
  6445. </summary>
  6446. <remarks>
  6447. References:
  6448. http://datatracker.ietf.org/doc/rfc2018/
  6449. </remarks>
  6450. </member>
  6451. <member name="M:PacketDotNet.Tcp.SACKPermitted.#ctor(System.Byte[],System.Int32,System.Int32)">
  6452. <summary>
  6453. Creates a Sack Permitted Option
  6454. </summary>
  6455. <param name="bytes">
  6456. A <see cref="T:System.Byte[]" /></param>
  6457. <param name="offset">
  6458. A <see cref="T:System.Int32" /></param>
  6459. <param name="length">
  6460. A <see cref="T:System.Int32" /></param>
  6461. </member>
  6462. <member name="T:PacketDotNet.Tcp.SACK">
  6463. <summary>
  6464. SACK (Selective Ack) Option
  6465. Provides a means for a receiver to notify the sender about
  6466. all the segments that have arrived successfully.
  6467. Used to cut down on the number of unnecessary re-transmissions.
  6468. </summary>
  6469. <remarks>
  6470. References:
  6471. http://datatracker.ietf.org/doc/rfc2018/
  6472. http://datatracker.ietf.org/doc/rfc2883/
  6473. </remarks>
  6474. </member>
  6475. <member name="M:PacketDotNet.Tcp.SACK.#ctor(System.Byte[],System.Int32,System.Int32)">
  6476. <summary>
  6477. Creates a SACK (Selective Ack) Option
  6478. </summary>
  6479. <param name="bytes">
  6480. A <see cref="T:System.Byte[]" /></param>
  6481. <param name="offset">
  6482. A <see cref="T:System.Int32" /></param>
  6483. <param name="length">
  6484. A <see cref="T:System.Int32" /></param>
  6485. </member>
  6486. <member name="P:PacketDotNet.Tcp.SACK.SACKBlocks">
  6487. <summary>
  6488. Contains an array of SACK (Selective Ack) Blocks
  6489. </summary>
  6490. </member>
  6491. <member name="M:PacketDotNet.Tcp.SACK.ToString">
  6492. <summary>
  6493. Returns the Option info as a string
  6494. </summary>
  6495. <returns>
  6496. A <see cref="T:System.String" /></returns>
  6497. </member>
  6498. <member name="T:PacketDotNet.Tcp.EchoReply">
  6499. <summary>
  6500. Echo Reply Option
  6501. Marked obsolete in the TCP spec Echo Reply Option has been
  6502. replaced by the TSOPT (Timestamp Option)
  6503. </summary>
  6504. <remarks>
  6505. References:
  6506. http://datatracker.ietf.org/doc/rfc1072/
  6507. </remarks>
  6508. </member>
  6509. <member name="M:PacketDotNet.Tcp.EchoReply.#ctor(System.Byte[],System.Int32,System.Int32)">
  6510. <summary>
  6511. Creates an Echo Reply Option
  6512. </summary>
  6513. <param name="bytes">
  6514. A <see cref="T:System.Byte[]" /></param>
  6515. <param name="offset">
  6516. A <see cref="T:System.Int32" /></param>
  6517. <param name="length">
  6518. A <see cref="T:System.Int32" /></param>
  6519. </member>
  6520. <member name="T:PacketDotNet.Tcp.TimeStamp">
  6521. <summary>
  6522. A Time Stamp Option
  6523. Used for RTTM (Round Trip Time Measurement)
  6524. and PAWS (Protect Against Wrapped Sequences)
  6525. Opsoletes the Echo and EchoReply option fields
  6526. </summary>
  6527. <remarks>
  6528. References:
  6529. http://datatracker.ietf.org/doc/rfc1323/
  6530. </remarks>
  6531. </member>
  6532. <member name="M:PacketDotNet.Tcp.TimeStamp.#ctor(System.Byte[],System.Int32,System.Int32)">
  6533. <summary>
  6534. Creates a Timestamp Option
  6535. </summary>
  6536. <param name="bytes">
  6537. A <see cref="T:System.Byte[]" /></param>
  6538. <param name="offset">
  6539. A <see cref="T:System.Int32" /></param>
  6540. <param name="length">
  6541. A <see cref="T:System.Int32" /></param>
  6542. </member>
  6543. <member name="P:PacketDotNet.Tcp.TimeStamp.Value">
  6544. <summary>
  6545. The Timestamp value
  6546. </summary>
  6547. </member>
  6548. <member name="P:PacketDotNet.Tcp.TimeStamp.EchoReply">
  6549. <summary>
  6550. The Echo Reply
  6551. </summary>
  6552. </member>
  6553. <member name="M:PacketDotNet.Tcp.TimeStamp.ToString">
  6554. <summary>
  6555. Returns the Option info as a string
  6556. </summary>
  6557. <returns>
  6558. A <see cref="T:System.String" /></returns>
  6559. </member>
  6560. <member name="T:PacketDotNet.Tcp.Echo">
  6561. <summary>
  6562. An Echo Option
  6563. throws an exception because Echo Options
  6564. are obsolete as per their spec
  6565. </summary>
  6566. </member>
  6567. <member name="M:PacketDotNet.Tcp.Echo.#ctor(System.Byte[],System.Int32,System.Int32)">
  6568. <summary>
  6569. Creates an Echo Option
  6570. </summary>
  6571. <param name="bytes">
  6572. A <see cref="T:System.Byte[]" /></param>
  6573. <param name="offset">
  6574. A <see cref="T:System.Int32" /></param>
  6575. <param name="length">
  6576. A <see cref="T:System.Int32" /></param>
  6577. </member>
  6578. <member name="T:PacketDotNet.Tcp.AlternateChecksumRequest">
  6579. <summary>
  6580. AlternateChecksumRequest Option
  6581. </summary>
  6582. </member>
  6583. <member name="M:PacketDotNet.Tcp.AlternateChecksumRequest.#ctor(System.Byte[],System.Int32,System.Int32)">
  6584. <summary>
  6585. Creates an Alternate Checksum Request Option
  6586. Used to negotiate an alternative checksum algorithm in a connection
  6587. </summary>
  6588. <param name="bytes">
  6589. A <see cref="T:System.Byte[]" /></param>
  6590. <param name="offset">
  6591. A <see cref="T:System.Int32" /></param>
  6592. <param name="length">
  6593. A <see cref="T:System.Int32" /></param>
  6594. <remarks>
  6595. References:
  6596. http://datatracker.ietf.org/doc/rfc1146/
  6597. </remarks>
  6598. </member>
  6599. <member name="P:PacketDotNet.Tcp.AlternateChecksumRequest.Checksum">
  6600. <summary>
  6601. The Checksum
  6602. </summary>
  6603. </member>
  6604. <member name="M:PacketDotNet.Tcp.AlternateChecksumRequest.ToString">
  6605. <summary>
  6606. Returns the Option info as a string
  6607. </summary>
  6608. <returns>
  6609. A <see cref="T:System.String" /></returns>
  6610. </member>
  6611. <member name="T:PacketDotNet.Tcp.ChecksumAlgorighmType">
  6612. <summary>
  6613. Specifies the different types of algorithms that the
  6614. Alternative Checksum option are allowed to use
  6615. </summary>
  6616. <remarks>
  6617. References:
  6618. http://datatracker.ietf.org/doc/rfc1146/
  6619. </remarks>
  6620. </member>
  6621. <member name="F:PacketDotNet.Tcp.ChecksumAlgorighmType.TCPChecksum">
  6622. <summary>Standard TCP Checksum Algorithm</summary>
  6623. </member>
  6624. <member name="F:PacketDotNet.Tcp.ChecksumAlgorighmType.EightBitFletchersAlgorithm">
  6625. <summary>8-bit Fletchers Algorighm</summary>
  6626. </member>
  6627. <member name="F:PacketDotNet.Tcp.ChecksumAlgorighmType.SixteenBitFletchersAlgorithm">
  6628. <summary>16-bit Fletchers Algorithm</summary>
  6629. </member>
  6630. <member name="F:PacketDotNet.Tcp.ChecksumAlgorighmType.RedundantChecksumAvoidance">
  6631. <summary>Redundant Checksum Avoidance</summary>
  6632. </member>
  6633. <member name="T:PacketDotNet.Tcp.AlternateChecksumData">
  6634. <summary>
  6635. Alternative Checksum Date
  6636. Used as an extension to Alternative Checksum Response when the
  6637. checksum is longer than the standard 16bit TCP Checksum field
  6638. </summary>
  6639. <remarks>
  6640. References:
  6641. http://datatracker.ietf.org/doc/rfc1146/
  6642. </remarks>
  6643. </member>
  6644. <member name="M:PacketDotNet.Tcp.AlternateChecksumData.#ctor(System.Byte[],System.Int32,System.Int32)">
  6645. <summary>
  6646. Creates an Alternate Checksum Data Option
  6647. </summary>
  6648. <param name="bytes">
  6649. A <see cref="T:System.Byte[]" /></param>
  6650. <param name="offset">
  6651. A <see cref="T:System.Int32" /></param>
  6652. <param name="length">
  6653. A <see cref="T:System.Int32" /></param>
  6654. </member>
  6655. <member name="P:PacketDotNet.Tcp.AlternateChecksumData.Data">
  6656. <summary>
  6657. The array of attached Checksum
  6658. </summary>
  6659. </member>
  6660. <member name="M:PacketDotNet.Tcp.AlternateChecksumData.ToString">
  6661. <summary>
  6662. Returns the Option info as a string
  6663. </summary>
  6664. <returns>
  6665. A <see cref="T:System.String" /></returns>
  6666. </member>
  6667. <member name="T:PacketDotNet.Tcp.MD5Signature">
  6668. <summary>
  6669. MD5 Signature
  6670. Carries the MD5 Digest used by the BGP protocol to
  6671. ensure security between two endpoints
  6672. </summary>
  6673. <remarks>
  6674. References:
  6675. http://datatracker.ietf.org/doc/rfc2385/
  6676. </remarks>
  6677. </member>
  6678. <member name="M:PacketDotNet.Tcp.MD5Signature.#ctor(System.Byte[],System.Int32,System.Int32)">
  6679. <summary>
  6680. Creates a MD5 Signature Option
  6681. </summary>
  6682. <param name="bytes">
  6683. A <see cref="T:System.Byte[]" /></param>
  6684. <param name="offset">
  6685. A <see cref="T:System.Int32" /></param>
  6686. <param name="length">
  6687. A <see cref="T:System.Int32" /></param>
  6688. </member>
  6689. <member name="P:PacketDotNet.Tcp.MD5Signature.MD5Digest">
  6690. <summary>
  6691. The MD5 Digest
  6692. </summary>
  6693. </member>
  6694. <member name="M:PacketDotNet.Tcp.MD5Signature.ToString">
  6695. <summary>
  6696. Returns the Option info as a string
  6697. </summary>
  6698. <returns>
  6699. A <see cref="T:System.String" /></returns>
  6700. </member>
  6701. <member name="T:PacketDotNet.Tcp.UserTimeout">
  6702. <summary>
  6703. User Timeout Option
  6704. The TCP user timeout controls how long transmitted data may remain
  6705. unacknowledged before a connection is forcefully closed
  6706. </summary>
  6707. <remarks>
  6708. References:
  6709. http://datatracker.ietf.org/doc/rfc5482/
  6710. </remarks>
  6711. </member>
  6712. <member name="M:PacketDotNet.Tcp.UserTimeout.#ctor(System.Byte[],System.Int32,System.Int32)">
  6713. <summary>
  6714. Creates a User Timeout Option
  6715. </summary>
  6716. <param name="bytes">
  6717. A <see cref="T:System.Byte[]" /></param>
  6718. <param name="offset">
  6719. A <see cref="T:System.Int32" /></param>
  6720. <param name="length">
  6721. A <see cref="T:System.Int32" /></param>
  6722. </member>
  6723. <member name="P:PacketDotNet.Tcp.UserTimeout.Granularity">
  6724. <summary>
  6725. The Granularity
  6726. </summary>
  6727. </member>
  6728. <member name="P:PacketDotNet.Tcp.UserTimeout.Timeout">
  6729. <summary>
  6730. The User Timeout
  6731. </summary>
  6732. </member>
  6733. <member name="M:PacketDotNet.Tcp.UserTimeout.ToString">
  6734. <summary>
  6735. Returns the Option info as a string
  6736. </summary>
  6737. <returns>
  6738. A <see cref="T:System.String" /></returns>
  6739. </member>
  6740. </members>
  6741. </doc>