Member Function Documentation

ApplicationConnector::ApplicationConnector()

Default constructs an instance of ApplicationConnector.

[virtual] ApplicationConnector::~ApplicationConnector()

Destroys the instance of ApplicationConnector. The destructor is virtual.

int ApplicationConnector::CDPversion_Major() const

Returns the CDP version major number

int ApplicationConnector::CDPversion_Minor() const

Returns the CDP version minor number

void ApplicationConnector::Clear()

Close connection to remote application.

[static] void ApplicationConnector::CloseStaticSendSockets()

Will call Close() on udpSend and udpBroadcast. Called from Messenger::Destroy().

double ApplicationConnector::GetBlockingTimer()

Get the last measured BlockingTimeout.

double ApplicationConnector::GetMaxBlockingTimer()

Get the last max BlockingTimeout.

[s] dMaxBlockingTimer filtered like this: no filtereng when value increases, decreasing with 1% of difference when value decreases.

Returns the time of the highest blocking time since last ResetMaxBlockingTimner [s].

unsigned int ApplicationConnector::GetNodeID() const

Returns the application handle

const std::string ApplicationConnector::GetNodeName() const

Returns the name of the application

void ApplicationConnector::Init(const char *name, const IpAddress &ipRemote, const IpAddress &ipLocal, int _appHandle, unsigned short brPort, const IpAddress &ipStudioAPI, int CDPversionMajor, int CDPversionMinor)

Initialise remote application connection.

IpAddress &ApplicationConnector::Ip()

Returns ApplicationConnector's ipRemote.

IpAddress contain both address and port information for remote application.

IpAddress &ApplicationConnector::IpLocal()

Returns ApplicationConnector's ipLocal. IpAddress contain both address and port information for local application.

bool ApplicationConnector::IsFree() const

Returns true if this ApplicationConnector is unused.

bool ApplicationConnector::IsNodeLocal() const

bool ApplicationConnector::IsSendReady(int timeout)

Determines if regular packet send socket can be written to. Returns false if not.

unsigned short ApplicationConnector::LargestBroadcastPort() const

Returns ApplicationConnector's remote largest broadcast portnumber used.

bool ApplicationConnector::Matches(unsigned int ipAddress1, unsigned short port1)

Returns true if this ApplicationConnector matches the info provided otherAppName is the Application name to compare with. ipAddress1 is the first IPAddress to compare with. port1 is the first port to compare with. ipAddress2 is the second IPAddress to compare with. port2 is the second port to compare with.

char *ApplicationConnector::Name()

Read remote application name.

void ApplicationConnector::ResetMaxBlockingTimer()

Reset the last max BlockingTimeout.

bool ApplicationConnector::ResetTimeoutAndUpdateSendFlag()

m_dTimeout is reset to new value (CDPTime::GetGlobalTimeFromHardware() + m_dDisconnectTimeout).

• sendIpPair is set to true (indicating that we can send on specified interface).
• Returns true if was timed out previous (sendIpPair was false).

int ApplicationConnector::SendBroadcastMessage(MessageTransportPacket *message)

Broadcast a message.

This method is called by Messenger::GetInstance()->ProcessSend(). Return values

• 0: Message sent OK
• -1: Message not sent (an error occurred, usually a socket-error)

int ApplicationConnector::SendMessage(MessageTransportPacket *message)

Send message to remote application.

Return-values:

• 0: Message sent OK
• -1: Message not sent (an error occurred, usually a socket-error)

void ApplicationConnector::SetName(const char *name)

Set the name of remote application.

void ApplicationConnector::SetStudioAPIIpAddress(const IpAddress &addr)

const IpAddress &ApplicationConnector::StudioAPIIpAddress() const

Returns ApplicationConnector's remote StudioAPI ip address. IpAddress contain both address and port information.

bool ApplicationConnector::Timeout()

Returns true if ApplicationConnector to remote application has timed out (not received notify for a period). If this ApplicationConnector is not used/occupied, false is returned.

bool ApplicationConnector::VerifyIPAddress(int32_t otherAppIpAddress, unsigned short _port)

Verifies if registered information about IP address(es) and port(s) in this connector matches info in received MessageApplicationNotify.

Returns true if information matches (OK).