WOscTcpClient Class Reference

Inherits WOscTcpHandler.

List of all members.

Public Member Functions
	WOscTcpClient (bool threading=true)
Error	Connect (const TheNetReturnAddress &serverAddress)
Error	Close ()
Protected Member Functions
virtual void	HandleOffendingPackets (const char *const data, int dataLen, const WOscException &exception)
virtual void	HandleNonmatchedMessages (const WOscMessage *msg, const WOscNetReturn *networkReturnAddress)

---

Detailed Description

Examples:

WOscStreamingClient.cpp.

Definition at line 13 of file WOscTcpClient.h.

---

Constructor & Destructor Documentation

WOscTcpClient::WOscTcpClient

(

bool

threading = true

)

WOscTCPClient.cpp - A streaming OSC client using posix threads and sockets

Created on: Apr 21, 2010 Author: uli Implements a full featured OSC client with TCP transport.

Parameters:

threading

If true, all reception happens in a separate thread and does not require any select logic in the main loop, but you have to take care when calling main thread code from the OSC message handlers/methods. If false, threading is disabled and the reception must be implemented by a select statement. On input WOscTcpClient::NetworkReceive() must be called. The socket is switched to non blocking automatically. See the streaming server example for further details.

Definition at line 25 of file WOscTcpClient.cpp.

                                           : WOscTcpHandler(threading)
{}

---

Member Function Documentation

WOscTcpClient::Error WOscTcpClient::Close

(

)

Close the receiving socket and shutdown the receiving thread if in threading mode.

Definition at line 74 of file WOscTcpClient.cpp.

References WOscTcpHandler::GetSocketID(), WOscTcpHandler::Stop(), WOscTcpHandler::WOS_ERR_ALREADY_CLOSED, and WOscTcpHandler::WOS_ERR_DISCONNECTED.

{
    // Check if reception thread has already been shut down
    if ( GetThreading() && GetRxThreadID() )
        return WOS_ERR_ALREADY_CLOSED;
    // Check if socket still
    if ( GetSocketID() < 0 )
        return WOS_ERR_DISCONNECTED;

    WOscTcpHandler::Error err = Stop();

    // close socket
    int ret = close(GetSocketID());
    if ( ret ) {
//      std::cout<<"Close failed."<<std::endl;
    }
    return err;
}

WOscTcpClient::Error WOscTcpClient::Connect

(

const TheNetReturnAddress &

serverAddress

)

Try to open a connection to a remote server. Establishes a connection to a remote server and creates a separate thread for reception of server replies.

Connect to a OSC server at a given address. Starts a receiver thread which handles any replies from the server when this class was constructed with threading enabled. If not, the socket is set to non blocking and can be used in a select statement.

Definition at line 39 of file WOscTcpClient.cpp.

References WOscTcpHandler::GetSocketID(), WOscTcpHandler::WOS_ERR_ALREADY_CONNECTED, WOscTcpHandler::WOS_ERR_ALREADY_RUNNING, WOscTcpHandler::WOS_ERR_NO_ERROR, WOscTcpHandler::WOS_ERR_SOCKET_CONNECT, and WOscTcpHandler::WOS_ERR_SOCKET_CREATE.

{
    // Check if reception thread is already running
    if ( GetRxThreadID() > 0 )
        return WOS_ERR_ALREADY_RUNNING;
    
    // Check if someone established a connection already
    if ( GetSocketID() >= 0 )
        return WOS_ERR_ALREADY_CONNECTED;

    // Create socket
    int sock = socket(AF_INET, SOCK_STREAM, 0);
    if (sock < 0) {
        return WOS_ERR_SOCKET_CREATE;
    }

    // Connect
    int ret = connect(sock, (struct sockaddr*) &serverAddress.m_addr, sizeof(serverAddress.m_addr));
    if ( ret < 0 ) {
        close(sock);
        return WOS_ERR_SOCKET_CONNECT;
    }
    
    // starts thread if threading is enabled
    WOscTcpHandler::Error err = Start(sock, serverAddress);
    if ( err != WOscTcpHandler::WOS_ERR_NO_ERROR )
        close(sock);

    return err;
}

virtual void WOscTcpClient::HandleNonmatchedMessages	(	const WOscMessage *	msg,
		const WOscNetReturn *	networkReturnAddress
	)			[inline, protected, virtual]

Handler for OSC messages which didn't match any address in the OSC address space. The user can define an own action by overriding this pure virtual function.

Parameters:

	msg	Pointer to Message which hasn't been processed.
	networkReturnAddress	Network address of the sender of this message.

Implements WOscReceiver.

Examples:

WOscStreamingClient.cpp.

Definition at line 27 of file WOscTcpClient.h.

                                                       { }

virtual void WOscTcpClient::HandleOffendingPackets	(	const char *const	data,
		int	dataLen,
		const WOscException &	exception
	)			[inline, protected, virtual]

Handler for packets which caused either an internal exception or another error. The user can decide what to do with such packets by overriding this function.

Parameters:

	data	Pointer to the buffer containing the offending packet data.
	dataLen	Lenght of the buffer containg the offending packet data.
	exception	Exception which has been generated during processing this packet.

Implements WOscReceiver.

Definition at line 25 of file WOscTcpClient.h.

                                            { }

---

The documentation for this class was generated from the following files:

• WOscTcpClient.h
• WOscTcpClient.cpp