com.aylanetworks.aylasdk.lan

Class AylaLanRequest

java.lang.Object

com.android.volley.Request<T>

com.aylanetworks.aylasdk.AylaAPIRequest<AylaLanRequest.LanResponse>

com.aylanetworks.aylasdk.lan.AylaLanRequest

All Implemented Interfaces:

java.lang.Comparable<com.android.volley.Request<AylaLanRequest.LanResponse>>

public class AylaLanRequest
extends AylaAPIRequest<AylaLanRequest.LanResponse>

Request objects for LAN operations. An AylaLanRequest contains a list of AylaLanCommands intended to be processed as a single operation.

All AylaLanRequest objects return a LanResponse, which contains the list of completed commands that either have a response or an error returned. Each command holds its own response or error.

When this request is processed in a queue that was initialized with an AylaLocalNetwork object, it will process each LAN command in order and gather the results. Even if each LAN command fails, the AylaLanRequest can still succeed, though each LanCommand contained within the request object will contain an error.

The AylaLanRequest itself can fail if the device is not found or the LAN session is not running at the time the request is sent out.

Generally, this request type is used internally and the results collated into a different type of response for an API. See AylaDevice.fetchPropertiesLAN(String[], Response.Listener, ErrorListener) for an example of this.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AylaLanRequest.LanResponse

Nested classes/interfaces inherited from class com.aylanetworks.aylasdk.AylaAPIRequest

AylaAPIRequest.EmptyResponse

Nested classes/interfaces inherited from class com.android.volley.Request

com.android.volley.Request.Method, com.android.volley.Request.Priority

Field Summary

Fields inherited from class com.aylanetworks.aylasdk.AylaAPIRequest

__customUserAgent, _additionalHeaders, _chainedRequest, _clazz, _errorListener, _logResponse, _networkResponse, _networkResponseTimestamp, _responseHeaders, _sessionManagerRef, _successListener

Constructor Summary

Constructors

Constructor and Description
AylaLanRequest(AylaDevice device, LanCommand lanCommand, AylaSessionManager sessionManager, com.android.volley.Response.Listener<AylaLanRequest.LanResponse> successListener, ErrorListener errorListener) Constructor taking in a single LanCommand
AylaLanRequest(AylaDevice device, java.util.List<LanCommand> lanCommands, AylaSessionManager sessionManager, com.android.volley.Response.Listener<AylaLanRequest.LanResponse> successListener, ErrorListener errorListener) Constructor

Method Summary

Modifier and Type	Method and Description
AylaDevice	getDevice()
java.util.List<LanCommand>	getLanCommands()
protected com.android.volley.Response<AylaLanRequest.LanResponse>	parseNetworkResponse(com.android.volley.NetworkResponse response)

Methods inherited from class com.aylanetworks.aylasdk.AylaAPIRequest

cancel, deliverResponse, dummyRequest, getGson, getHeaders, getLogTag, getNetworkResponse, getNetworkResponseTimestamp, getNetworkTimeMs, getRequestErrorListener, getSuccessListener, logResponse, parseNetworkError, setChainedRequest, setUserAgent

Methods inherited from class com.android.volley.Request

addMarker, compareTo, deliverError, getBody, getBodyContentType, getCacheEntry, getCacheKey, getErrorListener, getMethod, getParams, getParamsEncoding, getPostBody, getPostBodyContentType, getPostParams, getPostParamsEncoding, getPriority, getRetryPolicy, getSequence, getTag, getTimeoutMs, getTrafficStatsTag, getUrl, hasHadResponseDelivered, isCanceled, markDelivered, setCacheEntry, setRequestQueue, setRetryPolicy, setSequence, setShouldCache, setShouldRetryServerErrors, setTag, shouldCache, shouldRetryServerErrors, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AylaLanRequest

public AylaLanRequest(AylaDevice device,
                      java.util.List<LanCommand> lanCommands,
                      AylaSessionManager sessionManager,
                      com.android.volley.Response.Listener<AylaLanRequest.LanResponse> successListener,
                      ErrorListener errorListener)

Constructor

Parameters:

device - AylaDevice this request is meant for

lanCommands - List of commands that compose this request

sessionManager - The AylaSessionManager that owns our device

successListener - Listener to receive the results of a successful operation

errorListener - Listener to receive errors in case of failure

AylaLanRequest

public AylaLanRequest(AylaDevice device,
                      LanCommand lanCommand,
                      AylaSessionManager sessionManager,
                      com.android.volley.Response.Listener<AylaLanRequest.LanResponse> successListener,
                      ErrorListener errorListener)

Constructor taking in a single LanCommand

Parameters:

device - AylaDevice this request is meant for

lanCommand - Single command that composes this request

sessionManager - The AylaSessionManager that owns our device

successListener - Listener to receive the results of a successful operation

errorListener - Listener to receive errors in case of failure

Method Detail

getLanCommands

public java.util.List<LanCommand> getLanCommands()

getDevice

public AylaDevice getDevice()

parseNetworkResponse

protected com.android.volley.Response<AylaLanRequest.LanResponse> parseNetworkResponse(com.android.volley.NetworkResponse response)

Overrides:

parseNetworkResponse in class AylaAPIRequest<AylaLanRequest.LanResponse>