include/osl/socket.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef _OSL_SOCKET_HXX_
  20 #define _OSL_SOCKET_HXX_
  21
  22 #include <osl/socket_decl.hxx>
  23
  24 namespace osl
  25 {
  26     //______________________________________________________________________________
  27     inline SocketAddr::SocketAddr()
  28         : m_handle( osl_createEmptySocketAddr( osl_Socket_FamilyInet ) )
  29     {}
  30
  31     //______________________________________________________________________________
  32     inline SocketAddr::SocketAddr(const SocketAddr& Addr)
  33         : m_handle( osl_copySocketAddr( Addr.m_handle ) )
  34     {
  35     }
  36
  37     //______________________________________________________________________________
  38     inline SocketAddr::SocketAddr(oslSocketAddr Addr)
  39         : m_handle( osl_copySocketAddr( Addr ) )
  40     {
  41     }
  42
  43     //______________________________________________________________________________
  44     inline SocketAddr::SocketAddr(oslSocketAddr Addr, __osl_socket_NoCopy )
  45         : m_handle( Addr )
  46     {
  47     }
  48
  49     //______________________________________________________________________________
  50     inline SocketAddr::SocketAddr( const ::rtl::OUString& strAddrOrHostName, sal_Int32 nPort)
  51         : m_handle( osl_createInetSocketAddr( strAddrOrHostName.pData, nPort ) )
  52     {
  53         if(! m_handle )
  54         {
  55             m_handle = osl_resolveHostname(strAddrOrHostName.pData);
  56
  57             // host found?
  58             if(m_handle)
  59             {
  60                 osl_setInetPortOfSocketAddr(m_handle, nPort);
  61             }
  62             else
  63             {
  64                 osl_destroySocketAddr( m_handle );
  65                 m_handle = 0;
  66             }
  67         }
  68     }
  69
  70     //______________________________________________________________________________
  71     inline SocketAddr::~SocketAddr()
  72     {
  73         if( m_handle )
  74             osl_destroySocketAddr( m_handle );
  75     }
  76
  77     //______________________________________________________________________________
  78     inline ::rtl::OUString SocketAddr::getHostname( oslSocketResult *pResult ) const
  79     {
  80         ::rtl::OUString hostname;
  81         oslSocketResult result = osl_getHostnameOfSocketAddr( m_handle, &(hostname.pData) );
  82         if( pResult )
  83             *pResult = result;
  84         return hostname;
  85     }
  86
  87     //______________________________________________________________________________
  88     inline sal_Int32 SAL_CALL SocketAddr::getPort() const
  89     {
  90         return osl_getInetPortOfSocketAddr(m_handle);
  91     }
  92
  93     //______________________________________________________________________________
  94     inline sal_Bool SAL_CALL SocketAddr::setPort( sal_Int32 nPort )
  95     {
  96         return osl_setInetPortOfSocketAddr(m_handle, nPort );
  97     }
  98
  99     inline sal_Bool SAL_CALL SocketAddr::setHostname( const ::rtl::OUString &sDottedIpOrHostname )
 100     {
 101         *this = SocketAddr( sDottedIpOrHostname , getPort() );
 102         return is();
 103     }
 104
 105     //______________________________________________________________________________
 106     inline sal_Bool SAL_CALL SocketAddr::setAddr( const ::rtl::ByteSequence & address )
 107     {
 108         return osl_setAddrOfSocketAddr( m_handle, address.getHandle() )
 109             == osl_Socket_Ok;
 110     }
 111
 112     inline ::rtl::ByteSequence SAL_CALL SocketAddr::getAddr( oslSocketResult *pResult ) const
 113     {
 114         ::rtl::ByteSequence sequence;
 115         oslSocketResult result = osl_getAddrOfSocketAddr( m_handle,(sal_Sequence **) &sequence );
 116         if( pResult )
 117             *pResult = result;
 118         return sequence;
 119     }
 120
 121     //______________________________________________________________________________
 122     inline SocketAddr & SAL_CALL SocketAddr::operator= (oslSocketAddr Addr)
 123     {
 124         oslSocketAddr pNewAddr = osl_copySocketAddr( Addr );
 125         if( m_handle )
 126             osl_destroySocketAddr( m_handle );
 127         m_handle = pNewAddr;
 128         return *this;
 129     }
 130
 131     //______________________________________________________________________________
 132     inline SocketAddr & SAL_CALL SocketAddr::operator= (const SocketAddr& Addr)
 133     {
 134         *this = (Addr.getHandle());
 135         return *this;
 136     }
 137
 138     inline SocketAddr & SAL_CALL SocketAddr::assign( oslSocketAddr Addr, __osl_socket_NoCopy )
 139     {
 140         if( m_handle )
 141             osl_destroySocketAddr( m_handle );
 142         m_handle = Addr;
 143         return *this;
 144     }
 145
 146     //______________________________________________________________________________
 147     inline sal_Bool SAL_CALL SocketAddr::operator== (oslSocketAddr Addr) const
 148     {
 149         return osl_isEqualSocketAddr( m_handle, Addr );
 150     }
 151
 152     inline oslSocketAddr SocketAddr::getHandle() const
 153     {
 154         return m_handle;
 155     }
 156
 157     //______________________________________________________________________________
 158     inline sal_Bool SocketAddr::is() const
 159     {
 160         return m_handle != 0;
 161     }
 162
 163     // (static method)______________________________________________________________
 164     inline ::rtl::OUString SAL_CALL SocketAddr::getLocalHostname( oslSocketResult *pResult )
 165     {
 166         ::rtl::OUString hostname;
 167         oslSocketResult result = osl_getLocalHostname( &(hostname.pData) );
 168         if(pResult )
 169             *pResult = result;
 170         return hostname;
 171     }
 172
 173     // (static method)______________________________________________________________
 174     inline void SAL_CALL SocketAddr::resolveHostname(
 175         const ::rtl::OUString & strHostName, SocketAddr &Addr)
 176     {
 177         Addr = SocketAddr( osl_resolveHostname( strHostName.pData ) , SAL_NO_COPY );
 178     }
 179
 180     // (static method)______________________________________________________________
 181     inline sal_Int32 SAL_CALL SocketAddr::getServicePort(
 182             const ::rtl::OUString& strServiceName,
 183             const ::rtl::OUString & strProtocolName )
 184     {
 185         return osl_getServicePort( strServiceName.pData, strProtocolName.pData );
 186     }
 187
 188     //______________________________________________________________________________
 189     inline Socket::Socket(oslSocketType Type,
 190                           oslAddrFamily Family,
 191                           oslProtocol   Protocol)
 192         : m_handle( osl_createSocket(Family, Type, Protocol) )
 193     {}
 194
 195     //______________________________________________________________________________
 196     inline Socket::Socket( oslSocket socketHandle, __sal_NoAcquire )
 197         : m_handle( socketHandle )
 198     {}
 199
 200     //______________________________________________________________________________
 201     inline Socket::Socket( oslSocket socketHandle )
 202         : m_handle( socketHandle )
 203     {
 204         osl_acquireSocket( m_handle );
 205     }
 206
 207     //______________________________________________________________________________
 208     inline Socket::Socket( const Socket & socket )
 209         : m_handle( socket.getHandle() )
 210     {
 211         osl_acquireSocket( m_handle );
 212     }
 213
 214     //______________________________________________________________________________
 215     inline Socket::~Socket()
 216     {
 217         osl_releaseSocket( m_handle );
 218     }
 219
 220     //______________________________________________________________________________
 221     inline Socket& Socket::operator= ( oslSocket socketHandle)
 222     {
 223         osl_acquireSocket( socketHandle );
 224         osl_releaseSocket( m_handle );
 225         m_handle = socketHandle;
 226         return *this;
 227     }
 228
 229     //______________________________________________________________________________
 230     inline Socket&  Socket::operator= (const Socket& sock)
 231     {
 232         return (*this) = sock.getHandle();
 233     }
 234
 235     //______________________________________________________________________________
 236     inline sal_Bool Socket::operator==( const Socket& rSocket ) const
 237     {
 238         return m_handle == rSocket.getHandle();
 239     }
 240
 241     //______________________________________________________________________________
 242     inline sal_Bool Socket::operator==( const oslSocket socketHandle ) const
 243     {
 244         return m_handle == socketHandle;
 245     }
 246
 247     //______________________________________________________________________________
 248     inline void Socket::shutdown( oslSocketDirection Direction )
 249     {
 250         osl_shutdownSocket( m_handle , Direction );
 251     }
 252
 253     //______________________________________________________________________________
 254     inline void Socket::close()
 255     {
 256         osl_closeSocket( m_handle );
 257     }
 258
 259     //______________________________________________________________________________
 260     inline void Socket::getLocalAddr( SocketAddr & addr) const
 261     {
 262         addr.assign( osl_getLocalAddrOfSocket( m_handle ) , SAL_NO_COPY );
 263     }
 264
 265     //______________________________________________________________________________
 266     inline sal_Int32 Socket::getLocalPort() const
 267     {
 268         SocketAddr addr( 0 );
 269         getLocalAddr( addr );
 270         return addr.getPort();
 271     }
 272
 273     //______________________________________________________________________________
 274     inline ::rtl::OUString Socket::getLocalHost() const
 275     {
 276         SocketAddr addr( 0 );
 277         getLocalAddr( addr );
 278         return addr.getHostname();
 279     }
 280
 281     //______________________________________________________________________________
 282     inline void Socket::getPeerAddr( SocketAddr &addr ) const
 283     {
 284         addr.assign( osl_getPeerAddrOfSocket( m_handle ), SAL_NO_COPY );
 285     }
 286
 287     //______________________________________________________________________________
 288     inline sal_Int32 Socket::getPeerPort() const
 289     {
 290         SocketAddr addr( 0 );
 291         getPeerAddr( addr );
 292         return addr.getPort();
 293     }
 294
 295     //______________________________________________________________________________
 296     inline ::rtl::OUString Socket::getPeerHost() const
 297     {
 298         SocketAddr addr( 0 );
 299         getPeerAddr( addr );
 300         return addr.getHostname();
 301     }
 302
 303     //______________________________________________________________________________
 304     inline sal_Bool Socket::bind(const SocketAddr& LocalInterface)
 305     {
 306         return osl_bindAddrToSocket( m_handle , LocalInterface.getHandle() );
 307     }
 308
 309     //______________________________________________________________________________
 310     inline sal_Bool Socket::isRecvReady(const TimeValue *pTimeout ) const
 311     {
 312         return osl_isReceiveReady( m_handle , pTimeout );
 313     }
 314
 315     //______________________________________________________________________________
 316     inline sal_Bool Socket::isSendReady(const TimeValue *pTimeout ) const
 317     {
 318         return osl_isSendReady( m_handle, pTimeout );
 319     }
 320
 321     //______________________________________________________________________________
 322     inline sal_Bool Socket::isExceptionPending(const TimeValue *pTimeout ) const
 323     {
 324         return osl_isExceptionPending( m_handle, pTimeout );
 325     }
 326
 327     //______________________________________________________________________________
 328     inline oslSocketType Socket::getType() const
 329     {
 330         return osl_getSocketType( m_handle );
 331     }
 332
 333     //______________________________________________________________________________
 334     inline sal_Int32  Socket::getOption(
 335         oslSocketOption Option,
 336         void* pBuffer,
 337         sal_uInt32 BufferLen,
 338         oslSocketOptionLevel Level) const
 339     {
 340         return osl_getSocketOption( m_handle, Level, Option, pBuffer , BufferLen );
 341     }
 342
 343     //______________________________________________________________________________
 344     inline sal_Bool Socket::setOption(  oslSocketOption Option,
 345                                         void* pBuffer,
 346                                         sal_uInt32 BufferLen,
 347                                         oslSocketOptionLevel Level ) const
 348     {
 349         return osl_setSocketOption( m_handle, Level, Option , pBuffer, BufferLen );
 350     }
 351
 352     //______________________________________________________________________________
 353     inline sal_Bool Socket::setOption( oslSocketOption option, sal_Int32 nValue  )
 354     {
 355         return setOption( option, &nValue, sizeof( nValue ) );
 356     }
 357
 358     //______________________________________________________________________________
 359     inline sal_Int32 Socket::getOption( oslSocketOption option ) const
 360     {
 361         sal_Int32 n;
 362         getOption( option, &n, sizeof( n ) );
 363         return n;
 364     }
 365
 366     //______________________________________________________________________________
 367     inline sal_Bool Socket::enableNonBlockingMode( sal_Bool bNonBlockingMode)
 368     {
 369         return osl_enableNonBlockingMode( m_handle , bNonBlockingMode );
 370     }
 371
 372     //______________________________________________________________________________
 373     inline sal_Bool Socket::isNonBlockingMode() const
 374     {
 375         return osl_isNonBlockingMode( m_handle );
 376     }
 377
 378     //______________________________________________________________________________
 379     inline void SAL_CALL Socket::clearError() const
 380     {
 381         sal_Int32 err = 0;
 382         getOption(osl_Socket_OptionError, &err, sizeof(err));
 383     }
 384
 385     //______________________________________________________________________________
 386     inline oslSocketError Socket::getError() const
 387     {
 388         return osl_getLastSocketError( m_handle );
 389     }
 390
 391     //______________________________________________________________________________
 392     inline ::rtl::OUString Socket::getErrorAsString( ) const
 393     {
 394         ::rtl::OUString error;
 395         osl_getLastSocketErrorDescription( m_handle, &(error.pData) );
 396         return error;
 397     }
 398
 399     //______________________________________________________________________________
 400     inline oslSocket Socket::getHandle() const
 401     {
 402         return m_handle;
 403     }
 404
 405     //______________________________________________________________________________
 406     inline StreamSocket::StreamSocket(oslAddrFamily Family,
 407                                       oslProtocol Protocol,
 408                                       oslSocketType Type )
 409         : Socket( Type, Family, Protocol )
 410     {}
 411
 412     //______________________________________________________________________________
 413     inline StreamSocket::StreamSocket( oslSocket socketHandle, __sal_NoAcquire noacquire )
 414         : Socket( socketHandle, noacquire )
 415     {}
 416
 417     //______________________________________________________________________________
 418     inline StreamSocket::StreamSocket( oslSocket socketHandle )
 419         : Socket( socketHandle )
 420     {}
 421
 422     //______________________________________________________________________________
 423     inline StreamSocket::StreamSocket( const StreamSocket & socket )
 424         : Socket( socket )
 425     {}
 426
 427     //______________________________________________________________________________
 428     inline sal_Int32 StreamSocket::read(void* pBuffer, sal_uInt32 n)
 429     {
 430         return osl_readSocket( m_handle, pBuffer, n );
 431     }
 432
 433     //______________________________________________________________________________
 434     inline sal_Int32 StreamSocket::write(const void* pBuffer, sal_uInt32 n)
 435     {
 436         return osl_writeSocket( m_handle, pBuffer, n );
 437     }
 438
 439
 440     //______________________________________________________________________________
 441     inline sal_Int32 StreamSocket::recv(void* pBuffer,
 442                                         sal_uInt32 BytesToRead,
 443                                         oslSocketMsgFlag Flag)
 444     {
 445         return osl_receiveSocket( m_handle, pBuffer,BytesToRead, Flag );
 446     }
 447
 448     //______________________________________________________________________________
 449     inline sal_Int32 StreamSocket::send(const void* pBuffer,
 450                                         sal_uInt32 BytesToSend,
 451                                         oslSocketMsgFlag Flag)
 452     {
 453         return osl_sendSocket( m_handle, pBuffer, BytesToSend, Flag );
 454     }
 455
 456     //______________________________________________________________________________
 457       inline ConnectorSocket::ConnectorSocket(oslAddrFamily Family,
 458                                             oslProtocol Protocol,
 459                                             oslSocketType   Type)
 460         : StreamSocket( Family, Protocol ,Type )
 461     {}
 462
 463     //______________________________________________________________________________
 464     inline oslSocketResult ConnectorSocket::connect( const SocketAddr& TargetHost,
 465                                                      const TimeValue* pTimeout )
 466     {
 467         return osl_connectSocketTo( m_handle , TargetHost.getHandle(), pTimeout );
 468     }
 469
 470     //______________________________________________________________________________
 471     inline AcceptorSocket::AcceptorSocket(oslAddrFamily Family ,
 472                                           oslProtocol   Protocol ,
 473                                           oslSocketType Type )
 474         : Socket( Type, Family, Protocol )
 475     {}
 476
 477     //______________________________________________________________________________
 478     inline sal_Bool AcceptorSocket::listen(sal_Int32 MaxPendingConnections)
 479     {
 480         return osl_listenOnSocket( m_handle, MaxPendingConnections );
 481     }
 482
 483     //______________________________________________________________________________
 484     inline oslSocketResult AcceptorSocket::acceptConnection( StreamSocket& Connection)
 485     {
 486         oslSocket o = osl_acceptConnectionOnSocket( m_handle, 0 );
 487         oslSocketResult status = osl_Socket_Ok;
 488         if( o )
 489         {
 490             Connection = StreamSocket( o , SAL_NO_ACQUIRE );
 491         }
 492         else
 493         {
 494             Connection = StreamSocket();
 495             status = osl_Socket_Error;
 496         }
 497         return status;
 498     }
 499
 500     //______________________________________________________________________________
 501     inline oslSocketResult AcceptorSocket::acceptConnection(
 502         StreamSocket&   Connection, SocketAddr & PeerAddr)
 503     {
 504         // TODO change in/OUT parameter
 505         oslSocket o = osl_acceptConnectionOnSocket( m_handle, (oslSocketAddr *)&PeerAddr );
 506         oslSocketResult status = osl_Socket_Ok;
 507         if( o )
 508         {
 509             Connection = StreamSocket( o , SAL_NO_ACQUIRE );
 510         }
 511         else
 512         {
 513             Connection = StreamSocket();
 514             status = osl_Socket_Error;
 515         }
 516         return status;
 517     }
 518
 519     //______________________________________________________________________________
 520     inline DatagramSocket::DatagramSocket(oslAddrFamily Family,
 521                                           oslProtocol   Protocol,
 522                                           oslSocketType Type)
 523         : Socket( Type, Family, Protocol )
 524     {}
 525
 526     //______________________________________________________________________________
 527     inline sal_Int32 DatagramSocket::recvFrom(void*  pBuffer,
 528                                               sal_uInt32 BufferSize,
 529                                               SocketAddr* pSenderAddr,
 530                                               oslSocketMsgFlag Flag )
 531     {
 532         sal_Int32 nByteRead;
 533         if( pSenderAddr )
 534         {
 535             // TODO : correct the out-parameter pSenderAddr outparameter
 536               nByteRead = osl_receiveFromSocket( m_handle, pSenderAddr->getHandle() , pBuffer,
 537                                                  BufferSize, Flag);
 538 //              nByteRead = osl_receiveFromSocket( m_handle, *(oslSocketAddr**) &pSenderAddr , pBuffer,
 539 //                                                 BufferSize, Flag);
 540         }
 541         else
 542         {
 543             nByteRead = osl_receiveFromSocket( m_handle, 0 , pBuffer , BufferSize ,  Flag );
 544         }
 545         return nByteRead;
 546     }
 547
 548     //______________________________________________________________________________
 549     inline sal_Int32  DatagramSocket::sendTo( const SocketAddr& ReceiverAddr,
 550                                               const void* pBuffer,
 551                                               sal_uInt32 BufferSize,
 552                                               oslSocketMsgFlag Flag )
 553     {
 554         return osl_sendToSocket( m_handle, ReceiverAddr.getHandle(), pBuffer, BufferSize, Flag );
 555     }
 556 }
 557 #endif
 558
 559 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */