NetworkManager (Codename One API)

java.lang.Object
- com.codename1.io.NetworkManager

```
public class NetworkManager
extends Object
```
Main entry point for managing the connection requests, this is essentially a threaded queue that makes sure to route all connections via the network thread while sending the callbacks through the Codename One EDT.

The sample code below fetches a page of data from the nestoria housing listing API.
You can see instructions on how to display the data in the InfiniteScrollAdapter class. You can read more about networking in Codename One here

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ACCESS_POINT_TYPE_CABLE` Indicates an access point based on a cable
`static int`	`ACCESS_POINT_TYPE_CORPORATE` Indicates a corporate routing server access point type (e.g.
`static int`	`ACCESS_POINT_TYPE_NETWORK2G` Indicates a 2g network access point type
`static int`	`ACCESS_POINT_TYPE_NETWORK3G` Indicates a 3g network access point type
`static int`	`ACCESS_POINT_TYPE_UNKNOWN` Indicates an unknown access point type
`static int`	`ACCESS_POINT_TYPE_WLAN` Indicates a wlan (802.11b/c/g/n) access point type

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addDefaultHeader(String key, String value)` Adds a header to the global default headers, this header will be implicitly added to all requests going out from this point onwards.
`void`	`addErrorListener(ActionListener<NetworkEvent> e)` Adds a generic listener to a network error that is invoked before the exception is propagated.
`void`	`addProgressListener(ActionListener<NetworkEvent> al)` Adds a listener to be notified when progress updates
`void`	`addToQueue(ConnectionRequest request)` Adds the given network connection to the queue of execution
`void`	`addToQueueAndWait(ConnectionRequest request)` Identical to add to queue but waits until the request is processed in the queue, this is useful for completely synchronous operations.
`AsyncResource<ConnectionRequest>`	`addToQueueAsync(ConnectionRequest request)` Identical to add to queue but returns an AsyncResource object that will resolve to the ConnectionRequest.
`void`	`assignToThread(Class requestType, int offset)` Makes sure the given class (subclass of ConnectionRequest) is always assigned to the given thread number.
`Enumeration`	`enumurateQueue()` This method returns all pending ConnectioRequest connections.
`String[]`	`getAPIds()` Returns the ids of the access points available if supported
`String`	`getAPName(String id)` Returns the user displayable name for the given access point
`int`	`getAPType(String id)` Returns the type of the access point
`static String`	`getAutoDetectURL()` This URL is used to check whether an Internet connection is available
`String`	`getCurrentAccessPoint()` Returns the id of the current access point
`static NetworkManager`	`getInstance()` Returns the singleton instance of this class
`int`	`getThreadCount()` The number of threads
`int`	`getTimeout()` Returns the timeout duration
`boolean`	`isAPSupported()` Indicates whether looking up an access point is supported by this device
`boolean`	`isQueueIdle()` Indicates that the network queue is idle
`void`	`killAndWait(ConnectionRequest request)` Kills the given request and waits until the request is killed if it is being processed by one of the threads.
`void`	`removeErrorListener(ActionListener<NetworkEvent> e)` Removes the given error listener
`void`	`removeProgressListener(ActionListener<NetworkEvent> al)` Adds a listener to be notified when progress updates
`static void`	`setAutoDetectURL(String aAutoDetectURL)` This URL is used to check whether an Internet connection is available
`void`	`setCurrentAccessPoint(String id)` Returns the id of the current access point
`void`	`setThreadCount(int threadCount)` Deprecated. since the network is always running in Codename One this method is quite confusing unfortunately fixing it will probably break working code. You should migrate the code to use `updateThreadCount(int)`
`void`	`setTimeout(int t)` Sets the timeout in milliseconds for network connections, a timeout may be "faked" for platforms that don't support the notion of a timeout such as MIDP
`void`	`shutdown()` Deprecated. This method is for internal use only
`void`	`shutdownSync()` Shuts down the network thread and waits for shutdown to complete
`void`	`start()` There is no need to invoke this method since the network manager is started implicitly.
`void`	`updateThreadCount(int threadCount)` Sets the number of network threads and restarts the network threads

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ACCESS_POINT_TYPE_UNKNOWN
```
public static final int ACCESS_POINT_TYPE_UNKNOWN
```
    Indicates an unknown access point type
    
    See Also:
    
    Constant Field Values
  - ACCESS_POINT_TYPE_WLAN
