jyapayne/Nim
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

improve epoll docs (#15137)

Browse source
This commit is contained in:
flywind 2020-08-01 17:30:51 +08:00 • committed by GitHub
commit a7736b6b43
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 23 additions and 21 deletions
Download patch file Download diff file Expand all files Collapse all files

8
lib/posix/epoll.nim
View file

@ -45,6 +45,7 @@ type
proc epoll_create*(size: cint): cint {.importc: "epoll_create", proc epoll_create*(size: cint): cint {.importc: "epoll_create",
header: "<sys/epoll.h>".} header: "<sys/epoll.h>".}
## Creates an epoll instance. Returns an fd for the new instance. ## Creates an epoll instance. Returns an fd for the new instance.
##
## The "size" parameter is a hint specifying the number of file ## The "size" parameter is a hint specifying the number of file
## descriptors to be associated with the new instance. The fd ## descriptors to be associated with the new instance. The fd
## returned by epoll_create() should be closed with close(). ## returned by epoll_create() should be closed with close().
@ -56,9 +57,10 @@ proc epoll_create1*(flags: cint): cint {.importc: "epoll_create1",
proc epoll_ctl*(epfd: cint; op: cint; fd: cint | SocketHandle; event: ptr EpollEvent): cint {. proc epoll_ctl*(epfd: cint; op: cint; fd: cint | SocketHandle; event: ptr EpollEvent): cint {.
importc: "epoll_ctl", header: "<sys/epoll.h>".} importc: "epoll_ctl", header: "<sys/epoll.h>".}
## Manipulate an epoll instance "epfd". Returns 0 in case of success, ## Manipulate an epoll instance "epfd". Returns ``0`` in case of success,
## -1 in case of error ( the "errno" variable will contain the ## ``-1`` in case of error (the "errno" variable will contain the specific error code).
## specific error code ) The "op" parameter is one of the EPOLL_CTL_* ##
## The "op" parameter is one of the ``EPOLL_CTL_*``
## constants defined above. The "fd" parameter is the target of the ## constants defined above. The "fd" parameter is the target of the
## operation. The "event" parameter describes which events the caller ## operation. The "event" parameter describes which events the caller
## is interested in and any associated user data. ## is interested in and any associated user data.