zapISipFlow Interface Reference
[ZAP SIP transport layer]

import "zapISipFlow.idl";

List of all members.

---

Detailed Description

Describes a network protocol layer connection between two hosts.

Flow objects are managed by the the transport layer, see zapISipTransport.

Clients can add monitor callbacks to flows to observe the connectivity status and keep alive a connection through NAT.

Public Member Functions
void	addFlowMonitor (in zapISipFlowMonitor monitor, in unsigned short type)
void	removeFlowMonitor (in zapISipFlowMonitor monitor)
Public Attributes
readonly attribute ACString	localAddress
	IP address of local endpoint.
readonly attribute unsigned short	localPort
	Port of local endpoint.
readonly attribute ACString	remoteAddress
	IP address of remote endpoint.
readonly attribute unsigned short	remotePort
	Port of remote endpoint.
readonly attribute ACString	transportProtocol
	Transport protocol to remote endpoint (udp, tcp, .
readonly attribute zapISipConnection	connection
	Connection object of the flow (null for connection-less protocols).
const unsigned short	IETF_SIP_OUTBOUND_01_MONITOR = 0x0001
	Monitor the flow using periodic STUN binding requests as specified in draft-ietf-sip-outbound-01.
const unsigned short	OPTIONS_MONITOR = 0x0002
	Monitor the flow by sending periodic OPTIONS requests.

---

Member Function Documentation

void zapISipFlow::addFlowMonitor (  in zapISipFlowMonitor  monitor, in unsigned short  type )

void zapISipFlow::removeFlowMonitor (  in zapISipFlowMonitor  monitor  )

---

Member Data Documentation

readonly attribute zapISipConnection zapISipFlow::connection

Connection object of the flow (null for connection-less protocols).

const unsigned short zapISipFlow::IETF_SIP_OUTBOUND_01_MONITOR = 0x0001

Monitor the flow using periodic STUN binding requests as specified in draft-ietf-sip-outbound-01.

readonly attribute ACString zapISipFlow::localAddress

IP address of local endpoint.

readonly attribute unsigned short zapISipFlow::localPort

Port of local endpoint.

const unsigned short zapISipFlow::OPTIONS_MONITOR = 0x0002

Monitor the flow by sending periodic OPTIONS requests. OPTIONS monitoring will only be available if the transport layer has been initialized with a zapISipUAStack. See zapISipTransport::UAStack

readonly attribute ACString zapISipFlow::remoteAddress

IP address of remote endpoint.

readonly attribute unsigned short zapISipFlow::remotePort

Port of remote endpoint.

readonly attribute ACString zapISipFlow::transportProtocol

Transport protocol to remote endpoint (udp, tcp, . ..)

---

The documentation for this interface was generated from the following file:

• /home/alex/devel/zap/mozilla/zap/sip/idl/zapISipFlow.idl

---