Methods of Class Socket

Socket

Socket(

oslSocketType	Type,
oslAddrFamily	Family = osl_Socket_FamilyInet,
oslProtocol	議定書 = osl_Socket_ProtocolIp );

事実上の	abstract	const	volatile	template	static	inline	C-結合，連鎖
NO	NO	NO	NO	NO	NO	YES	NO

要約

Creates a socket. 公式文書，認める it's 保護するd.

Parameters

Type
Family
議定書

Socket

Socket();

事実上の	abstract	const	volatile	template	static	inline	C-結合，連鎖
NO	NO	NO	NO	NO	NO	YES	NO

Socket

Socket(

const Socket &

socket );

事実上の	abstract	const	volatile	template	static	inline	C-結合，連鎖
NO	NO	NO	NO	NO	NO	YES	NO

Socket

Socket(

oslSocket

socketHandle );

事実上の	abstract	const	volatile	template	static	inline	C-結合，連鎖
NO	NO	NO	NO	NO	NO	YES	NO

Socket

Socket(

oslSocket	socketHandle,
__sal_NoAcquire	noacquire );

事実上の	abstract	const	volatile	template	static	inline	C-結合，連鎖
NO	NO	NO	NO	NO	NO	YES	NO

要約

The instance takes over the 扱う's 所有権 without acquiring the 扱う, but 解放（する）s it within the dtor.

Parameters

noacquire

use SAL_NO_ACQUIRE

~Socket

~Socket();

事実上の	abstract	const	volatile	template	static	inline	C-結合，連鎖
NO	NO	NO	NO	NO	NO	YES	NO

要約: Destructor. 解放（する）s the underlying 扱う

操作者=

Socket & 操作者=(

oslSocket

socketHandle );

事実上の	abstract	const	volatile	template	static	inline	C-結合，連鎖
NO	NO	NO	NO	NO	NO	YES	NO

要約: Assignment 操作者. If socket was already created, the old one will be discarded.

操作者=

Socket & 操作者=(

const Socket &

sock );

事実上の	abstract	const	volatile	template	static	inline	C-結合，連鎖
NO	NO	NO	NO	NO	NO	YES	NO

要約: Assignment 操作者. If socket was already created, the old one will be discarded.

操作者==

sal_Bool 操作者==(

const Socket &

rSocket ) const;

事実上の	abstract	const	volatile	template	static	inline	C-結合，連鎖
NO	NO	YES	NO	NO	NO	YES	NO

Return: sal_True, when the underlying 扱う of both Socket instances are 同一の, sal_False さもなければ.

操作者==

sal_Bool 操作者==(

const oslSocket

socketHandle ) const;

事実上の	abstract	const	volatile	template	static	inline	C-結合，連鎖
NO	NO	YES	NO	NO	NO	YES	NO

Return: sal_True, when the underlying 扱う of both Socket instances are 同一の, sal_False さもなければ.

shutdown

無効の shutdown(

oslSocketDirection

Direction = osl_Socket_DirReadWrite );

事実上の	abstract	const	volatile	template	static	inline	C-結合，連鎖
NO	NO	NO	NO	NO	NO	YES	NO

要約

の近くにs a 限定された or both directions of the bidirectional stream.

Parameters

Direction

See Also

osl_shutdownSocket()

の近くに

無効の の近くに();

事実上の	abstract	const	volatile	template	static	inline	C-結合，連鎖
NO	NO	NO	NO	NO	NO	YES	NO

Description: の近くにs a socket. 公式文書，認める that の近くにing a socket is 同一の to shutdown( osl_Socket_DirReadWrite ), as the operating system distinguish both 事例／患者s, both 機能（する）／行事s or 申し込む／申し出d in this API.
See Also: osl_closeSocket()

getLocalAddr

無効の getLocalAddr(

SocketAddr &

Addr ) const;

事実上の	abstract	const	volatile	template	static	inline	C-結合，連鎖
NO	NO	YES	NO	NO	NO	YES	NO

要約

Retrieves the 演説（する）／住所 of the 地元の interface of this socket.

Parameters

Addr	receives the 演説（する）／住所.

See Also

osl_getLocalAddrOfSocket()

getLocalPort

sal_Int32 getLocalPort();

事実上の	abstract	const	volatile	template	static	inline	C-結合，連鎖
NO	NO	NO	NO	NO	NO	YES	NO

要約: Get the 地元の port of the socket. Usually used after 貯蔵所d().
Return: the port number or OSL_INVALID_PORT on errors.

getLocalHost

::rtl::OUString getLocalHost();

事実上の	abstract	const	volatile	template	static	inline	C-結合，連鎖
NO	NO	NO	NO	NO	NO	YES	NO

要約: Get the hostname for the 地元の interface.
Return: the hostname or an empty string ("").

getPeerAddr

無効の getPeerAddr(

SocketAddr &

Addr ) const;

事実上の	abstract	const	volatile	template	static	inline	C-結合，連鎖
NO	NO	YES	NO	NO	NO	YES	NO

要約

Retrieves the 演説（する）／住所 of the remote host of this socket.

Parameters

Addr	receives the 演説（する）／住所.

getPeerPort

sal_Int32 getPeerPort();

事実上の	abstract	const	volatile	template	static	inline	C-結合，連鎖
NO	NO	NO	NO	NO	NO	YES	NO

要約: Get the remote port of the socket.
Return: the port number or OSL_INVALID_PORT on errors.

getPeerHost

::rtl::OUString getPeerHost();

事実上の	abstract	const	volatile	template	static	inline	C-結合，連鎖
NO	NO	NO	NO	NO	NO	YES	NO

要約: Get the hostname for the remote interface.
Return: the hostname or an empty string ("").

貯蔵所d

sal_Bool 貯蔵所d(

const SocketAddr &

LocalInterface );

事実上の	abstract	const	volatile	template	static	inline	C-結合，連鎖
NO	NO	NO	NO	NO	NO	YES	NO

要約

貯蔵所d the socket to the 明示するd (地元の) interface.

Parameters

LocalInterface

演説（する）／住所 of the Interface

Return

True if 貯蔵所d was successful.

isRecvReady

sal_Bool isRecvReady(

const TimeValue *

pTimeout = 0 ) const;

事実上の	abstract	const	volatile	template	static	inline	C-結合，連鎖
NO	NO	YES	NO	NO	NO	YES	NO

要約

Checks if read 操作／手術s will 封鎖する.

Description

You can 明示する a timeout-value in seconds/nanoseconds that denotes how the 操作／手術 will 封鎖する if the Socket is not ready.

Return

sal_True if read 操作／手術s (recv, recvFrom, 受託する) on the Socket will NOT 封鎖する; sal_False if it would 封鎖する or if an error occured.

Parameters

pTimeout

if 0, the 操作／手術 will 封鎖する without a timeout. さもなければ
the 明示するd amout of time.

isSendReady

sal_Bool isSendReady(

const TimeValue *

pTimeout = 0 ) const;

事実上の	abstract	const	volatile	template	static	inline	C-結合，連鎖
NO	NO	YES	NO	NO	NO	YES	NO

要約

Checks if send 操作／手術s will 封鎖する.

Description

You can 明示する a timeout-value in seconds/nanoseconds that denotes how the 操作／手術 will 封鎖する if the Socket is not ready.

Return

sal_True if send 操作／手術s (send, sendTo) on the Socket will NOT 封鎖する; sal_False if it would 封鎖する or if an error occured.

Parameters

pTimeout

if 0, the 操作／手術 will 封鎖する without a timeout. さもなければ
the 明示するd amout of time.

isExceptionPending

sal_Bool isExceptionPending(

const TimeValue *

pTimeout = 0 ) const;

事実上の	abstract	const	volatile	template	static	inline	C-結合，連鎖
NO	NO	YES	NO	NO	NO	YES	NO

要約

Checks if a request for out-of-禁止（する）d data will 封鎖する.

Description

You can 明示する a timeout-value in seconds/nanoseconds that denotes how the 操作／手術 will 封鎖する if the Socket has no 未解決の OOB data.

Return

sal_True if OOB-request 操作／手術s (recv with appropriate 旗s) on the Socket will NOT 封鎖する; sal_False if it would 封鎖する or if an error occured.

Parameters

pTimeout

if 0, the 操作／手術 will 封鎖する without a timeout. さもなければ
the 明示するd amout of time.

getType

oslSocketType getType();

事実上の	abstract	const	volatile	template	static	inline	C-結合，連鎖
NO	NO	NO	NO	NO	NO	YES	NO

要約

