|
jens@2
|
1 |
//
|
|
jens@2
|
2 |
// maindocs.h
|
|
jens@2
|
3 |
// MYNetwork
|
|
jens@2
|
4 |
//
|
|
jens@2
|
5 |
// Created by Jens Alfke on 5/24/08.
|
|
jens@2
|
6 |
// Copyright 2008 Jens Alfke. All rights reserved.
|
|
jens@2
|
7 |
//
|
|
jens@2
|
8 |
// This file just contains the Doxygen comments that generate the main (index.html) page content.
|
|
jens@2
|
9 |
|
|
jens@2
|
10 |
|
|
jens@2
|
11 |
/*! \mainpage MYNetwork: Mooseyard Networking library, including BLIP protocol implementation.
|
|
jens@2
|
12 |
|
|
jens@2
|
13 |
\section intro_sec Introduction
|
|
jens@2
|
14 |
|
|
jens@2
|
15 |
MYNetwork is a set of Objective-C networking classes for Cocoa applications on Mac OS X.
|
|
jens@2
|
16 |
It consists of:
|
|
jens@2
|
17 |
<ul>
|
|
jens@2
|
18 |
<li>Networking utility classes (presently only IPAddress);
|
|
jens@2
|
19 |
<li>A generic TCP client/server implementation,
|
|
jens@2
|
20 |
useful for implementing your own network protocols; (see TCPListener and TCPConnection)
|
|
jens@2
|
21 |
<li>An implementation of BLIP, a lightweight network protocol I've invented as an easy way
|
|
jens@2
|
22 |
to send request and response messages between peers. (see BLIPListener, BLIPConnection, BLIPRequest, etc.)
|
|
jens@2
|
23 |
</ul>
|
|
jens@2
|
24 |
|
|
jens@2
|
25 |
MYNetwork is released under a BSD license, which means you can freely use it in open-source
|
|
jens@2
|
26 |
or commercial projects, provided you give credit in your documentation or About box.
|
|
jens@2
|
27 |
|
|
jens@2
|
28 |
\section config Configuration
|
|
jens@2
|
29 |
|
|
jens@2
|
30 |
MYNetwork requires Mac OS X 10.5 or later, since it uses Objective-C 2 features like
|
|
jens@2
|
31 |
properties and for...in loops.
|
|
jens@2
|
32 |
|
|
jens@2
|
33 |
MYNetwork uses my <a href="/hg/hgwebdir.cgi/MYUtilities">MYUtilities</a> library. You'll need to have downloaded that library, and added
|
|
jens@2
|
34 |
the necessary source files and headers to your project. See the MYNetwork Xcode project,
|
|
jens@2
|
35 |
which contains the minimal set of MYUtilities files needed to build MYUtilities. (That project
|
|
jens@2
|
36 |
has its search paths set up to assume that MYUtilities is in a directory next to MYNetwork.)
|
|
jens@2
|
37 |
|
|
jens@2
|
38 |
\section download How To Get It
|
|
jens@2
|
39 |
|
|
jens@2
|
40 |
<ul>
|
|
jens@2
|
41 |
<li><a href="http://mooseyard.com/hg/hgwebdir.cgi/MYNetwork/archive/tip.zip">Download the current source code</a>
|
|
jens@2
|
42 |
<li>To check out the source code using <a href="http://selenic.com/mercurial">Mercurial</a>:
|
|
jens@2
|
43 |
\verbatim hg clone http://mooseyard.com/hg/hgwebdir.cgi/MYNetwork/ MYNetwork \endverbatim
|
|
jens@2
|
44 |
</ul>
|
|
jens@2
|
45 |
|
|
jens@2
|
46 |
Or if you're just looking:
|
|
jens@2
|
47 |
|
|
jens@2
|
48 |
<ul>
|
|
jens@2
|
49 |
<li><a href="http://mooseyard.com/hg/hgwebdir.cgi/MYNetwork/file/tip">Browse the source code</a>
|
|
jens@2
|
50 |
<li><a href="annotated.html">Browse the class documentation</a>
|
|
jens@2
|
51 |
</ul>
|
|
jens@2
|
52 |
|
|
jens@2
|
53 |
*/
|