00001 /* ///////////////////////////////////////////////////////////////////////// 00002 * File: acestl/network/socket_functions.hpp 00003 * 00004 * Purpose: Helper functions for ACE_SOCK (and derived) classes 00005 * 00006 * Created: 28th November 2004 00007 * Updated: 10th August 2009 00008 * 00009 * Home: http://stlsoft.org/ 00010 * 00011 * Copyright (c) 2004-2009, Matthew Wilson and Synesis Software 00012 * All rights reserved. 00013 * 00014 * Redistribution and use in source and binary forms, with or without 00015 * modification, are permitted provided that the following conditions are met: 00016 * 00017 * - Redistributions of source code must retain the above copyright notice, this 00018 * list of conditions and the following disclaimer. 00019 * - Redistributions in binary form must reproduce the above copyright notice, 00020 * this list of conditions and the following disclaimer in the documentation 00021 * and/or other materials provided with the distribution. 00022 * - Neither the name(s) of Matthew Wilson and Synesis Software nor the names of 00023 * any contributors may be used to endorse or promote products derived from 00024 * this software without specific prior written permission. 00025 * 00026 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 00027 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 00028 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 00029 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 00030 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 00031 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 00032 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 00033 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 00034 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 00035 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 00036 * POSSIBILITY OF SUCH DAMAGE. 00037 * 00038 * ////////////////////////////////////////////////////////////////////// */ 00039 00040 00047 #ifndef ACESTL_INCL_ACESTL_NETWORK_HPP_SOCKET_FUNCTIONS 00048 #define ACESTL_INCL_ACESTL_NETWORK_HPP_SOCKET_FUNCTIONS 00049 00050 #ifndef STLSOFT_DOCUMENTATION_SKIP_SECTION 00051 # define ACESTL_VER_ACESTL_NETWORK_HPP_SOCKET_FUNCTIONS_MAJOR 2 00052 # define ACESTL_VER_ACESTL_NETWORK_HPP_SOCKET_FUNCTIONS_MINOR 0 00053 # define ACESTL_VER_ACESTL_NETWORK_HPP_SOCKET_FUNCTIONS_REVISION 2 00054 # define ACESTL_VER_ACESTL_NETWORK_HPP_SOCKET_FUNCTIONS_EDIT 24 00055 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */ 00056 00057 /* ///////////////////////////////////////////////////////////////////////// 00058 * Includes 00059 */ 00060 00061 #ifndef ACESTL_INCL_ACESTL_HPP_ACESTL 00062 # include <acestl/acestl.hpp> 00063 #endif /* !ACESTL_INCL_ACESTL_HPP_ACESTL */ 00064 00065 #ifndef STLSOFT_INCL_ACE_H_SOCK 00066 # define STLSOFT_INCL_ACE_H_SOCK 00067 # include <ace/SOCK.h> 00068 #endif /* !STLSOFT_INCL_ACE_H_SOCK */ 00069 #ifndef STLSOFT_INCL_ACE_H_REACTOR 00070 # define STLSOFT_INCL_ACE_H_REACTOR 00071 # include <ace/Reactor.h> 00072 #endif /* !STLSOFT_INCL_ACE_H_REACTOR */ 00073 00074 /* ///////////////////////////////////////////////////////////////////////// 00075 * Namespace 00076 */ 00077 00078 #ifndef _ACESTL_NO_NAMESPACE 00079 # if defined(_STLSOFT_NO_NAMESPACE) || \ 00080 defined(STLSOFT_DOCUMENTATION_SKIP_SECTION) 00081 /* There is no stlsoft namespace, so must define ::acestl */ 00082 namespace acestl 00083 { 00084 # else 00085 /* Define stlsoft::acestl_project */ 00086 00087 namespace stlsoft 00088 { 00089 00090 namespace acestl_project 00091 { 00092 00093 # endif /* _STLSOFT_NO_NAMESPACE */ 00094 #endif /* !_ACESTL_NO_NAMESPACE */ 00095 00096 /* ///////////////////////////////////////////////////////////////////////// 00097 * Functions 00098 */ 00099 00121 inline as_bool_t close_and_deregister(ACE_SOCK &sk, ACE_Reactor *reactor) 00122 { 00123 if(ACE_INVALID_HANDLE == sk.get_handle()) 00124 { 00125 return false; 00126 } 00127 00128 if(NULL != reactor) 00129 { 00130 const ACE_Reactor_Mask close_mask = ACE_Event_Handler::ALL_EVENTS_MASK 00131 | ACE_Event_Handler::DONT_CALL; 00132 00133 reactor->remove_handler(sk.get_handle(), close_mask); 00134 } 00135 00136 sk.close(); 00137 00138 return true; 00139 } 00140 00142 // Unit-testing 00143 00144 #ifdef STLSOFT_UNITTEST 00145 # include "./unittest/socket_functions_unittest_.h" 00146 #endif /* STLSOFT_UNITTEST */ 00147 00148 /* ////////////////////////////////////////////////////////////////////// */ 00149 00150 #ifndef _ACESTL_NO_NAMESPACE 00151 # if defined(_STLSOFT_NO_NAMESPACE) || \ 00152 defined(STLSOFT_DOCUMENTATION_SKIP_SECTION) 00153 } // namespace acestl 00154 # else 00155 } // namespace acestl_project 00156 } // namespace stlsoft 00157 # endif /* _STLSOFT_NO_NAMESPACE */ 00158 #endif /* !_ACESTL_NO_NAMESPACE */ 00159 00160 /* ////////////////////////////////////////////////////////////////////// */ 00161 00162 #endif /* ACESTL_INCL_ACESTL_NETWORK_HPP_SOCKET_FUNCTIONS */ 00163 00164 /* ///////////////////////////// end of file //////////////////////////// */