LibreOffice
LibreOffice 7.4 SDK C/C++ API Reference
socket_decl.hxx
Go to the documentation of this file.
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 
20 /*
21  * This file is part of LibreOffice published API.
22  */
23 
24 #ifndef INCLUDED_OSL_SOCKET_DECL_HXX
25 #define INCLUDED_OSL_SOCKET_DECL_HXX
26 
27 #include "sal/config.h"
28 
29 #include <cstddef>
30 
31 #include "osl/socket.h"
32 #include "rtl/ustring.hxx"
33 #include "rtl/byteseq.hxx"
34 
35 namespace osl
36 {
38 
43  class SocketAddr
44  {
45  protected:
47  public:
48 
51  inline SocketAddr();
52 
55  inline SocketAddr(const SocketAddr& Addr);
56 
57 #if defined LIBO_INTERNAL_ONLY
58  inline SocketAddr(SocketAddr && other) noexcept;
59 #endif
60 
67  inline SocketAddr(const oslSocketAddr Addr, __osl_socket_NoCopy nocopy );
68 
73  inline SocketAddr(oslSocketAddr Addr);
74 
81  inline SocketAddr(const ::rtl::OUString& strAddrOrHostName, sal_Int32 nPort);
82 
85  inline ~SocketAddr();
86 
92  inline bool is() const;
93 
104  inline ::rtl::OUString SAL_CALL getHostname(oslSocketResult *pResult = NULL) const;
105 
113  inline bool SAL_CALL setHostname(const ::rtl::OUString &sDottedIpOrHostname);
114 
119  inline sal_Int32 SAL_CALL getPort() const;
120 
128  inline bool SAL_CALL setPort(sal_Int32 nPort);
129 
135  inline bool SAL_CALL setAddr(const ::rtl::ByteSequence & address);
136 
139  inline ::rtl::ByteSequence SAL_CALL getAddr(oslSocketResult *pResult = NULL) const;
140 
143  inline SocketAddr & SAL_CALL operator= (oslSocketAddr Addr);
144 
145  inline SocketAddr & SAL_CALL operator= (const SocketAddr& Addr);
146 
147 #if defined LIBO_INTERNAL_ONLY
148  inline SocketAddr & operator =(SocketAddr && other) noexcept;
149 #endif
150 
155  inline SocketAddr & SAL_CALL assign( oslSocketAddr Addr, __osl_socket_NoCopy nocopy );
156 
159  inline bool SAL_CALL operator== (oslSocketAddr Addr) const;
160 
163  inline bool SAL_CALL operator== (const SocketAddr & Addr) const;
164 
167  inline oslSocketAddr SAL_CALL getHandle() const;
168 
174  static inline ::rtl::OUString SAL_CALL getLocalHostname( oslSocketResult *pResult = NULL);
175 
180  static inline void SAL_CALL resolveHostname(
181  const ::rtl::OUString & strHostName , SocketAddr & Addr );
182 
189  static inline sal_Int32 SAL_CALL getServicePort(
190  const ::rtl::OUString& strServiceName,
191  const ::rtl::OUString & strProtocolName= ::rtl::OUString("tcp") );
192  };
193 
194 
195  class Socket
196  {
197  protected:
199  protected:
205  inline Socket(oslSocketType Type,
208  public:
209  inline Socket( );
210 
211  inline Socket( const Socket & socket );
212 
213  inline Socket( oslSocket socketHandle );
214 
220  inline Socket( oslSocket socketHandle, __sal_NoAcquire noacquire );
221 
224  inline ~Socket();
225 
229  inline Socket& SAL_CALL operator= ( oslSocket socketHandle);
230 
234  inline Socket& SAL_CALL operator= (const Socket& sock);
235 
240  inline bool SAL_CALL operator==( const Socket& rSocket ) const ;
241 
246  inline bool SAL_CALL operator==( const oslSocket socketHandle ) const;
247 
253  inline void SAL_CALL shutdown( oslSocketDirection Direction = osl_Socket_DirReadWrite );
254 
260  inline void SAL_CALL close();
261 
266  inline void SAL_CALL getLocalAddr( SocketAddr &Addr ) const;
267 
271  inline sal_Int32 SAL_CALL getLocalPort() const;
272 
276  inline ::rtl::OUString SAL_CALL getLocalHost() const;
277 
281  inline void SAL_CALL getPeerAddr( SocketAddr & Addr) const;
282 
286  inline sal_Int32 SAL_CALL getPeerPort() const;
287 
291  inline ::rtl::OUString SAL_CALL getPeerHost() const;
292 
297  inline bool SAL_CALL bind(const SocketAddr& LocalInterface);
298 
309  inline bool SAL_CALL isRecvReady(const TimeValue *pTimeout = NULL) const;
310 
321  inline bool SAL_CALL isSendReady(const TimeValue *pTimeout = NULL) const;
322 
323 
336  inline bool SAL_CALL isExceptionPending(const TimeValue *pTimeout = NULL) const;
337 
338 
348  inline oslSocketType SAL_CALL getType() const;
349 
431  inline sal_Int32 SAL_CALL getOption(
432  oslSocketOption Option,
433  void* pBuffer,
434  sal_uInt32 BufferLen,
436 
478  inline bool SAL_CALL setOption( oslSocketOption Option,
479  void* pBuffer,
480  sal_uInt32 BufferLen,
482 
486  inline bool setOption( oslSocketOption option, sal_Int32 nValue );
487 
491  inline sal_Int32 getOption( oslSocketOption option ) const;
492 
499  inline bool SAL_CALL enableNonBlockingMode( bool bNonBlockingMode);
500 
504  inline bool SAL_CALL isNonBlockingMode() const;
505 
506 
509  inline void SAL_CALL clearError() const;
510 
518  inline oslSocketError getError() const;
519 
522  inline ::rtl::OUString getErrorAsString( ) const;
523 
526  inline oslSocket getHandle() const;
527  };
528 
529 
530  class StreamSocket : public Socket
531  {
532  public:
544 
545  inline StreamSocket( oslSocket Socket , __sal_NoAcquire noacquire );
546 
547  inline StreamSocket( oslSocket Socket );
548 
558  inline sal_Int32 SAL_CALL read(void* pBuffer, sal_uInt32 n);
559 
567  inline sal_Int32 SAL_CALL write(const void* pBuffer, sal_uInt32 n);
568 
569 
586  inline sal_Int32 SAL_CALL recv(void* pBuffer,
587  sal_uInt32 BytesToRead,
589 
606  sal_Int32 SAL_CALL send(const void* pBuffer,
607  sal_uInt32 BytesToSend,
609  };
610 
612  {
613  public:
625 
626 
636  oslSocketResult SAL_CALL connect(const SocketAddr& TargetHost, const TimeValue* pTimeout = NULL);
637  };
638 
641  class AcceptorSocket : public Socket
642  {
643  public:
647 
655  inline bool SAL_CALL listen(sal_Int32 MaxPendingConnections= -1);
656 
664  inline oslSocketResult SAL_CALL acceptConnection( StreamSocket& Connection);
665 
675  inline oslSocketResult SAL_CALL acceptConnection( StreamSocket& Connection, SocketAddr & PeerAddr);
676  };
677 
678 
681  class DatagramSocket : public Socket
682  {
683  public:
684 
693 
713  inline sal_Int32 SAL_CALL recvFrom(void* pBuffer,
714  sal_uInt32 BufferSize,
715  SocketAddr* pSenderAddr= NULL,
717 
740  inline sal_Int32 SAL_CALL sendTo( const SocketAddr& ReceiverAddr,
741  const void* pBuffer,
742  sal_uInt32 BufferSize,
744  };
745 
746 }
747 
748 #endif
749 
750 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
__sal_NoAcquire
Definition: types.h:353
oslSocketOption
Represents socket-options.
Definition: socket.h:89
oslSocketResult
Common return codes of socket related functions.
Definition: socket.h:197
struct oslSocketAddrImpl * oslSocketAddr
Opaque datatype SocketAddr.
Definition: socket.h:44
oslSocketType
Represents the type of a socket.
Definition: socket.h:71
@ osl_Socket_TypeStream
Definition: socket.h:72
@ osl_Socket_TypeDgram
Definition: socket.h:73
struct oslSocketImpl * oslSocket
Definition: socket.h:216
oslSocketOptionLevel
Represents the different socket-option levels.
Definition: socket.h:125
@ osl_Socket_LevelSocket
Definition: socket.h:126
oslSocketDirection
Used by shutdown to denote which end of the socket to "close".
Definition: socket.h:148
@ osl_Socket_DirReadWrite
Definition: socket.h:151
oslProtocol
represent a specific protocol within an address-family
Definition: socket.h:59
@ osl_Socket_ProtocolIp
Definition: socket.h:60
oslSocketError
Describes the various error socket error conditions, which may occur.
Definition: socket.h:158
oslAddrFamily
Represents the address-family of a socket.
Definition: socket.h:49
@ osl_Socket_FamilyInet
Definition: socket.h:50
oslSocketMsgFlag
Represents flags to be used with send/recv-calls.
Definition: socket.h:135
@ osl_Socket_MsgNormal
Definition: socket.h:136
Definition: condition.hxx:31
__osl_socket_NoCopy
Definition: socket_decl.hxx:37
@ SAL_NO_COPY
Definition: socket_decl.hxx:37
This String class provides base functionality for C++ like Unicode character array handling.
Definition: ustring.hxx:203
The class should be understood as a reference to a socket address handle (struct sockaddr).
Definition: socket_decl.hxx:44
inline ::rtl::OUString getHostname(oslSocketResult *pResult=NULL) const
Converts the address to a (human readable) domain-name.
Definition: socket.hxx:88
bool operator==(oslSocketAddr Addr) const
Returns true if the underlying handle is identical to the Addr handle.
Definition: socket.hxx:168
static void resolveHostname(const ::rtl::OUString &strHostName, SocketAddr &Addr)
Tries to find an address for a host.
Definition: socket.hxx:193
inline ::rtl::ByteSequence getAddr(oslSocketResult *pResult=NULL) const
Returns the address of the underlying socket in network byte order.
Definition: socket.hxx:122
bool setPort(sal_Int32 nPort)
Sets the port number of the address.
Definition: socket.hxx:104
bool setAddr(const ::rtl::ByteSequence &address)
Sets the address of the underlying socket address struct in network byte order.
Definition: socket.hxx:116
SocketAddr & operator=(oslSocketAddr Addr)
assign the handle to this reference.
Definition: socket.hxx:132
static inline ::rtl::OUString getLocalHostname(oslSocketResult *pResult=NULL)
Get the hostname for the local interface.
Definition: socket.hxx:184
oslSocketAddr getHandle() const
Returns the underlying SocketAddr handle without copyconstructing it.
Definition: socket.hxx:173
SocketAddr & assign(oslSocketAddr Addr, __osl_socket_NoCopy nocopy)
Assigns the socket addr without copyconstructing it.
Definition: socket.hxx:159
bool setHostname(const ::rtl::OUString &sDottedIpOrHostname)
Sets the IP address or hostname of the SocketAddress.
Definition: socket.hxx:109
static sal_Int32 getServicePort(const ::rtl::OUString &strServiceName, const ::rtl::OUString &strProtocolName=::rtl::OUString("tcp"))
Tries to find the port associated with the given service/protocol- pair (e.g.
Definition: socket.hxx:199
SocketAddr()
Creates socket address of unknown type.
Definition: socket.hxx:32
sal_Int32 getPort() const
Returns the port number of the address.
Definition: socket.hxx:98
bool is() const
Checks if the SocketAddr was created successful.
Definition: socket.hxx:179
oslSocketAddr m_handle
Definition: socket_decl.hxx:46
~SocketAddr()
destroys underlying oslSocketAddress
Definition: socket.hxx:81
Definition: socket_decl.hxx:196
sal_Int32 getPeerPort() const
Get the remote port of the socket.
Definition: socket.hxx:307
oslSocket getHandle() const
Returns the underlying handle unacquired (The caller must acquire it to keep it).
Definition: socket.hxx:419
bool setOption(oslSocketOption Option, void *pBuffer, sal_uInt32 BufferLen, oslSocketOptionLevel Level=osl_Socket_LevelSocket) const
Sets the sockets attributes.
Definition: socket.hxx:363
void shutdown(oslSocketDirection Direction=osl_Socket_DirReadWrite)
Closes a definite or both directions of the bidirectional stream.
Definition: socket.hxx:267
bool isNonBlockingMode() const
Query blocking mode of the socket.
Definition: socket.hxx:392
oslSocketError getError() const
returns a constant describing the last error for the socket system.
Definition: socket.hxx:405
inline ::rtl::OUString getErrorAsString() const
Builds a string with the last error-message for the socket.
Definition: socket.hxx:411
inline ::rtl::OUString getPeerHost() const
Get the hostname for the remote interface.
Definition: socket.hxx:315
sal_Int32 getLocalPort() const
Get the local port of the socket.
Definition: socket.hxx:285
void getPeerAddr(SocketAddr &Addr) const
Retrieves the address of the remote host of this socket.
Definition: socket.hxx:301
bool bind(const SocketAddr &LocalInterface)
Binds the socket to the specified (local) interface.
Definition: socket.hxx:323
oslSocketType getType() const
Queries the socket for its type.
Definition: socket.hxx:347
bool isSendReady(const TimeValue *pTimeout=NULL) const
Checks if send operations will block.
Definition: socket.hxx:335
void getLocalAddr(SocketAddr &Addr) const
Retrieves the address of the local interface of this socket.
Definition: socket.hxx:279
void close()
Closes a socket.
Definition: socket.hxx:273
bool isRecvReady(const TimeValue *pTimeout=NULL) const
Checks if read operations will block.
Definition: socket.hxx:329
inline ::rtl::OUString getLocalHost() const
Get the hostname for the local interface.
Definition: socket.hxx:293
bool isExceptionPending(const TimeValue *pTimeout=NULL) const
Checks if a request for out-of-band data will block.
Definition: socket.hxx:341
oslSocket m_handle
Definition: socket_decl.hxx:198
void clearError() const
clears the error status
Definition: socket.hxx:398
bool enableNonBlockingMode(bool bNonBlockingMode)
Enables/disables non-blocking mode of the socket.
Definition: socket.hxx:386
bool operator==(const Socket &rSocket) const
Definition: socket.hxx:255
sal_Int32 getOption(oslSocketOption Option, void *pBuffer, sal_uInt32 BufferLen, oslSocketOptionLevel Level=osl_Socket_LevelSocket) const
Retrieves option-attributes associated with the socket.
Definition: socket.hxx:353
Socket & operator=(oslSocket socketHandle)
Assignment operator.
Definition: socket.hxx:239
~Socket()
Destructor.
Definition: socket.hxx:233
Definition: socket_decl.hxx:531
StreamSocket(oslAddrFamily Family=osl_Socket_FamilyInet, oslProtocol Protocol=osl_Socket_ProtocolIp, oslSocketType Type=osl_Socket_TypeStream)
Creates a socket.
Definition: socket.hxx:425
sal_Int32 write(const void *pBuffer, sal_uInt32 n)
Writes n bytes from pBuffer to the stream.
Definition: socket.hxx:448
sal_Int32 read(void *pBuffer, sal_uInt32 n)
Retrieves n bytes from the stream and copies them into pBuffer.
Definition: socket.hxx:442
sal_Int32 send(const void *pBuffer, sal_uInt32 BytesToSend, oslSocketMsgFlag=osl_Socket_MsgNormal)
Tries to send BytesToSend data to the connected socket.
Definition: socket.hxx:462
sal_Int32 recv(void *pBuffer, sal_uInt32 BytesToRead, oslSocketMsgFlag flags=osl_Socket_MsgNormal)
Tries to receive BytesToRead data from the connected socket,.
Definition: socket.hxx:454
Definition: socket_decl.hxx:612
ConnectorSocket(oslAddrFamily Family=osl_Socket_FamilyInet, oslProtocol Protocol=osl_Socket_ProtocolIp, oslSocketType Type=osl_Socket_TypeStream)
Creates a socket that can connect to a (remote) host.
Definition: socket.hxx:470
oslSocketResult connect(const SocketAddr &TargetHost, const TimeValue *pTimeout=NULL)
Connects the socket to a (remote) host.
Definition: socket.hxx:477
Allows to accept socket connections.
Definition: socket_decl.hxx:642
oslSocketResult acceptConnection(StreamSocket &Connection)
Accepts incoming connections on the socket.
Definition: socket.hxx:497
bool listen(sal_Int32 MaxPendingConnections=-1)
Prepare a socket for the accept-call.
Definition: socket.hxx:491
AcceptorSocket(oslAddrFamily Family=osl_Socket_FamilyInet, oslProtocol Protocol=osl_Socket_ProtocolIp, oslSocketType Type=osl_Socket_TypeStream)
Definition: socket.hxx:484
A connectionless socket to send and receive datagrams.
Definition: socket_decl.hxx:682
DatagramSocket(oslAddrFamily Family=osl_Socket_FamilyInet, oslProtocol Protocol=osl_Socket_ProtocolIp, oslSocketType Type=osl_Socket_TypeDgram)
Creates a datagram socket.
Definition: socket.hxx:534
sal_Int32 sendTo(const SocketAddr &ReceiverAddr, const void *pBuffer, sal_uInt32 BufferSize, oslSocketMsgFlag Flag=osl_Socket_MsgNormal)
Tries to send one datagram with BytesToSend size to the given ReceiverAddr.
Definition: socket.hxx:561
sal_Int32 recvFrom(void *pBuffer, sal_uInt32 BufferSize, SocketAddr *pSenderAddr=NULL, oslSocketMsgFlag Flag=osl_Socket_MsgNormal)
Tries to receives BufferSize data from the socket, if no error occurs.
Definition: socket.hxx:541
Definition: time.h:72