diff options
Diffstat (limited to 'ace/ACE.h')
| -rw-r--r-- | ace/ACE.h | 727 |
1 files changed, 0 insertions, 727 deletions
diff --git a/ace/ACE.h b/ace/ACE.h deleted file mode 100644 index a5f3601d579..00000000000 --- a/ace/ACE.h +++ /dev/null @@ -1,727 +0,0 @@ -/* -*- C++ -*- */ - -//============================================================================= -/** - * @file ACE.h - * - * $Id$ - * - * @author Doug Schmidt - */ -//============================================================================= - - -#ifndef ACE_ACE_H -#define ACE_ACE_H -#include "ace/pre.h" - -#include "ace/OS.h" - -#if !defined (ACE_LACKS_PRAGMA_ONCE) -# pragma once -#endif /* ACE_LACKS_PRAGMA_ONCE */ - -#include "ace/Flag_Manip.h" -#include "ace/Handle_Ops.h" -#include "ace/Lib_Find.h" -#include "ace/Init_ACE.h" -#include "ace/Sock_Connect.h" - -// Forward declarations. -class ACE_Time_Value; -class ACE_Message_Block; - -/** - * @class ACE - * - * @brief Contains value added ACE methods that extend the behavior - * of the UNIX and Win32 OS calls. - * - * This class consolidates all these ACE static methods in a - * single place in order to manage the namespace better. These - * methods are put here rather than in ACE_OS in order to - * separate concerns. - */ -class ACE_Export ACE : public ACE_Flag_Manip, public ACE_Handle_Ops, - public ACE_Lib_Find, public ACE_Init_ACE, - public ACE_Sock_Connect -{ - - ACE_CLASS_IS_NAMESPACE (ACE); -public: - - // = ACE version information. - /// E.g., the "4" in ACE 4.3.19. - static u_int major_version (void); - - /// E.g., the "3" in ACE 4.3.19. - static u_int minor_version (void); - - /// E.g., the "19" in ACE 4.3.19. - /// Returns 0 for "stable" (non-beta) releases. - static u_int beta_version (void); - - // = C++ compiler version information. - /// E.g., the "SunPro C++" in SunPro C++ 4.32.0 - static const ACE_TCHAR * compiler_name (void); - - /// E.g., the "4" in SunPro C++ 4.32.0 - static u_int compiler_major_version (void); - - /// E.g., the "32" in SunPro C++ 4.32.0 - static u_int compiler_minor_version (void); - - /// E.g., the "0" in SunPro C++ 4.32.0 - static u_int compiler_beta_version (void); - - /// Check if error indicates the process being out of handles (file - /// descriptors). - static int out_of_handles (int error); - - /** - * @name I/O operations - * - * Notes on common parameters: - * - * <handle> is the connected endpoint that will be used for I/O. - * - * <buf> is the buffer to write from or receive into. - * - * <len> is the number of bytes to transfer. - * - * The <timeout> parameter in the following methods indicates how - * long to blocking trying to transfer data. If <timeout> == 0, - * then the call behaves as a normal send/recv call, i.e., for - * blocking sockets, the call will block until action is possible; - * for non-blocking sockets, EWOULDBLOCK will be returned if no - * action is immediately possible. - * - * If <timeout> != 0, the call will wait until the relative time - * specified in *<timeout> elapses. - * - * The "_n()" I/O methods keep looping until all the data has been - * transferred. These methods also work for sockets in non-blocking - * mode i.e., they keep looping on EWOULDBLOCK. <timeout> is used - * to make sure we keep making progress, i.e., the same timeout - * value is used for every I/O operation in the loop and the timeout - * is not counted down. - * - * The return values for the "*_n()" methods match the return values - * from the non "_n()" methods and are specified as follows: - * - * - On complete transfer, the number of bytes transferred is returned. - * - On timeout, -1 is returned, errno == ETIME. - * - On error, -1 is returned, errno is set to appropriate error. - * - On EOF, 0 is returned, errno is irrelevant. - * - * On partial transfers, i.e., if any data is transferred before - * timeout/error/EOF, <bytes_transferred> will contain the number of - * bytes transferred. - * - * Methods with <iovec> parameter are I/O vector variants of the I/O - * operations. - * - * Methods with the extra <flags> argument will always result in - * <send> getting called. Methods without the extra <flags> argument - * will result in <send> getting called on Win32 platforms, and - * <write> getting called on non-Win32 platforms. - */ - //@{ - static ssize_t recv (ACE_HANDLE handle, - void *buf, - size_t len, - int flags, - const ACE_Time_Value *timeout = 0); - -#if defined (ACE_HAS_TLI) - - static ssize_t t_rcv (ACE_HANDLE handle, - void *buf, - size_t len, - int *flags, - const ACE_Time_Value *timeout = 0); - -#endif /* ACE_HAS_TLI */ - - static ssize_t recv (ACE_HANDLE handle, - void *buf, - size_t len, - const ACE_Time_Value *timeout = 0); - - static ssize_t recvmsg (ACE_HANDLE handle, - struct msghdr *msg, - int flags, - const ACE_Time_Value *timeout = 0); - - static ssize_t recvfrom (ACE_HANDLE handle, - char *buf, - int len, - int flags, - struct sockaddr *addr, - int *addrlen, - const ACE_Time_Value *timeout = 0); - - static ssize_t recv_n (ACE_HANDLE handle, - void *buf, - size_t len, - int flags, - const ACE_Time_Value *timeout = 0, - size_t *bytes_transferred = 0); - -#if defined (ACE_HAS_TLI) - - static ssize_t t_rcv_n (ACE_HANDLE handle, - void *buf, - size_t len, - int *flags, - const ACE_Time_Value *timeout = 0, - size_t *bytes_transferred = 0); - -#endif /* ACE_HAS_TLI */ - - static ssize_t recv_n (ACE_HANDLE handle, - void *buf, - size_t len, - const ACE_Time_Value *timeout = 0, - size_t *bytes_transferred = 0); - - /// Varargs variant. - static ssize_t recv (ACE_HANDLE handle, size_t n, ...); - - static ssize_t recvv (ACE_HANDLE handle, - iovec *iov, - int iovcnt, - const ACE_Time_Value *timeout = 0); - - static ssize_t recvv_n (ACE_HANDLE handle, - iovec *iov, - int iovcnt, - const ACE_Time_Value *timeout = 0, - size_t *bytes_transferred = 0); - - static ssize_t recv_n (ACE_HANDLE handle, - ACE_Message_Block *message_block, - const ACE_Time_Value *timeout = 0, - size_t *bytes_transferred = 0); - - static ssize_t send (ACE_HANDLE handle, - const void *buf, - size_t len, - int flags, - const ACE_Time_Value *timeout = 0); - -#if defined (ACE_HAS_TLI) - - static ssize_t t_snd (ACE_HANDLE handle, - const void *buf, - size_t len, - int flags, - const ACE_Time_Value *timeout = 0); - -#endif /* ACE_HAS_TLI */ - - static ssize_t send (ACE_HANDLE handle, - const void *buf, - size_t len, - const ACE_Time_Value *timeout = 0); - - static ssize_t sendmsg (ACE_HANDLE handle, - const struct msghdr *msg, - int flags, - const ACE_Time_Value *timeout = 0); - - static ssize_t sendto (ACE_HANDLE handle, - const char *buf, - int len, - int flags, - const struct sockaddr *addr, - int addrlen, - const ACE_Time_Value *timeout = 0); - - static ssize_t send_n (ACE_HANDLE handle, - const void *buf, - size_t len, - int flags, - const ACE_Time_Value *timeout = 0, - size_t *bytes_transferred = 0); - -#if defined (ACE_HAS_TLI) - - static ssize_t t_snd_n (ACE_HANDLE handle, - const void *buf, - size_t len, - int flags, - const ACE_Time_Value *timeout = 0, - size_t *bytes_transferred = 0); - -#endif /* ACE_HAS_TLI */ - - static ssize_t send_n (ACE_HANDLE handle, - const void *buf, - size_t len, - const ACE_Time_Value *timeout = 0, - size_t *bytes_transferred = 0); - - /// Varargs variant. - static ssize_t send (ACE_HANDLE handle, size_t n, ...); - - static ssize_t sendv (ACE_HANDLE handle, - const iovec *iov, - int iovcnt, - const ACE_Time_Value *timeout = 0); - - static ssize_t sendv_n (ACE_HANDLE handle, - const iovec *iov, - int iovcnt, - const ACE_Time_Value *timeout = 0, - size_t *bytes_transferred = 0); - - static ssize_t send_n (ACE_HANDLE handle, - const ACE_Message_Block *message_block, - const ACE_Time_Value *timeout = 0, - size_t *bytes_transferred = 0); - - // = File system I/O functions (these don't support timeouts). - - static ssize_t read_n (ACE_HANDLE handle, - void *buf, - size_t len, - size_t *bytes_transferred = 0); - - static ssize_t write_n (ACE_HANDLE handle, - const void *buf, - size_t len, - size_t *bytes_transferred = 0); - - static ssize_t readv_n (ACE_HANDLE handle, - iovec *iov, - int iovcnt, - size_t *bytes_transferred = 0); - - static ssize_t writev_n (ACE_HANDLE handle, - const iovec *iov, - int iovcnt, - size_t *bytes_transferred = 0); - //@} - - /** - * Wait up to <timeout> amount of time to passively establish a - * connection. This method doesn't perform the <accept>, it just - * does the timed wait... - */ - static int handle_timed_accept (ACE_HANDLE listener, - ACE_Time_Value *timeout, - int restart); - - /** - * Wait up to <timeout> amount of time to complete an actively - * established non-blocking connection. If <is_tli> is non-0 then - * we are being called by a TLI wrapper (which behaves slightly - * differently from a socket wrapper). - */ - static ACE_HANDLE handle_timed_complete (ACE_HANDLE listener, - const ACE_Time_Value *timeout, - int is_tli = 0); - - /** - * Reset the limit on the number of open handles. If <new_limit> == - * -1 set the limit to the maximum allowable. Otherwise, set it to - * be the value of <new_limit>. - */ - static int set_handle_limit (int new_limit = -1); - - /** - * Returns the maximum number of open handles currently permitted in - * this process. This maximum may be extended using - * <ACE::set_handle_limit>. - */ - static int max_handles (void); - - // = String functions -#if !defined (ACE_HAS_WINCE) - /** - * Return a dynamically allocated duplicate of <str>, substituting - * the environment variable if <str[0] == '$'>. Note that the - * pointer is allocated with <ACE_OS::malloc> and must be freed by - * <ACE_OS::free>. - */ - static ACE_TCHAR *strenvdup (const ACE_TCHAR *str); -#endif /* ACE_HAS_WINCE */ - - /// Returns a pointer to the "end" of the string, i.e., the character - /// past the '\0'. - static const char *strend (const char *s); - - /// This method is just like <strdup>, except that it uses <operator - /// new> rather than <malloc>. - static char *strnew (const char *s); - - /// Create a fresh new copy of <str>, up to <n> chars long. Uses - /// <ACE_OS::malloc> to allocate the new string. - static char *strndup (const char *str, size_t n); - - /// Create a fresh new copy of <str>, up to <n> chars long. Uses - /// <ACE_OS::malloc> to allocate the new string. - static char *strnnew (const char *str, size_t n); - -#if defined (ACE_HAS_WCHAR) - static const wchar_t *strend (const wchar_t *s); - - static wchar_t *strnew (const wchar_t *s); - - static wchar_t *strndup (const wchar_t *str, size_t n); - - static wchar_t *strnnew (const wchar_t *str, size_t n); - -#endif /* ACE_HAS_WCHAR */ - - /** - * On Win32 returns <pathname> if it already ends in ".exe," - * otherwise returns a dynamically allocated buffer containing - * "<pathname>.exe". Always returns <pathname> on UNIX. - */ - static const ACE_TCHAR *execname (const ACE_TCHAR *pathname); - - /** - * Returns the "basename" of a <pathname> separated by <delim>. For - * instance, the basename of "/tmp/foo.cpp" is "foo.cpp" when - * <delim> is '/'. - */ - static const ACE_TCHAR *basename (const ACE_TCHAR *pathname, - ACE_TCHAR delim = - ACE_DIRECTORY_SEPARATOR_CHAR); - - /** - * Returns the "dirname" of a <pathname>. For instance, the dirname - * of "/tmp/foo.cpp" is "/tmp" when <delim> is '/'. If <pathname> - * has no <delim> ".\0" is returned. This method does not modify - * <pathname> and is not reentrant. - */ - static const ACE_TCHAR *dirname (const ACE_TCHAR *pathname, - ACE_TCHAR delim = - ACE_DIRECTORY_SEPARATOR_CHAR); - - - - /** - * Returns the current timestamp in the form - * "hour:minute:second:microsecond." The month, day, and year are - * also stored in the beginning of the date_and_time array. Returns - * 0 if unsuccessful, else returns pointer to beginning of the - * "time" portion of <day_and_time>. If - * <return_pointer_to_first_digit> is 0 then return a pointer to the - * space before the time, else return a pointer to the beginning of - * the time portion. - */ - static ACE_TCHAR *timestamp (ACE_TCHAR date_and_time[], - int time_len, - int return_pointer_to_first_digit = 0); - - /** - * if <avoid_zombies> == 0 call <ACE_OS::fork> directly, else create - * an orphan process that's inherited by the init process; init - * cleans up when the orphan process terminates so we don't create - * zombies. - */ - static pid_t fork (const ACE_TCHAR *program_name = ACE_LIB_TEXT ("<unknown>"), - int avoid_zombies = 0); - - /** - * Become a daemon process using the algorithm in Richard Stevens - * "Advanced Programming in the UNIX Environment." If - * <close_all_handles> is non-zero then all open file handles are - * closed. - */ - static int daemonize (const ACE_TCHAR pathname[] = ACE_LIB_TEXT ("/"), - int close_all_handles = ACE_DEFAULT_CLOSE_ALL_HANDLES, - const ACE_TCHAR program_name[] = ACE_LIB_TEXT ("<unknown>")); - - // = Shield us from Win32's inability to select on STDIN. - - // = Miscelleous functions. - /// Rounds the request to a multiple of the page size. - static size_t round_to_pagesize (off_t length); - - /// Rounds the request to a multiple of the allocation granularity. - static size_t round_to_allocation_granularity (off_t len); - - // @@ UNICODE what about buffer? - /// Format buffer into printable format. This is useful for - /// debugging. - static int format_hexdump (const char *buffer, int size, - ACE_TCHAR *obuf, int obuf_sz); - - /// Computes the hash value of <str> using the "Hash PJW" routine. - static u_long hash_pjw (const char *str); - - /// Computes the hash value of <str> using the "Hash PJW" routine. - static u_long hash_pjw (const char *str, size_t len); - -#if defined (ACE_HAS_WCHAR) - /// Computes the hash value of <str> using the "Hash PJW" routine. - static u_long hash_pjw (const wchar_t *str); - - /// Computes the hash value of <str> using the "Hash PJW" routine. - static u_long hash_pjw (const wchar_t *str, size_t len); -#endif /* ACE_HAS_WCHAR */ - - /// Computes the ISO 8802-3 standard 32 bits CRC for the string - /// (not for a file). - static u_long crc32 (const char *str); - - /// Computes the ISO 8802-3 standard 32 bits CRC for the given - /// buffer (the length is included in the CRC). - static u_long crc32 (const char *buf, ACE_UINT32 len); - - /// Euclid's greatest common divisor algorithm. - static u_long gcd (u_long x, u_long y); - - /// Calculates the minimum enclosing frame size for the given values. - static u_long minimum_frame_size (u_long period1, u_long period2); - - /** - * Function that can burn up noticeable CPU time: brute-force - * determination of whether number "n" is prime. Returns 0 if - * it is prime, or the smallest factor if it is not prime. min_factor - * and max_factor can be used to partition the work among threads. - * For just one thread, typical values are 2 and n/2. - */ - static u_long is_prime (const u_long n, - const u_long min_factor, - const u_long max_factor); - - /// Map troublesome win32 errno values to values that standard C - /// strerr function understands. Thank you Microsoft. - static int map_errno (int error); - - /// Returns a string containing the error message corresponding to a - /// WinSock error. This works around an omission in the Win32 API... - static const ACE_TCHAR *sock_error (int error); - - /** - * Checks if process with <pid> is still alive. Returns 1 if it is - * still alive, 0 if it isn't alive, and -1 if something weird - * happened. - */ - static int process_active (pid_t pid); - - /** - * Terminate the process abruptly with id <pid>. On Win32 platforms - * this uses <TerminateProcess> and on POSIX platforms is uses - * <kill> with the -9 (SIGKILL) signal, which cannot be caught or - * ignored. Note that this call is potentially dangerous to use - * since the process being terminated may not have a chance to - * cleanup before it shuts down. - */ - static int terminate_process (pid_t pid); - - /** - * This method uses process id and object pointer to come up with a - * machine wide unique name. The process ID will provide uniqueness - * between processes on the same machine. The "this" pointer of the - * <object> will provide uniqueness between other "live" objects in - * the same process. The uniqueness of this name is therefore only - * valid for the life of <object>. - */ - static void unique_name (const void *object, - ACE_TCHAR *name, - size_t length); - - /// Computes the base 2 logarithm of <num>. - static u_long log2 (u_long num); - - /// Hex conversion utility. - static ACE_TCHAR nibble2hex (u_int n); - - /// Convert a hex character to its byte representation. - static u_char hex2byte (ACE_TCHAR c); - - // = Set/get the debug level. - static char debug (void); - static void debug (char d); - - /// Timed wait for handle to get read ready. - static int handle_read_ready (ACE_HANDLE handle, - const ACE_Time_Value *timeout); - - /// Timed wait for handle to get write ready. - static int handle_write_ready (ACE_HANDLE handle, - const ACE_Time_Value *timeout); - - /// Timed wait for handle to get exception ready. - static int handle_exception_ready (ACE_HANDLE handle, - const ACE_Time_Value *timeout); - - /// Timed wait for handle to get read, write, or exception ready. - static int handle_ready (ACE_HANDLE handle, - const ACE_Time_Value *timeout, - int read_ready, - int write_ready, - int exception_ready); - - /// Wait for <timeout> before proceeding to a <recv> operation. - /// <val> keeps track of whether we're in non-blocking mode or not. - static int enter_recv_timedwait (ACE_HANDLE handle, - const ACE_Time_Value *timeout, - int &val); - - /// Wait for <timeout> before proceeding to a <send> operation. - /// <val> keeps track of whether we're in non-blocking mode or not. - static int enter_send_timedwait (ACE_HANDLE handle, - const ACE_Time_Value* timeout, - int &val); - - /// This makes sure that <handle> is set into non-blocking mode. - /// <val> keeps track of whether were in non-blocking mode or not. - static void record_and_set_non_blocking_mode (ACE_HANDLE handle, - int &val); - - /// Cleanup after a timed operation, restore the appropriate - /// non-blocking status of <handle>. - static void restore_non_blocking_mode (ACE_HANDLE handle, - int val); - -private: - - // - // = Recv_n helpers - // - - static ssize_t recv_i (ACE_HANDLE handle, - void *buf, - size_t len); - - static ssize_t recv_n_i (ACE_HANDLE handle, - void *buf, - size_t len, - int flags, - size_t *bytes_transferred); - - static ssize_t recv_n_i (ACE_HANDLE handle, - void *buf, - size_t len, - int flags, - const ACE_Time_Value *timeout, - size_t *bytes_transferred); - -#if defined (ACE_HAS_TLI) - - static ssize_t t_rcv_n_i (ACE_HANDLE handle, - void *buf, - size_t len, - int *flags, - size_t *bytes_transferred); - - static ssize_t t_rcv_n_i (ACE_HANDLE handle, - void *buf, - size_t len, - int *flags, - const ACE_Time_Value *timeout, - size_t *bytes_transferred); - -#endif /* ACE_HAS_TLI */ - - static ssize_t recv_n_i (ACE_HANDLE handle, - void *buf, - size_t len, - size_t *bytes_transferred); - - static ssize_t recv_n_i (ACE_HANDLE handle, - void *buf, - size_t len, - const ACE_Time_Value *timeout, - size_t *bytes_transferred); - - static ssize_t recvv_n_i (ACE_HANDLE handle, - iovec *iov, - int iovcnt, - size_t *bytes_transferred); - - static ssize_t recvv_n_i (ACE_HANDLE handle, - iovec *iov, - int iovcnt, - const ACE_Time_Value *timeout, - size_t *bytes_transferred); - - // - // = Send_n helpers - // - - static ssize_t send_i (ACE_HANDLE handle, - const void *buf, - size_t len); - - static ssize_t send_n_i (ACE_HANDLE handle, - const void *buf, - size_t len, - int flags, - size_t *bytes_transferred); - - static ssize_t send_n_i (ACE_HANDLE handle, - const void *buf, - size_t len, - int flags, - const ACE_Time_Value *timeout, - size_t *bytes_transferred); - -#if defined (ACE_HAS_TLI) - - static ssize_t t_snd_n_i (ACE_HANDLE handle, - const void *buf, - size_t len, - int flags, - size_t *bytes_transferred); - - static ssize_t t_snd_n_i (ACE_HANDLE handle, - const void *buf, - size_t len, - int flags, - const ACE_Time_Value *timeout, - size_t *bytes_transferred); - -#endif /* ACE_HAS_TLI */ - - static ssize_t send_n_i (ACE_HANDLE handle, - const void *buf, - size_t len, - size_t *bytes_transferred); - - static ssize_t send_n_i (ACE_HANDLE handle, - const void *buf, - size_t len, - const ACE_Time_Value *timeout, - size_t *bytes_transferred); - - static ssize_t sendv_n_i (ACE_HANDLE handle, - const iovec *iov, - int iovcnt, - size_t *bytes_transferred); - - static ssize_t sendv_n_i (ACE_HANDLE handle, - const iovec *iov, - int iovcnt, - const ACE_Time_Value *timeout, - size_t *bytes_transferred); - - /// Size of a VM page. - static size_t pagesize_; - - /// Size of allocation granularity. - static size_t allocation_granularity_; - - /// CRC table. - static u_long crc_table_[]; - - /// Hex characters. - static const ACE_TCHAR hex_chars_[]; - - /// Are we debugging ACE? - static char debug_; -}; - -#if !defined (ACE_LACKS_INLINE_FUNCTIONS) -#include "ace/ACE.i" -#endif /* ACE_LACKS_INLINE_FUNCTIONS */ - -#include "ace/post.h" -#endif /* ACE_ACE_H */ |