org.opendaylight.vtn.manager.internal.util.flow.match

Class VTNTcpMatch

java.lang.Object

org.opendaylight.vtn.manager.internal.util.flow.match.VTNLayer4Match

org.opendaylight.vtn.manager.internal.util.flow.match.VTNLayer4PortMatch<TcpHeader>

org.opendaylight.vtn.manager.internal.util.flow.match.VTNTcpMatch

public final class VTNTcpMatch
extends VTNLayer4PortMatch<TcpHeader>

VTNTcpMatch describes the condition for TCP header to match against packets.

Note that this class is not synchronized.

Constructor Summary

Constructors

Constructor and Description
VTNTcpMatch() Construct a new instance that matches every TCP packet.
VTNTcpMatch(org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.TcpMatchFields tmatch) Construct a new instance from the given TcpMatchFields instance.
VTNTcpMatch(VTNPortRange src, VTNPortRange dst) Construct a new instance.
VTNTcpMatch(VtnTcpMatchFields vtmatch) Construct a new instance from the given VtnTcpMatchFields instance.

Method Summary

Modifier and Type	Method and Description
FlowMatchType	getDestinationMatchType() Return a flow match type corresponding to the destination port.
Class<TcpHeader>	getHeaderType() Return a class which represents the packet header type.
short	getInetProtocol(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpVersion ver) Return an IP protocol number assigned to this protocol.
FlowMatchType	getSourceMatchType() Return a flow match type corresponding to the source port.
void	setMatch(org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.flow.MatchBuilder builder, org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpVersion ver) Configure the condition represented by this instance into the given MD-SAL flow match builder.
VtnTcpMatch	toVtnLayer4Match() Return a VtnTcpMatch instance which contains the condition represented by this instance.

Methods inherited from class org.opendaylight.vtn.manager.internal.util.flow.match.VTNLayer4PortMatch

equals, getDestinationPort, getSourcePort, hashCode, isEmpty, match, setConditionKey, verify

Methods inherited from class org.opendaylight.vtn.manager.internal.util.flow.match.VTNLayer4Match

create, create

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VTNTcpMatch

public VTNTcpMatch()

Construct a new instance that matches every TCP packet.

VTNTcpMatch

public VTNTcpMatch(VTNPortRange src,
                   VTNPortRange dst)

Construct a new instance.

Parameters:

src - A VTNPortRange instance which specifies the range of the source port number. null matches every source port number.

dst - A VTNPortRange instance which specifies the range of the destination port number. null matches every destination port number.

VTNTcpMatch

public VTNTcpMatch(VtnTcpMatchFields vtmatch)
            throws RpcException

Construct a new instance from the given VtnTcpMatchFields instance.

Parameters:

vtmatch - A VtnTcpMatchFields instance.

Throws:

NullPointerException - vtmatch is null.

RpcException - vtmatch contains invalid value.

VTNTcpMatch

public VTNTcpMatch(org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.TcpMatchFields tmatch)
            throws RpcException

Construct a new instance from the given TcpMatchFields instance.

Parameters:

tmatch - A TcpMatchFields instance.

Throws:

NullPointerException - tmatch is null.

RpcException - tmatch contains invalid value.

Method Detail

getInetProtocol

public short getInetProtocol(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpVersion ver)

Return an IP protocol number assigned to this protocol.

Specified by:

getInetProtocol in class VTNLayer4Match

Parameters:

ver - An IpVersion instance which describes the IP version.

Returns:

6 is always returned.

toVtnLayer4Match

public VtnTcpMatch toVtnLayer4Match()

Return a VtnTcpMatch instance which contains the condition represented by this instance.

Specified by:

toVtnLayer4Match in class VTNLayer4Match

Returns:

A VtnTcpMatch instance if this instance contains the condition. null if this instance does not contain any condition.

setMatch

public void setMatch(org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.flow.MatchBuilder builder,
                     org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpVersion ver)

Configure the condition represented by this instance into the given MD-SAL flow match builder.

Specified by:

setMatch in class VTNLayer4Match

Parameters:

builder - A MatchBuilder instance.

ver - An IpVersion instance which describes the IP version.

getHeaderType

public Class<TcpHeader> getHeaderType()

Return a class which represents the packet header type.

Specified by:

getHeaderType in class VTNLayer4PortMatch<TcpHeader>

Returns:

A class for TcpHeader.

getSourceMatchType

public FlowMatchType getSourceMatchType()

Return a flow match type corresponding to the source port.

Specified by:

getSourceMatchType in class VTNLayer4PortMatch<TcpHeader>

Returns:

FlowMatchType.TCP_SRC.

getDestinationMatchType

public FlowMatchType getDestinationMatchType()

Return a flow match type corresponding to the destination port.

Specified by:

getDestinationMatchType in class VTNLayer4PortMatch<TcpHeader>

Returns:

FlowMatchType.TCP_DST.