public final class UdpDataSource extends Object implements DataSource
DataSource
.Modifier and Type | Class and Description |
---|---|
static class |
UdpDataSource.UdpDataSourceException
Thrown when an error is encountered when trying to read from a
UdpDataSource . |
DataSource.Factory
Modifier and Type | Field and Description |
---|---|
static int |
DEAFULT_SOCKET_TIMEOUT_MILLIS
The default socket timeout, in milliseconds.
|
static int |
DEFAULT_MAX_PACKET_SIZE
The default maximum datagram packet size, in bytes.
|
Constructor and Description |
---|
UdpDataSource(TransferListener<? super UdpDataSource> listener) |
UdpDataSource(TransferListener<? super UdpDataSource> listener,
int maxPacketSize) |
UdpDataSource(TransferListener<? super UdpDataSource> listener,
int maxPacketSize,
int socketTimeoutMillis) |
Modifier and Type | Method and Description |
---|---|
void |
close()
Closes the source.
|
Uri |
getUri()
When the source is open, returns the
Uri from which data is being read. |
long |
open(DataSpec dataSpec)
Opens the source to read the specified data.
|
int |
read(byte[] buffer,
int offset,
int readLength)
Reads up to
length bytes of data and stores them into buffer , starting at
index offset . |
public static final int DEFAULT_MAX_PACKET_SIZE
public static final int DEAFULT_SOCKET_TIMEOUT_MILLIS
public UdpDataSource(TransferListener<? super UdpDataSource> listener)
listener
- An optional listener.public UdpDataSource(TransferListener<? super UdpDataSource> listener, int maxPacketSize)
listener
- An optional listener.maxPacketSize
- The maximum datagram packet size, in bytes.public UdpDataSource(TransferListener<? super UdpDataSource> listener, int maxPacketSize, int socketTimeoutMillis)
listener
- An optional listener.maxPacketSize
- The maximum datagram packet size, in bytes.socketTimeoutMillis
- The socket timeout in milliseconds. A timeout of zero is interpreted
as an infinite timeout.public long open(DataSpec dataSpec) throws UdpDataSource.UdpDataSourceException
DataSource
Note: If an IOException
is thrown, callers must still call DataSource.close()
to ensure
that any partial effects of the invocation are cleaned up.
open
in interface DataSource
dataSpec
- Defines the data to be read.DataSpec.length
equals C.LENGTH_UNSET
) this value
is the resolved length of the request, or C.LENGTH_UNSET
if the length is still
unresolved. For all other requests, the value returned will be equal to the request's
DataSpec.length
.UdpDataSource.UdpDataSourceException
public int read(byte[] buffer, int offset, int readLength) throws UdpDataSource.UdpDataSourceException
DataSource
length
bytes of data and stores them into buffer
, starting at
index offset
.
If length
is zero then 0 is returned. Otherwise, if no data is available because the
end of the opened range has been reached, then C.RESULT_END_OF_INPUT
is returned.
Otherwise, the call will block until at least one byte of data has been read and the number of
bytes read is returned.
read
in interface DataSource
buffer
- The buffer into which the read data should be stored.offset
- The start offset into buffer
at which data should be written.readLength
- The maximum number of bytes to read.C.RESULT_END_OF_INPUT
if no data is avaliable
because the end of the opened range has been reached.UdpDataSource.UdpDataSourceException
public Uri getUri()
DataSource
Uri
from which data is being read. The returned
Uri
will be identical to the one passed DataSource.open(DataSpec)
in the DataSpec
unless redirection has occurred. If redirection has occurred, the Uri
after redirection
is returned.getUri
in interface DataSource
Uri
from which data is being read, or null if the source is not open.public void close()
DataSource
Note: This method must be called even if the corresponding call to DataSource.open(DataSpec)
threw an IOException
. See DataSource.open(DataSpec)
for more details.
close
in interface DataSource