.TH "rte_epoll.h" 3 "Version 25.11.0" "DPDK" \" -*- nroff -*-
.ad l
.nh
.SH NAME
rte_epoll.h
.SH SYNOPSIS
.br
.PP
\fR#include <stdint\&.h>\fP
.br
\fR#include <rte_stdatomic\&.h>\fP
.br

.SS "Data Structures"

.in +1c
.ti -1c
.RI "struct \fBrte_epoll_event\fP"
.br
.in -1c
.SS "Macros"

.in +1c
.ti -1c
.RI "#define \fBRTE_EPOLL_PER_THREAD\fP   \-1"
.br
.in -1c
.SS "Functions"

.in +1c
.ti -1c
.RI "int \fBrte_epoll_wait\fP (int epfd, struct \fBrte_epoll_event\fP *events, int maxevents, int timeout)"
.br
.ti -1c
.RI "int \fBrte_epoll_wait_interruptible\fP (int epfd, struct \fBrte_epoll_event\fP *events, int maxevents, int timeout)"
.br
.ti -1c
.RI "int \fBrte_epoll_ctl\fP (int epfd, int op, int fd, struct \fBrte_epoll_event\fP *event)"
.br
.in -1c
.SH "Detailed Description"
.PP 
The rte_epoll provides interfaces functions to add delete events, wait poll for an event\&. 
.PP
Definition in file \fBrte_epoll\&.h\fP\&.
.SH "Macro Definition Documentation"
.PP 
.SS "#define RTE_EPOLL_PER_THREAD   \-1"
to hint using per thread epfd 
.PP
Definition at line \fB48\fP of file \fBrte_epoll\&.h\fP\&.
.SH "Function Documentation"
.PP 
.SS "int rte_epoll_wait (int epfd, struct \fBrte_epoll_event\fP * events, int maxevents, int timeout)"
It waits for events on the epoll instance\&. Retries if signal received\&.

.PP
\fBParameters\fP
.RS 4
\fIepfd\fP Epoll instance fd on which the caller wait for events\&. 
.br
\fIevents\fP Memory area contains the events that will be available for the caller\&. 
.br
\fImaxevents\fP Up to maxevents are returned, must greater than zero\&. 
.br
\fItimeout\fP Specifying a timeout of -1 causes a block indefinitely\&. Specifying a timeout equal to zero cause to return immediately\&. 
.RE
.PP
\fBReturns\fP
.RS 4
.IP "\(bu" 2
On success, returns the number of available event\&.
.IP "\(bu" 2
On failure, a negative value\&. 
.PP
.RE
.PP

.SS "int rte_epoll_wait_interruptible (int epfd, struct \fBrte_epoll_event\fP * events, int maxevents, int timeout)"
It waits for events on the epoll instance\&. Does not retry if signal received\&.

.PP
\fBParameters\fP
.RS 4
\fIepfd\fP Epoll instance fd on which the caller wait for events\&. 
.br
\fIevents\fP Memory area contains the events that will be available for the caller\&. 
.br
\fImaxevents\fP Up to maxevents are returned, must greater than zero\&. 
.br
\fItimeout\fP Specifying a timeout of -1 causes a block indefinitely\&. Specifying a timeout equal to zero cause to return immediately\&. 
.RE
.PP
\fBReturns\fP
.RS 4
.IP "\(bu" 2
On success, returns the number of available event\&.
.IP "\(bu" 2
On failure, a negative value\&. 
.PP
.RE
.PP

.SS "int rte_epoll_ctl (int epfd, int op, int fd, struct \fBrte_epoll_event\fP * event)"
It performs control operations on epoll instance referred by the epfd\&. It requests that the operation op be performed for the target fd\&.

.PP
\fBParameters\fP
.RS 4
\fIepfd\fP Epoll instance fd on which the caller perform control operations\&. 
.br
\fIop\fP The operation be performed for the target fd\&. 
.br
\fIfd\fP The target fd on which the control ops perform\&. 
.br
\fIevent\fP Describes the object linked to the fd\&. Note: The caller must take care the object deletion after CTL_DEL\&. 
.RE
.PP
\fBReturns\fP
.RS 4
.IP "\(bu" 2
On success, zero\&.
.IP "\(bu" 2
On failure, a negative value\&. 
.PP
.RE
.PP

.SH "Author"
.PP 
Generated automatically by Doxygen for DPDK from the source code\&.