SDK Home Glossary Index Left Right Up

Protocol description


Section contents


Overview

Defined in

csocket.oxh

Description

<TBS>

See also

SocketServiceGetProtocolInfo, SocketInfo


Construction / destruction


NewProtocolDesc

Usage

this& = NewProtoclDesc&:

Description

Create a protocol description object and returns a handle to the created object.

Return Value
this& A handle which represents the created protocol description
Error Handling

If the object could not be created then an error is generated which should be trapped by an ONERR handler.


DeleteProtoclDesc

Usage

DeleteProtocolDesc:(BYREF this&)

Description

Destroys the protocol description object

Arguments
BYREF this& A handle to a protocol description. A zero value is written back into the variable

Methods provided


ProtocolDescAddrFamily

Usage

family& = ProtocolDescAddrFamily&:(this&)

Description

Returns the address family that this object describes.

Arguments
this& A handle to a protocol description
Return value
family& Specifies the address family

ProtocolDescByteOrder

Usage

order& = ProtocolDescByteOrder&:(this&)

Description

Returns the byte order of the data returned by this protocol.

Arguments
this& A handle to a protocol description
Return value
order& One of the following
  • KBigEndian&,
  • KLittleEndian&
  • KOtherByteOrder&
See Also

BigEndian, LittleEndian


ProtocolDescMessageSize

Usage

size& = ProtocolDescMessageSize&:(this&)

Description

<TBS>

Arguments
this& A handle to a protocol description
Return value
size& The message size

ProtocolDescName

Usage

name$ = ProtocolDescName$:(this&)

Description

Returns the name of the protocol.

Arguments
this& A handle to a protocol description
Return value
name$ The name of the protocol. The maximum size of the returned string is KProtocolNameMax%

ProtocolDescNamingServices

Usage

services& = ProtocolDescNamingServices&:(this&)

Description

Returns the naming services supported by this protocol

Arguments
this& A handle to a protocol description
Return value
services& The naming services

ProtocolDescProtocol

Usage

protocol& = ProtocolDescProtocol&:(this&)

Description

Returns the protocol type.

Arguments
this& A handle to a protocol description
Return value
protocol& The protocol type

ProtocolDescSecurity

Usage

security& = ProtocolDescSecurity&:(this&)

Description

Returns the protocol security scheme supported by this protocol.

Arguments
this& A handle to a protocol description
Return value
security& The protocol security scheme

ProtocolDescServiceInfo

Usage

info& = ProtocolDescServiceInfo&:(this&)

Description

Returns the protocol service information for this protocol.

Arguments
this& A handle to a protocol description
Return value
info& Bitmask of the protocol service information

ProtocolDescSockType

Usage

socketType& = ProtocolDescSockType&:(this&)

Description

Returns the socket type used for this protocol.

Arguments
this& A handle to a protocol description
Return value
socketType& Specifies the socket type

ProtocolDescVersion

Usage

version& = ProtocolDescVersion&:(this&)

Description

Returns the version number of this protocol.

Arguments
this& A handle to a protocol description
Return value
version& The version number object. This object must be deleted by the caller.
Error Handling

If the version& object cannot be created then an error is generated which should be trapped by an ONERR handler.


  SDK Home Glossary Index Left Right Up