Changeset 87b490e3 in mainline for uspace/lib/pcap/src/pcapdump_client.c

Timestamp:

2024-12-13T08:44:05Z (15 months ago)

Author:

Nataliia Korop <n.corop08@…>

Children:

420b13d

Parents:

fb31682

git-author:

Nataliia Korop <n.corop08@…> (2024-11-30 19:08:32)

git-committer:

Nataliia Korop <n.corop08@…> (2024-12-13 08:44:05)

Message:

docs comments

File:

• uspace/lib/pcap/src/pcapdump_client.c (modified) (9 diffs)

uspace/lib/pcap/src/pcapdump_client.c

@@ -30 +30 @@
  * @{
  */
-/** @file
- * @brief Client side of the pcapctl. Functions are called from the app pcapctl
+/** @file Client side of the pcapctl. Functions are called from the app pcapctl.
  */
 
@@ -52 +51 @@
 }
 
+/** Get service based on the index of the device.
+ *  @param index of the device.
+ *  @param svc placeholder for service ide.
+ *  @return EOK if successful, error code otherwise.
+ */
 static errno_t pcapctl_cat_get_svc(int *index, service_id_t *svc)
 {
@@ -80 +84 @@
 }
 
+/** Check if the index is an index of valid device.
+ *  @param index to check.
+ *  @return EOK if device is valid, error code otherwise.
+ */
 errno_t pcapctl_is_valid_device(int *index)
 {
@@ -105 +113 @@
 }
 
+/** Check if the index is an index of valid writer operations.
+ * @param index to check.
+ * @param sess  pcapctl session for IPC communictaion.
+ */
 errno_t pcapctl_is_valid_ops_number(int *index, pcapctl_sess_t *sess)
 {
@@ -127 +139 @@
 }
 
-/**
- *
- */
+/** Get all devices that can dump packets. */
 errno_t pcapctl_list(void)
 {
@@ -160 +170 @@
 }
 
-/**
- *
+/** Start pcapctl IPC session.
+ *  @param index        index of the device which can dump packets.
+ *  @param rsess        placeholder for the session.
+ *  @return                     EOK if successful, error code otherwise.
  */
 errno_t pcapctl_dump_open(int *index, pcapctl_sess_t **rsess)
@@ -196 +208 @@
 }
 
-/**
- *
+/** Close pcapctl IPC session.
+ *  @param sess Session to close.
+ *  @return EOK if successful, error code otherwise.
  */
 errno_t pcapctl_dump_close(pcapctl_sess_t *sess)
@@ -205 +218 @@
 }
 
-/** Starting a new session for pcapctl
- *
- * @param name Name of the file to dump packets to
- * @param sess session to start
- * @return EOK on success or an error code
+/** Send start request via IPC to start dumping.
+ *
+ * @param name  Name of the destination buffer to dump packets to.
+ * @param sess  Session that is used for communication.
+ * @return              EOK on success or an error code.
  */
 errno_t pcapctl_dump_start(const char *name, int *ops_index, pcapctl_sess_t *sess)
@@ -233 +246 @@
 }
 
-/** Finish current session for pcapctl
- *
- * @param sess Session to finish
- * @return EOK on success or an error code
+/** Send stop request via IPC to start dumping.
+ *
+ * @param sess  Session that is used for communication.
+ * @return              EOK on success or an error code.
  */
 errno_t pcapctl_dump_stop(pcapctl_sess_t *sess)