• BlackBerry Dynamics
  • Runtime library for Android applications
  • 12.0.1.79
HttpServerConnection Interface Reference

An HTTP connection for use on the server side. More...

Inheritance diagram for HttpServerConnection:
HttpConnection

Description

Requests are received, responses are sent.

Author
Oleg Kalnichevski
Version
Revision
542199
Since
4.0

Notice

The following notice applies to the original API on which this API is based, and to its documentation. The documentation of this API has been revised from the original.

/*
 * Copyright (C) 2006 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

Public Member Functions

HttpRequest receiveRequestHeader () throws HttpException, IOException
 Receives the request line and all headers available from this connection. More...
 
void receiveRequestEntity (HttpEntityEnclosingRequest request) throws HttpException, IOException
 Receives the next request entity available from this connection and attaches it to an existing request. More...
 
void sendResponseHeader (HttpResponse response) throws HttpException, IOException
 Sends the response line and headers of a response over this connection. More...
 
void sendResponseEntity (HttpResponse response) throws HttpException, IOException
 Sends the response entity of a response over this connection. More...
 
void flush () throws IOException
 Sends all pending buffered data over this connection. More...
 
- Public Member Functions inherited from HttpConnection
void close () throws IOException
 Closes this connection gracefully. More...
 
boolean isOpen ()
 Checks if this connection is open. More...
 
boolean isStale ()
 Checks whether this connection has gone down. More...
 
void setSocketTimeout (int timeout)
 Sets the socket timeout value. More...
 
int getSocketTimeout ()
 Returns the socket timeout value. More...
 
void shutdown () throws IOException
 Force-closes this connection. More...
 
HttpConnectionMetrics getMetrics ()
 Returns a collection of connection metrcis. More...
 

Member Function Documentation

◆ receiveRequestHeader()

HttpRequest receiveRequestHeader ( ) throws HttpException, IOException

The caller should examine the returned request and decide if to receive a request entity as well.

Returns
a new HttpRequest object whose request line and headers are initialized.
Exceptions
HttpException
IOException

◆ receiveRequestEntity()

void receiveRequestEntity ( HttpEntityEnclosingRequest  request) throws HttpException, IOException
Parameters
requestthe request to attach the entity to.
Exceptions
HttpException
IOException

◆ sendResponseHeader()

void sendResponseHeader ( HttpResponse  response) throws HttpException, IOException
Parameters
responsethe response whose headers to send.
Exceptions
HttpException
IOException

◆ sendResponseEntity()

void sendResponseEntity ( HttpResponse  response) throws HttpException, IOException
Parameters
responsethe response whose entity to send.
Exceptions
HttpException
IOException

◆ flush()

void flush ( ) throws IOException
Exceptions
IOException