| Willy Tarreau | d1d5454 | 2012-09-12 22:58:11 +0200 | [diff] [blame] | 1 | /* |
| 2 | * include/proto/protocol.h |
| 3 | * This file declares generic protocol management primitives. |
| 4 | * |
| 5 | * Copyright (C) 2000-2012 Willy Tarreau - w@1wt.eu |
| 6 | * |
| 7 | * This library is free software; you can redistribute it and/or |
| 8 | * modify it under the terms of the GNU Lesser General Public |
| 9 | * License as published by the Free Software Foundation, version 2.1 |
| 10 | * exclusively. |
| 11 | * |
| 12 | * This library is distributed in the hope that it will be useful, |
| 13 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
| 15 | * Lesser General Public License for more details. |
| 16 | * |
| 17 | * You should have received a copy of the GNU Lesser General Public |
| 18 | * License along with this library; if not, write to the Free Software |
| 19 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA |
| 20 | */ |
| 21 | |
| 22 | #ifndef _PROTO_PROTOCOL_H |
| 23 | #define _PROTO_PROTOCOL_H |
| 24 | |
| Willy Tarreau | b550d00 | 2015-02-20 16:53:25 +0100 | [diff] [blame] | 25 | #include <sys/socket.h> |
| Willy Tarreau | d1d5454 | 2012-09-12 22:58:11 +0200 | [diff] [blame] | 26 | #include <types/protocol.h> |
| 27 | |
| William Lallemand | 2d3f8a4 | 2018-09-11 16:51:28 +0200 | [diff] [blame] | 28 | extern struct protocol *__protocol_by_family[AF_CUST_MAX]; |
| Willy Tarreau | b550d00 | 2015-02-20 16:53:25 +0100 | [diff] [blame] | 29 | |
| Willy Tarreau | d1d5454 | 2012-09-12 22:58:11 +0200 | [diff] [blame] | 30 | /* Registers the protocol <proto> */ |
| 31 | void protocol_register(struct protocol *proto); |
| 32 | |
| 33 | /* Unregisters the protocol <proto>. Note that all listeners must have |
| 34 | * previously been unbound. |
| 35 | */ |
| 36 | void protocol_unregister(struct protocol *proto); |
| 37 | |
| 38 | /* binds all listeneres of all registered protocols. Returns a composition |
| 39 | * of ERR_NONE, ERR_RETRYABLE, ERR_FATAL. |
| 40 | */ |
| 41 | int protocol_bind_all(char *errmsg, int errlen); |
| 42 | |
| 43 | /* unbinds all listeners of all registered protocols. They are also closed. |
| 44 | * This must be performed before calling exit() in order to get a chance to |
| 45 | * remove file-system based sockets and pipes. |
| 46 | * Returns a composition of ERR_NONE, ERR_RETRYABLE, ERR_FATAL. |
| 47 | */ |
| 48 | int protocol_unbind_all(void); |
| 49 | |
| 50 | /* enables all listeners of all registered protocols. This is intended to be |
| 51 | * used after a fork() to enable reading on all file descriptors. Returns a |
| 52 | * composition of ERR_NONE, ERR_RETRYABLE, ERR_FATAL. |
| 53 | */ |
| 54 | int protocol_enable_all(void); |
| 55 | |
| 56 | /* returns the protocol associated to family <family> or NULL if not found */ |
| Willy Tarreau | b550d00 | 2015-02-20 16:53:25 +0100 | [diff] [blame] | 57 | static inline struct protocol *protocol_by_family(int family) |
| 58 | { |
| William Lallemand | 2d3f8a4 | 2018-09-11 16:51:28 +0200 | [diff] [blame] | 59 | if (family >= 0 && family < AF_CUST_MAX) |
| Willy Tarreau | b550d00 | 2015-02-20 16:53:25 +0100 | [diff] [blame] | 60 | return __protocol_by_family[family]; |
| 61 | return NULL; |
| 62 | } |
| Willy Tarreau | d1d5454 | 2012-09-12 22:58:11 +0200 | [diff] [blame] | 63 | |
| 64 | #endif /* _PROTO_PROTOCOL_H */ |
| 65 | |
| 66 | /* |
| 67 | * Local variables: |
| 68 | * c-indent-level: 8 |
| 69 | * c-basic-offset: 8 |
| 70 | * End: |
| 71 | */ |