Queries the socket for its type.

Return

one of:

osl_Socket_TypeStream
osl_Socket_TypeDgram
osl_Socket_TypeRaw
osl_Socket_TypeRdm
osl_Socket_TypeSeqPacket
osl_invalid_SocketType, if an error occured

getOption

sal_Int32 getOption(

oslSocketOption	選択,
無効の *	pBuffer,
sal_uInt32	BufferLen,
oslSocketOptionLevel	Level = osl_Socket_LevelSocket ) const;

事実上の	abstract	const	volatile	template	static	inline	C-結合，連鎖
NO	NO	YES	NO	NO	NO	YES	NO

要約

Retrieves 選択-せいにするs associated with the socket.

Parameters

選択	The せいにする to query. Valid values (depending on the Level) are: `osl_Socket_Option_Debug` (sal_Bool) Socket debug 旗 1 = enabled, 0 = 無能にするd. `osl_Socket_OptionAcceptConn` `osl_Socket_OptionReuseAddr` (sal_Bool) 許すs the socket to be bound to an 演説（する）／住所 that is already in use. 1 = 多重の bound 許すd, 0 = no 多重の bounds 許すd `osl_Socket_OptionKeepAlive` (sal_Bool) Keepalive packets are sent by the underlying socket. 1 = enabled, 0 = 無能にするd `osl_Socket_OptionDontRoute` (sal_Bool) Do not 大勝する: send 直接／まっすぐに to interface. 1 = do not 大勝する , 0 = 大勝するing possible `osl_Socket_OptionBroadcast` (sal_Bool) 伝達／伝染 of broadcast messages are 許すd on the socket. 1 = 伝達／伝染許すd, 0 = 伝達／伝染 disallowed `osl_Socket_OptionUseLoopback` `osl_Socket_OptionLinger` (ぐずぐず残る) ぐずぐず残る on の近くに if unsent data is 現在の. ぐずぐず残る has two members: l_onoff, l_linger l_onoff = 0 is off, l_onoff > 0 and l_linger= timeout in seconds. `osl_Socket_OptionOOBinLine` `osl_Socket_OptionSndBuf` (sal_Int32) Size of the send 衝撃を和らげるもの in bytes. Data is sent after SndTimeo or when the 衝撃を和らげるもの is 十分な. This 許すs faster 令状ing to the socket. `osl_Socket_OptionRcvBuf` (sal_Int32) Size of the receive 衝撃を和らげるもの in bytes. Data is sent after SndTimeo or when the 衝撃を和らげるもの is 十分な. This 許すs faster 令状ing to the socket and larger packet sizes. `osl_Socket_OptionSndLowat` `osl_Socket_OptionRcvLowat` `osl_Socket_OptionSndTimeo` (sal_Int32) Data is sent after this timeout. This 許すs 集会 of data to send larger 一括s but 増加するs latency times. `osl_Socket_OptionRcvTimeo` `osl_Socket_OptionError` `osl_Socket_OptionType` `osl_Socket_OptionTcpNoDelay` 無能にするs the Nagle algorithm for send coalescing. (Do not collect data until a packet is 十分な, instead send immediatly. This 増加するs 網状組織 traffic but might 改善する latency-times.) 1 = 無能にするs the algorithm, 0 = keeps it enabled. If not above について言及するd さもなければ, the 選択s are only valid for level `osl_Socket_LevelSocket`.
pBuffer	The 衝撃を和らげるもの will be filled with the せいにする.
BufferSize	The size of pBuffer.
Level	The 選択 level. Valid values are: `osl_Socket_LevelSocket` : Socket Level `osl_Socket_LevelTcp` : Level of 伝達／伝染支配（する）／統制する議定書

Return

The size of the せいにする copied into pBuffer or -1 if an error occured.

setOption

sal_Bool setOption(

oslSocketOption	選択,
無効の *	pBuffer,
sal_uInt32	BufferLen,
oslSocketOptionLevel	Level = osl_Socket_LevelSocket ) const;

事実上の	abstract	const	volatile	template	static	inline	C-結合，連鎖
NO	NO	YES	NO	NO	NO	YES	NO

要約

始める，決めるs the sockets せいにするs.

Parameters

