Changeset 21

Show
Ignore:
Timestamp:
09/22/05 13:07:28 (3 years ago)
Author:
ross
Message:

updated README and TODO, and added CHANGES in preparation for new release

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • oscpack/trunk/README

    r5 r21  
    77 
    88 
    9 Oscpack is simply a set of C++ classes for packing and unpacking OSC packets. 
    10 Oscpack is not a networking library, or a framework for bulding OSC 
    11 applications. Simple classes for UDP networking are included, but you are 
    12 encouraged to use another networking framework. The library should also be 
    13 easy to use for other transport methods (eg serial). 
     9Oscpack is simply a set of C++ classes for packing and unpacking OSC packets.  
     10Oscpack includes a minimal set of UDP networking classes for windows and posix  
     11which are sufficient for writing many OSC applications and servers, but you are  
     12encouraged to use another networking framework if it better suits your needs.  
     13Oscpack is not an OSC application framework, it doesn't include infrastructure for  
     14constructing or routing OSC namespaces, just classes for easily constructing,  
     15sending, receiving and parsing OSC packets. The library should also be easy to use  
     16for other transport methods (eg serial). 
    1417 
    15 The key goals of this library are: 
     18The key goals of the oscpack library are: 
    1619 
    1720  - to be a simple and complete implementation of OSC 
    …… 
    2427Here's a summary of the key files: 
    2528 
    26 OscReceivedElements -- classes for parsing a packet 
    27 OscPrintRecievedElements -- iostream << operators for printing packet elements 
    28 OscOutboundPacket -- a class for packing messages into a packet 
    29 OscPacketListener -- base class for listening to OSC packets on a UdpSocket 
    30 OscUnitTests -- unit test program for the OSC modules 
    31 OscDump -- a program that prints received OSC packets 
    32 OscSendTests -- examples of how to send messages 
    33 OscReceiveTest -- example of how to receive the messages sent by OSCSendTests 
     29osc/OscReceivedElements -- classes for parsing a packet 
     30osc/OscPrintRecievedElements -- iostream << operators for printing packet elements 
     31osc/OscOutboundPacket -- a class for packing messages into a packet 
     32osc/OscPacketListener -- base class for listening to OSC packets on a UdpSocket 
     33osc/OscUnitTests -- unit test program for the OSC modules 
     34osc/OscDump -- a program that prints received OSC packets 
     35osc/OscSendTests -- examples of how to send messages 
     36osc/OscReceiveTest -- example of how to receive the messages sent by OSCSendTests 
    3437 
    3538If you fix anything or write a set of TCP send/recieve classes  
    …… 
    4750 
    4851Portions developed at the Music Technology Group, Audiovisual Institute, 
    49 University Pompeu Fabra, Barcelona, November 2004 - June 2005. 
     52University Pompeu Fabra, Barcelona, November 2004 - September 2005. 
    5053 
    5154See the file LICENSE for information about distributing and using this code. 

  • oscpack/trunk/TODO

    r5 r21  
    11TODO: 
     2 
     3    - consider adding the local endpoint name to PacketListener::PacketReceived() params 
    24 
    35    - consider adding ListenerThread class to support old seperate thread listener functionality, something like: 
    …… 
    1214            void Stop(); 
    1315        }; 
    14  
    15  
    1616 
    1717    - provide some kind of automatic endianness configuration (hopefully there 
    …… 
    4949    - add a method to discard an inprogress message if it gets half 
    5050        constructed and the buffer is full in OutboundPacket 
     51 
     52    - write a stress testing app which can send garbage packets to try to flush out other bugs in the parsing code. 
     53 
     54 
     55