```
public static final int ACCESS_POINT_TYPE_WLAN
```
    Indicates a wlan (802.11b/c/g/n) access point type
    
    See Also:
    
    Constant Field Values
  - ACCESS_POINT_TYPE_CABLE
```
public static final int ACCESS_POINT_TYPE_CABLE
```
    Indicates an access point based on a cable
    
    See Also:
    
    Constant Field Values
  - ACCESS_POINT_TYPE_NETWORK3G
```
public static final int ACCESS_POINT_TYPE_NETWORK3G
```
    Indicates a 3g network access point type
    
    See Also:
    
    Constant Field Values
  - ACCESS_POINT_TYPE_NETWORK2G
```
public static final int ACCESS_POINT_TYPE_NETWORK2G
```
    Indicates a 2g network access point type
    
    See Also:
    
    Constant Field Values
  - ACCESS_POINT_TYPE_CORPORATE
```
public static final int ACCESS_POINT_TYPE_CORPORATE
```
    Indicates a corporate routing server access point type (e.g. BIS etc.)
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getAutoDetectURL
```
public static String getAutoDetectURL()
```
    This URL is used to check whether an Internet connection is available
    
    Returns:
    
    the autoDetectURL
  - setAutoDetectURL
```
public static void setAutoDetectURL(String aAutoDetectURL)
```
    This URL is used to check whether an Internet connection is available
    
    Parameters:
    
    aAutoDetectURL - the autoDetectURL to set
  - getThreadCount
```
public int getThreadCount()
```
    The number of threads
    
    Returns:
    
    the threadCount
  - setThreadCount
```
public void setThreadCount(int threadCount)
```
    Deprecated. since the network is always running in Codename One this method is quite confusing unfortunately fixing it will probably break working code. You should migrate the code to use updateThreadCount(int)
    
    Thread count should never be changed when the network is running since it will have no effect. Increasing the thread count can bring many race conditions and problems to the surface, furthermore MIDP doesn't require support for more than one network thread hence increasing the thread count might fail.
    
    Parameters:
    
    threadCount - the threadCount to set
  - updateThreadCount
```
public void updateThreadCount(int threadCount)
```
    Sets the number of network threads and restarts the network threads
    
    Parameters:
    
    threadCount - the new number of threads
  - start
```
public void start()
```
    There is no need to invoke this method since the network manager is started implicitly. It is useful only if you explicitly stop the network manager. Invoking this method otherwise will just do nothing.
  - shutdown
```
public void shutdown()
```
    Deprecated. This method is for internal use only
    
    Shuts down the network thread, this will trigger failures if you have network requests
  - shutdownSync
```
public void shutdownSync()
```
    Shuts down the network thread and waits for shutdown to complete
  - getInstance
```
public static NetworkManager getInstance()
```
    Returns the singleton instance of this class
    
    Returns:
    
    instance of this class
  - addDefaultHeader
```
public void addDefaultHeader(String key,
                             String value)
```
    Adds a header to the global default headers, this header will be implicitly added to all requests going out from this point onwards. The main use case for this is for authentication information communication via the header.
    
    Parameters:
    
    key - the key of the header
    
    value - the value of the header
  - addToQueueAsync
```
public AsyncResource<ConnectionRequest> addToQueueAsync(ConnectionRequest request)
```
    Identical to add to queue but returns an AsyncResource object that will resolve to the ConnectionRequest.
    
    Parameters:
    
    request - the request object to add.
    
    Returns:
    
    AsyncResource resolving to the connection request on complete.
    
    Since:
    
    7.0
  - addToQueueAndWait
```
public void addToQueueAndWait(ConnectionRequest request)
```
    Identical to add to queue but waits until the request is processed in the queue, this is useful for completely synchronous operations.
    
    Parameters:
    
    request - the request object to add
  - addToQueue
```
public void addToQueue(ConnectionRequest request)
```
    Adds the given network connection to the queue of execution
    
    Parameters:
    
    request - network request for execution
  - killAndWait
