ball.upnp.ant.taskdefs

Class SSDPTask

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.Task

ball.upnp.ant.taskdefs.SSDPTask

All Implemented Interfaces:

SSDPDiscoveryService.Listener, AnnotatedAntTask, AntTaskLogMethods, AntTaskMixIn, ClasspathDelegateAntTask, ConfigurableAntTask, Cloneable

Direct Known Subclasses:

SSDPTask.Discover, SSDPTask.Listen, SSDPTask.MSearch

public abstract class SSDPTask
extends Task
implements AnnotatedAntTask, ClasspathDelegateAntTask, ConfigurableAntTask, SSDPDiscoveryService.Listener

Abstract Ant Task base class for SSDP tasks.

<SSDPTask classname="String" classpathref="Reference" description="String" product="String" taskname="String">
  <classpath .../>
</SSDPTask>

Version:

$Revision: 7215 $

Author:

Allen D. Ball

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SSDPTask.Discover Ant Task to run SSDP discovery.
static class	SSDPTask.Listen Ant Task listen on the SSDP UDP port.
static class	SSDPTask.MSearch Ant Task to send an M-SEARCH command and then listen on the SSDP UDP port.

Field Summary

Fields inherited from class org.apache.tools.ant.Task

target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

description, location, project

Constructor Summary

Constructors

Constructor and Description
SSDPTask()

Method Summary

Modifier and Type	Method and Description
void	execute() Default implementation for Task subclasses.
void	init() Default implementation for Task subclasses.
void	receiveEvent(SSDPDiscoveryService service, DatagramSocket socket, SSDPMessage message) Callback made after receiving a SSDPMessage.
void	register(SSDPDiscoveryService service) Callback when a SSDPDiscoveryService.Listener is added to a SSDPDiscoveryService.
void	sendEvent(SSDPDiscoveryService service, DatagramSocket socket, SSDPMessage message) Callback made just before sending a SSDPMessage.
void	unregister(SSDPDiscoveryService service) Callback when a SSDPDiscoveryService.Listener is removed from a SSDPDiscoveryService.

Methods inherited from class org.apache.tools.ant.Task

bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent

clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject

Methods inherited from class java.lang.Object

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

Methods inherited from interface ball.util.ant.taskdefs.AnnotatedAntTask

getAntTaskName

Methods inherited from interface ball.util.ant.taskdefs.AntTaskLogMethods

log, log, log, log, log, log, log, log, log, log, log

Methods inherited from interface ball.util.ant.taskdefs.ClasspathDelegateAntTask

createClasspath, delegate, delegate, getClassForName, getClassLoader, setClassname, setClasspathref

Methods inherited from interface ball.util.ant.taskdefs.ConfigurableAntTask

configure

Constructor Detail

SSDPTask

public SSDPTask()

Method Detail

init

public void init()
          throws BuildException

Description copied from interface: ClasspathDelegateAntTask

Default implementation for Task subclasses.

Specified by:

init in interface ClasspathDelegateAntTask

Specified by:

init in interface ConfigurableAntTask

Overrides:

init in class Task

Throws:

BuildException

execute

public void execute()
             throws BuildException

Description copied from interface: AnnotatedAntTask

Default implementation for Task subclasses. Check attributes annotated with AntTaskAttributeConstraint. See AnnotatedAntTaskConfigurationChecker.

Specified by:

execute in interface AnnotatedAntTask

Overrides:

execute in class Task

Throws:

BuildException - If a AntTaskAttributeConstraint.Checker fails.

register

public void register(SSDPDiscoveryService service)

Description copied from interface: SSDPDiscoveryService.Listener

Callback when a SSDPDiscoveryService.Listener is added to a SSDPDiscoveryService.

Specified by:

register in interface SSDPDiscoveryService.Listener

Parameters:

service - The SSDPDiscoveryService.

unregister

public void unregister(SSDPDiscoveryService service)

Description copied from interface: SSDPDiscoveryService.Listener

Callback when a SSDPDiscoveryService.Listener is removed from a SSDPDiscoveryService.

Specified by:

unregister in interface SSDPDiscoveryService.Listener

Parameters:

service - The SSDPDiscoveryService.

sendEvent

public void sendEvent(SSDPDiscoveryService service,
                      DatagramSocket socket,
                      SSDPMessage message)

Description copied from interface: SSDPDiscoveryService.Listener

Callback made just before sending a SSDPMessage.

Specified by:

sendEvent in interface SSDPDiscoveryService.Listener

Parameters:

service - The SSDPDiscoveryService.

socket - The DatagramSocket.

message - The SSDPMessage.

receiveEvent

public void receiveEvent(SSDPDiscoveryService service,
                         DatagramSocket socket,
                         SSDPMessage message)

Description copied from interface: SSDPDiscoveryService.Listener

Callback made after receiving a SSDPMessage.

Specified by:

receiveEvent in interface SSDPDiscoveryService.Listener

Parameters:

service - The SSDPDiscoveryService.

socket - The DatagramSocket.

message - The SSDPMessage.