Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
daneren2005 committed Feb 22, 2014
1 parent 563794b commit 1fab7a8
Showing 1 changed file with 19 additions and 7 deletions.
26 changes: 19 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,22 @@ ServerProxy

ServerProxy is a Android library to provide easy to use classes to create a local server proxies. The following classes exist:

ServerProxy: abstract class which creates a socket and has methods to get a url to reference it.
-start: Start the proxy listening for requests
-stop: Stop the proxy listening for requests
-getPrivateAddress: Get a local url good for being passed internally to another application on the same device
-getPublicAddress: Get a url good for being passed to another device on the same LAN
FileProxy: Streams whichever file is referenced in the url. Can handle multiple concurrent streams
BufferProxy: Streams a file which is being concurrently downloaded. Takes a BufferProgress object to determine when the file is finished downloading. This is useful for serving a song to a MediaPlayer which is still being downloaded. Can only handle one at a time.
**ServerProxy**: abstract class which creates a socket and has methods to get a url to reference it.
- start: Start the proxy listening for requests
- stop: Stop the proxy listening for requests
- getPrivateAddress: Get a local url good for being passed internally to another application on the same device
- getPublicAddress: Get a url good for being passed to another device on the same LAN

**FileProxy**: Streams whichever file is referenced in the url. Can handle partial requests.

**BufferProxy**: Streams a file which is being concurrently downloaded. Takes a BufferProgress object to determine when the file is finished downloading. This is useful for serving a song to a MediaPlayer which is still being downloaded. Can only handle one at a time.
- setBufferFile: Set the buffer file which is used to query for the state of the download


**BufferFile**: Interface to be implemented, which is queried to get various information about the file being downloaded
- getFile: Return the file which is being buffered
- getContentLength: The content length which is passed as a header. ONLY set if you absolutely know for certain the end size of the file
- getEstimatedSize: The guessed size of the file. It is used to keep track of how much more data needs to be processed. It should be relatively close.
- isWorkDone: Whether or not the file is done being downloaded
- onStart: called when the streaming starts
- onStop: called when the streaming is done

0 comments on commit 1fab7a8

Please sign in to comment.