Something went wrong. Try again.
[READ-ONLY] Mirror of https://github.com/VibeDevelopers/Comet.
Something went wrong. Try again.
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104/* * Comet: a slightly advanced ircd * batch.h: support functions for batches * * Copyright (c) 2025 Ryan Schmidt <skizzerz@skizzerz.net> * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * * This program 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 General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */
#ifndef INCLUDED_batch_h#define INCLUDED_batch_h
#include "msgbuf.h"
#define BATCH_EXPIRY (15)#define BATCH_ID_LEN (16)
/* If set, nested batches are not automatically dispatched to their handler. * Instead, the batch handler must manually process child batches. * Child batches are still automatically freed at the end of the handler invocation. */#define BATCH_FLAG_SKIP_CHILDREN 0x01/* If set, allows all batch types to be nested under this batch. * The child_allowed field is ignored and never called if this is set. */#define BATCH_FLAG_ALLOW_ALL 0x02
struct ResponseInfo;
struct Batch{ /* server-generated batch ID (15 random characters + trailing null byte) */ char id[BATCH_ID_LEN]; /* BATCH command that started this batch */ struct BatchMessage *start; /* client-generated batch reference tag */ const char *tag; /* batch type */ const char *type; /* time when this batch expires (times out) */ time_t expires; /* For nested batches, points at the batch immediately encapsulating this one * NULL if this batch is not nested */ struct Batch *parent; /* All finished batches nested under this one (linked list of struct Batch *) */ rb_dlink_list children; /* Number of messages inside of this batch */ unsigned int len; /* A linked list of struct BatchMessage * for each message inside of the batch */ rb_dlink_list messages; /* labeled-response context for this batch */ struct ResponseInfo *response_info;};
struct BatchMessage{ /* A copy of all string data for the message */ char *data; /* Size of data in bytes */ size_t datalen; /* A MsgBuf whose internal pointers all point to portions of the data array */ struct MsgBuf msg;};
struct Client;typedef void (*batch_cb)(struct Client *client_p, struct Client *source_p, struct Batch *batch, void *userdata);typedef bool (*child_allowed_cb)(struct Client *client_p, struct Client *source_p, struct Batch *parent, struct MsgBuf *child, void *userdata, const char **error);
struct BatchHandler{ /* function called when the batch is completed */ batch_cb handler; /* optional data pointer to pass into the handler */ void *userdata; /* bitfield of flags for this handler from the BATCH_FLAG_* constants */ unsigned int flags; /* function called to determine if some other batch is allowed to be nested under this one; * If false is returned and *error is not NULL, *error will be used as the error code/message * instead of INVALID_NESTING */ child_allowed_cb child_allowed;};
bool register_batch_handler(const char *type, const struct BatchHandler *handler);const struct BatchHandler *get_batch_handler(const char *type);void remove_batch_handler(const char *type);void generate_batch_id(char *buf, size_t size);struct Batch *batch_init(struct MsgBuf *start);struct BatchMessage *allocate_batch_message(struct MsgBuf *msg);void batch_free(struct Batch *batch, struct ResponseInfo *resume);
#endif /* INCLUDED_batch_h */