mirror of
https://git.proxmox.com/git/mirror_corosync
synced 2025-07-16 21:26:19 +00:00
5da4d5479a
This patch modifies most of the existing comments in header files to be in a format that doxygen can interpret. This provides another significant improvement to the web/pdf/etc generated documentation without having to add new content. Signed-off-by: Russell Bryant <russell@russellbryant.net> Reviewed-by: Angus Salkeld <asalkeld@redhat.com>
117 lines
3.5 KiB
C
117 lines
3.5 KiB
C
/*
|
|
* Copyright (c) 2005 MontaVista Software, Inc.
|
|
* Copyright (c) 2006-2007, 2009 Red Hat, Inc.
|
|
*
|
|
* All rights reserved.
|
|
*
|
|
* Author: Steven Dake (sdake@redhat.com)
|
|
*
|
|
* This software licensed under BSD license, the text of which follows:
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions are met:
|
|
*
|
|
* - Redistributions of source code must retain the above copyright notice,
|
|
* this list of conditions and the following disclaimer.
|
|
* - Redistributions in binary form must reproduce the above copyright notice,
|
|
* this list of conditions and the following disclaimer in the documentation
|
|
* and/or other materials provided with the distribution.
|
|
* - Neither the name of the MontaVista Software, Inc. nor the names of its
|
|
* contributors may be used to endorse or promote products derived from this
|
|
* software without specific prior written permission.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
|
|
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
|
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
|
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
|
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
|
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
|
|
* THE POSSIBILITY OF SUCH DAMAGE.
|
|
*/
|
|
#ifndef TOTEMUDP_H_DEFINED
|
|
#define TOTEMUDP_H_DEFINED
|
|
|
|
#include <sys/types.h>
|
|
#include <sys/socket.h>
|
|
#include <corosync/hdb.h>
|
|
|
|
#include <corosync/totem/totem.h>
|
|
|
|
/**
|
|
* Create an instance
|
|
*/
|
|
extern int totemudp_initialize (
|
|
hdb_handle_t poll_handle,
|
|
void **udp_context,
|
|
struct totem_config *totem_config,
|
|
int interface_no,
|
|
void *context,
|
|
|
|
void (*deliver_fn) (
|
|
void *context,
|
|
const void *msg,
|
|
unsigned int msg_len),
|
|
|
|
void (*iface_change_fn) (
|
|
void *context,
|
|
const struct totem_ip_address *iface_address),
|
|
|
|
void (*target_set_completed) (
|
|
void *context));
|
|
|
|
extern void *totemudp_buffer_alloc (void);
|
|
|
|
extern void totemudp_buffer_release (void *ptr);
|
|
|
|
extern int totemudp_processor_count_set (
|
|
void *udp_context,
|
|
int processor_count);
|
|
|
|
extern int totemudp_token_send (
|
|
void *udp_context,
|
|
const void *msg,
|
|
unsigned int msg_len);
|
|
|
|
extern int totemudp_mcast_flush_send (
|
|
void *udp_context,
|
|
const void *msg,
|
|
unsigned int msg_len);
|
|
|
|
extern int totemudp_mcast_noflush_send (
|
|
void *udp_context,
|
|
const void *msg,
|
|
unsigned int msg_len);
|
|
|
|
extern int totemudp_recv_flush (void *udp_context);
|
|
|
|
extern int totemudp_send_flush (void *udp_context);
|
|
|
|
extern int totemudp_iface_check (void *udp_context);
|
|
|
|
extern int totemudp_finalize (void *udp_context);
|
|
|
|
extern void totemudp_net_mtu_adjust (void *udp_context, struct totem_config *totem_config);
|
|
|
|
extern const char *totemudp_iface_print (void *udp_context);
|
|
|
|
extern int totemudp_iface_get (
|
|
void *udp_context,
|
|
struct totem_ip_address *addr);
|
|
|
|
extern int totemudp_token_target_set (
|
|
void *udp_context,
|
|
const struct totem_ip_address *token_target);
|
|
|
|
extern int totemudp_crypto_set (
|
|
void *udp_context,
|
|
unsigned int type);
|
|
|
|
extern int totemudp_recv_mcast_empty (
|
|
void *udp_context);
|
|
|
|
#endif /* TOTEMUDP_H_DEFINED */
|