1 /*- 2 * Copyright (c) 2015-2016 Varnish Software AS 3 * All rights reserved. 4 * 5 * Author: Poul-Henning Kamp <phk@phk.freebsd.dk> 6 * 7 * SPDX-License-Identifier: BSD-2-Clause 8 * 9 * Redistribution and use in source and binary forms, with or without 10 * modification, are permitted provided that the following conditions 11 * are met: 12 * 1. Redistributions of source code must retain the above copyright 13 * notice, this list of conditions and the following disclaimer. 14 * 2. Redistributions in binary form must reproduce the above copyright 15 * notice, this list of conditions and the following disclaimer in the 16 * documentation and/or other materials provided with the distribution. 17 * 18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 21 * ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE 22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 28 * SUCH DAMAGE. 29 * 30 */ 31 32 /* Methods on objcore ------------------------------------------------*/ 33 34 typedef void objfree_f(struct worker *, struct objcore *); 35 36 typedef void objsetstate_f(struct worker *, const struct objcore *, 37 enum boc_state_e); 38 39 typedef int objiterator_f(struct worker *, struct objcore *, 40 void *priv, objiterate_f *func, int final); 41 typedef int objgetspace_f(struct worker *, struct objcore *, 42 ssize_t *sz, uint8_t **ptr); 43 typedef void objextend_f(struct worker *, struct objcore *, ssize_t l); 44 typedef void objtrimstore_f(struct worker *, struct objcore *); 45 typedef void objbocdone_f(struct worker *, struct objcore *, struct boc *); 46 typedef void objslim_f(struct worker *, struct objcore *); 47 typedef const void *objgetattr_f(struct worker *, struct objcore *, 48 enum obj_attr attr, ssize_t *len); 49 typedef void *objsetattr_f(struct worker *, struct objcore *, 50 enum obj_attr attr, ssize_t len, const void *ptr); 51 typedef void objtouch_f(struct worker *, struct objcore *, vtim_real now); 52 53 struct obj_methods { 54 /* required */ 55 objfree_f *objfree; 56 objiterator_f *objiterator; 57 objgetspace_f *objgetspace; 58 objextend_f *objextend; 59 objgetattr_f *objgetattr; 60 objsetattr_f *objsetattr; 61 /* optional */ 62 objtrimstore_f *objtrimstore; 63 objbocdone_f *objbocdone; 64 objslim_f *objslim; 65 objtouch_f *objtouch; 66 objsetstate_f *objsetstate; 67 }; 68 69