Improve TCP documentation a bit

This commit is contained in:
Dirk Ziegelmeier 2017-03-22 23:32:17 +01:00
parent d04dc46ccb
commit 7e12240af3
2 changed files with 4 additions and 0 deletions

View File

@ -1428,6 +1428,7 @@ tcp_seg_free(struct tcp_seg *seg)
} }
/** /**
* @ingroup tcp
* Sets the priority of a connection. * Sets the priority of a connection.
* *
* @param pcb the tcp_pcb to manipulate * @param pcb the tcp_pcb to manipulate

View File

@ -349,9 +349,12 @@ void tcp_poll (struct tcp_pcb *pcb, tcp_poll_fn poll, u8_t interv
#if LWIP_TCP_TIMESTAMPS #if LWIP_TCP_TIMESTAMPS
#define tcp_mss(pcb) (((pcb)->flags & TF_TIMESTAMP) ? ((pcb)->mss - 12) : (pcb)->mss) #define tcp_mss(pcb) (((pcb)->flags & TF_TIMESTAMP) ? ((pcb)->mss - 12) : (pcb)->mss)
#else /* LWIP_TCP_TIMESTAMPS */ #else /* LWIP_TCP_TIMESTAMPS */
/** @ingroup tcp_raw */
#define tcp_mss(pcb) ((pcb)->mss) #define tcp_mss(pcb) ((pcb)->mss)
#endif /* LWIP_TCP_TIMESTAMPS */ #endif /* LWIP_TCP_TIMESTAMPS */
/** @ingroup tcp_raw */
#define tcp_sndbuf(pcb) (TCPWND16((pcb)->snd_buf)) #define tcp_sndbuf(pcb) (TCPWND16((pcb)->snd_buf))
/** @ingroup tcp_raw */
#define tcp_sndqueuelen(pcb) ((pcb)->snd_queuelen) #define tcp_sndqueuelen(pcb) ((pcb)->snd_queuelen)
/** @ingroup tcp_raw */ /** @ingroup tcp_raw */
#define tcp_nagle_disable(pcb) ((pcb)->flags |= TF_NODELAY) #define tcp_nagle_disable(pcb) ((pcb)->flags |= TF_NODELAY)