SHOW Signed

net.rim.device.api.io.http
Class TCPPushInputStream

java.lang.Object
  |
  +--java.io.InputStream
        |
        +--java.io.DataInputStream
              |
              +--net.rim.device.api.io.http.PushInputStream
                    |
                    +--net.rim.device.api.io.http.TCPPushInputStream
All Implemented Interfaces:
DataInput

public final class TCPPushInputStream
extends PushInputStream

A push input stream specifically for use with TCP/IP connections.

Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

Since:
JDE 4.0.2

Fields inherited from class net.rim.device.api.io.http.PushInputStream
CONNECTION_IPPP_UID, CONNECTION_IPV4, CONNECTION_SMSC, DECLINE_REASON_USERDCR, DECLINE_REASON_USERDCU, DECLINE_REASON_USERPND, DECLINE_REASON_USERRFS
 
Fields inherited from class java.io.DataInputStream
in
 
Constructor Summary
 Category: Signed TCPPushInputStream(HttpServerConnection connection, InputStream in)
          Creates a new TCPPushInputStream instance from a connection.
 
Method Summary
 Category: Signed  void accept()
          Accepts this push.
 Category: Signed  void decline(int reasonCode)
          Declines this push because of the reason provided.
 Category: Signed  int getConnectionType()
          Retrieves the connection type for this push.
 Category: Signed  String getSource()
          Retrieves the source for this push stream.
 Category: Signed  boolean isChannelEncrypted()
          Returns if the channel is encrypted.
 Category: Signed  void setDoWAPResponse(boolean value)
          Sets whether or not to do WAP Push Status response.
 
Methods inherited from class java.io.DataInputStream
available, close, mark, markSupported, read, read, read, readBoolean, readByte, readChar, readDouble, readFloat, readFully, readFully, readInt, readLong, readShort, readUnsignedByte, readUnsignedShort, readUTF, readUTF, reset, skip, skipBytes
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TCPPushInputStream

public TCPPushInputStream(HttpServerConnection connection,
                          InputStream in)
Creates a new TCPPushInputStream instance from a connection.
Parameters:
connection - HttpServerConnection received from the invocation of HttpServerSocketConnectionBase.acceptAndOpen().
in - Input stream associated with the server connection.
Since:
JDE 4.0.2
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.
Method Detail

getSource

public String getSource()
Retrieves the source for this push stream.
Overrides:
getSource in class PushInputStream
Returns:
String form of the source of this push; it could be a UID for a connection, IPv4 address, or SMSC.
Since:
JDE 4.0.2
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getConnectionType

public int getConnectionType()
Retrieves the connection type for this push.
Overrides:
getConnectionType in class PushInputStream
Returns:
PushInputStream.CONNECTION_IPPP_UID.
Since:
JDE 4.0.2
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

decline

public void decline(int reasonCode)
             throws IOException
Declines this push because of the reason provided.
Overrides:
decline in class PushInputStream
Parameters:
reasonCode - Code for the reason why the push was declined.
Since:
JDE 4.0.2
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

accept

public void accept()
            throws IOException
Accepts this push.

Indicates the push acceptance to the server if the bearer supports acknowledgement.

Overrides:
accept in class PushInputStream
Since:
JDE 4.0.2
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

isChannelEncrypted

public boolean isChannelEncrypted()
Returns if the channel is encrypted.
Overrides:
isChannelEncrypted in class PushInputStream
Returns:
Returns false, TLS/SSL currently not supported.
Since:
JDE 4.0.2
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

setDoWAPResponse

public void setDoWAPResponse(boolean value)
Sets whether or not to do WAP Push Status response.
Parameters:
value - Whether or not to send the WAP Push Status response.
Since:
JDE 4.0.2
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.


Copyright 1999-2004 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Copyright 1993-2003 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.