Main Page

From Auspice
Jump to: navigation, search

This wiki contains information to help developers who want to use Auspice and the GNS in their projects.

See the GNS Overview for a brief description of what the GNS is and a definition of a few terms.

For technical support questions or comments use the email support@gns.name.

Example Code

There are also some example Java classes in the edu.umass.cs.gnsclient.examples package in the source code of the GNS. You can find instructions for one of them, the ClientExample.java class, on the Client Example page. There are other examples in that code package and you can use any of them as a good starting point for coding using a GNS Client and Server as well as a way to test if a server you are running yourself is working.

Getting Started / Tutorials

There are currently a few different tutorial pages on this wiki and also some example code in the GNS Client to help you get started with the GNS. They vary in the amount of programming you need to do and understand and the intensity level of their use of the GNS.

Tutorials

  1. The Simple Source Tutorial shows you how to clone or fork the source from github, compile the GNS from sources, run a single or three node GNS server on your local host and connect to it using a command line interface. It also has instructions for running a comprehensive junit test.
  2. The Java Programming Tutorial page guides you through a simple programming exercise using the GNS Java Client. It will run you through one page of Java code that replicates some of the information in the other tutorials but in a Java programming context.
  3. The IOS Programming Tutorial page shows you the sample iOS app which uses the GNSClientKit framework for iOS.
  4. The Getting Started with the GNS CLI page. This guides you through an exercise of creating your first guid and using it to read and write some basic information in the GNS. It uses and explains the GNS Command Line Interface (CLI).
  5. The final tutorial goes into more depth using the GNS Java Client to build a simulation called the Friendly Walkers App. It builds a set of simulated GNS-based mobile clients discovering other clients and sending messages using GNS geo-location operations.


Client Javadoc

The Javadoc for the client is located at the Javadoc for the GNSClient

Running a GNS Service

You have a few options for installing and running a GNS Service:

  1. For testing it is often useful to run a GNS service on a single machine. Instructions for running a minimal single node system are on the Deploying a Single Instance GNS Server page.
  2. Instructions for running 3 nodes on a single machine are on the 3_Nodes_Local page.
  3. Instructions for installing and running a GNS Service on a distributed set of machines is on the Distributed_Install page.

GNS Specification

For folks trying to understand the GNS from the standpoint of modifying or developing new components the GNS Specification is a good place to start.

GNS Category Pages AKA Table of Contents Pages

  • GNS Developers will be interested in the Category:Developer page.
  • GNS Administrators will be interested in the Category:Admin page.
  • The set of pages containing a design specification of the GNS is on the Category:GNSSpec page.
  • For an indexed list of all GNS related pages see the Category:GNS page.

Other Links

Keypairs - public / private keys and their use in the GNS

MSocket User Documentation - User Documentation for MSocket

If you're curious what servers are serving what read the Sites_Map.