libssh 0.12.0
The SSH library
Loading...
Searching...
No Matches
poll.h
1/*
2 * This file is part of the SSH Library
3 *
4 * Copyright (c) 2009 by Aris Adamantiadis
5 *
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
10 *
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
15 *
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19 */
20
21#ifndef POLL_H_
22#define POLL_H_
23
24#include "config.h"
25
26#ifdef HAVE_POLL
27#include <poll.h>
28#endif
29
30#include "libssh/libssh.h"
31
32#ifdef HAVE_POLL
33typedef struct pollfd ssh_pollfd_t;
34
35#else /* HAVE_POLL */
36
37/* poll emulation support */
38
39typedef struct ssh_pollfd_struct {
40 socket_t fd; /* file descriptor */
41 short events; /* requested events */
42 short revents; /* returned events */
43} ssh_pollfd_t;
44
45typedef unsigned long int nfds_t;
46
47#ifdef _WIN32
48
49#ifndef POLLRDNORM
50#define POLLRDNORM 0x0100
51#endif
52#ifndef POLLRDBAND
53#define POLLRDBAND 0x0200
54#endif
55#ifndef POLLIN
56#define POLLIN (POLLRDNORM | POLLRDBAND)
57#endif
58#ifndef POLLPRI
59#define POLLPRI 0x0400
60#endif
61
62#ifndef POLLWRNORM
63#define POLLWRNORM 0x0010
64#endif
65#ifndef POLLOUT
66#define POLLOUT (POLLWRNORM)
67#endif
68#ifndef POLLWRBAND
69#define POLLWRBAND 0x0020
70#endif
71
72#ifndef POLLERR
73#define POLLERR 0x0001
74#endif
75#ifndef POLLHUP
76#define POLLHUP 0x0002
77#endif
78#ifndef POLLNVAL
79#define POLLNVAL 0x0004
80#endif
81
82#else /* _WIN32 */
83
84/* poll.c */
85#ifndef POLLIN
86#define POLLIN 0x001 /* There is data to read. */
87#endif
88#ifndef POLLPRI
89#define POLLPRI 0x002 /* There is urgent data to read. */
90#endif
91#ifndef POLLOUT
92#define POLLOUT 0x004 /* Writing now will not block. */
93#endif
94
95#ifndef POLLERR
96#define POLLERR 0x008 /* Error condition. */
97#endif
98#ifndef POLLHUP
99#define POLLHUP 0x010 /* Hung up. */
100#endif
101#ifndef POLLNVAL
102#define POLLNVAL 0x020 /* Invalid polling request. */
103#endif
104
105#ifndef POLLRDNORM
106#define POLLRDNORM 0x040 /* mapped to read fds_set */
107#endif
108#ifndef POLLRDBAND
109#define POLLRDBAND 0x080 /* mapped to exception fds_set */
110#endif
111#ifndef POLLWRNORM
112#define POLLWRNORM 0x100 /* mapped to write fds_set */
113#endif
114#ifndef POLLWRBAND
115#define POLLWRBAND 0x200 /* mapped to write fds_set */
116#endif
117
118#endif /* WIN32 */
119#endif /* HAVE_POLL */
120
121#ifdef __cplusplus
122extern "C" {
123#endif
124
125void ssh_poll_init(void);
126void ssh_poll_cleanup(void);
127int ssh_poll(ssh_pollfd_t *fds, nfds_t nfds, int timeout);
128typedef struct ssh_poll_ctx_struct *ssh_poll_ctx;
129typedef struct ssh_poll_handle_struct *ssh_poll_handle;
130
143typedef int (*ssh_poll_callback)(ssh_poll_handle p, socket_t fd, int revents,
144 void *userdata);
145
146struct ssh_socket_struct;
147
148ssh_poll_handle ssh_poll_new(socket_t fd, short events, ssh_poll_callback cb,
149 void *userdata);
150void ssh_poll_free(ssh_poll_handle p);
151ssh_poll_ctx ssh_poll_get_ctx(ssh_poll_handle p);
152short ssh_poll_get_events(ssh_poll_handle p);
153void ssh_poll_set_events(ssh_poll_handle p, short events);
154void ssh_poll_add_events(ssh_poll_handle p, short events);
155void ssh_poll_remove_events(ssh_poll_handle p, short events);
156socket_t ssh_poll_get_fd(ssh_poll_handle p);
157void ssh_poll_set_fd(ssh_poll_handle p, socket_t fd);
158void ssh_poll_set_callback(ssh_poll_handle p, ssh_poll_callback cb, void *userdata);
159ssh_poll_ctx ssh_poll_ctx_new(size_t chunk_size);
160void ssh_poll_ctx_free(ssh_poll_ctx ctx);
161int ssh_poll_ctx_add(ssh_poll_ctx ctx, ssh_poll_handle p);
162int ssh_poll_ctx_add_socket (ssh_poll_ctx ctx, struct ssh_socket_struct *s);
163void ssh_poll_ctx_remove(ssh_poll_ctx ctx, ssh_poll_handle p);
164bool ssh_poll_is_locked(ssh_poll_handle p);
165int ssh_poll_ctx_dopoll(ssh_poll_ctx ctx, int timeout);
166ssh_poll_ctx ssh_poll_get_default_ctx(ssh_session session);
167int ssh_event_add_poll(ssh_event event, ssh_poll_handle p);
168void ssh_event_remove_poll(ssh_event event, ssh_poll_handle p);
169
170#ifdef __cplusplus
171}
172#endif
173
174#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:509
ssh_poll_is_locked
bool ssh_poll_is_locked(ssh_poll_handle p)
Returns if a poll object is locked.
Definition poll.c:725
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:497
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:522
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:646
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:481
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:984
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:559
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:749
ssh_poll_ctx_free
void ssh_poll_ctx_free(ssh_poll_ctx ctx)
Free a poll context.
Definition poll.c:583
ssh_poll_free
void ssh_poll_free(ssh_poll_handle p)
Free a poll object.
Definition poll.c:419
ssh_poll_get_events
short ssh_poll_get_events(ssh_poll_handle p)
Get the events of a poll object.
Definition poll.c:447
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:538
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:972
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:460
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:395
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:435
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:696