SolidWallOfCode commented on a change in pull request #6712:
URL: https://github.com/apache/trafficserver/pull/6712#discussion_r416697784
##########
File path: iocore/net/P_UnixNet.h
##########
@@ -98,14 +100,37 @@ struct EventIO {
int start(EventLoop l, NetAccept *vc, int events);
int start(EventLoop l, NetEvent *ne, int events);
int start(EventLoop l, UnixUDPConnection *vc, int events);
+ /** Setup a continuation to be called when a file descriptor is available
for read or write.
+ @param l: the event loop
+ @param fd: file descriptor (or port)
+ @param c: the continuation to call
+ @param events: a mask of flags (for details `man epoll_ctl`)
+ @return int: the number of events created, -1 is error
+ */
int start(EventLoop l, int fd, Continuation *c, int events);
- // Change the existing events by adding modify(EVENTIO_READ)
- // or removing modify(-EVENTIO_READ), for level triggered I/O
+
+ /** Alter the events that will trigger the continuation, for level triggered
I/O.
+ @param events: add with positive mask(+EVENTIO_READ), or remove with
negative mask (-EVENTIO_READ)
+ @return int: the number of events created, -1 is error
+ */
int modify(int events);
- // Refresh the existing events (i.e. KQUEUE EV_CLEAR), for edge triggered I/O
+
+ /** Refresh the existing events (i.e. KQUEUE EV_CLEAR), for edge triggered
I/O
+ @param events: mask of events
Review comment:
Don't use colon as a separator. Space suffices.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
