globus_types.h man page

globus_types.h — Common Primitive Types.

Synopsis

#include 'globus_config.h'
#include <stdlib.h>
#include <stdint.h>
#include <sys/types.h>
#include <sys/socket.h>

Macros

#define GLOBUS_TRUE 1
True value for globus_bool_t.
#define GLOBUS_FALSE 0
False value for globus_bool_t.
#define GLOBUS_NULL NULL
NULL value.
#define GLOBUS_SUCCESS 0
Generic success result

Most Globus API functions return this value to indicate success, or some error constant or globus_result_t to indicate an error. "

#define GLOBUS_FAILURE -1
Generic failure result

Some Globus API functions without good error handling return this value to indicate some undetermined error occurred. "

Typedefs

typedef size_t globus_size_t
Standard size of memory object

The globus_size_t is the size of a memory object. It is identical to size_t in all cases and doesn't need to be used ever. "

typedef socklen_t globus_socklen_t
Size of a socket length parameter.
typedef unsigned char globus_byte_t
Unsigned byte datatype

This is used for byte-addressable arrays of arbitrary data which is not subject to sign extension. "

typedef int globus_bool_t
Boolean type.
typedef uint32_t globus_result_t

Detailed Description

Common Primitive Types.

Defines the macros and typedefs common to all globus_common components.

Macro Definition Documentation

#define GLOBUS_NULL NULL

NULL value. From back long ago before NULL was standardized? No reason to use this on any modern system.

Author

Generated automatically by Doxygen for globus_common from the source code.

Referenced By

globus_byte_t(3), GLOBUS_FAILURE(3), GLOBUS_FALSE(3), GLOBUS_NULL(3), globus_size_t(3), GLOBUS_SUCCESS(3) and GLOBUS_TRUE(3) are aliases of globus_types.h(3).

Sat Nov 5 2016 Version 16.8 globus_common