n_reactor.h

Go to the documentation of this file.

/*
 * Nilorea Library
 * Copyright (C) 2005-2026 Castagnier Mickael
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
 * implied. See the License for the specific language governing
 * permissions and limitations under the License.
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef NILOREA_N_REACTOR_H
#define NILOREA_N_REACTOR_H
 
/* Compile-time availability gate. Linux + Android both ship epoll
 * + eventfd. Solaris has /dev/poll and event ports (different
 * primitive); Windows has IOCP (different architecture). For now
 * the reactor is Linux/Android-only and falls back to the existing
 * thread engine on every other target.
 *
 * Wrapped in `#ifndef` so the build system can force the gate off
 * via `-DN_REACTOR_AVAILABLE=0` (e.g. on Linux when the user
 * deliberately opts out of reactor mode to drop the n_reactor.o
 * link dependency). The Makefile sets this when HAVE_REACTOR=0. */
#ifndef N_REACTOR_AVAILABLE
#if defined(__linux__) || defined(__ANDROID__)
#define N_REACTOR_AVAILABLE 1
#else
#define N_REACTOR_AVAILABLE 0
#endif
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include "nilorea/n_common.h"
#include "nilorea/n_network.h"
 
typedef struct n_reactor n_reactor;
 
typedef struct {
    long long events_processed; 
    long long writes_partial;   
    long long reads_partial;    
    long long fds_registered;   
    long long fds_unregistered; 
    long long wake_signals;     
    /* Registered-list walk diagnostics. wake_walks counts how many
     * times the wake-time list walk fired; wake_walk_visits sums
     * every NETWORK visited; wake_walk_drains sums every visit that
     * found data to send. Ratio (drains/visits) measures how
     * productive the walk is. */
    long long wake_walks;
    long long wake_walk_visits;
    long long wake_walk_drains;
} n_reactor_stats;
 
n_reactor* n_reactor_new(int max_fds_hint);
 
void n_reactor_destroy(n_reactor** reactor);
 
void n_reactor_run(n_reactor* reactor);
 
void* n_reactor_run_thread_entry(void* arg);
 
void n_reactor_stop(n_reactor* reactor);
 
void n_reactor_get_stats(const n_reactor* reactor, n_reactor_stats* out);
 
int n_reactor_register(n_reactor* reactor, NETWORK* netw);
 
void n_reactor_unregister(n_reactor* reactor, NETWORK* netw);
 
void n_reactor_notify_send(NETWORK* netw);
 
void n_reactor_close_netw_sync(NETWORK* netw);
 
NETWORK* netw_accept_into_reactor(NETWORK* listener,
                                  size_t send_list_limit,
                                  size_t recv_list_limit,
                                  int blocking,
                                  n_reactor* reactor,
                                  int* retval);
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* NILOREA_N_REACTOR_H */