JACK 5.4 Application Interface

aos.dci
Class Portal

java.lang.Object
  extended byaos.dci.Portal

public abstract class Portal
extends java.lang.Object

This is the base class for all portals. In general it's methods should not be used directly. Instead, use the methods described in the Dci utility class.


Constructor Summary
Portal()
           
 
Method Summary
 boolean getAllowAutoConnect()
          Return whether automatic connections are allowed.
 boolean getAllowIncomingConnect()
          Return whether incoming connections are allowed.
 java.lang.String getName()
          Get the name of this portal.
static java.lang.String knownAddressablesString()
          Return a list of all registered 'Addressable' objects for all portals in the process.
static int numPortals()
          Return the number of portals in the process (currently there can be only one).
 int numRoutes()
          Get the number of connected routes.
static java.lang.String pingStatusString(int status)
          Convert ping status code into human readable message.
 void setAllowAutoConnect(boolean val)
          Set whether automatic connections are allowed.
 void setAllowIncomingConnect(boolean val)
          Set whether incoming connections are allowed.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Portal

public Portal()
Method Detail

pingStatusString

public static java.lang.String pingStatusString(int status)
Convert ping status code into human readable message.

Parameters:
status - an int value holding the ping status code.
Returns:
a String value holding the human readable message.

numPortals

public static int numPortals()
Return the number of portals in the process (currently there can be only one).


getName

public java.lang.String getName()
Get the name of this portal.

Returns:
a String value holding the name of the portal.

numRoutes

public int numRoutes()
Get the number of connected routes.

Returns:
an int value holding the number of connected routes.

getAllowIncomingConnect

public boolean getAllowIncomingConnect()
Return whether incoming connections are allowed.


setAllowIncomingConnect

public void setAllowIncomingConnect(boolean val)
Set whether incoming connections are allowed.


getAllowAutoConnect

public boolean getAllowAutoConnect()
Return whether automatic connections are allowed.


setAllowAutoConnect

public void setAllowAutoConnect(boolean val)
Set whether automatic connections are allowed.


knownAddressablesString

public static java.lang.String knownAddressablesString()
Return a list of all registered 'Addressable' objects for all portals in the process.

Returns:
a String value holding the list of addressesable separated by the ':' character.

JACK 5.4 Application Interface

Copyright (C) 1999-2008, Agent Oriented Software Pty. Ltd.

US Government Restricted Rights
The JACK Modules and relevant Software Material have been developed entirely at private expense and are accordingly provided with RESTRICTED RIGHTS. Use, duplication, or disclosure by Government is subject to restrictions as set forth in subparagraph (c)(1)(ii) of DFARS 252.227-7013 or subparagraph (c)(1) and (2) of the Commercial Computer Software Restricted Rights and 48 CFR 52.2270-19, as applicable.


Agent Oriented Software Pty. Ltd.     http://www.aosgrp.com
PO Box 639, Carlton South, Victoria 3053, Australia
Phone: +61 3 9349 5055, Fax: +61 3 9349 5088