Loading...
Searching...
No Matches
poll.h
/*
* This file is part of the SSH Library
*
* Copyright (c) 2009 by Aris Adamantiadis
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
#ifndef POLL_H_
#define POLL_H_
#include "config.h"
#ifdef HAVE_POLL
#include <poll.h>
typedef struct pollfd ssh_pollfd_t;
#else /* HAVE_POLL */
/* poll emulation support */
typedef struct ssh_pollfd_struct {
socket_t fd; /* file descriptor */
short events; /* requested events */
short revents; /* returned events */
} ssh_pollfd_t;
typedef unsigned long int nfds_t;
#ifdef _WIN32
#ifndef POLLRDNORM
#define POLLRDNORM 0x0100
#endif
#ifndef POLLRDBAND
#define POLLRDBAND 0x0200
#endif
#ifndef POLLIN
#define POLLIN (POLLRDNORM | POLLRDBAND)
#endif
#ifndef POLLPRI
#define POLLPRI 0x0400
#endif
#ifndef POLLWRNORM
#define POLLWRNORM 0x0010
#endif
#ifndef POLLOUT
#define POLLOUT (POLLWRNORM)
#endif
#ifndef POLLWRBAND
#define POLLWRBAND 0x0020
#endif
#ifndef POLLERR
#define POLLERR 0x0001
#endif
#ifndef POLLHUP
#define POLLHUP 0x0002
#endif
#ifndef POLLNVAL
#define POLLNVAL 0x0004
#endif
#else /* _WIN32 */
/* poll.c */
#ifndef POLLIN
#define POLLIN 0x001 /* There is data to read. */
#endif
#ifndef POLLPRI
#define POLLPRI 0x002 /* There is urgent data to read. */
#endif
#ifndef POLLOUT
#define POLLOUT 0x004 /* Writing now will not block. */
#endif
#ifndef POLLERR
#define POLLERR 0x008 /* Error condition. */
#endif
#ifndef POLLHUP
#define POLLHUP 0x010 /* Hung up. */
#endif
#ifndef POLLNVAL
#define POLLNVAL 0x020 /* Invalid polling request. */
#endif
#ifndef POLLRDNORM
#define POLLRDNORM 0x040 /* mapped to read fds_set */
#endif
#ifndef POLLRDBAND
#define POLLRDBAND 0x080 /* mapped to exception fds_set */
#endif
#ifndef POLLWRNORM
#define POLLWRNORM 0x100 /* mapped to write fds_set */
#endif
#ifndef POLLWRBAND
#define POLLWRBAND 0x200 /* mapped to write fds_set */
#endif
#endif /* WIN32 */
#endif /* HAVE_POLL */
#ifdef __cplusplus
extern "C" {
#endif
void ssh_poll_init(void);
void ssh_poll_cleanup(void);
int ssh_poll(ssh_pollfd_t *fds, nfds_t nfds, int timeout);
typedef struct ssh_poll_ctx_struct *ssh_poll_ctx;
typedef struct ssh_poll_handle_struct *ssh_poll_handle;
typedef int (*ssh_poll_callback)(ssh_poll_handle p, socket_t fd, int revents,
void *userdata);
struct ssh_socket_struct;
ssh_poll_handle ssh_poll_new(socket_t fd, short events, ssh_poll_callback cb,
void *userdata);
void ssh_poll_free(ssh_poll_handle p);
ssh_poll_ctx ssh_poll_get_ctx(ssh_poll_handle p);
short ssh_poll_get_events(ssh_poll_handle p);
void ssh_poll_set_events(ssh_poll_handle p, short events);
void ssh_poll_add_events(ssh_poll_handle p, short events);
void ssh_poll_remove_events(ssh_poll_handle p, short events);
socket_t ssh_poll_get_fd(ssh_poll_handle p);
void ssh_poll_set_fd(ssh_poll_handle p, socket_t fd);
void ssh_poll_set_callback(ssh_poll_handle p, ssh_poll_callback cb, void *userdata);
ssh_poll_ctx ssh_poll_ctx_new(size_t chunk_size);
void ssh_poll_ctx_free(ssh_poll_ctx ctx);
int ssh_poll_ctx_add(ssh_poll_ctx ctx, ssh_poll_handle p);
int ssh_poll_ctx_add_socket (ssh_poll_ctx ctx, struct ssh_socket_struct *s);
void ssh_poll_ctx_remove(ssh_poll_ctx ctx, ssh_poll_handle p);
bool ssh_poll_is_locked(ssh_poll_handle p);
int ssh_poll_ctx_dopoll(ssh_poll_ctx ctx, int timeout);
ssh_poll_ctx ssh_poll_get_default_ctx(ssh_session session);
int ssh_event_add_poll(ssh_event event, ssh_poll_handle p);
void ssh_event_remove_poll(ssh_event event, ssh_poll_handle p);
#ifdef __cplusplus
}
#endif
#endif /* POLL_H_ */
ssh_poll_remove_events
void ssh_poll_remove_events(ssh_poll_handle p, short events)
Remove events from a poll object. Non-existent are ignored. The events will also be propagated to an ...
Definition poll.c:470
ssh_poll_is_locked
bool ssh_poll_is_locked(ssh_poll_handle p)
Returns if a poll object is locked.
Definition poll.c:678
ssh_poll_add_events
void ssh_poll_add_events(ssh_poll_handle p, short events)
Add extra events to a poll object. Duplicates are ignored. The events will also be propagated to an a...
Definition poll.c:458
ssh_poll_get_fd
socket_t ssh_poll_get_fd(ssh_poll_handle p)
Get the raw socket of a poll object.
Definition poll.c:483
ssh_poll_ctx_add
int ssh_poll_ctx_add(ssh_poll_ctx ctx, ssh_poll_handle p)
Add a poll object to a poll context.
Definition poll.c:596
ssh_poll_set_fd
void ssh_poll_set_fd(ssh_poll_handle p, socket_t fd)
Set the file descriptor of a poll object. The FD will also be propagated to an associated poll contex...
Definition poll.c:442
ssh_event_remove_poll
void ssh_event_remove_poll(ssh_event event, ssh_poll_handle p)
remove a poll handle to the event.
Definition poll.c:930
ssh_poll_ctx_new
ssh_poll_ctx ssh_poll_ctx_new(size_t chunk_size)
Create a new poll context. It could be associated with many poll object which are going to be polled ...
Definition poll.c:518
ssh_poll_ctx_dopoll
int ssh_poll_ctx_dopoll(ssh_poll_ctx ctx, int timeout)
Poll all the sockets associated through a poll object with a poll context. If any of the events are s...
Definition poll.c:702
ssh_poll_ctx_free
void ssh_poll_ctx_free(ssh_poll_ctx ctx)
Free a poll context.
Definition poll.c:542
ssh_poll_free
void ssh_poll_free(ssh_poll_handle p)
Free a poll object.
Definition poll.c:380
ssh_poll_get_events
short ssh_poll_get_events(ssh_poll_handle p)
Get the events of a poll object.
Definition poll.c:408
ssh_poll_set_callback
void ssh_poll_set_callback(ssh_poll_handle p, ssh_poll_callback cb, void *userdata)
Set the callback of a poll object.
Definition poll.c:499
ssh_event_add_poll
int ssh_event_add_poll(ssh_event event, ssh_poll_handle p)
Add a poll handle to the event.
Definition poll.c:918
ssh_poll_set_events
void ssh_poll_set_events(ssh_poll_handle p, short events)
Set the events of a poll object. The events will also be propagated to an associated poll context unl...
Definition poll.c:421
ssh_poll_new
ssh_poll_handle ssh_poll_new(socket_t fd, short events, ssh_poll_callback cb, void *userdata)
Allocate a new poll object, which could be used within a poll context.
Definition poll.c:355
ssh_poll_get_ctx
ssh_poll_ctx ssh_poll_get_ctx(ssh_poll_handle p)
Get the poll context of a poll object.
Definition poll.c:396
ssh_poll_ctx_remove
void ssh_poll_ctx_remove(ssh_poll_ctx ctx, ssh_poll_handle p)
Remove a poll object from a poll context.
Definition poll.c:649