The Synthesis ToolKit in C++ (STK)

Home Information Classes Download Usage Mail List Requirements Links FAQ Tutorial

UdpSocket.h
1 #ifndef STK_UDPSOCKET_H
2 #define STK_UDPSOCKET_H
3
4 #include "Socket.h"
5
6 namespace stk {
7
8 /***************************************************/
29 /***************************************************/
30
31 class UdpSocket : public Socket
32 {
33 public:
35
38 UdpSocket( int port = 2006 );
39
41 ~UdpSocket();
42
44
47 void setDestination( int port = 2006, std::string hostname = "localhost" );
48
50
53 int writeBuffer(const void *buffer, long bufferSize, int flags = 0);
54
56 int readBuffer(void *buffer, long bufferSize, int flags = 0);
57
59 int writeBufferTo(const void *buffer, long bufferSize, int port, std::string hostname = "localhost", int flags = 0 );
60
61 protected:
62
64
67 void setAddress( struct sockaddr_in *address, int port = 2006, std::string hostname = "localhost" );
68
69 struct sockaddr_in address_;
70 bool validAddress_;
71
72 };
73
74 } // stk namespace
75
76 #endif
stk::UdpSocket::setAddress
void setAddress(struct sockaddr_in *address, int port=2006, std::string hostname="localhost")
A protected function for use in writing a socket address structure.
stk::UdpSocket::writeBuffer
int writeBuffer(const void *buffer, long bufferSize, int flags=0)
Send a buffer to the address specified with the setDestination() function. Returns the number of byte...
stk::UdpSocket::readBuffer
int readBuffer(void *buffer, long bufferSize, int flags=0)
Read an input buffer, up to length bufferSize. Returns the number of bytes read or -1 if an error occ...
stk::Socket
STK internet socket abstract base class.
Definition: Socket.h:39
stk::UdpSocket::setDestination
void setDestination(int port=2006, std::string hostname="localhost")
Set the address for subsequent outgoing data sent via the writeBuffer() function.
stk::UdpSocket::writeBufferTo
int writeBufferTo(const void *buffer, long bufferSize, int port, std::string hostname="localhost", int flags=0)
Write a buffer to the specified socket. Returns the number of bytes written or -1 if an error occurs.
stk::UdpSocket::~UdpSocket
~UdpSocket()
The class destructor closes the socket instance.
stk::UdpSocket
STK UDP socket server/client class.
Definition: UdpSocket.h:32
stk
The STK namespace.
Definition: ADSR.h:6
stk::UdpSocket::UdpSocket
UdpSocket(int port=2006)
Default constructor creates a local UDP socket on port 2006 (or the specified port number).
stk::Socket::port
int port(void) const
Return the socket port number.
Definition: Socket.h:60

The Synthesis ToolKit in C++ (STK)
©1995--2019 Perry R. Cook and Gary P. Scavone. All Rights Reserved.