```
public void killAndWait(ConnectionRequest request)
```
    Kills the given request and waits until the request is killed if it is being processed by one of the threads. This method must not be invoked from a network thread!
    
    Parameters:
    
    request -
  - setTimeout
```
public void setTimeout(int t)
```
    Sets the timeout in milliseconds for network connections, a timeout may be "faked" for platforms that don't support the notion of a timeout such as MIDP
    
    Parameters:
    
    t - the timeout duration
  - getTimeout
```
public int getTimeout()
```
    Returns the timeout duration
    
    Returns:
    
    timeout in milliseconds
  - addErrorListener
```
public void addErrorListener(ActionListener<NetworkEvent> e)
```
    Adds a generic listener to a network error that is invoked before the exception is propagated. Note that this handles also server error codes by default! You can change this default behavior setting to false ConnectionRequest.setHandleErrorCodesInGlobalErrorHandler(boolean). Consume the event in order to prevent it from propagating further.
    
    Parameters:
    
    e - callback will be invoked with the Exception as the source object
  - removeErrorListener
```
public void removeErrorListener(ActionListener<NetworkEvent> e)
```
    Removes the given error listener
    
    Parameters:
    
    e - callback to remove
  - addProgressListener
```
public void addProgressListener(ActionListener<NetworkEvent> al)
```
    Adds a listener to be notified when progress updates
    
    Parameters:
    
    al - action listener
  - removeProgressListener
```
public void removeProgressListener(ActionListener<NetworkEvent> al)
```
    Adds a listener to be notified when progress updates
    
    Parameters:
    
    al - action listener
  - assignToThread
```
public void assignToThread(Class requestType,
                           int offset)
```
    Makes sure the given class (subclass of ConnectionRequest) is always assigned to the given thread number. This is useful for a case of an application that wants all background downloads to occur on one thread so it doesn't tie up the main network thread (but doesn't stop like a low priority request would).
    
    Parameters:
    
    requestType - the class of the specific connection request
    
    offset - the offset of the thread starting from 0 and smaller than thread count
  - enumurateQueue
```
public Enumeration enumurateQueue()
```
    This method returns all pending ConnectioRequest connections.
    
    Returns:
    
    the queue elements
  - isQueueIdle
```
public boolean isQueueIdle()
```
    Indicates that the network queue is idle
    
    Returns:
    
    true if no network activity is in progress or pending
  - isAPSupported
```
public boolean isAPSupported()
```
    Indicates whether looking up an access point is supported by this device
    
    Returns:
    
    true if access point lookup is supported
  - getAPIds
```
public String[] getAPIds()
```
    Returns the ids of the access points available if supported
    
    Returns:
    
    ids of access points
  - getAPType
```
public int getAPType(String id)
```
    Returns the type of the access point
    
    Parameters:
    
    id - access point id
    
    Returns:
    
    one of the supported access point types from network manager
  - getAPName
```
public String getAPName(String id)
```
    Returns the user displayable name for the given access point
    
    Parameters:
    
    id - the id of the access point
    
    Returns:
    
    the name of the access point
  - getCurrentAccessPoint
```
public String getCurrentAccessPoint()
```
    Returns the id of the current access point
    
    Returns:
    
    id of the current access point
  - setCurrentAccessPoint
```
public void setCurrentAccessPoint(String id)
```
    Returns the id of the current access point
    
    Parameters:
    
    id - id of the current access point

Class NetworkManager

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ACCESS_POINT_TYPE_UNKNOWN

ACCESS_POINT_TYPE_WLAN

ACCESS_POINT_TYPE_CABLE

ACCESS_POINT_TYPE_NETWORK3G

ACCESS_POINT_TYPE_NETWORK2G

ACCESS_POINT_TYPE_CORPORATE

Method Detail

getAutoDetectURL

setAutoDetectURL

getThreadCount

setThreadCount

updateThreadCount

start

shutdown

shutdownSync

getInstance

addDefaultHeader

addToQueueAsync

addToQueueAndWait

addToQueue

killAndWait

setTimeout

getTimeout

addErrorListener

removeErrorListener

addProgressListener

removeProgressListener

assignToThread

enumurateQueue

isQueueIdle

isAPSupported

getAPIds

getAPType

getAPName

getCurrentAccessPoint

setCurrentAccessPoint