LibreOffice: osl/socket.hxx Source File

LibreOffice LibreOffice 5.2 SDK C/C++ API Reference

socket.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 #ifndef INCLUDED_OSL_SOCKET_HXX
20 #define INCLUDED_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 = NULL;
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 bool SAL_CALL SocketAddr::setPort( sal_Int32 nPort )
95 {
96 return osl_setInetPortOfSocketAddr(m_handle, nPort );
97 }
98
99 inline bool SAL_CALL SocketAddr::setHostname( const ::rtl::OUString &sDottedIpOrHostname )
100 {
101 *this = SocketAddr( sDottedIpOrHostname , getPort() );
102 return is();
103 }
104
105
106 inline 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, reinterpret_cast<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 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 bool SocketAddr::is() const
159 {
160 return m_handle != NULL;
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 bool Socket::operator==( const Socket& rSocket ) const
237 {
238 return m_handle == rSocket.getHandle();
239 }
240
241
242 inline 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( NULL );
269 getLocalAddr( addr );
270 return addr.getPort();
271 }
272
273
274 inline ::rtl::OUString Socket::getLocalHost() const
275 {
276 SocketAddr addr( NULL );
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( NULL );
291 getPeerAddr( addr );
292 return addr.getPort();
293 }
294
295
296 inline ::rtl::OUString Socket::getPeerHost() const
297 {
298 SocketAddr addr( NULL );
299 getPeerAddr( addr );
300 return addr.getHostname();
301 }
302
303
304 inline bool Socket::bind(const SocketAddr& LocalInterface)
305 {
306 return osl_bindAddrToSocket( m_handle , LocalInterface.getHandle() );
307 }
308
309
310 inline bool Socket::isRecvReady(const TimeValue *pTimeout ) const
311 {
312 return osl_isReceiveReady( m_handle , pTimeout );
313 }
314
315
316 inline bool Socket::isSendReady(const TimeValue *pTimeout ) const
317 {
318 return osl_isSendReady( m_handle, pTimeout );
319 }
320
321
322 inline 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 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 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 bool Socket::enableNonBlockingMode( bool bNonBlockingMode)
368 {
369 return osl_enableNonBlockingMode( m_handle , bNonBlockingMode );
370 }
371
372
373 inline 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 inline sal_Int32 StreamSocket::recv(void* pBuffer,
441 sal_uInt32 BytesToRead,
442 oslSocketMsgFlag Flag)
443 {
444 return osl_receiveSocket( m_handle, pBuffer,BytesToRead, Flag );
445 }
446
447
448 inline sal_Int32 StreamSocket::send(const void* pBuffer,
449 sal_uInt32 BytesToSend,
450 oslSocketMsgFlag Flag)
451 {
452 return osl_sendSocket( m_handle, pBuffer, BytesToSend, Flag );
453 }
454
455
456 inline ConnectorSocket::ConnectorSocket(oslAddrFamily Family,
457 oslProtocol Protocol,
458 oslSocketType Type)
459 : StreamSocket( Family, Protocol ,Type )
460 {}
461
462
463 inline oslSocketResult ConnectorSocket::connect( const SocketAddr& TargetHost,
464 const TimeValue* pTimeout )
465 {
466 return osl_connectSocketTo( m_handle , TargetHost.getHandle(), pTimeout );
467 }
468
469
470 inline AcceptorSocket::AcceptorSocket(oslAddrFamily Family ,
471 oslProtocol Protocol ,
472 oslSocketType Type )
473 : Socket( Type, Family, Protocol )
474 {}
475
476
477 inline bool AcceptorSocket::listen(sal_Int32 MaxPendingConnections)
478 {
479 return osl_listenOnSocket( m_handle, MaxPendingConnections );
480 }
481
482
483 inline oslSocketResult AcceptorSocket::acceptConnection( StreamSocket& Connection)
484 {
485 oslSocket o = osl_acceptConnectionOnSocket( m_handle, NULL );
486 oslSocketResult status = osl_Socket_Ok;
487 if( o )
488 {
489 Connection = StreamSocket( o , SAL_NO_ACQUIRE );
490 }
491 else
492 {
493 Connection = StreamSocket();
494 status = osl_Socket_Error;
495 }
496 return status;
497 }
498
499
500 inline oslSocketResult AcceptorSocket::acceptConnection(
501 StreamSocket& Connection, SocketAddr & PeerAddr)
502 {
503 // TODO change in/OUT parameter
504 oslSocket o = osl_acceptConnectionOnSocket(
505 m_handle, reinterpret_cast<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, NULL , 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: */
osl_listenOnSocket
SAL_DLLPUBLIC sal_Bool osl_listenOnSocket(oslSocket Socket, sal_Int32 MaxPendingConnections)
Prepares the socket to act as an acceptor of incoming connections.
osl::SocketAddr::~SocketAddr
~SocketAddr()
destroys underlying oslSocketAddress
Definition: socket.hxx:71
osl::StreamSocket::read
sal_Int32 read(void *pBuffer, sal_uInt32 n)
Retrieves n bytes from the stream and copies them into pBuffer.
Definition: socket.hxx:428
osl::DatagramSocket::recvFrom
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:527
osl::SocketAddr::assign
SocketAddr & assign(oslSocketAddr Addr, __osl_socket_NoCopy nocopy)
Assigns the socket addr without copyconstructing it.
Definition: socket.hxx:138
osl::Socket::getPeerPort
sal_Int32 getPeerPort() const
Get the remote port of the socket.
Definition: socket.hxx:288
osl::SocketAddr::setPort
bool setPort(sal_Int32 nPort)
Sets the port number of the address.
Definition: socket.hxx:94
osl_Socket_FamilyInet
Definition: socket.h:47
osl::AcceptorSocket::AcceptorSocket
AcceptorSocket(oslAddrFamily Family=osl_Socket_FamilyInet, oslProtocol Protocol=osl_Socket_ProtocolIp, oslSocketType Type=osl_Socket_TypeStream)
Definition: socket.hxx:470
osl::StreamSocket::recv
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:440
socket_decl.hxx
osl::SocketAddr::getHandle
oslSocketAddr getHandle() const
Returns the underlying SocketAddr handle without copyconstructing it.
Definition: socket.hxx:152
osl::ConnectorSocket::connect
oslSocketResult connect(const SocketAddr &TargetHost, const TimeValue *pTimeout=NULL)
Connects the socket to a (remote) host.
Definition: socket.hxx:463
osl_shutdownSocket
SAL_DLLPUBLIC sal_Bool osl_shutdownSocket(oslSocket Socket, oslSocketDirection Direction)
Shuts down communication on a connected socket.
osl::SocketAddr::SocketAddr
SocketAddr()
Creates socket address of unknown type.
Definition: socket.hxx:27
osl::Socket::operator=
Socket & operator=(oslSocket socketHandle)
Assignment operator.
Definition: socket.hxx:221
osl::Socket::Socket
Socket()
TimeValue
Definition: time.h:70
osl::AcceptorSocket::listen
bool listen(sal_Int32 MaxPendingConnections=-1)
Prepare a socket for the accept-call.
Definition: socket.hxx:477
osl_getHostnameOfSocketAddr
SAL_DLLPUBLIC oslSocketResult osl_getHostnameOfSocketAddr(oslSocketAddr Addr, rtl_uString **strHostname)
Returns the hostname represented by Addr.
osl::SocketAddr::operator==
bool operator==(oslSocketAddr Addr) const
Returns true if the underlying handle is identical to the Addr handle.
Definition: socket.hxx:147
oslSocketMsgFlag
oslSocketMsgFlag
Represents flags to be used with send/recv-calls.
Definition: socket.h:120
osl::Socket::isRecvReady
bool isRecvReady(const TimeValue *pTimeout=NULL) const
Checks if read operations will block.
Definition: socket.hxx:310
osl::AcceptorSocket::acceptConnection
oslSocketResult acceptConnection(StreamSocket &Connection)
Accepts incoming connections on the socket.
Definition: socket.hxx:483
osl_getLocalHostname
SAL_DLLPUBLIC oslSocketResult osl_getLocalHostname(rtl_uString **strLocalHostname)
Retrieve this machines hostname.
osl::Socket::~Socket
~Socket()
Destructor.
Definition: socket.hxx:215
osl_sendToSocket
SAL_DLLPUBLIC sal_Int32 osl_sendToSocket(oslSocket Socket, oslSocketAddr ReceiverAddr, const void *pBuffer, sal_uInt32 BytesToSend, oslSocketMsgFlag Flag)
Tries to send one datagram with BytesToSend data to the given ReceiverAddr via the (implicitly unconn...
osl::SocketAddr::setAddr
bool setAddr(const ::rtl::ByteSequence &address)
Sets the address of the underlying socket address struct in network byte order.
Definition: socket.hxx:106
oslSocketError
oslSocketError
Describes the various error socket error conditions, which may occur.
Definition: socket.h:143
osl::SocketAddr::getServicePort
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:181
osl::SocketAddr::getLocalHostname
static inline ::rtl::OUString getLocalHostname(oslSocketResult *pResult=NULL)
Get the hostname for the local interface.
Definition: socket.hxx:164
osl_connectSocketTo
SAL_DLLPUBLIC oslSocketResult osl_connectSocketTo(oslSocket Socket, oslSocketAddr Addr, const TimeValue *pTimeout)
Connects the socket to the given address.
osl_sendSocket
SAL_DLLPUBLIC sal_Int32 osl_sendSocket(oslSocket Socket, const void *pBuffer, sal_uInt32 BytesToSend, oslSocketMsgFlag Flag)
Tries to send BytesToSend data from the connected socket, if no error occurs.
osl_bindAddrToSocket
SAL_DLLPUBLIC sal_Bool osl_bindAddrToSocket(oslSocket Socket, oslSocketAddr Addr)
Binds the given address to the socket.
osl::Socket::bind
bool bind(const SocketAddr &LocalInterface)
Binds the socket to the specified (local) interface.
Definition: socket.hxx:304
osl::SocketAddr::getHostname
inline ::rtl::OUString getHostname(oslSocketResult *pResult=NULL) const
Converts the address to a (human readable) domain-name.
Definition: socket.hxx:78
oslSocket
struct oslSocketImpl * oslSocket
Definition: socket.h:402
osl::DatagramSocket::sendTo
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:549
osl::SocketAddr::getAddr
inline ::rtl::ByteSequence getAddr(oslSocketResult *pResult=NULL) const
Returns the address of the underlying socket in network byte order.
Definition: socket.hxx:112
osl::Socket::clearError
void clearError() const
clears the error status
Definition: socket.hxx:379
osl_acquireSocket
SAL_DLLPUBLIC void osl_acquireSocket(oslSocket Socket)
increases the refcount of the socket handle by one
osl::Socket::getPeerHost
inline ::rtl::OUString getPeerHost() const
Get the hostname for the remote interface.
Definition: socket.hxx:296
osl_createEmptySocketAddr
SAL_DLLPUBLIC oslSocketAddr osl_createEmptySocketAddr(oslAddrFamily Family)
Creates a socket-address for the given family.
osl::Socket::setOption
bool setOption(oslSocketOption Option, void *pBuffer, sal_uInt32 BufferLen, oslSocketOptionLevel Level=osl_Socket_LevelSocket) const
Sets the sockets attributes.
Definition: socket.hxx:344
osl_isEqualSocketAddr
SAL_DLLPUBLIC sal_Bool osl_isEqualSocketAddr(oslSocketAddr Addr1, oslSocketAddr Addr2)
Compares the values of two SocketAddresses.
oslSocketAddr
struct oslSocketAddrImpl * oslSocketAddr
Opaque datatype SocketAddr.
Definition: socket.h:40
osl::Socket::operator==
bool operator==(const Socket &rSocket) const
Definition: socket.hxx:236
osl::Socket::getLocalAddr
void getLocalAddr(SocketAddr &Addr) const
Retrieves the address of the local interface of this socket.
Definition: socket.hxx:260
osl::Socket::isExceptionPending
bool isExceptionPending(const TimeValue *pTimeout=NULL) const
Checks if a request for out-of-band data will block.
Definition: socket.hxx:322
osl_setInetPortOfSocketAddr
SAL_DLLPUBLIC sal_Bool osl_setInetPortOfSocketAddr(oslSocketAddr Addr, sal_Int32 Port)
Sets the Port of Addr.
osl::SocketAddr::m_handle
oslSocketAddr m_handle
Definition: socket_decl.hxx:42
osl_releaseSocket
SAL_DLLPUBLIC void osl_releaseSocket(oslSocket Socket)
decreases the refcount of the socket handle by one.
osl_receiveSocket
SAL_DLLPUBLIC sal_Int32 osl_receiveSocket(oslSocket Socket, void *pBuffer, sal_uInt32 BytesToRead, oslSocketMsgFlag Flag)
Tries to receive BytesToRead data from the connected socket, if no error occurs.
osl_Socket_Error
Definition: socket.h:184
rtl::ByteSequence
C++ class representing a SAL byte sequence.
Definition: byteseq.h:165
osl_getLastSocketError
SAL_DLLPUBLIC oslSocketError osl_getLastSocketError(oslSocket Socket)
returns a constant describing the last error for the socket system.
osl_getPeerAddrOfSocket
SAL_DLLPUBLIC oslSocketAddr osl_getPeerAddrOfSocket(oslSocket Socket)
Retrieves the Address of the remote end of the socket.
osl_getSocketType
SAL_DLLPUBLIC oslSocketType osl_getSocketType(oslSocket Socket)
Queries the socket for its type.
osl::Socket::getPeerAddr
void getPeerAddr(SocketAddr &Addr) const
Retrieves the address of the remote host of this socket.
Definition: socket.hxx:282
oslSocketDirection
oslSocketDirection
Used by shutdown to denote which end of the socket to "close".
Definition: socket.h:133
osl::__osl_socket_NoCopy
__osl_socket_NoCopy
Definition: socket_decl.hxx:33
oslProtocol
oslProtocol
represent a specific protocol within a address-family
Definition: socket.h:56
osl_isNonBlockingMode
SAL_DLLPUBLIC sal_Bool osl_isNonBlockingMode(oslSocket Socket)
Query state of non-blocking-mode of the socket.
osl::SocketAddr::getPort
sal_Int32 getPort() const
Returns the port number of the address.
Definition: socket.hxx:88
osl_setAddrOfSocketAddr
SAL_DLLPUBLIC oslSocketResult osl_setAddrOfSocketAddr(oslSocketAddr Addr, sal_Sequence *pByteSeq)
Sets the addr field in the struct sockaddr with pByteSeq.
__sal_NoAcquire
__sal_NoAcquire
Definition: types.h:384
osl_isReceiveReady
SAL_DLLPUBLIC sal_Bool osl_isReceiveReady(oslSocket Socket, const TimeValue *pTimeout)
Checks if read operations will block.
osl_destroySocketAddr
SAL_DLLPUBLIC void osl_destroySocketAddr(oslSocketAddr Addr)
Frees all resources allocated by Addr.
oslSocketOption
oslSocketOption
Represents socket-options.
Definition: socket.h:83
osl::StreamSocket::StreamSocket
StreamSocket(oslAddrFamily Family=osl_Socket_FamilyInet, oslProtocol Protocol=osl_Socket_ProtocolIp, oslSocketType Type=osl_Socket_TypeStream)
Creates a socket.
Definition: socket.hxx:406
osl_readSocket
SAL_DLLPUBLIC sal_Int32 osl_readSocket(oslSocket Socket, void *pBuffer, sal_Int32 nSize)
Retrieves n bytes from the stream and copies them into pBuffer.
osl::Socket::isSendReady
bool isSendReady(const TimeValue *pTimeout=NULL) const
Checks if send operations will block.
Definition: socket.hxx:316
osl_closeSocket
SAL_DLLPUBLIC void osl_closeSocket(oslSocket Socket)
Closes the socket terminating any ongoing dataflow.
osl::Socket::getLocalHost
inline ::rtl::OUString getLocalHost() const
Get the hostname for the local interface.
Definition: socket.hxx:274
osl::SocketAddr::is
bool is() const
checks, if the SocketAddr was created successful.
Definition: socket.hxx:158
osl_resolveHostname
SAL_DLLPUBLIC oslSocketAddr osl_resolveHostname(rtl_uString *strHostname)
Uses the systems name-service interface to find an address for strHostname.
osl_receiveFromSocket
SAL_DLLPUBLIC sal_Int32 osl_receiveFromSocket(oslSocket Socket, oslSocketAddr SenderAddr, void *pBuffer, sal_uInt32 BufferSize, oslSocketMsgFlag Flag)
Tries to receives BufferSize data from the (usually unconnected) (datagram-)socket, if no error occurs.
osl
Definition: conditn.hxx:32
osl::Socket::isNonBlockingMode
bool isNonBlockingMode() const
Query blocking mode of the socket.
Definition: socket.hxx:373
osl_setSocketOption
SAL_DLLPUBLIC sal_Bool osl_setSocketOption(oslSocket Socket, oslSocketOptionLevel Level, oslSocketOption Option, void *pBuffer, sal_uInt32 BufferLen)
Sets the sockets attributes.
osl::StreamSocket::send
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:448
osl::SocketAddr::operator=
SocketAddr & operator=(oslSocketAddr Addr)
assign the handle to this reference.
Definition: socket.hxx:122
osl::Socket::getType
oslSocketType getType() const
Queries the socket for its type.
Definition: socket.hxx:328
oslAddrFamily
oslAddrFamily
Represents the address-family of a socket.
Definition: socket.h:46
osl_getAddrOfSocketAddr
SAL_DLLPUBLIC oslSocketResult osl_getAddrOfSocketAddr(oslSocketAddr Addr, sal_Sequence **ppByteSeq)
Returns the addr field in the struct sockaddr.
osl::Socket::getError
oslSocketError getError() const
returns a constant describing the last error for the socket system.
Definition: socket.hxx:386
SAL_NO_ACQUIRE
definition of a no acquire enum for ctors
Definition: types.h:388
osl_getLastSocketErrorDescription
SAL_DLLPUBLIC void osl_getLastSocketErrorDescription(oslSocket Socket, rtl_uString **strError)
returns a string which describes the last socket error.
osl_isExceptionPending
SAL_DLLPUBLIC sal_Bool osl_isExceptionPending(oslSocket Socket, const TimeValue *pTimeout)
Checks if a request for out-of-band data will block.
osl::Socket::getErrorAsString
inline ::rtl::OUString getErrorAsString() const
Builds a string with the last error-message for the socket.
Definition: socket.hxx:392
osl_Socket_Ok
Definition: socket.h:183
osl_enableNonBlockingMode
SAL_DLLPUBLIC sal_Bool osl_enableNonBlockingMode(oslSocket Socket, sal_Bool On)
Enables/disables non-blocking-mode of the socket.
osl::DatagramSocket::DatagramSocket
DatagramSocket(oslAddrFamily Family=osl_Socket_FamilyInet, oslProtocol Protocol=osl_Socket_ProtocolIp, oslSocketType Type=osl_Socket_TypeDgram)
Creates a datagram socket.
Definition: socket.hxx:520
osl_copySocketAddr
SAL_DLLPUBLIC oslSocketAddr osl_copySocketAddr(oslSocketAddr Addr)
Creates a new SocketAddress and fills it from Addr.
osl::SAL_NO_COPY
Definition: socket_decl.hxx:33
osl::Socket::m_handle
oslSocket m_handle
Definition: socket_decl.hxx:169
osl_getInetPortOfSocketAddr
SAL_DLLPUBLIC sal_Int32 osl_getInetPortOfSocketAddr(oslSocketAddr Addr)
Retrieves the internet port-number of Addr.
osl::SocketAddr
The class should be understood as a reference to a socket address handle ( struct sockaddr )...
Definition: socket_decl.hxx:39
rtl::OUString
This String class provides base functionality for C++ like Unicode character array handling...
Definition: ustring.hxx:106
osl::StreamSocket::write
sal_Int32 write(const void *pBuffer, sal_uInt32 n)
Writes n bytes from pBuffer to the stream.
Definition: socket.hxx:434
oslSocketOptionLevel
oslSocketOptionLevel
Represents the different socket-option levels.
Definition: socket.h:109
osl_getServicePort
SAL_DLLPUBLIC sal_Int32 osl_getServicePort(rtl_uString *strServicename, rtl_uString *strProtocol)
Looks up the port-number designated to the specified service/protocol-pair.
oslSocketResult
oslSocketResult
Common return codes of socket related functions.
Definition: socket.h:182
osl::Socket::getLocalPort
sal_Int32 getLocalPort() const
Get the local port of the socket.
Definition: socket.hxx:266
osl_createSocket
SAL_DLLPUBLIC oslSocket osl_createSocket(oslAddrFamily Family, oslSocketType Type, oslProtocol Protocol)
Create a socket of the specified Family and Type.
osl::Socket::enableNonBlockingMode
bool enableNonBlockingMode(bool bNonBlockingMode)
Enables/disables non-blocking mode of the socket.
Definition: socket.hxx:367
osl_getLocalAddrOfSocket
SAL_DLLPUBLIC oslSocketAddr osl_getLocalAddrOfSocket(oslSocket Socket)
Retrieves the Address of the local end of the socket.
osl_isSendReady
SAL_DLLPUBLIC sal_Bool osl_isSendReady(oslSocket Socket, const TimeValue *pTimeout)
Checks if send operations will block.
osl::StreamSocket
Definition: socket_decl.hxx:503
osl::Socket::close
void close()
Closes a socket.
Definition: socket.hxx:254
osl::SocketAddr::setHostname
bool setHostname(const ::rtl::OUString &sDottedIpOrHostname)
Sets the ipaddress or hostname of the SocketAddress.
Definition: socket.hxx:99
osl_acceptConnectionOnSocket
SAL_DLLPUBLIC oslSocket osl_acceptConnectionOnSocket(oslSocket Socket, oslSocketAddr *pAddr)
Waits for an ingoing connection on the socket.
osl_getSocketOption
SAL_DLLPUBLIC sal_Int32 osl_getSocketOption(oslSocket Socket, oslSocketOptionLevel Level, oslSocketOption Option, void *pBuffer, sal_uInt32 BufferLen)
Retrieves attributes associated with the socket.
osl_createInetSocketAddr
SAL_DLLPUBLIC oslSocketAddr osl_createInetSocketAddr(rtl_uString *strDottedAddr, sal_Int32 Port)
Create an internet-address, consisting of hostaddress and port.
osl::SocketAddr::resolveHostname
static void resolveHostname(const ::rtl::OUString &strHostName, SocketAddr &Addr)
Tries to find an address for a host.
Definition: socket.hxx:174
osl::Socket::getHandle
oslSocket getHandle() const
Returns the underlying handle unacquired (The caller must acquire it to keep it). ...
Definition: socket.hxx:400
osl_writeSocket
SAL_DLLPUBLIC sal_Int32 osl_writeSocket(oslSocket Socket, const void *pBuffer, sal_Int32 nSize)
Writes n bytes from pBuffer to the stream.
osl::Socket
Definition: socket_decl.hxx:166
osl::Socket::shutdown
void shutdown(oslSocketDirection Direction=osl_Socket_DirReadWrite)
Closes a definite or both directions of the bidirectional stream.
Definition: socket.hxx:248
osl::Socket::getOption
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:334
oslSocketType
oslSocketType
Represents the type of a socket.
Definition: socket.h:69
osl::ConnectorSocket::ConnectorSocket
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:456
osl_Socket_OptionError
Definition: socket.h:99