Changeset 1897 for trunk/src/common/sendpacket.c

Timestamp:

08/24/07 21:57:38 (17 months ago)

Author:

aturner

Message:

fix comments. refs #176

Files:

• trunk/src/common/sendpacket.c (modified) (17 diffs)

trunk/src/common/sendpacket.c

@@ -167 +167 @@
 
 
-/*
+/**
  * returns number of bytes sent on success or -1 on error
  * Note: it is theoretically possible to get a return code >0 and < len
@@ -267 +267 @@
 }
 
-
+/**
+ * Open the given network device name and returns a sendpacket_t struct
+ * pass the error buffer (in case there's a problem) and the direction
+ * that this interface represents
+ */
 sendpacket_t *
 sendpacket_open(const char *device, char *errbuf, tcpr_dir_t direction)
@@ -292 +296 @@
 }
 
-
+/**
+ * Get packet stats for the given sendpacket_t
+ */
 char *
 sendpacket_getstat(sendpacket_t *sp)
@@ -310 +316 @@
 }
 
+/**
+ * close the given sendpacket
+ */
 int
 sendpacket_close(sendpacket_t *sp)
@@ -319 +328 @@
 }
 
-/*
+/**
  * returns the Layer 2 address of the interface current 
  * open.  on error, return NULL
@@ -345 +354 @@
 }
 
-/*
+/**
  * returns the error string
  */
@@ -355 +364 @@
 }
 
-/*
+/**
  * Set's the error string
  */
@@ -375 +384 @@
 
 #if defined HAVE_PCAP_INJECT || defined HAVE_PCAP_SENDPACKET
+/**
+ * Inner sendpacket_open() method for using libpcap
+ */
 static sendpacket_t *
 sendpacket_open_pcap(const char *device, char *errbuf)
@@ -407 +419 @@
 }
 
+/**
+ * Get the hardware MAC address for the given interface using libpcap
+ */
 static struct tcpr_ether_addr *
 sendpacket_get_hwaddr_pcap(sendpacket_t *sp)
@@ -417 +432 @@
 
 #if defined HAVE_LIBNET
+/**
+ * Inner sendpacket_open() method for using libnet
+ */
 static sendpacket_t * 
 sendpacket_open_libnet(const char *device, char *errbuf)
@@ -437 +455 @@
 }
 
+/**
+ * Get the hardware MAC address for the given interface using libnet
+ */
 static struct tcpr_ether_addr *
 sendpacket_get_hwaddr_libnet(sendpacket_t *sp)
@@ -456 +477 @@
 
 #if defined HAVE_PF_PACKET
+/**
+ * Inner sendpacket_open() method for using Linux's PF_PACKET
+ */
 static sendpacket_t *
 sendpacket_open_pf(const char *device, char *errbuf)
@@ -555 +579 @@
 }
 
-/* get the interface index (necessary for sending packets w/ PF_PACKET) */
+/** 
+ * get the interface index (necessary for sending packets w/ PF_PACKET) 
+ */
 static int
 get_iface_index(int fd, const int8_t *device, char *errbuf) {
@@ -571 +597 @@
 }              
 
-/*
- * get's the hardware address via Linux's PF packet
- * interface
+/**
+ * get's the hardware address via Linux's PF packet interface
  */
 struct tcpr_ether_addr *
@@ -611 +636 @@
 
 #if defined HAVE_BPF
+/**
+ * Inner sendpacket_open() method for using BSD's BPF interface
+ */
 static sendpacket_t *
 sendpacket_open_bpf(const char *device, char *errbuf)
@@ -726 +754 @@
 }
 
+/**
+ * Get the interface hardware MAC address when using BPF
+ */
 struct tcpr_ether_addr *
 sendpacket_get_hwaddr_bpf(sendpacket_t *sp)
@@ -774 +805 @@
 #endif /* HAVE_BPF */
 
-/*
+/**
+ * Get the DLT type of the opened sendpacket
  * Return -1 if we can't figure it out, else return the DLT_ value
  */