| Willy Tarreau | 8a8d83b | 2015-04-13 13:24:54 +0200 | [diff] [blame^] | 1 | /* |
| 2 | * include/proto/applet.h |
| 3 | * This file contains applet function prototypes |
| 4 | * |
| 5 | * Copyright (C) 2000-2015 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_APPLET_H |
| 23 | #define _PROTO_APPLET_H |
| 24 | |
| 25 | #include <stdlib.h> |
| 26 | |
| 27 | #include <common/config.h> |
| 28 | #include <types/applet.h> |
| 29 | #include <proto/connection.h> |
| 30 | |
| 31 | /* Initializes all required fields for a new appctx. Note that it does the |
| 32 | * minimum acceptable initialization for an appctx. This means only the |
| 33 | * 3 integer states st0, st1, st2 are zeroed. |
| 34 | */ |
| 35 | static inline void appctx_init(struct appctx *appctx) |
| 36 | { |
| 37 | appctx->st0 = appctx->st1 = appctx->st2 = 0; |
| 38 | } |
| 39 | |
| 40 | /* Tries to allocate a new appctx and initialize its main fields. The appctx |
| 41 | * is returned on success, NULL on failure. The appctx must be released using |
| 42 | * pool_free2(connection) or appctx_free(), since it's allocated from the |
| 43 | * connection pool. <applet> is assigned as the applet, but it can be NULL. |
| 44 | */ |
| 45 | static inline struct appctx *appctx_new(struct si_applet *applet) |
| 46 | { |
| 47 | struct appctx *appctx; |
| 48 | |
| 49 | appctx = pool_alloc2(pool2_connection); |
| 50 | if (likely(appctx != NULL)) { |
| 51 | appctx->obj_type = OBJ_TYPE_APPCTX; |
| 52 | appctx->applet = applet; |
| 53 | appctx_init(appctx); |
| 54 | } |
| 55 | return appctx; |
| 56 | } |
| 57 | |
| 58 | /* Releases an appctx previously allocated by appctx_new(). Note that |
| 59 | * we share the connection pool. |
| 60 | */ |
| 61 | static inline void appctx_free(struct appctx *appctx) |
| 62 | { |
| 63 | pool_free2(pool2_connection, appctx); |
| 64 | } |
| 65 | |
| 66 | #endif /* _PROTO_APPLET_H */ |
| 67 | |
| 68 | /* |
| 69 | * Local variables: |
| 70 | * c-indent-level: 8 |
| 71 | * c-basic-offset: 8 |
| 72 | * End: |
| 73 | */ |