network.h

浏览该文件的文档.

/* SPDX-License-Identifier: Apache-2.0 */
 
/*
 * Copyright 2018-2022 Joel E. Anderson
 *
 * 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.
 */
 
#ifndef __STUMPLESS_TARGET_NETWORK_H
#  define __STUMPLESS_TARGET_NETWORK_H
 
#  include <stddef.h>
#  include <stumpless/config.h>
#  include <stumpless/target.h>
 
#define STUMPLESS_DEFAULT_TRANSPORT_PORT "514"
 
#define STUMPLESS_DEFAULT_UDP_MAX_MESSAGE_SIZE 1472
 
#  ifdef __cplusplus
extern "C" {
#  endif
 
enum stumpless_network_protocol {
  STUMPLESS_IPV4_NETWORK_PROTOCOL, 
  STUMPLESS_IPV6_NETWORK_PROTOCOL 
};
 
enum stumpless_transport_protocol {
  STUMPLESS_TCP_TRANSPORT_PROTOCOL, 
  STUMPLESS_UDP_TRANSPORT_PROTOCOL  
};
 
STUMPLESS_PUBLIC_FUNCTION
void
stumpless_close_network_target( const struct stumpless_target *target );
 
STUMPLESS_PUBLIC_FUNCTION
const char *
stumpless_get_destination( const struct stumpless_target *target );
 
STUMPLESS_PUBLIC_FUNCTION
const char *
stumpless_get_transport_port( const struct stumpless_target *target );
 
STUMPLESS_PUBLIC_FUNCTION
size_t
stumpless_get_udp_max_message_size( const struct stumpless_target *target );
 
STUMPLESS_PUBLIC_FUNCTION
struct stumpless_target *
stumpless_new_network_target( const char *name,
                              enum stumpless_network_protocol network,
                              enum stumpless_transport_protocol transport );
 
STUMPLESS_PUBLIC_FUNCTION
struct stumpless_target *
stumpless_new_tcp4_target( const char *name );
 
STUMPLESS_PUBLIC_FUNCTION
struct stumpless_target *
stumpless_new_tcp6_target( const char *name );
 
STUMPLESS_PUBLIC_FUNCTION
struct stumpless_target *
stumpless_new_udp4_target( const char *name );
 
STUMPLESS_PUBLIC_FUNCTION
struct stumpless_target *
stumpless_new_udp6_target( const char *name );
 
STUMPLESS_PUBLIC_FUNCTION
struct stumpless_target *
stumpless_open_network_target( const char *name,
                               const char *destination,
                               enum stumpless_network_protocol network,
                               enum stumpless_transport_protocol transport );
 
STUMPLESS_PUBLIC_FUNCTION
struct stumpless_target *
stumpless_open_tcp4_target( const char *name, const char *destination );
 
STUMPLESS_PUBLIC_FUNCTION
struct stumpless_target *
stumpless_open_tcp6_target( const char *name, const char *destination );
 
STUMPLESS_PUBLIC_FUNCTION
struct stumpless_target *
stumpless_open_udp4_target( const char *name, const char *destination );
 
STUMPLESS_PUBLIC_FUNCTION
struct stumpless_target *
stumpless_open_udp6_target( const char *name, const char *destination );
 
STUMPLESS_PUBLIC_FUNCTION
struct stumpless_target *
stumpless_set_destination( struct stumpless_target *target,
                           const char *destination );
 
STUMPLESS_PUBLIC_FUNCTION
struct stumpless_target *
stumpless_set_transport_port( struct stumpless_target *target,
                              const char *port );
 
STUMPLESS_PUBLIC_FUNCTION
struct stumpless_target *
stumpless_set_udp_max_message_size( struct stumpless_target *target,
                                    size_t max_msg_size );
 
STUMPLESS_PUBLIC_FUNCTION
enum stumpless_network_protocol
stumpless_get_network_protocol( const struct stumpless_target *target );
 
STUMPLESS_PUBLIC_FUNCTION
enum stumpless_transport_protocol
stumpless_get_transport_protocol( const struct stumpless_target *target );                     
 
#  ifdef __cplusplus
}                               /* extern "C" */
#  endif
#endif                          /* __STUMPLESS_TARGET_NETWORK_H */