選択	denotes the 選択 to 修正する. Valid values (depending on the Level) are: osl_Socket_Option_Debug osl_Socket_OptionAcceptConn osl_Socket_OptionReuseAddr osl_Socket_OptionKeepAlive osl_Socket_OptionDontRoute osl_Socket_OptionBroadcast osl_Socket_OptionUseLoopback osl_Socket_OptionLinger osl_Socket_OptionOOBinLine osl_Socket_OptionSndBuf osl_Socket_OptionRcvBuf osl_Socket_OptionSndLowat osl_Socket_OptionRcvLowat osl_Socket_OptionSndTimeo osl_Socket_OptionRcvTimeo osl_Socket_OptionError osl_Socket_OptionType osl_Socket_OptionTcpNoDelay If not above について言及するd さもなければ, the 選択s are only valid for level osl_Socket_LevelSocket.
pBuffer	Pointer to a 衝撃を和らげるもの which 含む／封じ込めるs the せいにする-value.
BufferSize	含む／封じ込めるs the length of the 衝撃を和らげるもの.
Level	selects the level for which an 選択 should be changed. Valid values are: osl_Socket_evel_Socket : Socket Level osl_Socket_Level_Tcp : Level of 伝達／伝染支配（する）／統制する議定書

Return

True if the 選択 could be changed.

setOption

sal_Bool setOption(

oslSocketOption	選択,
sal_Int32	nValue );

事実上の	abstract	const	volatile	template	static	inline	C-結合，連鎖
NO	NO	NO	NO	NO	NO	YES	NO

要約: Convenience 機能（する）／行事 for setting sal_Bool and sal_Int32 選択 values.
See Also: setOption()

getOption

sal_Int32 getOption(

oslSocketOption

選択 ) const;

事実上の	abstract	const	volatile	template	static	inline	C-結合，連鎖
NO	NO	YES	NO	NO	NO	YES	NO

要約: Convenience 機能（する）／行事 for retrieving sal_Bool and sal_Int32 選択 values.
See Also: setOption()

enableNonBlockingMode

sal_Bool enableNonBlockingMode(

sal_Bool

bNonBlockingMode );

事実上の	abstract	const	volatile	template	static	inline	C-結合，連鎖
NO	NO	NO	NO	NO	NO	YES	NO

要約

Enables/無能にするs 非，不，無-封鎖するing 方式 of the socket.

Parameters

bNonBlockingMode

If sal_True, 封鎖するing 方式 will be switched off
       If sal_False, the socket will become a 封鎖するing
       socket (which is the default behaviour of a socket).

Return

sal_True if 方式 could be 始める，決める.

isNonBlockingMode

sal_Bool isNonBlockingMode();

事実上の	abstract	const	volatile	template	static	inline	C-結合，連鎖
NO	NO	NO	NO	NO	NO	YES	NO

要約: Query 封鎖するing 方式 of the socket.
Return: sal_True if 非，不，無-封鎖するing 方式 is 始める，決める.

clearError

無効の clearError();

事実上の	abstract	const	volatile	template	static	inline	C-結合，連鎖
NO	NO	NO	NO	NO	NO	YES	NO

要約: （疑いを）晴らすs the error status

getError

oslSocketError getError();

事実上の	abstract	const	volatile	template	static	inline	C-結合，連鎖
NO	NO	NO	NO	NO	NO	YES	NO

要約: returns a constant decribing the last error for the socket system.
Return: osl_Socket_E_NONE if no error occured, invalid_SocketError if an unknown (unmapped) error occured, さもなければ an enum 述べるing the error.
See Also: osl_getLastSocketError()

getErrorAsString

::rtl::OUString getErrorAsString();

事実上の	abstract	const	volatile	template	static	inline	C-結合，連鎖
NO	NO	NO	NO	NO	NO	YES	NO

要約: Builds a string with the last error-message for the socket.

getHandle

oslSocket getHandle();

事実上の	abstract	const	volatile	template	static	inline	C-結合，連鎖
NO	NO	NO	NO	NO	NO	YES	NO

要約: Returns the underlying 扱う unacquired (The 報知係 must acquire it to keep it).

最高の，を越す of Page

Copyright © 2012, The Apache ソフトウェア創立／基礎, Licensed under the Apache License, 見解／翻訳／版 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache ソフトウェア創立／基礎. Other 指名するs may be trademarks of their 各々の owners.

API

SDK

Tips ‘n’ Tricks

Miscellaneous

Methods of Class Socket