org.onosproject.lisp.msg.protocols

Interface LispMessage

All Known Subinterfaces:

LispEncapsulatedControl, LispInfo, LispInfoReply, LispInfoRequest, LispMapNotify, LispMapReferral, LispMapRegister, LispMapReply, LispMapRequest

All Known Implementing Classes:

AbstractLispMessage, DefaultLispEncapsulatedControl, DefaultLispInfo, DefaultLispInfoReply, DefaultLispInfoRequest, DefaultLispMapNotify, DefaultLispMapReferral, DefaultLispMapRegister, DefaultLispMapReply, DefaultLispMapRequest

public interface LispMessage

LISP message interface.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	LispMessage.Builder LISP message builder interface.

Method Summary

Modifier and Type	Method and Description
void	configSender(InetSocketAddress sender) Configures the sender's IP address with port number.
LispMessage.Builder	createBuilder() Generates LISP message builder.
InetSocketAddress	getSender() Obtains the sender's IP address with port number.
LispType	getType() Obtains LISP message type.
void	writeTo(io.netty.buffer.ByteBuf byteBuf) Writes LISP message object into communication channel.

Method Detail

getType

LispType getType()

Obtains LISP message type.

Returns:

LISP message type

configSender

void configSender(InetSocketAddress sender)

Configures the sender's IP address with port number. Note that this information is used to make the UDP datagram packet.

Parameters:

sender - LISP message sender

getSender

InetSocketAddress getSender()

Obtains the sender's IP address with port number. Note that this information is used to make the UDP datagram packet.

Returns:

send's IP address with port number

writeTo

void writeTo(io.netty.buffer.ByteBuf byteBuf)
      throws LispWriterException

Writes LISP message object into communication channel.

Parameters:

byteBuf - byte buffer

Throws:

LispWriterException - if the writing request is failed due to the lisp object cannot be written to the buffer.

createBuilder

LispMessage.Builder createBuilder()

Generates LISP message builder.

Returns:

builder object